| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Catalogs</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.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.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.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Catalogs"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>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.mr</a></div> |
| <h2 title="Class Catalogs" class="title">Class Catalogs</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.mr.Catalogs</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">Catalogs</span> |
| extends java.lang.Object</pre> |
| <div class="block">Class for catalog resolution and accessing the common functions for <a href="../catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><code>Catalog</code></a> API. |
| |
| <p>If the catalog name is provided, get the catalog type from iceberg.catalog.<code>catalogName |
| </code>.type config. |
| |
| <p>In case the catalog name is <a href="#ICEBERG_HADOOP_TABLE_NAME"><code>location_based_table</code></a>, type is |
| ignored and tables will be loaded using <a href="../hadoop/HadoopTables.html" title="class in org.apache.iceberg.hadoop"><code>HadoopTables</code></a>. |
| |
| <p>In case the value of catalog type is null, iceberg.catalog.<code>catalogName</code> |
| .catalog-impl config is used to determine the catalog implementation class. |
| |
| <p>If catalog name is null, get the catalog type from <a href="../CatalogUtil.html#ICEBERG_CATALOG_TYPE"><code>catalog type</code></a> config: |
| |
| <ul> |
| <li>hive: HiveCatalog |
| <li>location: HadoopTables |
| <li>hadoop: HadoopCatalog |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ICEBERG_DEFAULT_CATALOG_NAME">ICEBERG_DEFAULT_CATALOG_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ICEBERG_HADOOP_TABLE_NAME">ICEBERG_HADOOP_TABLE_NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOCATION">LOCATION</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NAME">NAME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createTable(org.apache.hadoop.conf.Configuration,java.util.Properties)">createTable</a></span>​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an Iceberg table using the catalog specified by the configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropTable(org.apache.hadoop.conf.Configuration,java.util.Properties)">dropTable</a></span>​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</code></th> |
| <td class="colLast"> |
| <div class="block">Drops an Iceberg table using the catalog specified by the configuration.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hiveCatalog(org.apache.hadoop.conf.Configuration,java.util.Properties)">hiveCatalog</a></span>​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if HiveCatalog is used</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadTable(org.apache.hadoop.conf.Configuration)">loadTable</a></span>​(org.apache.hadoop.conf.Configuration conf)</code></th> |
| <td class="colLast"> |
| <div class="block">Load an Iceberg table using the catalog and table identifier (or table path) specified by the |
| configuration.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadTable(org.apache.hadoop.conf.Configuration,java.util.Properties)">loadTable</a></span>​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</code></th> |
| <td class="colLast"> |
| <div class="block">Load an Iceberg table using the catalog specified by the configuration.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="ICEBERG_DEFAULT_CATALOG_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_DEFAULT_CATALOG_NAME</h4> |
| <pre>public static final java.lang.String ICEBERG_DEFAULT_CATALOG_NAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.iceberg.mr.Catalogs.ICEBERG_DEFAULT_CATALOG_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="ICEBERG_HADOOP_TABLE_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_HADOOP_TABLE_NAME</h4> |
| <pre>public static final java.lang.String ICEBERG_HADOOP_TABLE_NAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.iceberg.mr.Catalogs.ICEBERG_HADOOP_TABLE_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NAME</h4> |
| <pre>public static final java.lang.String NAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.iceberg.mr.Catalogs.NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="LOCATION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LOCATION</h4> |
| <pre>public static final java.lang.String LOCATION</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.iceberg.mr.Catalogs.LOCATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="loadTable(org.apache.hadoop.conf.Configuration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTable</h4> |
| <pre class="methodSignature">public static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a> loadTable​(org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Load an Iceberg table using the catalog and table identifier (or table path) specified by the |
| configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - a Hadoop conf</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Iceberg table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadTable(org.apache.hadoop.conf.Configuration,java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTable</h4> |
| <pre class="methodSignature">public static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a> loadTable​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</pre> |
| <div class="block">Load an Iceberg table using the catalog specified by the configuration. |
| |
| <p>The table identifier (<a href="#NAME"><code>NAME</code></a>) and the catalog name (<a href="InputFormatConfig.html#CATALOG_NAME"><code>InputFormatConfig.CATALOG_NAME</code></a>), or table path (<a href="#LOCATION"><code>LOCATION</code></a>) should be specified |
| by the controlling properties. |
| |
| <p>Used by HiveIcebergSerDe and HiveIcebergStorageHandler</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - a Hadoop</dd> |
| <dd><code>props</code> - the controlling properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Iceberg table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createTable(org.apache.hadoop.conf.Configuration,java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre class="methodSignature">public static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a> createTable​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</pre> |
| <div class="block">Creates an Iceberg table using the catalog specified by the configuration. |
| |
| <p>The properties should contain the following values: |
| |
| <ul> |
| <li>Table identifier (<a href="#NAME"><code>NAME</code></a>) or table path (<a href="#LOCATION"><code>LOCATION</code></a>) is |
| required |
| <li>Table schema (<a href="InputFormatConfig.html#TABLE_SCHEMA"><code>InputFormatConfig.TABLE_SCHEMA</code></a>) is required |
| <li>Partition specification (<a href="InputFormatConfig.html#PARTITION_SPEC"><code>InputFormatConfig.PARTITION_SPEC</code></a>) is optional. Table |
| will be unpartitioned if not provided |
| </ul> |
| |
| <p>Other properties will be handled over to the Table creation. The controlling properties |
| above will not be propagated.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - a Hadoop conf</dd> |
| <dd><code>props</code> - the controlling properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the created Iceberg table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dropTable(org.apache.hadoop.conf.Configuration,java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTable</h4> |
| <pre class="methodSignature">public static boolean dropTable​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</pre> |
| <div class="block">Drops an Iceberg table using the catalog specified by the configuration. |
| |
| <p>The table identifier (<a href="#NAME"><code>NAME</code></a>) or table path (<a href="#LOCATION"><code>LOCATION</code></a>) |
| should be specified by the controlling properties.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - a Hadoop conf</dd> |
| <dd><code>props</code> - the controlling properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the created Iceberg table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hiveCatalog(org.apache.hadoop.conf.Configuration,java.util.Properties)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hiveCatalog</h4> |
| <pre class="methodSignature">public static boolean hiveCatalog​(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</pre> |
| <div class="block">Returns true if HiveCatalog is used</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - a Hadoop conf</dd> |
| <dd><code>props</code> - the controlling properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the Catalog is HiveCatalog</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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>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> |
