| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Schema (Apache Calcite calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.schema, interface: Schema"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= 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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.schema</a></div> |
| <h1 title="Interface Schema" class="title">Interface Schema</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></code>, <code><a href="SemiMutableSchema.html" title="interface in org.apache.calcite.schema">SemiMutableSchema</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/AbstractSchema.html" title="class in org.apache.calcite.schema.impl">AbstractSchema</a></code>, <code><a href="../adapter/cassandra/CassandraSchema.html" title="class in org.apache.calcite.adapter.cassandra">CassandraSchema</a></code>, <code><a href="../adapter/clone/CloneSchema.html" title="class in org.apache.calcite.adapter.clone">CloneSchema</a></code>, <code><a href="../adapter/csv/CsvSchema.html" title="class in org.apache.calcite.adapter.csv">CsvSchema</a></code>, <code><a href="impl/DelegatingSchema.html" title="class in org.apache.calcite.schema.impl">DelegatingSchema</a></code>, <code><a href="../adapter/druid/DruidSchema.html" title="class in org.apache.calcite.adapter.druid">DruidSchema</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchSchema.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSchema</a></code>, <code><a href="../adapter/geode/rel/GeodeSchema.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeSchema</a></code>, <code><a href="../adapter/geode/simple/GeodeSimpleSchema.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleSchema</a></code>, <code><a href="../adapter/jdbc/JdbcCatalogSchema.html" title="class in org.apache.calcite.adapter.jdbc">JdbcCatalogSchema</a></code>, <code><a href="../adapter/jdbc/JdbcSchema.html" title="class in org.apache.calcite.adapter.jdbc">JdbcSchema</a></code>, <code><a href="../adapter/mongodb/MongoSchema.html" title="class in org.apache.calcite.adapter.mongodb">MongoSchema</a></code>, <code><a href="../adapter/pig/PigSchema.html" title="class in org.apache.calcite.adapter.pig">PigSchema</a></code>, <code><a href="../adapter/java/ReflectiveSchema.html" title="class in org.apache.calcite.adapter.java">ReflectiveSchema</a></code>, <code><a href="../adapter/splunk/SplunkSchema.html" title="class in org.apache.calcite.adapter.splunk">SplunkSchema</a></code>, <code><a href="../adapter/tpcds/TpcdsSchema.html" title="class in org.apache.calcite.adapter.tpcds">TpcdsSchema</a></code>, <code><a href="../adapter/tpch/TpchSchema.html" title="class in org.apache.calcite.adapter.tpch">TpchSchema</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Schema</span></pre> |
| <div class="block">A namespace for tables and functions. |
| |
| <p>A schema can also contain sub-schemas, to any level of nesting. Most |
| providers have a limited number of levels; for example, most JDBC databases |
| have either one level ("schemas") or two levels ("database" and |
| "catalog").</p> |
| |
| <p>There may be multiple overloaded functions with the same name but |
| different numbers or types of parameters. |
| For this reason, <a href="#getFunctions(java.lang.String)"><code>getFunctions(java.lang.String)</code></a> returns a list of all |
| members with the same name. Calcite will call |
| <a href="Schemas.html#resolve(org.apache.calcite.rel.type.RelDataTypeFactory,java.lang.String,java.util.Collection,java.util.List)"><code>Schemas.resolve(org.apache.calcite.rel.type.RelDataTypeFactory, String, java.util.Collection, java.util.List)</code></a> |
| to choose the appropriate one.</p> |
| |
| <p>The most common and important type of member is the one with no |
| arguments and a result type that is a collection of records. This is called a |
| <dfn>relation</dfn>. It is equivalent to a table in a relational |
| database.</p> |
| |
| <p>For example, the query</p> |
| |
| <blockquote>select * from sales.emps</blockquote> |
| |
| <p>is valid if "sales" is a registered |
| schema and "emps" is a member with zero parameters and a result type |
| of <code>Collection(Record(int: "empno", String: "name"))</code>.</p> |
| |
| <p>A schema may be nested within another schema; see |
| <a href="#getSubSchema(java.lang.String)"><code>getSubSchema(String)</code></a>.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Table type.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code><a href="../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">getExpression</a></span>​(<a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the expression by which this schema can be referenced in generated |
| code.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFunctionNames()">getFunctionNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the names of the functions in this schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="Function.html" title="interface in org.apache.calcite.schema">Function</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFunctions(java.lang.String)">getFunctions</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a list of functions in this schema with the given name, or |
| an empty list if there is no such function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubSchema(java.lang.String)">getSubSchema</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a sub-schema with a given name, or null.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubSchemaNames()">getSubSchemaNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the names of this schema's child schemas.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTable(java.lang.String)">getTable</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a table with a given name, or null if not found.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTableNames()">getTableNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the names of the tables in this schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType(java.lang.String)">getType</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a type with a given name, or null if not found.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeNames()">getTypeNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the names of the types in this schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMutable()">isMutable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the user is allowed to create new tables, functions |
| and sub-schemas in this schema, in addition to those returned automatically |
| by methods such as <a href="#getTable(java.lang.String)"><code>getTable(String)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#snapshot(org.apache.calcite.schema.SchemaVersion)">snapshot</a></span>​(<a href="SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a> version)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the snapshot of this schema as of the specified time.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getTable(java.lang.String)">getTable</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></span> <span class="memberName">getTable</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</span></div> |
| <div class="block">Returns a table with a given name, or null if not found.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Table name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Table, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getTableNames()">getTableNames</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></span> <span class="memberName">getTableNames</span>()</div> |
| <div class="block">Returns the names of the tables in this schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Names of the tables in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getType(java.lang.String)">getType</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></span> <span class="memberName">getType</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</span></div> |
| <div class="block">Returns a type with a given name, or null if not found.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Table name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Table, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getTypeNames()">getTypeNames</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></span> <span class="memberName">getTypeNames</span>()</div> |
| <div class="block">Returns the names of the types in this schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Names of the tables in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFunctions(java.lang.String)">getFunctions</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="Function.html" title="interface in org.apache.calcite.schema">Function</a>></span> <span class="memberName">getFunctions</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</span></div> |
| <div class="block">Returns a list of functions in this schema with the given name, or |
| an empty list if there is no such function.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of function</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of functions with given name, or empty list</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFunctionNames()">getFunctionNames</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></span> <span class="memberName">getFunctionNames</span>()</div> |
| <div class="block">Returns the names of the functions in this schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Names of the functions in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSubSchema(java.lang.String)">getSubSchema</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></span> <span class="memberName">getSubSchema</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</span></div> |
| <div class="block">Returns a sub-schema with a given name, or null.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Sub-schema name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Sub-schema with a given name, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSubSchemaNames()">getSubSchemaNames</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></span> <span class="memberName">getSubSchemaNames</span>()</div> |
| <div class="block">Returns the names of this schema's child schemas.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Names of this schema's child schemas</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">getExpression</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="memberName">getExpression</span>​(<span class="arguments"><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</span></div> |
| <div class="block">Returns the expression by which this schema can be referenced in generated |
| code.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parentSchema</code> - Parent schema</dd> |
| <dd><code>name</code> - Name of this schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Expression by which this schema can be referenced in generated code</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isMutable()">isMutable</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">isMutable</span>()</div> |
| <div class="block">Returns whether the user is allowed to create new tables, functions |
| and sub-schemas in this schema, in addition to those returned automatically |
| by methods such as <a href="#getTable(java.lang.String)"><code>getTable(String)</code></a>. |
| |
| <p>Even if this method returns true, the maps are not modified. Calcite |
| stores the defined objects in a wrapper object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the user is allowed to create new tables, functions |
| and sub-schemas in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="snapshot(org.apache.calcite.schema.SchemaVersion)">snapshot</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></span> <span class="memberName">snapshot</span>​(<span class="arguments"><a href="SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a> version)</span></div> |
| <div class="block">Returns the snapshot of this schema as of the specified time. The |
| contents of the schema snapshot should not change over time.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>version</code> - The current schema version</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the schema snapshot.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
