| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SchemaFactory (Apache Calcite API)</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.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.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="SchemaFactory (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":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 = "../../../../"; |
| 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="class-use/SchemaFactory.html">Use</a></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.calcite.schema</a></div> |
| <h2 title="Interface SchemaFactory" class="title">Interface SchemaFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <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/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/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> |
| <pre>public interface <span class="typeNameLabel">SchemaFactory</span></pre> |
| <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="http://calcite.apache.org/apidocs/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: "target/test-classes/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> |
| </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></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="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(org.apache.calcite.schema.SchemaPlus,java.lang.String,java.util.Map)">create</a></span>​(<a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| java.lang.String name, |
| java.util.Map<java.lang.String,​java.lang.Object> operand)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Schema.</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="create(org.apache.calcite.schema.SchemaPlus,java.lang.String,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre class="methodSignature"><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a> create​(<a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| java.lang.String name, |
| java.util.Map<java.lang.String,​java.lang.Object> operand)</pre> |
| <div class="block">Creates a Schema.</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> |
| <dd><code>operand</code> - The "operand" JSON property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Created schema</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="class-use/SchemaFactory.html">Use</a></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> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
