| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ViewCatalog</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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="ViewCatalog"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":18,"i3":18,"i4":6,"i5":6,"i6":6,"i7":6,"i8":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.iceberg.catalog</a></div> |
| <h2 title="Interface ViewCatalog" class="title">Interface ViewCatalog</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">ViewCatalog</span></pre> |
| <div class="block">A Catalog API for view create, drop, and load operations.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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><a href="../view/ViewBuilder.html" title="interface in org.apache.iceberg.view">ViewBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildView(org.apache.iceberg.catalog.TableIdentifier)">buildView</a></span>​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Instantiate a builder to create or replace a SQL view.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropView(org.apache.iceberg.catalog.TableIdentifier)">dropView</a></span>​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Drop a view.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.lang.String,java.util.Map)">initialize</a></span>​(java.lang.String name, |
| java.util.Map<java.lang.String,​java.lang.String> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Initialize a view catalog given a custom name and a map of catalog properties.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invalidateView(org.apache.iceberg.catalog.TableIdentifier)">invalidateView</a></span>​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Invalidate cached view metadata from current catalog.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listViews(org.apache.iceberg.catalog.Namespace)">listViews</a></span>​(<a href="Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace)</code></th> |
| <td class="colLast"> |
| <div class="block">Return all the identifiers under this namespace.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../view/View.html" title="interface in org.apache.iceberg.view">View</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadView(org.apache.iceberg.catalog.TableIdentifier)">loadView</a></span>​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Load a view.</div> |
| </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="#name()">name</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the name for this catalog.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameView(org.apache.iceberg.catalog.TableIdentifier,org.apache.iceberg.catalog.TableIdentifier)">renameView</a></span>​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> from, |
| <a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> to)</code></th> |
| <td class="colLast"> |
| <div class="block">Rename a view.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#viewExists(org.apache.iceberg.catalog.TableIdentifier)">viewExists</a></span>​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Check whether view exists.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre class="methodSignature">java.lang.String name()</pre> |
| <div class="block">Return the name for this catalog.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this catalog's name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="listViews(org.apache.iceberg.catalog.Namespace)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listViews</h4> |
| <pre class="methodSignature">java.util.List<<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>> listViews​(<a href="Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> namespace)</pre> |
| <div class="block">Return all the identifiers under this namespace.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - a namespace</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of identifiers for views</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/NoSuchNamespaceException.html" title="class in org.apache.iceberg.exceptions">NoSuchNamespaceException</a></code> - if the namespace is not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="loadView(org.apache.iceberg.catalog.TableIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadView</h4> |
| <pre class="methodSignature"><a href="../view/View.html" title="interface in org.apache.iceberg.view">View</a> loadView​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Load a view.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a view identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>instance of <a href="../view/View.html" title="interface in org.apache.iceberg.view"><code>View</code></a> implementation referred by the identifier</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/NoSuchViewException.html" title="class in org.apache.iceberg.exceptions">NoSuchViewException</a></code> - if the view does not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="viewExists(org.apache.iceberg.catalog.TableIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>viewExists</h4> |
| <pre class="methodSignature">default boolean viewExists​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Check whether view exists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a view identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the view exists, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="buildView(org.apache.iceberg.catalog.TableIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildView</h4> |
| <pre class="methodSignature"><a href="../view/ViewBuilder.html" title="interface in org.apache.iceberg.view">ViewBuilder</a> buildView​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Instantiate a builder to create or replace a SQL view.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a view identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a view builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dropView(org.apache.iceberg.catalog.TableIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropView</h4> |
| <pre class="methodSignature">boolean dropView​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Drop a view.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a view identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the view was dropped, false if the view did not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="renameView(org.apache.iceberg.catalog.TableIdentifier,org.apache.iceberg.catalog.TableIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameView</h4> |
| <pre class="methodSignature">void renameView​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> from, |
| <a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> to)</pre> |
| <div class="block">Rename a view.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>from</code> - identifier of the view to rename</dd> |
| <dd><code>to</code> - new view identifier</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/NoSuchViewException.html" title="class in org.apache.iceberg.exceptions">NoSuchViewException</a></code> - if the "from" view does not exist</dd> |
| <dd><code><a href="../exceptions/AlreadyExistsException.html" title="class in org.apache.iceberg.exceptions">AlreadyExistsException</a></code> - if the "to" view already exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="invalidateView(org.apache.iceberg.catalog.TableIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateView</h4> |
| <pre class="methodSignature">default void invalidateView​(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a> identifier)</pre> |
| <div class="block">Invalidate cached view metadata from current catalog. |
| |
| <p>If the view is already loaded or cached, drop cached data. If the view does not exist or is |
| not cached, do nothing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - a view identifier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="initialize(java.lang.String,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">default void initialize​(java.lang.String name, |
| java.util.Map<java.lang.String,​java.lang.String> properties)</pre> |
| <div class="block">Initialize a view catalog given a custom name and a map of catalog properties. |
| |
| <p>A custom view catalog implementation must have a no-arg constructor. A compute engine like |
| Spark or Flink will first initialize the catalog without any arguments, and then call this |
| method to complete catalog initialization with properties passed into the engine.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a custom name for the catalog</dd> |
| <dd><code>properties</code> - catalog properties</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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
