| <!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>CatalogUtil</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="CatalogUtil"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":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/CatalogProperties.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/ChangelogOperation.html" title="enum in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/CatalogUtil.html" target="_top">Frames</a></li> |
| <li><a href="CatalogUtil.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</div> |
| <h2 title="Class CatalogUtil" class="title">Class CatalogUtil</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.CatalogUtil</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CatalogUtil</span> |
| extends java.lang.Object</pre> |
| </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/CatalogUtil.html#ICEBERG_CATALOG_HADOOP">ICEBERG_CATALOG_HADOOP</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/CatalogUtil.html#ICEBERG_CATALOG_HIVE">ICEBERG_CATALOG_HIVE</a></span></code> </td> |
| </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/CatalogUtil.html#ICEBERG_CATALOG_REST">ICEBERG_CATALOG_REST</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/CatalogUtil.html#ICEBERG_CATALOG_TYPE">ICEBERG_CATALOG_TYPE</a></span></code> |
| <div class="block">Shortcut catalog property to load a catalog implementation through a short type name, instead |
| of specifying a full java class through <a href="../../../org/apache/iceberg/CatalogProperties.html#CATALOG_IMPL"><code>CatalogProperties.CATALOG_IMPL</code></a>.</div> |
| </td> |
| </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/CatalogUtil.html#ICEBERG_CATALOG_TYPE_HADOOP">ICEBERG_CATALOG_TYPE_HADOOP</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/CatalogUtil.html#ICEBERG_CATALOG_TYPE_HIVE">ICEBERG_CATALOG_TYPE_HIVE</a></span></code> </td> |
| </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/CatalogUtil.html#ICEBERG_CATALOG_TYPE_REST">ICEBERG_CATALOG_TYPE_REST</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/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog">Catalog</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/CatalogUtil.html#buildIcebergCatalog-java.lang.String-java.util.Map-java.lang.Object-">buildIcebergCatalog</a></span>(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.String> options, |
| java.lang.Object conf)</code> |
| <div class="block">Build an Iceberg <a href="../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><code>Catalog</code></a> based on a map of catalog properties and optional Hadoop |
| configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/CatalogUtil.html#configureHadoopConf-java.lang.Object-java.lang.Object-">configureHadoopConf</a></span>(java.lang.Object maybeConfigurable, |
| java.lang.Object conf)</code> |
| <div class="block">Dynamically detects whether an object is a Hadoop Configurable and calls setConf.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/CatalogUtil.html#deleteFiles-org.apache.iceberg.io.FileIO-java.lang.Iterable-java.lang.String-boolean-">deleteFiles</a></span>(<a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> io, |
| java.lang.Iterable<java.lang.String> files, |
| java.lang.String type, |
| boolean concurrent)</code> |
| <div class="block">Helper to delete files.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/CatalogUtil.html#dropTableData-org.apache.iceberg.io.FileIO-org.apache.iceberg.TableMetadata-">dropTableData</a></span>(<a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> io, |
| <a href="../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</code> |
| <div class="block">Drops all data and metadata files referenced by TableMetadata.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog">Catalog</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/CatalogUtil.html#loadCatalog-java.lang.String-java.lang.String-java.util.Map-java.lang.Object-">loadCatalog</a></span>(java.lang.String impl, |
| java.lang.String catalogName, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| java.lang.Object hadoopConf)</code> |
| <div class="block">Load a custom catalog implementation.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/CatalogUtil.html#loadFileIO-java.lang.String-java.util.Map-java.lang.Object-">loadFileIO</a></span>(java.lang.String impl, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| java.lang.Object hadoopConf)</code> |
| <div class="block">Load a custom <a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io"><code>FileIO</code></a> implementation.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics">MetricsReporter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/CatalogUtil.html#loadMetricsReporter-java.util.Map-">loadMetricsReporter</a></span>(java.util.Map<java.lang.String,java.lang.String> properties)</code> |
| <div class="block">Load a custom <a href="../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReporter</code></a> implementation.</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="ICEBERG_CATALOG_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_CATALOG_TYPE</h4> |
| <pre>public static final java.lang.String ICEBERG_CATALOG_TYPE</pre> |
| <div class="block">Shortcut catalog property to load a catalog implementation through a short type name, instead |
| of specifying a full java class through <a href="../../../org/apache/iceberg/CatalogProperties.html#CATALOG_IMPL"><code>CatalogProperties.CATALOG_IMPL</code></a>. Currently the |
| following type to implementation mappings are supported: |
| |
| <ul> |
| <li>hive: org.apache.iceberg.hive.HiveCatalog |
| <li>hadoop: org.apache.iceberg.hadoop.HadoopCatalog |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.CatalogUtil.ICEBERG_CATALOG_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ICEBERG_CATALOG_TYPE_HADOOP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_CATALOG_TYPE_HADOOP</h4> |
| <pre>public static final java.lang.String ICEBERG_CATALOG_TYPE_HADOOP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.CatalogUtil.ICEBERG_CATALOG_TYPE_HADOOP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ICEBERG_CATALOG_TYPE_HIVE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_CATALOG_TYPE_HIVE</h4> |
| <pre>public static final java.lang.String ICEBERG_CATALOG_TYPE_HIVE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.CatalogUtil.ICEBERG_CATALOG_TYPE_HIVE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ICEBERG_CATALOG_TYPE_REST"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_CATALOG_TYPE_REST</h4> |
| <pre>public static final java.lang.String ICEBERG_CATALOG_TYPE_REST</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.CatalogUtil.ICEBERG_CATALOG_TYPE_REST">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ICEBERG_CATALOG_HADOOP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_CATALOG_HADOOP</h4> |
| <pre>public static final java.lang.String ICEBERG_CATALOG_HADOOP</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.CatalogUtil.ICEBERG_CATALOG_HADOOP">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ICEBERG_CATALOG_HIVE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ICEBERG_CATALOG_HIVE</h4> |
| <pre>public static final java.lang.String ICEBERG_CATALOG_HIVE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.CatalogUtil.ICEBERG_CATALOG_HIVE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ICEBERG_CATALOG_REST"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ICEBERG_CATALOG_REST</h4> |
| <pre>public static final java.lang.String ICEBERG_CATALOG_REST</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.iceberg.CatalogUtil.ICEBERG_CATALOG_REST">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="dropTableData-org.apache.iceberg.io.FileIO-org.apache.iceberg.TableMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTableData</h4> |
| <pre>public static void dropTableData(<a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> io, |
| <a href="../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a> metadata)</pre> |
| <div class="block">Drops all data and metadata files referenced by TableMetadata. |
| |
| <p>This should be called by dropTable implementations to clean up table files once the table |
| has been dropped in the metastore.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>io</code> - a FileIO to use for deletes</dd> |
| <dd><code>metadata</code> - the last valid TableMetadata instance for a dropped table.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteFiles-org.apache.iceberg.io.FileIO-java.lang.Iterable-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteFiles</h4> |
| <pre>public static void deleteFiles(<a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> io, |
| java.lang.Iterable<java.lang.String> files, |
| java.lang.String type, |
| boolean concurrent)</pre> |
| <div class="block">Helper to delete files. Bulk deletion is used if possible.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>io</code> - FileIO for deletes</dd> |
| <dd><code>files</code> - files to delete</dd> |
| <dd><code>type</code> - type of files being deleted</dd> |
| <dd><code>concurrent</code> - controls concurrent deletion. Only applicable for non-bulk FileIO</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadCatalog-java.lang.String-java.lang.String-java.util.Map-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadCatalog</h4> |
| <pre>public static <a href="../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog">Catalog</a> loadCatalog(java.lang.String impl, |
| java.lang.String catalogName, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| java.lang.Object hadoopConf)</pre> |
| <div class="block">Load a custom catalog implementation. |
| |
| <p>The catalog must have a no-arg constructor. If the class implements Configurable, a Hadoop |
| config will be passed using Configurable.setConf. <a href="../../../org/apache/iceberg/catalog/Catalog.html#initialize-java.lang.String-java.util.Map-"><code>Catalog.initialize(String catalogName, |
| Map options)</code></a> is called to complete the initialization.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>impl</code> - catalog implementation full class name</dd> |
| <dd><code>catalogName</code> - catalog name</dd> |
| <dd><code>properties</code> - catalog properties</dd> |
| <dd><code>hadoopConf</code> - hadoop configuration if needed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>initialized catalog object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if no-arg constructor not found or error during initialization</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildIcebergCatalog-java.lang.String-java.util.Map-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildIcebergCatalog</h4> |
| <pre>public static <a href="../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog">Catalog</a> buildIcebergCatalog(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.String> options, |
| java.lang.Object conf)</pre> |
| <div class="block">Build an Iceberg <a href="../../../org/apache/iceberg/catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><code>Catalog</code></a> based on a map of catalog properties and optional Hadoop |
| configuration. |
| |
| <p>This method examines both the <a href="../../../org/apache/iceberg/CatalogUtil.html#ICEBERG_CATALOG_TYPE"><code>ICEBERG_CATALOG_TYPE</code></a> and <a href="../../../org/apache/iceberg/CatalogProperties.html#CATALOG_IMPL"><code>CatalogProperties.CATALOG_IMPL</code></a> properties to determine the catalog implementation to load. If |
| nothing is specified for both properties, Hive catalog will be loaded by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - catalog name</dd> |
| <dd><code>options</code> - catalog properties</dd> |
| <dd><code>conf</code> - a Hadoop Configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>initialized catalog</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadFileIO-java.lang.String-java.util.Map-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadFileIO</h4> |
| <pre>public static <a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a> loadFileIO(java.lang.String impl, |
| java.util.Map<java.lang.String,java.lang.String> properties, |
| java.lang.Object hadoopConf)</pre> |
| <div class="block">Load a custom <a href="../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io"><code>FileIO</code></a> implementation. |
| |
| <p>The implementation must have a no-arg constructor. If the class implements Configurable, a |
| Hadoop config will be passed using Configurable.setConf. <a href="../../../org/apache/iceberg/io/FileIO.html#initialize-java.util.Map-"><code>FileIO.initialize(Map |
| properties)</code></a> is called to complete the initialization.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>impl</code> - full class name of a custom FileIO implementation</dd> |
| <dd><code>properties</code> - used to initialize the FileIO implementation</dd> |
| <dd><code>hadoopConf</code> - a hadoop Configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>FileIO class</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if class path not found or right constructor not found or the |
| loaded class cannot be cast to the given interface type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="configureHadoopConf-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureHadoopConf</h4> |
| <pre>public static void configureHadoopConf(java.lang.Object maybeConfigurable, |
| java.lang.Object conf)</pre> |
| <div class="block">Dynamically detects whether an object is a Hadoop Configurable and calls setConf.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maybeConfigurable</code> - an object that may be Configurable</dd> |
| <dd><code>conf</code> - a Configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadMetricsReporter-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>loadMetricsReporter</h4> |
| <pre>public static <a href="../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics">MetricsReporter</a> loadMetricsReporter(java.util.Map<java.lang.String,java.lang.String> properties)</pre> |
| <div class="block">Load a custom <a href="../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReporter</code></a> implementation. |
| |
| <p>The implementation must have a no-arg constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - catalog properties which contains class name of a custom <a href="../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReporter</code></a> implementation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An initialized <a href="../../../org/apache/iceberg/metrics/MetricsReporter.html" title="interface in org.apache.iceberg.metrics"><code>MetricsReporter</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if class path not found or right constructor not found or the |
| loaded class cannot be cast to the given interface type</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/CatalogProperties.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/ChangelogOperation.html" title="enum in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/CatalogUtil.html" target="_top">Frames</a></li> |
| <li><a href="CatalogUtil.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> |
