| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>BaseMetastoreTableOperations</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BaseMetastoreTableOperations"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":6,"i17":10,"i18":10,"i19":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.iceberg</a></div> |
| <h2 title="Class BaseMetastoreTableOperations" class="title">Class BaseMetastoreTableOperations</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.BaseMetastoreTableOperations</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="dell/ecs/EcsTableOperations.html" title="class in org.apache.iceberg.dell.ecs">EcsTableOperations</a></code>, <code><a href="hive/HiveTableOperations.html" title="class in org.apache.iceberg.hive">HiveTableOperations</a></code>, <code><a href="nessie/NessieTableOperations.html" title="class in org.apache.iceberg.nessie">NessieTableOperations</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">BaseMetastoreTableOperations</span> |
| extends java.lang.Object |
| implements <a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="BaseMetastoreTableOperations.CommitStatus.html" title="enum in org.apache.iceberg">BaseMetastoreTableOperations.CommitStatus</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ICEBERG_TABLE_TYPE_VALUE">ICEBERG_TABLE_TYPE_VALUE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#METADATA_LOCATION_PROP">METADATA_LOCATION_PROP</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PREVIOUS_METADATA_LOCATION_PROP">PREVIOUS_METADATA_LOCATION_PROP</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TABLE_TYPE_PROP">TABLE_TYPE_PROP</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">BaseMetastoreTableOperations</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected <a href="BaseMetastoreTableOperations.CommitStatus.html" title="enum in org.apache.iceberg">BaseMetastoreTableOperations.CommitStatus</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkCommitStatus(java.lang.String,org.apache.iceberg.TableMetadata)">checkCommitStatus</a></span>​(java.lang.String newMetadataLocation, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> config)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempt to load the table and see if any current or past metadata location matches the one we |
| were attempting to set.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)">commit</a></span>​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> base, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</code></th> |
| <td class="colLast"> |
| <div class="block">Replace the base table metadata with a new version.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#current()">current</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the currently loaded table metadata, without checking for updates.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#currentMetadataLocation()">currentMetadataLocation</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#currentVersion()">currentVersion</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disableRefresh()">disableRefresh</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doCommit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)">doCommit</a></span>​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> base, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doRefresh()">doRefresh</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="io/LocationProvider.html" title="interface in org.apache.iceberg.io">LocationProvider</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#locationProvider()">locationProvider</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a <a href="io/LocationProvider.html" title="interface in org.apache.iceberg.io"><code>LocationProvider</code></a> that supplies locations for new new data files.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metadataFileLocation(java.lang.String)">metadataFileLocation</a></span>​(java.lang.String filename)</code></th> |
| <td class="colLast"> |
| <div class="block">Given the name of a metadata file, obtain the full path of that file using an appropriate base |
| location of the implementation's choosing.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refresh()">refresh</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the current table metadata after checking for updates.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshFromMetadataLocation(java.lang.String)">refreshFromMetadataLocation</a></span>​(java.lang.String newLocation)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshFromMetadataLocation(java.lang.String,int)">refreshFromMetadataLocation</a></span>​(java.lang.String newLocation, |
| int numRetries)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshFromMetadataLocation(java.lang.String,java.util.function.Predicate,int)">refreshFromMetadataLocation</a></span>​(java.lang.String newLocation, |
| java.util.function.Predicate<java.lang.Exception> shouldRetry, |
| int numRetries)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshFromMetadataLocation(java.lang.String,java.util.function.Predicate,int,java.util.function.Function)">refreshFromMetadataLocation</a></span>​(java.lang.String newLocation, |
| java.util.function.Predicate<java.lang.Exception> shouldRetry, |
| int numRetries, |
| java.util.function.Function<java.lang.String,​<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>> metadataLoader)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestRefresh()">requestRefresh</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected abstract java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tableName()">tableName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The full name of the table used for logging purposes only.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#temp(org.apache.iceberg.TableMetadata)">temp</a></span>​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> uncommittedMetadata)</code></th> |
| <td class="colLast"> |
| <div class="block">Return a temporary <a href="TableOperations.html" title="interface in org.apache.iceberg"><code>TableOperations</code></a> instance that uses configuration from uncommitted |
| metadata.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeNewMetadata(org.apache.iceberg.TableMetadata,int)">writeNewMetadata</a></span>​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata, |
| int newVersion)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeNewMetadataIfRequired(boolean,org.apache.iceberg.TableMetadata)">writeNewMetadataIfRequired</a></span>​(boolean newTable, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.TableOperations"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></h3> |
| <code><a href="TableOperations.html#encryption()">encryption</a>, <a href="TableOperations.html#io()">io</a>, <a href="TableOperations.html#newSnapshotId()">newSnapshotId</a>, <a href="TableOperations.html#requireStrictCleanup()">requireStrictCleanup</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="TABLE_TYPE_PROP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TABLE_TYPE_PROP</h4> |
| <pre>public static final java.lang.String TABLE_TYPE_PROP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.BaseMetastoreTableOperations.TABLE_TYPE_PROP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="ICEBERG_TABLE_TYPE_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_TABLE_TYPE_VALUE</h4> |
| <pre>public static final java.lang.String ICEBERG_TABLE_TYPE_VALUE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.BaseMetastoreTableOperations.ICEBERG_TABLE_TYPE_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="METADATA_LOCATION_PROP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METADATA_LOCATION_PROP</h4> |
| <pre>public static final java.lang.String METADATA_LOCATION_PROP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.BaseMetastoreTableOperations.METADATA_LOCATION_PROP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="PREVIOUS_METADATA_LOCATION_PROP"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PREVIOUS_METADATA_LOCATION_PROP</h4> |
| <pre>public static final java.lang.String PREVIOUS_METADATA_LOCATION_PROP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.BaseMetastoreTableOperations.PREVIOUS_METADATA_LOCATION_PROP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseMetastoreTableOperations</h4> |
| <pre>protected BaseMetastoreTableOperations()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="tableName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tableName</h4> |
| <pre class="methodSignature">protected abstract java.lang.String tableName()</pre> |
| <div class="block">The full name of the table used for logging purposes only. For example for HiveTableOperations |
| it is catalogName + "." + database + "." + table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The full name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="current()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>current</h4> |
| <pre class="methodSignature">public <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> current()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="TableOperations.html#current()">TableOperations</a></code></span></div> |
| <div class="block">Return the currently loaded table metadata, without checking for updates.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="TableOperations.html#current()">current</a></code> in interface <code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>table metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="currentMetadataLocation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentMetadataLocation</h4> |
| <pre class="methodSignature">public java.lang.String currentMetadataLocation()</pre> |
| </li> |
| </ul> |
| <a id="currentVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentVersion</h4> |
| <pre class="methodSignature">public int currentVersion()</pre> |
| </li> |
| </ul> |
| <a id="refresh()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refresh</h4> |
| <pre class="methodSignature">public <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> refresh()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="TableOperations.html#refresh()">TableOperations</a></code></span></div> |
| <div class="block">Return the current table metadata after checking for updates.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="TableOperations.html#refresh()">refresh</a></code> in interface <code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>table metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doRefresh()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doRefresh</h4> |
| <pre class="methodSignature">protected void doRefresh()</pre> |
| </li> |
| </ul> |
| <a id="commit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre class="methodSignature">public void commit​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> base, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="TableOperations.html#commit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)">TableOperations</a></code></span></div> |
| <div class="block">Replace the base table metadata with a new version. |
| |
| <p>This method should implement and document atomicity guarantees. |
| |
| <p>Implementations must check that the base metadata is current to avoid overwriting updates. |
| Once the atomic commit operation succeeds, implementations must not perform any operations that |
| may fail because failure in this method cannot be distinguished from commit failure. |
| |
| <p>Implementations must throw a <a href="exceptions/CommitStateUnknownException.html" title="class in org.apache.iceberg.exceptions"><code>CommitStateUnknownException</code></a> in cases where it cannot be |
| determined if the commit succeeded or failed. For example if a network partition causes the |
| confirmation of the commit to be lost, the implementation should throw a |
| CommitStateUnknownException. This is important because downstream users of this API need to |
| know whether they can clean up the commit or not, if the state is unknown then it is not safe |
| to remove any files. All other exceptions will be treated as if the commit has failed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="TableOperations.html#commit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)">commit</a></code> in interface <code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>base</code> - table metadata on which changes were based</dd> |
| <dd><code>metadata</code> - new table metadata with updates</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doCommit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doCommit</h4> |
| <pre class="methodSignature">protected void doCommit​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> base, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</pre> |
| </li> |
| </ul> |
| <a id="requestRefresh()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestRefresh</h4> |
| <pre class="methodSignature">protected void requestRefresh()</pre> |
| </li> |
| </ul> |
| <a id="disableRefresh()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disableRefresh</h4> |
| <pre class="methodSignature">protected void disableRefresh()</pre> |
| </li> |
| </ul> |
| <a id="writeNewMetadataIfRequired(boolean,org.apache.iceberg.TableMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeNewMetadataIfRequired</h4> |
| <pre class="methodSignature">protected java.lang.String writeNewMetadataIfRequired​(boolean newTable, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</pre> |
| </li> |
| </ul> |
| <a id="writeNewMetadata(org.apache.iceberg.TableMetadata,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeNewMetadata</h4> |
| <pre class="methodSignature">protected java.lang.String writeNewMetadata​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata, |
| int newVersion)</pre> |
| </li> |
| </ul> |
| <a id="refreshFromMetadataLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshFromMetadataLocation</h4> |
| <pre class="methodSignature">protected void refreshFromMetadataLocation​(java.lang.String newLocation)</pre> |
| </li> |
| </ul> |
| <a id="refreshFromMetadataLocation(java.lang.String,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshFromMetadataLocation</h4> |
| <pre class="methodSignature">protected void refreshFromMetadataLocation​(java.lang.String newLocation, |
| int numRetries)</pre> |
| </li> |
| </ul> |
| <a id="refreshFromMetadataLocation(java.lang.String,java.util.function.Predicate,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshFromMetadataLocation</h4> |
| <pre class="methodSignature">protected void refreshFromMetadataLocation​(java.lang.String newLocation, |
| java.util.function.Predicate<java.lang.Exception> shouldRetry, |
| int numRetries)</pre> |
| </li> |
| </ul> |
| <a id="refreshFromMetadataLocation(java.lang.String,java.util.function.Predicate,int,java.util.function.Function)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshFromMetadataLocation</h4> |
| <pre class="methodSignature">protected void refreshFromMetadataLocation​(java.lang.String newLocation, |
| java.util.function.Predicate<java.lang.Exception> shouldRetry, |
| int numRetries, |
| java.util.function.Function<java.lang.String,​<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>> metadataLoader)</pre> |
| </li> |
| </ul> |
| <a id="metadataFileLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>metadataFileLocation</h4> |
| <pre class="methodSignature">public java.lang.String metadataFileLocation​(java.lang.String filename)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="TableOperations.html#metadataFileLocation(java.lang.String)">TableOperations</a></code></span></div> |
| <div class="block">Given the name of a metadata file, obtain the full path of that file using an appropriate base |
| location of the implementation's choosing. |
| |
| <p>The file may not exist yet, in which case the path should be returned as if it were to be |
| created by e.g. <a href="io/FileIO.html#newOutputFile(java.lang.String)"><code>FileIO.newOutputFile(String)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="TableOperations.html#metadataFileLocation(java.lang.String)">metadataFileLocation</a></code> in interface <code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="locationProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>locationProvider</h4> |
| <pre class="methodSignature">public <a href="io/LocationProvider.html" title="interface in org.apache.iceberg.io">LocationProvider</a> locationProvider()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="TableOperations.html#locationProvider()">TableOperations</a></code></span></div> |
| <div class="block">Returns a <a href="io/LocationProvider.html" title="interface in org.apache.iceberg.io"><code>LocationProvider</code></a> that supplies locations for new new data files.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="TableOperations.html#locationProvider()">locationProvider</a></code> in interface <code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a location provider configured for the current table state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="temp(org.apache.iceberg.TableMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>temp</h4> |
| <pre class="methodSignature">public <a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a> temp​(<a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> uncommittedMetadata)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="TableOperations.html#temp(org.apache.iceberg.TableMetadata)">TableOperations</a></code></span></div> |
| <div class="block">Return a temporary <a href="TableOperations.html" title="interface in org.apache.iceberg"><code>TableOperations</code></a> instance that uses configuration from uncommitted |
| metadata. |
| |
| <p>This is called by transactions when uncommitted table metadata should be used; for example, |
| to create a metadata file location based on metadata in the transaction that has not been |
| committed. |
| |
| <p>Transactions will not call <a href="TableOperations.html#refresh()"><code>TableOperations.refresh()</code></a> or <a href="TableOperations.html#commit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)"><code>TableOperations.commit(TableMetadata, |
| TableMetadata)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="TableOperations.html#temp(org.apache.iceberg.TableMetadata)">temp</a></code> in interface <code><a href="TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uncommittedMetadata</code> - uncommitted table metadata</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a temporary table operations that behaves like the uncommitted metadata is current</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkCommitStatus(java.lang.String,org.apache.iceberg.TableMetadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>checkCommitStatus</h4> |
| <pre class="methodSignature">protected <a href="BaseMetastoreTableOperations.CommitStatus.html" title="enum in org.apache.iceberg">BaseMetastoreTableOperations.CommitStatus</a> checkCommitStatus​(java.lang.String newMetadataLocation, |
| <a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> config)</pre> |
| <div class="block">Attempt to load the table and see if any current or past metadata location matches the one we |
| were attempting to set. This is used as a last resort when we are dealing with exceptions that |
| may indicate the commit has failed but are not proof that this is the case. Past locations must |
| also be searched on the chance that a second committer was able to successfully commit on top |
| of our commit.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMetadataLocation</code> - the path of the new commit file</dd> |
| <dd><code>config</code> - metadata to use for configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Commit Status of Success, Failure or Unknown</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
