| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SchemaFactory (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.schema, interface: SchemaFactory"> |
| <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.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.schema</a></div> |
| <h1 title="Interface SchemaFactory" class="title">Interface SchemaFactory</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/AbstractSchema.Factory.html" title="class in org.apache.calcite.schema.impl">AbstractSchema.Factory</a></code>, <code><a href="../adapter/cassandra/CassandraSchemaFactory.html" title="class in org.apache.calcite.adapter.cassandra">CassandraSchemaFactory</a></code>, <code><a href="../adapter/clone/CloneSchema.Factory.html" title="class in org.apache.calcite.adapter.clone">CloneSchema.Factory</a></code>, <code><a href="../adapter/csv/CsvSchemaFactory.html" title="class in org.apache.calcite.adapter.csv">CsvSchemaFactory</a></code>, <code><a href="../adapter/druid/DruidSchemaFactory.html" title="class in org.apache.calcite.adapter.druid">DruidSchemaFactory</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchSchemaFactory.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSchemaFactory</a></code>, <code><a href="../adapter/file/FileSchemaFactory.html" title="class in org.apache.calcite.adapter.file">FileSchemaFactory</a></code>, <code><a href="../adapter/geode/rel/GeodeSchemaFactory.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeSchemaFactory</a></code>, <code><a href="../adapter/geode/simple/GeodeSimpleSchemaFactory.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleSchemaFactory</a></code>, <code><a href="../adapter/innodb/InnodbSchemaFactory.html" title="class in org.apache.calcite.adapter.innodb">InnodbSchemaFactory</a></code>, <code><a href="../adapter/jdbc/JdbcSchema.Factory.html" title="class in org.apache.calcite.adapter.jdbc">JdbcSchema.Factory</a></code>, <code><a href="../adapter/mongodb/MongoSchemaFactory.html" title="class in org.apache.calcite.adapter.mongodb">MongoSchemaFactory</a></code>, <code><a href="../adapter/pig/PigSchemaFactory.html" title="class in org.apache.calcite.adapter.pig">PigSchemaFactory</a></code>, <code><a href="../adapter/redis/RedisSchemaFactory.html" title="class in org.apache.calcite.adapter.redis">RedisSchemaFactory</a></code>, <code><a href="../adapter/java/ReflectiveSchema.Factory.html" title="class in org.apache.calcite.adapter.java">ReflectiveSchema.Factory</a></code>, <code><a href="../adapter/tpcds/TpcdsSchemaFactory.html" title="class in org.apache.calcite.adapter.tpcds">TpcdsSchemaFactory</a></code>, <code><a href="../adapter/tpch/TpchSchemaFactory.html" title="class in org.apache.calcite.adapter.tpch">TpchSchemaFactory</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SchemaFactory</span></div> |
| <div class="block">Factory for <a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> objects. |
| |
| <p>A schema factory allows you to include a custom schema in a model file. |
| For example, here is a model that contains a custom schema whose tables |
| read CSV files. (See the |
| <a href="https://calcite.apache.org/javadocAggregate/org/apache/calcite/adapter/csv/package-summary.html">example CSV adapter</a> |
| for more details about this particular adapter.) |
| |
| <blockquote><pre>{ |
| "version": "1.0", |
| "defaultSchema": "SALES", |
| "schemas": [ |
| { |
| "name": "SALES", |
| "type": "custom", |
| "factory": "org.apache.calcite.adapter.csv.CsvSchemaFactory", |
| "mutable": true, |
| "operand": { |
| directory: "sales" |
| }, |
| "tables": [ |
| { |
| "name": "FEMALE_EMPS", |
| "type": "view", |
| "sql": "SELECT * FROM emps WHERE gender = 'F'" |
| } |
| ] |
| } |
| ] |
| }</pre></blockquote> |
| |
| <p>If you do not wish to allow model authors to add additional tables |
| (including views) to an instance of your schema, specify |
| 'mutable: false'. |
| |
| <p>A class that implements SchemaFactory specified in a schema must have a |
| public default constructor.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#create(org.apache.calcite.schema.SchemaPlus,java.lang.String,java.util.Map)" class="member-name-link">create</a><wbr>(<a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> operand)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a Schema.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="create(org.apache.calcite.schema.SchemaPlus,java.lang.String,java.util.Map)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="return-type"><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> operand)</span></div> |
| <div class="block">Creates a Schema.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parentSchema</code> - Parent schema</dd> |
| <dd><code>name</code> - Name of this schema</dd> |
| <dd><code>operand</code> - The "operand" JSON property</dd> |
| <dt>Returns:</dt> |
| <dd>Created schema</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |