| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Catalog.TableBuilder</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Catalog.TableBuilder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <li><a href="../../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/catalog/Catalog.TableBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Catalog.TableBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg.catalog</div> |
| <h2 title="Interface Catalog.TableBuilder" class="title">Interface Catalog.TableBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/iceberg/BaseMetastoreCatalog.BaseMetastoreCatalogTableBuilder.html" title="class in org.apache.iceberg">BaseMetastoreCatalog.BaseMetastoreCatalogTableBuilder</a>, <a href="../../../../org/apache/iceberg/view/BaseMetastoreViewCatalog.BaseMetastoreViewCatalogTableBuilder.html" title="class in org.apache.iceberg.view">BaseMetastoreViewCatalog.BaseMetastoreViewCatalogTableBuilder</a>, <a href="../../../../org/apache/iceberg/jdbc/JdbcCatalog.ViewAwareTableBuilder.html" title="class in org.apache.iceberg.jdbc">JdbcCatalog.ViewAwareTableBuilder</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog">Catalog</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">Catalog.TableBuilder</span></pre> |
| <div class="block">A builder used to create valid <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg"><code>tables</code></a> or start create/replace <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>transactions</code></a>. |
| |
| <p>Call <a href="../../../../org/apache/iceberg/catalog/Catalog.html#buildTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-"><code>Catalog.buildTable(TableIdentifier, Schema)</code></a> to create a new builder.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#create--">create</a></span>()</code> |
| <div class="block">Creates the table.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#createOrReplaceTransaction--">createOrReplaceTransaction</a></span>()</code> |
| <div class="block">Starts a transaction to create or replace the table.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#createTransaction--">createTransaction</a></span>()</code> |
| <div class="block">Starts a transaction to create the table.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#replaceTransaction--">replaceTransaction</a></span>()</code> |
| <div class="block">Starts a transaction to replace the table.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#withLocation-java.lang.String-">withLocation</a></span>(java.lang.String location)</code> |
| <div class="block">Sets a location for the table.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#withPartitionSpec-org.apache.iceberg.PartitionSpec-">withPartitionSpec</a></span>(<a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</code> |
| <div class="block">Sets a partition spec for the table.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#withProperties-java.util.Map-">withProperties</a></span>(java.util.Map<java.lang.String,java.lang.String> properties)</code> |
| <div class="block">Adds key/value properties to the table.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#withProperty-java.lang.String-java.lang.String-">withProperty</a></span>(java.lang.String key, |
| java.lang.String value)</code> |
| <div class="block">Adds a key/value property to the table.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html#withSortOrder-org.apache.iceberg.SortOrder-">withSortOrder</a></span>(<a href="../../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg">SortOrder</a> sortOrder)</code> |
| <div class="block">Sets a sort order for the table.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withPartitionSpec-org.apache.iceberg.PartitionSpec-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withPartitionSpec</h4> |
| <pre><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a> withPartitionSpec(<a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</pre> |
| <div class="block">Sets a partition spec for the table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withSortOrder-org.apache.iceberg.SortOrder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSortOrder</h4> |
| <pre><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a> withSortOrder(<a href="../../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg">SortOrder</a> sortOrder)</pre> |
| <div class="block">Sets a sort order for the table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sortOrder</code> - a sort order</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withLocation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withLocation</h4> |
| <pre><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a> withLocation(java.lang.String location)</pre> |
| <div class="block">Sets a location for the table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>location</code> - a location</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withProperties-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withProperties</h4> |
| <pre><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a> withProperties(java.util.Map<java.lang.String,java.lang.String> properties)</pre> |
| <div class="block">Adds key/value properties to the table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - key/value properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withProperty-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withProperty</h4> |
| <pre><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a> withProperty(java.lang.String key, |
| java.lang.String value)</pre> |
| <div class="block">Adds a key/value property to the table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - a key</dd> |
| <dd><code>value</code> - a value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre><a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> create()</pre> |
| <div class="block">Creates the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the created table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTransaction</h4> |
| <pre><a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> createTransaction()</pre> |
| <div class="block">Starts a transaction to create the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to create the table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceTransaction</h4> |
| <pre><a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> replaceTransaction()</pre> |
| <div class="block">Starts a transaction to replace the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to replace the table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createOrReplaceTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createOrReplaceTransaction</h4> |
| <pre><a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> createOrReplaceTransaction()</pre> |
| <div class="block">Starts a transaction to create or replace the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to create or replace the table</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <li><a href="../../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/catalog/Catalog.TableBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Catalog.TableBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |