| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.12) on Wed Aug 18 10:34:26 PDT 2021 --> |
| <title>SparkCatalog</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <meta name="dc.created" content="2021-08-18"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SparkCatalog"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.spark</a></div> |
| <h2 title="Class SparkCatalog" class="title">Class SparkCatalog</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.spark.SparkCatalog</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.apache.spark.sql.connector.catalog.CatalogPlugin</code>, <code>org.apache.spark.sql.connector.catalog.StagingTableCatalog</code>, <code>org.apache.spark.sql.connector.catalog.SupportsNamespaces</code>, <code>org.apache.spark.sql.connector.catalog.TableCatalog</code>, <code><a href="../../spark/sql/connector/iceberg/catalog/ProcedureCatalog.html" title="interface in org.apache.spark.sql.connector.iceberg.catalog">ProcedureCatalog</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SparkCatalog</span> |
| extends java.lang.Object</pre> |
| <div class="block">A Spark TableCatalog implementation that wraps an Iceberg <a href="../catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><code>Catalog</code></a>. |
| <p> |
| This supports the following catalog configuration options: |
| <ul> |
| <li><code>type</code> - catalog type, "hive" or "hadoop"</li> |
| <li><code>uri</code> - the Hive Metastore URI (Hive catalog only)</li> |
| <li><code>warehouse</code> - the warehouse path (Hadoop catalog only)</li> |
| <li><code>default-namespace</code> - a namespace to use as the default</li> |
| <li><code>cache-enabled</code> - whether to enable catalog cache</li> |
| </ul> |
| <p> |
| To use a custom catalog that is not a Hive or Hadoop catalog, extend this class and override |
| <a href="#buildIcebergCatalog(java.lang.String,org.apache.spark.sql.util.CaseInsensitiveStringMap)"><code>buildIcebergCatalog(String, CaseInsensitiveStringMap)</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.spark.sql.connector.catalog.SupportsNamespaces"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.spark.sql.connector.catalog.SupportsNamespaces</h3> |
| <code>PROP_COMMENT, PROP_LOCATION, PROP_OWNER</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.spark.sql.connector.catalog.TableCatalog"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.spark.sql.connector.catalog.TableCatalog</h3> |
| <code>PROP_COMMENT, PROP_LOCATION, PROP_OWNER, PROP_PROVIDER</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SparkCatalog</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterNamespace(java.lang.String%5B%5D,org.apache.spark.sql.connector.catalog.NamespaceChange...)">alterNamespace</a></span>​(java.lang.String[] namespace, |
| org.apache.spark.sql.connector.catalog.NamespaceChange... changes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="source/SparkTable.html" title="class in org.apache.iceberg.spark.source">SparkTable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterTable(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.connector.catalog.TableChange...)">alterTable</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.connector.catalog.TableChange... changes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../catalog/Catalog.html" title="interface in org.apache.iceberg.catalog">Catalog</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildIcebergCatalog(java.lang.String,org.apache.spark.sql.util.CaseInsensitiveStringMap)">buildIcebergCatalog</a></span>​(java.lang.String name, |
| org.apache.spark.sql.util.CaseInsensitiveStringMap options)</code></th> |
| <td class="colLast"> |
| <div class="block">Build an Iceberg <a href="../catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><code>Catalog</code></a> to be used by this Spark catalog adapter.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildIdentifier(org.apache.spark.sql.connector.catalog.Identifier)">buildIdentifier</a></span>​(org.apache.spark.sql.connector.catalog.Identifier identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Build an Iceberg <a href="../catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog"><code>TableIdentifier</code></a> for the given Spark identifier.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createNamespace(java.lang.String%5B%5D,java.util.Map)">createNamespace</a></span>​(java.lang.String[] namespace, |
| java.util.Map<java.lang.String,​java.lang.String> metadata)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="source/SparkTable.html" title="class in org.apache.iceberg.spark.source">SparkTable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createTable(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform%5B%5D,java.util.Map)">createTable</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultNamespace()">defaultNamespace</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropNamespace(java.lang.String%5B%5D)">dropNamespace</a></span>​(java.lang.String[] namespace)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropTable(org.apache.spark.sql.connector.catalog.Identifier)">dropTable</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.lang.String,org.apache.spark.sql.util.CaseInsensitiveStringMap)">initialize</a></span>​(java.lang.String name, |
| org.apache.spark.sql.util.CaseInsensitiveStringMap options)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invalidateTable(org.apache.spark.sql.connector.catalog.Identifier)">invalidateTable</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[][]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listNamespaces()">listNamespaces</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[][]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listNamespaces(java.lang.String%5B%5D)">listNamespaces</a></span>​(java.lang.String[] namespace)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.connector.catalog.Identifier[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listTables(java.lang.String%5B%5D)">listTables</a></span>​(java.lang.String[] namespace)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadNamespaceMetadata(java.lang.String%5B%5D)">loadNamespaceMetadata</a></span>​(java.lang.String[] namespace)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../spark/sql/connector/iceberg/catalog/Procedure.html" title="interface in org.apache.spark.sql.connector.iceberg.catalog">Procedure</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadProcedure(org.apache.spark.sql.connector.catalog.Identifier)">loadProcedure</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident)</code></th> |
| <td class="colLast"> |
| <div class="block">Load a <a href="../../spark/sql/connector/iceberg/catalog/Procedure.html" title="interface in org.apache.spark.sql.connector.iceberg.catalog"><code>stored procedure</code></a> by <code>identifier</code>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="source/SparkTable.html" title="class in org.apache.iceberg.spark.source">SparkTable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadTable(org.apache.spark.sql.connector.catalog.Identifier)">loadTable</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>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> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameTable(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.connector.catalog.Identifier)">renameTable</a></span>​(org.apache.spark.sql.connector.catalog.Identifier from, |
| org.apache.spark.sql.connector.catalog.Identifier to)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.connector.catalog.StagedTable</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stageCreate(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform%5B%5D,java.util.Map)">stageCreate</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.connector.catalog.StagedTable</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stageCreateOrReplace(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform%5B%5D,java.util.Map)">stageCreateOrReplace</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>org.apache.spark.sql.connector.catalog.StagedTable</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stageReplace(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform%5B%5D,java.util.Map)">stageReplace</a></span>​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties)</code></th> |
| <td class="colLast"> </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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.spark.sql.connector.catalog.SupportsNamespaces"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.sql.connector.catalog.SupportsNamespaces</h3> |
| <code>namespaceExists</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.spark.sql.connector.catalog.TableCatalog"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.sql.connector.catalog.TableCatalog</h3> |
| <code>tableExists</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SparkCatalog</h4> |
| <pre>public SparkCatalog()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="buildIcebergCatalog(java.lang.String,org.apache.spark.sql.util.CaseInsensitiveStringMap)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildIcebergCatalog</h4> |
| <pre class="methodSignature">protected <a href="../catalog/Catalog.html" title="interface in org.apache.iceberg.catalog">Catalog</a> buildIcebergCatalog​(java.lang.String name, |
| org.apache.spark.sql.util.CaseInsensitiveStringMap options)</pre> |
| <div class="block">Build an Iceberg <a href="../catalog/Catalog.html" title="interface in org.apache.iceberg.catalog"><code>Catalog</code></a> to be used by this Spark catalog adapter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Spark's catalog name</dd> |
| <dd><code>options</code> - Spark's catalog options</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Iceberg catalog</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="buildIdentifier(org.apache.spark.sql.connector.catalog.Identifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildIdentifier</h4> |
| <pre class="methodSignature">protected <a href="../catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> buildIdentifier​(org.apache.spark.sql.connector.catalog.Identifier identifier)</pre> |
| <div class="block">Build an Iceberg <a href="../catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog"><code>TableIdentifier</code></a> for the given Spark identifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - Spark's identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Iceberg identifier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadTable(org.apache.spark.sql.connector.catalog.Identifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTable</h4> |
| <pre class="methodSignature">public <a href="source/SparkTable.html" title="class in org.apache.iceberg.spark.source">SparkTable</a> loadTable​(org.apache.spark.sql.connector.catalog.Identifier ident) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchTableException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchTableException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createTable(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform[],java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre class="methodSignature">public <a href="source/SparkTable.html" title="class in org.apache.iceberg.spark.source">SparkTable</a> createTable​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties) |
| throws org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stageCreate(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform[],java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stageCreate</h4> |
| <pre class="methodSignature">public org.apache.spark.sql.connector.catalog.StagedTable stageCreate​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties) |
| throws org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stageReplace(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform[],java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stageReplace</h4> |
| <pre class="methodSignature">public org.apache.spark.sql.connector.catalog.StagedTable stageReplace​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchTableException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchTableException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="stageCreateOrReplace(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.types.StructType,org.apache.spark.sql.connector.expressions.Transform[],java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stageCreateOrReplace</h4> |
| <pre class="methodSignature">public org.apache.spark.sql.connector.catalog.StagedTable stageCreateOrReplace​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.types.StructType schema, |
| org.apache.spark.sql.connector.expressions.Transform[] transforms, |
| java.util.Map<java.lang.String,​java.lang.String> properties)</pre> |
| </li> |
| </ul> |
| <a id="alterTable(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.connector.catalog.TableChange...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alterTable</h4> |
| <pre class="methodSignature">public <a href="source/SparkTable.html" title="class in org.apache.iceberg.spark.source">SparkTable</a> alterTable​(org.apache.spark.sql.connector.catalog.Identifier ident, |
| org.apache.spark.sql.connector.catalog.TableChange... changes) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchTableException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchTableException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dropTable(org.apache.spark.sql.connector.catalog.Identifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTable</h4> |
| <pre class="methodSignature">public boolean dropTable​(org.apache.spark.sql.connector.catalog.Identifier ident)</pre> |
| </li> |
| </ul> |
| <a id="renameTable(org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.connector.catalog.Identifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameTable</h4> |
| <pre class="methodSignature">public void renameTable​(org.apache.spark.sql.connector.catalog.Identifier from, |
| org.apache.spark.sql.connector.catalog.Identifier to) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchTableException, |
| org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchTableException</code></dd> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.TableAlreadyExistsException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="invalidateTable(org.apache.spark.sql.connector.catalog.Identifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateTable</h4> |
| <pre class="methodSignature">public void invalidateTable​(org.apache.spark.sql.connector.catalog.Identifier ident)</pre> |
| </li> |
| </ul> |
| <a id="listTables(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listTables</h4> |
| <pre class="methodSignature">public org.apache.spark.sql.connector.catalog.Identifier[] listTables​(java.lang.String[] namespace)</pre> |
| </li> |
| </ul> |
| <a id="defaultNamespace()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultNamespace</h4> |
| <pre class="methodSignature">public java.lang.String[] defaultNamespace()</pre> |
| </li> |
| </ul> |
| <a id="listNamespaces()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listNamespaces</h4> |
| <pre class="methodSignature">public java.lang.String[][] listNamespaces()</pre> |
| </li> |
| </ul> |
| <a id="listNamespaces(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listNamespaces</h4> |
| <pre class="methodSignature">public java.lang.String[][] listNamespaces​(java.lang.String[] namespace) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadNamespaceMetadata(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadNamespaceMetadata</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.String> loadNamespaceMetadata​(java.lang.String[] namespace) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createNamespace(java.lang.String[],java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNamespace</h4> |
| <pre class="methodSignature">public void createNamespace​(java.lang.String[] namespace, |
| java.util.Map<java.lang.String,​java.lang.String> metadata) |
| throws org.apache.spark.sql.catalyst.analysis.NamespaceAlreadyExistsException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NamespaceAlreadyExistsException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="alterNamespace(java.lang.String[],org.apache.spark.sql.connector.catalog.NamespaceChange...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alterNamespace</h4> |
| <pre class="methodSignature">public void alterNamespace​(java.lang.String[] namespace, |
| org.apache.spark.sql.connector.catalog.NamespaceChange... changes) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dropNamespace(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropNamespace</h4> |
| <pre class="methodSignature">public boolean dropNamespace​(java.lang.String[] namespace) |
| throws org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchNamespaceException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="initialize(java.lang.String,org.apache.spark.sql.util.CaseInsensitiveStringMap)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">public final void initialize​(java.lang.String name, |
| org.apache.spark.sql.util.CaseInsensitiveStringMap options)</pre> |
| </li> |
| </ul> |
| <a id="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre class="methodSignature">public java.lang.String name()</pre> |
| </li> |
| </ul> |
| <a id="loadProcedure(org.apache.spark.sql.connector.catalog.Identifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>loadProcedure</h4> |
| <pre class="methodSignature">public <a href="../../spark/sql/connector/iceberg/catalog/Procedure.html" title="interface in org.apache.spark.sql.connector.iceberg.catalog">Procedure</a> loadProcedure​(org.apache.spark.sql.connector.catalog.Identifier ident) |
| throws <a href="../../spark/sql/catalyst/analysis/NoSuchProcedureException.html" title="class in org.apache.spark.sql.catalyst.analysis">NoSuchProcedureException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../spark/sql/connector/iceberg/catalog/ProcedureCatalog.html#loadProcedure(org.apache.spark.sql.connector.catalog.Identifier)">ProcedureCatalog</a></code></span></div> |
| <div class="block">Load a <a href="../../spark/sql/connector/iceberg/catalog/Procedure.html" title="interface in org.apache.spark.sql.connector.iceberg.catalog"><code>stored procedure</code></a> by <code>identifier</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../spark/sql/connector/iceberg/catalog/ProcedureCatalog.html#loadProcedure(org.apache.spark.sql.connector.catalog.Identifier)">loadProcedure</a></code> in interface <code><a href="../../spark/sql/connector/iceberg/catalog/ProcedureCatalog.html" title="interface in org.apache.spark.sql.connector.iceberg.catalog">ProcedureCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ident</code> - a stored procedure identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the stored procedure's metadata</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../spark/sql/catalyst/analysis/NoSuchProcedureException.html" title="class in org.apache.spark.sql.catalyst.analysis">NoSuchProcedureException</a></code> - if there is no matching stored procedure</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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
