| <!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>RESTSessionCatalog</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="RESTSessionCatalog"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"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":42,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/rest/RESTSerializers.UpdateRequirementSerializer.html" title="class in org.apache.iceberg.rest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/rest/RESTUtil.html" title="class in org.apache.iceberg.rest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/rest/RESTSessionCatalog.html" target="_top">Frames</a></li> |
| <li><a href="RESTSessionCatalog.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.iceberg.catalog.BaseSessionCatalog">Nested</a> | </li> |
| <li>Field | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg.rest</div> |
| <h2 title="Class RESTSessionCatalog" class="title">Class RESTSessionCatalog</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html" title="class in org.apache.iceberg.catalog">org.apache.iceberg.catalog.BaseSessionCatalog</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.rest.RESTSessionCatalog</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Closeable, java.lang.AutoCloseable, <a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a>, <a href="../../../../org/apache/iceberg/hadoop/Configurable.html" title="interface in org.apache.iceberg.hadoop">Configurable</a><java.lang.Object></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RESTSessionCatalog</span> |
| extends <a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html" title="class in org.apache.iceberg.catalog">BaseSessionCatalog</a> |
| implements <a href="../../../../org/apache/iceberg/hadoop/Configurable.html" title="interface in org.apache.iceberg.hadoop">Configurable</a><java.lang.Object>, java.io.Closeable</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.iceberg.catalog.BaseSessionCatalog"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.iceberg.catalog.<a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html" title="class in org.apache.iceberg.catalog">BaseSessionCatalog</a></h3> |
| <code><a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.AsCatalog.html" title="class in org.apache.iceberg.catalog">BaseSessionCatalog.AsCatalog</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.iceberg.catalog.SessionCatalog"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.iceberg.catalog.<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></h3> |
| <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#RESTSessionCatalog--">RESTSessionCatalog</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#RESTSessionCatalog-java.util.function.Function-java.util.function.BiFunction-">RESTSessionCatalog</a></span>(java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,<a href="../../../../org/apache/iceberg/rest/RESTClient.html" title="interface in org.apache.iceberg.rest">RESTClient</a>> clientBuilder, |
| java.util.function.BiFunction<<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a>,java.util.Map<java.lang.String,java.lang.String>,<a href="../../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a>> ioBuilder)</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="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#buildTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-">buildTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</code> |
| <div class="block">Create a builder to create a table or start a create/replace transaction.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#createNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-">createNamespace</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace, |
| java.util.Map<java.lang.String,java.lang.String> metadata)</code> |
| <div class="block">Create a namespace in the catalog.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#dropNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">dropNamespace</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</code> |
| <div class="block">Drop a namespace.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#dropTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">dropTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code> |
| <div class="block">Drop a table, without requesting that files are immediately deleted.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#initialize-java.lang.String-java.util.Map-">initialize</a></span>(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.String> unresolved)</code> |
| <div class="block">Initialize given a custom name and a map of catalog properties.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#invalidateTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">invalidateTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> ident)</code> |
| <div class="block">Invalidate cached table metadata from current catalog.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#listNamespaces-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">listNamespaces</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace)</code> |
| <div class="block">List namespaces from the namespace.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#listTables-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">listTables</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</code> |
| <div class="block">Return all the identifiers under this namespace.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#loadNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">loadNamespaceMetadata</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</code> |
| <div class="block">Load metadata properties for a namespace.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#loadTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">loadTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code> |
| <div class="block">Load a table.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#purgeTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">purgeTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code> |
| <div class="block">Drop a table and request that files are immediately deleted.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#registerTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-java.lang.String-">registerTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> ident, |
| java.lang.String metadataFileLocation)</code> |
| <div class="block">Register a table if it does not exist.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#renameTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.catalog.TableIdentifier-">renameTable</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> from, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> to)</code> |
| <div class="block">Rename a table.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#setConf-org.apache.hadoop.conf.Configuration-">setConf</a></span>(org.apache.hadoop.conf.Configuration newConf)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">will be removed in 1.3.0; use <a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#setConf-java.lang.Object-"><code>setConf(Object)</code></a></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#setConf-java.lang.Object-">setConf</a></span>(java.lang.Object newConf)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#updateNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-java.util.Set-">updateNamespaceMetadata</a></span>(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns, |
| java.util.Map<java.lang.String,java.lang.String> updates, |
| java.util.Set<java.lang.String> removals)</code> |
| <div class="block">Set a collection of properties on a namespace in the catalog.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.catalog.BaseSessionCatalog"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.iceberg.catalog.<a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html" title="class in org.apache.iceberg.catalog">BaseSessionCatalog</a></h3> |
| <code><a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html#asCatalog-org.apache.iceberg.catalog.SessionCatalog.SessionContext-">asCatalog</a>, <a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html#name--">name</a>, <a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html#properties--">properties</a>, <a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html#withContext-org.apache.iceberg.catalog.SessionCatalog.SessionContext-java.util.function.Function-">withContext</a></code></li> |
| </ul> |
| <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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.catalog.SessionCatalog"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.catalog.<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></h3> |
| <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#createNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">createNamespace</a>, <a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#listNamespaces-org.apache.iceberg.catalog.SessionCatalog.SessionContext-">listNamespaces</a>, <a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#namespaceExists-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">namespaceExists</a>, <a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#tableExists-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">tableExists</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="RESTSessionCatalog--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESTSessionCatalog</h4> |
| <pre>public RESTSessionCatalog()</pre> |
| </li> |
| </ul> |
| <a name="RESTSessionCatalog-java.util.function.Function-java.util.function.BiFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RESTSessionCatalog</h4> |
| <pre>public RESTSessionCatalog(java.util.function.Function<java.util.Map<java.lang.String,java.lang.String>,<a href="../../../../org/apache/iceberg/rest/RESTClient.html" title="interface in org.apache.iceberg.rest">RESTClient</a>> clientBuilder, |
| java.util.function.BiFunction<<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a>,java.util.Map<java.lang.String,java.lang.String>,<a href="../../../../org/apache/iceberg/io/FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a>> ioBuilder)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initialize-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.String> unresolved)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#initialize-java.lang.String-java.util.Map-">SessionCatalog</a></code></span></div> |
| <div class="block">Initialize given a custom name and a map of catalog properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#initialize-java.lang.String-java.util.Map-">initialize</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html#initialize-java.lang.String-java.util.Map-">initialize</a></code> in class <code><a href="../../../../org/apache/iceberg/catalog/BaseSessionCatalog.html" title="class in org.apache.iceberg.catalog">BaseSessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a custom name for the catalog</dd> |
| <dd><code>unresolved</code> - catalog properties</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConf-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConf</h4> |
| <pre>public void setConf(java.lang.Object newConf)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/hadoop/Configurable.html#setConf-C-">setConf</a></code> in interface <code><a href="../../../../org/apache/iceberg/hadoop/Configurable.html" title="interface in org.apache.iceberg.hadoop">Configurable</a><java.lang.Object></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConf-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConf</h4> |
| <pre>@Deprecated |
| public void setConf(org.apache.hadoop.conf.Configuration newConf)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">will be removed in 1.3.0; use <a href="../../../../org/apache/iceberg/rest/RESTSessionCatalog.html#setConf-java.lang.Object-"><code>setConf(Object)</code></a></span></div> |
| </li> |
| </ul> |
| <a name="listTables-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listTables</h4> |
| <pre>public java.util.List<<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>> listTables(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#listTables-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">SessionCatalog</a></code></span></div> |
| <div class="block">Return all the identifiers under this namespace.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#listTables-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">listTables</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>ns</code> - a namespace</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of identifiers for tables</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropTable</h4> |
| <pre>public boolean dropTable(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#dropTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">SessionCatalog</a></code></span></div> |
| <div class="block">Drop a table, without requesting that files are immediately deleted. |
| |
| <p>Data and metadata files should be deleted according to the catalog's policy.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#dropTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">dropTable</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the table was dropped, false if the table did not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="purgeTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>purgeTable</h4> |
| <pre>public boolean purgeTable(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#purgeTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">SessionCatalog</a></code></span></div> |
| <div class="block">Drop a table and request that files are immediately deleted.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#purgeTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">purgeTable</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the table was dropped and purged, false if the table did not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="renameTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameTable</h4> |
| <pre>public void renameTable(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> from, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> to)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#renameTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.catalog.TableIdentifier-">SessionCatalog</a></code></span></div> |
| <div class="block">Rename a table.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#renameTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.catalog.TableIdentifier-">renameTable</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>from</code> - identifier of the table to rename</dd> |
| <dd><code>to</code> - new table name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadTable</h4> |
| <pre>public <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> loadTable(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#loadTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">SessionCatalog</a></code></span></div> |
| <div class="block">Load a table.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#loadTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">loadTable</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>instance of <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg"><code>Table</code></a> implementation referred by <code>tableIdentifier</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildTable</h4> |
| <pre>public <a href="../../../../org/apache/iceberg/catalog/Catalog.TableBuilder.html" title="interface in org.apache.iceberg.catalog">Catalog.TableBuilder</a> buildTable(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#buildTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-">SessionCatalog</a></code></span></div> |
| <div class="block">Create a builder to create a table or start a create/replace transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#buildTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.Schema-">buildTable</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>identifier</code> - a table identifier</dd> |
| <dd><code>schema</code> - a schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder to create a table or start a create/replace transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invalidateTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateTable</h4> |
| <pre>public void invalidateTable(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> ident)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#invalidateTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">SessionCatalog</a></code></span></div> |
| <div class="block">Invalidate cached table metadata from current catalog. |
| |
| <p>If the table is already loaded or cached, drop cached data. If the table does not exist or |
| is not cached, do nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#invalidateTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-">invalidateTable</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>ident</code> - a table identifier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerTable</h4> |
| <pre>public <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> registerTable(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> ident, |
| java.lang.String metadataFileLocation)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#registerTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-java.lang.String-">SessionCatalog</a></code></span></div> |
| <div class="block">Register a table if it does not exist.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#registerTable-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.TableIdentifier-java.lang.String-">registerTable</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>ident</code> - a table identifier</dd> |
| <dd><code>metadataFileLocation</code> - the location of a metadata file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Table instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNamespace</h4> |
| <pre>public void createNamespace(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace, |
| java.util.Map<java.lang.String,java.lang.String> metadata)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#createNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-">SessionCatalog</a></code></span></div> |
| <div class="block">Create a namespace in the catalog.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#createNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-">createNamespace</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>namespace</code> - a <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><code>namespace</code></a></dd> |
| <dd><code>metadata</code> - a string Map of properties for the given namespace</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listNamespaces-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listNamespaces</h4> |
| <pre>public java.util.List<<a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a>> listNamespaces(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#listNamespaces-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">SessionCatalog</a></code></span></div> |
| <div class="block">List namespaces from the namespace. |
| |
| <p>For example, if table a.b.t exists, use 'SELECT NAMESPACE IN a' this method must return |
| Namepace.of("a","b") <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><code>Namespace</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#listNamespaces-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">listNamespaces</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>namespace</code> - a <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><code>namespace</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a List of namespace <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><code>Namespace</code></a> names</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadNamespaceMetadata</h4> |
| <pre>public java.util.Map<java.lang.String,java.lang.String> loadNamespaceMetadata(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#loadNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">SessionCatalog</a></code></span></div> |
| <div class="block">Load metadata properties for a namespace.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#loadNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">loadNamespaceMetadata</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>ns</code> - a <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><code>namespace</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string map of properties for the given namespace</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropNamespace</h4> |
| <pre>public boolean dropNamespace(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#dropNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">SessionCatalog</a></code></span></div> |
| <div class="block">Drop a namespace. If the namespace exists and was dropped, this will return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#dropNamespace-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-">dropNamespace</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>ns</code> - a <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><code>namespace</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the namespace was dropped, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateNamespaceMetadata</h4> |
| <pre>public boolean updateNamespaceMetadata(<a href="../../../../org/apache/iceberg/catalog/SessionCatalog.SessionContext.html" title="class in org.apache.iceberg.catalog">SessionCatalog.SessionContext</a> context, |
| <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns, |
| java.util.Map<java.lang.String,java.lang.String> updates, |
| java.util.Set<java.lang.String> removals)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#updateNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-java.util.Set-">SessionCatalog</a></code></span></div> |
| <div class="block">Set a collection of properties on a namespace in the catalog. |
| |
| <p>Properties that are not in the given map are not modified or removed by this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html#updateNamespaceMetadata-org.apache.iceberg.catalog.SessionCatalog.SessionContext-org.apache.iceberg.catalog.Namespace-java.util.Map-java.util.Set-">updateNamespaceMetadata</a></code> in interface <code><a href="../../../../org/apache/iceberg/catalog/SessionCatalog.html" title="interface in org.apache.iceberg.catalog">SessionCatalog</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - session context</dd> |
| <dd><code>ns</code> - a <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog"><code>namespace</code></a></dd> |
| <dd><code>updates</code> - properties to set for the namespace</dd> |
| <dd><code>removals</code> - properties to remove from the namespace</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></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/rest/RESTSerializers.UpdateRequirementSerializer.html" title="class in org.apache.iceberg.rest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/rest/RESTUtil.html" title="class in org.apache.iceberg.rest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/rest/RESTSessionCatalog.html" target="_top">Frames</a></li> |
| <li><a href="RESTSessionCatalog.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.iceberg.catalog.BaseSessionCatalog">Nested</a> | </li> |
| <li>Field | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |