| <!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</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"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":18,"i5":18,"i6":6,"i7":18,"i8":18,"i9":6,"i10":6,"i11":18,"i12":18,"i13":18,"i14":18,"i15":18,"i16":18,"i17":18,"i18":18,"i19":18,"i20":18,"i21":6,"i22":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"; |
| </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/BaseSessionCatalog.AsCatalog.html" title="class in org.apache.iceberg.catalog"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface 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.html" target="_top">Frames</a></li> |
| <li><a href="Catalog.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><a href="#nested.class.summary">Nested</a> | </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" class="title">Interface Catalog</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.html" title="class in org.apache.iceberg">BaseMetastoreCatalog</a>, <a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.AsCatalog.html" title="class in org.apache.iceberg.catalog">BaseSessionCatalog.AsCatalog</a>, <a href="../../../../org/apache/iceberg/CachingCatalog.html" title="class in org.apache.iceberg">CachingCatalog</a>, <a href="../../../../org/apache/iceberg/aws/dynamodb/DynamoDbCatalog.html" title="class in org.apache.iceberg.aws.dynamodb">DynamoDbCatalog</a>, <a href="../../../../org/apache/iceberg/dell/ecs/EcsCatalog.html" title="class in org.apache.iceberg.dell.ecs">EcsCatalog</a>, <a href="../../../../org/apache/iceberg/aws/glue/GlueCatalog.html" title="class in org.apache.iceberg.aws.glue">GlueCatalog</a>, <a href="../../../../org/apache/iceberg/hadoop/HadoopCatalog.html" title="class in org.apache.iceberg.hadoop">HadoopCatalog</a>, <a href="../../../../org/apache/iceberg/hive/HiveCatalog.html" title="class in org.apache.iceberg.hive">HiveCatalog</a>, <a href="../../../../org/apache/iceberg/jdbc/JdbcCatalog.html" title="class in org.apache.iceberg.jdbc">JdbcCatalog</a>, <a href="../../../../org/apache/iceberg/nessie/NessieCatalog.html" title="class in org.apache.iceberg.nessie">NessieCatalog</a>, <a href="../../../../org/apache/iceberg/rest/RESTCatalog.html" title="class in org.apache.iceberg.rest">RESTCatalog</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Catalog</span></pre> |
| <div class="block">A Catalog API for table create, drop, and load operations.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a></span></code> |
| <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>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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><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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default <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.html#buildTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-">buildTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</code> |
| <div class="block">/** Instantiate a builder to either create a table or start a create/replace transaction.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default <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.html#createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-">createTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</code> |
| <div class="block">Create an unpartitioned table.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default <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.html#createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-">createTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</code> |
| <div class="block">Create a table.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <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.html#createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.util.Map-">createTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.util.Map<java.lang.String,java.lang.String> properties)</code> |
| <div class="block">Create a table.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default <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.html#createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.lang.String-java.util.Map-">createTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.lang.String location, |
| java.util.Map<java.lang.String,java.lang.String> properties)</code> |
| <div class="block">Create a table.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#dropTable-org.apache.iceberg.catalog.TableIdentifier-">dropTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code> |
| <div class="block">Drop a table and delete all data and metadata files.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#dropTable-org.apache.iceberg.catalog.TableIdentifier-boolean-">dropTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| boolean purge)</code> |
| <div class="block">Drop a table; optionally delete data and metadata files.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#initialize-java.lang.String-java.util.Map-">initialize</a></span>(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.String> properties)</code> |
| <div class="block">Initialize a catalog given a custom name and a map of catalog properties.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#invalidateTable-org.apache.iceberg.catalog.TableIdentifier-">invalidateTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code> |
| <div class="block">Invalidate cached table metadata from current catalog.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#listTables-org.apache.iceberg.catalog.Namespace-">listTables</a></span>(<a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace)</code> |
| <div class="block">Return all the identifiers under this namespace.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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.html#loadTable-org.apache.iceberg.catalog.TableIdentifier-">loadTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code> |
| <div class="block">Load a table.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>default java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#name--">name</a></span>()</code> |
| <div class="block">Return the name for this catalog.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default <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.html#newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-">newCreateTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</code> |
| <div class="block">Start a transaction to create a table.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default <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.html#newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-">newCreateTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</code> |
| <div class="block">Start a transaction to create a table.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>default <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.html#newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.util.Map-">newCreateTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.util.Map<java.lang.String,java.lang.String> properties)</code> |
| <div class="block">Start a transaction to create a table.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>default <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.html#newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.lang.String-java.util.Map-">newCreateTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.lang.String location, |
| java.util.Map<java.lang.String,java.lang.String> properties)</code> |
| <div class="block">Start a transaction to create a table.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>default <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.html#newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-boolean-">newReplaceTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| boolean orCreate)</code> |
| <div class="block">Start a transaction to replace a table.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>default <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.html#newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-boolean-">newReplaceTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| boolean orCreate)</code> |
| <div class="block">Start a transaction to replace a table.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>default <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.html#newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.util.Map-boolean-">newReplaceTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| boolean orCreate)</code> |
| <div class="block">Start a transaction to replace a table.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>default <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.html#newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.lang.String-java.util.Map-boolean-">newReplaceTableTransaction</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.lang.String location, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| boolean orCreate)</code> |
| <div class="block">Start a transaction to replace a table.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>default <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.html#registerTable-org.apache.iceberg.catalog.TableIdentifier-java.lang.String-">registerTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| java.lang.String metadataFileLocation)</code> |
| <div class="block">Register a table with the catalog if it does not exist.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#renameTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.catalog.TableIdentifier-">renameTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> from, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> to)</code> |
| <div class="block">Rename a table.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/Catalog.html#tableExists-org.apache.iceberg.catalog.TableIdentifier-">tableExists</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code> |
| <div class="block">Check whether table exists.</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="name--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>default java.lang.String name()</pre> |
| <div class="block">Return the name for this catalog.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this catalog's name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listTables-org.apache.iceberg.catalog.Namespace-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listTables</h4> |
| <pre>java.util.List<<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>> listTables(<a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace)</pre> |
| <div class="block">Return all the identifiers under this namespace.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - a namespace</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of identifiers for tables</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/NotFoundException.html" title="class in org.apache.iceberg.exceptions">NotFoundException</a></code> - if the namespace is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> createTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.lang.String location, |
| java.util.Map<java.lang.String,java.lang.String> properties)</pre> |
| <div class="block">Create a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dd><code>location</code> - a location for the table; leave null if unspecified</dd> |
| <dd><code>properties</code> - a string map of table properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Table instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> createTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.util.Map<java.lang.String,java.lang.String> properties)</pre> |
| <div class="block">Create a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dd><code>properties</code> - a string map of table properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Table instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> createTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</pre> |
| <div class="block">Create a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Table instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> createTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</pre> |
| <div class="block">Create an unpartitioned table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Table instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newCreateTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newCreateTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.lang.String location, |
| java.util.Map<java.lang.String,java.lang.String> properties)</pre> |
| <div class="block">Start a transaction to create a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dd><code>location</code> - a location for the table; leave null if unspecified</dd> |
| <dd><code>properties</code> - a string map of table properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to create the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newCreateTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newCreateTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.util.Map<java.lang.String,java.lang.String> properties)</pre> |
| <div class="block">Start a transaction to create a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dd><code>properties</code> - a string map of table properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to create the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newCreateTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newCreateTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec)</pre> |
| <div class="block">Start a transaction to create a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to create the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newCreateTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newCreateTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newCreateTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</pre> |
| <div class="block">Start a transaction to create a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to create the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.lang.String-java.util.Map-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newReplaceTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newReplaceTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.lang.String location, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| boolean orCreate)</pre> |
| <div class="block">Start a transaction to replace a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dd><code>location</code> - a location for the table; leave null if unspecified</dd> |
| <dd><code>properties</code> - a string map of table properties</dd> |
| <dd><code>orCreate</code> - whether to create the table if not exists</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to replace the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/NoSuchTableException.html" title="class in org.apache.iceberg.exceptions">NoSuchTableException</a></code> - if the table doesn't exist and orCreate is false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-java.util.Map-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newReplaceTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newReplaceTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| boolean orCreate)</pre> |
| <div class="block">Start a transaction to replace a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dd><code>properties</code> - a string map of table properties</dd> |
| <dd><code>orCreate</code> - whether to create the table if not exists</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to replace the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/NoSuchTableException.html" title="class in org.apache.iceberg.exceptions">NoSuchTableException</a></code> - if the table doesn't exist and orCreate is false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-org.apache.iceberg.PartitionSpec-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newReplaceTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newReplaceTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| boolean orCreate)</pre> |
| <div class="block">Start a transaction to replace a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dd><code>orCreate</code> - whether to create the table if not exists</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to replace the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/NoSuchTableException.html" title="class in org.apache.iceberg.exceptions">NoSuchTableException</a></code> - if the table doesn't exist and orCreate is false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newReplaceTableTransaction-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newReplaceTableTransaction</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg">Transaction</a> newReplaceTableTransaction(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| boolean orCreate)</pre> |
| <div class="block">Start a transaction to replace a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dd><code>orCreate</code> - whether to create the table if not exists</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../../../org/apache/iceberg/Transaction.html" title="interface in org.apache.iceberg"><code>Transaction</code></a> to replace the table</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/NoSuchTableException.html" title="class in org.apache.iceberg.exceptions">NoSuchTableException</a></code> - if the table doesn't exist and orCreate is false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tableExists-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tableExists</h4> |
| <pre>default boolean tableExists(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Check whether table exists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the table exists, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropTable-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTable</h4> |
| <pre>default boolean dropTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Drop a table and delete all data and metadata files.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the table was dropped, false if the table did not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropTable-org.apache.iceberg.catalog.TableIdentifier-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTable</h4> |
| <pre>boolean dropTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| boolean purge)</pre> |
| <div class="block">Drop a table; optionally delete data and metadata files. |
| |
| <p>If purge is set to true the implementation should delete all data and metadata files.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>purge</code> - if true, delete all data and metadata files in the table</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the table was dropped, false if the table did not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="renameTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameTable</h4> |
| <pre>void renameTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> from, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> to)</pre> |
| <div class="block">Rename a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>from</code> - identifier of the table to rename</dd> |
| <dd><code>to</code> - new table name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/NoSuchTableException.html" title="class in org.apache.iceberg.exceptions">NoSuchTableException</a></code> - if the from table does not exist</dd> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the to table already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadTable-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTable</h4> |
| <pre><a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> loadTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Load a table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>instance of <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg"><code>Table</code></a> implementation referred by <code>tableIdentifier</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/NoSuchTableException.html" title="class in org.apache.iceberg.exceptions">NoSuchTableException</a></code> - if the table does not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invalidateTable-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateTable</h4> |
| <pre>default void invalidateTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Invalidate cached table metadata from current catalog. |
| |
| <p>If the table is already loaded or cached, drop cached data. If the table does not exist or |
| is not cached, do nothing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerTable-org.apache.iceberg.catalog.TableIdentifier-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerTable</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> registerTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| java.lang.String metadataFileLocation)</pre> |
| <div class="block">Register a table with the catalog if it does not exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>metadataFileLocation</code> - the location of a metadata file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Table instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the table already exists in the catalog.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildTable-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildTable</h4> |
| <pre>default <a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a> buildTable(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</pre> |
| <div class="block">/** Instantiate a builder to either create a table or start a create/replace transaction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder to create a table or start a create/replace transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initialize-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>default void initialize(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.String> properties)</pre> |
| <div class="block">Initialize a catalog given a custom name and a map of catalog properties. |
| |
| <p>A custom Catalog implementation must have a no-arg constructor. A compute engine like Spark |
| or Flink will first initialize the catalog without any arguments, and then call this method to |
| complete catalog initialization with properties passed into the engine.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a custom name for the catalog</dd> |
| <dd><code>properties</code> - catalog properties</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/BaseSessionCatalog.AsCatalog.html" title="class in org.apache.iceberg.catalog"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface 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.html" target="_top">Frames</a></li> |
| <li><a href="Catalog.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><a href="#nested.class.summary">Nested</a> | </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> |