blob: 72106b65459297f893b200125d5089af7f73a6bb [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SchemaFactory (Apache Calcite calcite API)</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="SchemaFactory (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../index-all.html">索引</a></li>
<li><a href="../../../../help-doc.html">帮助</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/schema/Schema.TableType.html" title="org.apache.calcite.schema中的枚举"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/schema/SchemaPlus.html" title="org.apache.calcite.schema中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/schema/SchemaFactory.html" target="_top">框架</a></li>
<li><a href="SchemaFactory.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</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.calcite.schema</div>
<h2 title="接口 SchemaFactory" class="title">接口 SchemaFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../org/apache/calcite/schema/impl/AbstractSchema.Factory.html" title="org.apache.calcite.schema.impl中的类">AbstractSchema.Factory</a>, <a href="../../../../org/apache/calcite/adapter/cassandra/CassandraSchemaFactory.html" title="org.apache.calcite.adapter.cassandra中的类">CassandraSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/clone/CloneSchema.Factory.html" title="org.apache.calcite.adapter.clone中的类">CloneSchema.Factory</a>, <a href="../../../../org/apache/calcite/adapter/csv/CsvSchemaFactory.html" title="org.apache.calcite.adapter.csv中的类">CsvSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/druid/DruidSchemaFactory.html" title="org.apache.calcite.adapter.druid中的类">DruidSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchSchemaFactory.html" title="org.apache.calcite.adapter.elasticsearch中的类">ElasticsearchSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/file/FileSchemaFactory.html" title="org.apache.calcite.adapter.file中的类">FileSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/geode/rel/GeodeSchemaFactory.html" title="org.apache.calcite.adapter.geode.rel中的类">GeodeSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/geode/simple/GeodeSimpleSchemaFactory.html" title="org.apache.calcite.adapter.geode.simple中的类">GeodeSimpleSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/jdbc/JdbcSchema.Factory.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcSchema.Factory</a>, <a href="../../../../org/apache/calcite/adapter/mongodb/MongoSchemaFactory.html" title="org.apache.calcite.adapter.mongodb中的类">MongoSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/pig/PigSchemaFactory.html" title="org.apache.calcite.adapter.pig中的类">PigSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/redis/RedisSchemaFactory.html" title="org.apache.calcite.adapter.redis中的类">RedisSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/java/ReflectiveSchema.Factory.html" title="org.apache.calcite.adapter.java中的类">ReflectiveSchema.Factory</a>, <a href="../../../../org/apache/calcite/adapter/tpcds/TpcdsSchemaFactory.html" title="org.apache.calcite.adapter.tpcds中的类">TpcdsSchemaFactory</a>, <a href="../../../../org/apache/calcite/adapter/tpch/TpchSchemaFactory.html" title="org.apache.calcite.adapter.tpch中的类">TpchSchemaFactory</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SchemaFactory</span></pre>
<div class="block">Factory for <a href="../../../../org/apache/calcite/schema/Schema.html" title="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: "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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>方法概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/schema/Schema.html" title="org.apache.calcite.schema中的接口">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/schema/SchemaFactory.html#create-org.apache.calcite.schema.SchemaPlus-java.lang.String-java.util.Map-">create</a></span>(<a href="../../../../org/apache/calcite/schema/SchemaPlus.html" title="org.apache.calcite.schema中的接口">SchemaPlus</a>&nbsp;parentSchema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="java.util中的类或接口">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&gt;&nbsp;operand)</code>
<div class="block">Creates a Schema.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>方法详细资料</h3>
<a name="create-org.apache.calcite.schema.SchemaPlus-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre><a href="../../../../org/apache/calcite/schema/Schema.html" title="org.apache.calcite.schema中的接口">Schema</a>&nbsp;create(<a href="../../../../org/apache/calcite/schema/SchemaPlus.html" title="org.apache.calcite.schema中的接口">SchemaPlus</a>&nbsp;parentSchema,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="java.util中的类或接口">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&gt;&nbsp;operand)</pre>
<div class="block">Creates a Schema.</div>
<dl>
<dt><span class="paramLabel">参数:</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">返回:</span></dt>
<dd>Created schema</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="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../index-all.html">索引</a></li>
<li><a href="../../../../help-doc.html">帮助</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/schema/Schema.TableType.html" title="org.apache.calcite.schema中的枚举"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/schema/SchemaPlus.html" title="org.apache.calcite.schema中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/schema/SchemaFactory.html" target="_top">框架</a></li>
<li><a href="SchemaFactory.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>