| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>TableOperations</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="TableOperations"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":18,"i7":6,"i8":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface TableOperations" class="title">Interface TableOperations</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseMetastoreTableOperations.html" title="class in org.apache.iceberg">BaseMetastoreTableOperations</a></code>, <code><a href="hadoop/HadoopTableOperations.html" title="class in org.apache.iceberg.hadoop">HadoopTableOperations</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>, <code><a href="StaticTableOperations.html" title="class in org.apache.iceberg">StaticTableOperations</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">TableOperations</span></pre> |
| <div class="block">SPI interface to abstract table metadata access and updates.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>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="i1" class="rowColor"> |
| <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="i2" class="altColor"> |
| <td class="colFirst"><code>default <a href="encryption/EncryptionManager.html" title="interface in org.apache.iceberg.encryption">EncryptionManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encryption()">encryption</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a <a href="encryption/EncryptionManager.html" title="interface in org.apache.iceberg.encryption"><code>EncryptionManager</code></a> to encrypt and decrypt data files.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#io()">io</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a <a href="io/FileIO.html" title="interface in org.apache.iceberg.io"><code>FileIO</code></a> to read and write table data and metadata files.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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="i5" 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="i6" class="altColor"> |
| <td class="colFirst"><code>default long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSnapshotId()">newSnapshotId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new ID for a Snapshot</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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="i8" class="altColor"> |
| <td class="colFirst"><code>default <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> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="current()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>current</h4> |
| <pre class="methodSignature"><a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> current()</pre> |
| <div class="block">Return the currently loaded table metadata, without checking for updates.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>table metadata</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="refresh()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refresh</h4> |
| <pre class="methodSignature"><a href="TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> refresh()</pre> |
| <div class="block">Return the current table metadata after checking for updates.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>table metadata</dd> |
| </dl> |
| </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">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">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="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="io()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>io</h4> |
| <pre class="methodSignature"><a href="io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> io()</pre> |
| <div class="block">Returns a <a href="io/FileIO.html" title="interface in org.apache.iceberg.io"><code>FileIO</code></a> to read and write table data and metadata files.</div> |
| </li> |
| </ul> |
| <a id="encryption()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encryption</h4> |
| <pre class="methodSignature">default <a href="encryption/EncryptionManager.html" title="interface in org.apache.iceberg.encryption">EncryptionManager</a> encryption()</pre> |
| <div class="block">Returns a <a href="encryption/EncryptionManager.html" title="interface in org.apache.iceberg.encryption"><code>EncryptionManager</code></a> to encrypt and decrypt data files.</div> |
| </li> |
| </ul> |
| <a id="metadataFileLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>metadataFileLocation</h4> |
| <pre class="methodSignature">java.lang.String metadataFileLocation​(java.lang.String fileName)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="locationProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>locationProvider</h4> |
| <pre class="methodSignature"><a href="io/LocationProvider.html" title="interface in org.apache.iceberg.io">LocationProvider</a> locationProvider()</pre> |
| <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="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">default <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">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="#refresh()"><code>refresh()</code></a> or <a href="#commit(org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)"><code>commit(TableMetadata, TableMetadata)</code></a>.</div> |
| <dl> |
| <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="newSnapshotId()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newSnapshotId</h4> |
| <pre class="methodSignature">default long newSnapshotId()</pre> |
| <div class="block">Create a new ID for a Snapshot</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a long snapshot ID</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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
