| <!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 (1.8.0_231) on Tue Jan 26 14:32:15 PST 2021 --> |
| <title>Catalogs</title> |
| <meta name="date" content="2021-01-26"> |
| <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="Catalogs"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"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"; |
| </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/mr/CatalogLoader.html" title="interface in org.apache.iceberg.mr"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/mr/InputFormatConfig.html" title="class in org.apache.iceberg.mr"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/mr/Catalogs.html" target="_top">Frames</a></li> |
| <li><a href="Catalogs.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><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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg.mr</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> |
| <br> |
| <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="../../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><code>Catalog</code></a> API. |
| <p> |
| Catalog resolution happens in this order: |
| <ol> |
| <li>Custom catalog if specified by <a href="../../../../org/apache/iceberg/mr/InputFormatConfig.html#CATALOG_LOADER_CLASS"><code>InputFormatConfig.CATALOG_LOADER_CLASS</code></a> |
| <li>Hadoop or Hive catalog if specified by <a href="../../../../org/apache/iceberg/mr/InputFormatConfig.html#CATALOG"><code>InputFormatConfig.CATALOG</code></a> |
| <li>Hadoop Tables |
| </ol></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/mr/Catalogs.html#LOCATION">LOCATION</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/mr/Catalogs.html#NAME">NAME</a></span></code> </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="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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <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/mr/Catalogs.html#createTable-org.apache.hadoop.conf.Configuration-java.util.Properties-">createTable</a></span>(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/mr/Catalogs.html#dropTable-org.apache.hadoop.conf.Configuration-java.util.Properties-">dropTable</a></span>(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/mr/Catalogs.html#hiveCatalog-org.apache.hadoop.conf.Configuration-">hiveCatalog</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Returns true if HiveCatalog is used</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <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/mr/Catalogs.html#loadTable-org.apache.hadoop.conf.Configuration-">loadTable</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <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="../../../../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/mr/Catalogs.html#loadTable-org.apache.hadoop.conf.Configuration-java.util.Properties-">loadTable</a></span>(org.apache.hadoop.conf.Configuration conf, |
| java.util.Properties props)</code> |
| <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 name="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> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="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 name="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> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="loadTable-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTable</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/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 name="loadTable-org.apache.hadoop.conf.Configuration-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTable</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/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="../../../../org/apache/iceberg/mr/Catalogs.html#NAME"><code>NAME</code></a>) or table path (<a href="../../../../org/apache/iceberg/mr/Catalogs.html#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 name="createTable-org.apache.hadoop.conf.Configuration-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/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="../../../../org/apache/iceberg/mr/Catalogs.html#NAME"><code>NAME</code></a>) or table path (<a href="../../../../org/apache/iceberg/mr/Catalogs.html#LOCATION"><code>LOCATION</code></a>) is required |
| <li>Table schema (<a href="../../../../org/apache/iceberg/mr/InputFormatConfig.html#TABLE_SCHEMA"><code>InputFormatConfig.TABLE_SCHEMA</code></a>) is required |
| <li>Partition specification (<a href="../../../../org/apache/iceberg/mr/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 name="dropTable-org.apache.hadoop.conf.Configuration-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTable</h4> |
| <pre>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="../../../../org/apache/iceberg/mr/Catalogs.html#NAME"><code>NAME</code></a>) or table path (<a href="../../../../org/apache/iceberg/mr/Catalogs.html#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 name="hiveCatalog-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hiveCatalog</h4> |
| <pre>public static boolean hiveCatalog(org.apache.hadoop.conf.Configuration conf)</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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the Catalog is HiveCatalog</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/mr/CatalogLoader.html" title="interface in org.apache.iceberg.mr"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/mr/InputFormatConfig.html" title="class in org.apache.iceberg.mr"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/mr/Catalogs.html" target="_top">Frames</a></li> |
| <li><a href="Catalogs.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><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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
