blob: bf8d392fa76df73984de02b74aa39cd27cbf99e0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>MongoSchema (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="MongoSchema (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/MongoSchema.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&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.adapter.mongodb</a></div>
<h2 title="Class MongoSchema" class="title">Class MongoSchema</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../schema/impl/AbstractSchema.html" title="class in org.apache.calcite.schema.impl">org.apache.calcite.schema.impl.AbstractSchema</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.adapter.mongodb.MongoSchema</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../schema/Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">MongoSchema</span>
extends <a href="../../schema/impl/AbstractSchema.html" title="class in org.apache.calcite.schema.impl">AbstractSchema</a></pre>
<div class="block">Schema mapped onto a directory of MONGO files. Each table in the schema
is a MONGO file in that directory.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.schema.impl.AbstractSchema">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.calcite.schema.impl.<a href="../../schema/impl/AbstractSchema.html" title="class in org.apache.calcite.schema.impl">AbstractSchema</a></h3>
<code><a href="../../schema/impl/AbstractSchema.Factory.html" title="class in org.apache.calcite.schema.impl">AbstractSchema.Factory</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.schema.Schema">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.schema.<a href="../../schema/Schema.html" title="interface in org.apache.calcite.schema">Schema</a></h3>
<code><a href="../../schema/Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) com.mongodb.client.MongoDatabase</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mongoDb">mongoDb</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.mongodb.client.MongoDatabase)">MongoSchema</a></span>&#8203;(com.mongodb.client.MongoDatabase&nbsp;mongoDb)</code></th>
<td class="colLast">
<div class="block">Allows tests to inject their instance of the database.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,com.mongodb.MongoCredential,com.mongodb.MongoClientOptions)">MongoSchema</a></span>&#8203;(java.lang.String&nbsp;host,
java.lang.String&nbsp;database,
com.mongodb.MongoCredential&nbsp;credential,
com.mongodb.MongoClientOptions&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Creates a MongoDB schema.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected java.util.Map&lt;java.lang.String,&#8203;<a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTableMap()">getTableMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a map of tables in this schema by name.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.schema.impl.AbstractSchema">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.schema.impl.<a href="../../schema/impl/AbstractSchema.html" title="class in org.apache.calcite.schema.impl">AbstractSchema</a></h3>
<code><a href="../../schema/impl/AbstractSchema.html#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">getExpression</a>, <a href="../../schema/impl/AbstractSchema.html#getFunctionMultimap()">getFunctionMultimap</a>, <a href="../../schema/impl/AbstractSchema.html#getFunctionNames()">getFunctionNames</a>, <a href="../../schema/impl/AbstractSchema.html#getFunctions(java.lang.String)">getFunctions</a>, <a href="../../schema/impl/AbstractSchema.html#getSubSchema(java.lang.String)">getSubSchema</a>, <a href="../../schema/impl/AbstractSchema.html#getSubSchemaMap()">getSubSchemaMap</a>, <a href="../../schema/impl/AbstractSchema.html#getSubSchemaNames()">getSubSchemaNames</a>, <a href="../../schema/impl/AbstractSchema.html#getTable(java.lang.String)">getTable</a>, <a href="../../schema/impl/AbstractSchema.html#getTableNames()">getTableNames</a>, <a href="../../schema/impl/AbstractSchema.html#getType(java.lang.String)">getType</a>, <a href="../../schema/impl/AbstractSchema.html#getTypeMap()">getTypeMap</a>, <a href="../../schema/impl/AbstractSchema.html#getTypeNames()">getTypeNames</a>, <a href="../../schema/impl/AbstractSchema.html#isMutable()">isMutable</a>, <a href="../../schema/impl/AbstractSchema.html#snapshot(org.apache.calcite.schema.SchemaVersion)">snapshot</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="mongoDb">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mongoDb</h4>
<pre>final&nbsp;com.mongodb.client.MongoDatabase mongoDb</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,com.mongodb.MongoCredential,com.mongodb.MongoClientOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MongoSchema</h4>
<pre>MongoSchema&#8203;(java.lang.String&nbsp;host,
java.lang.String&nbsp;database,
com.mongodb.MongoCredential&nbsp;credential,
com.mongodb.MongoClientOptions&nbsp;options)</pre>
<div class="block">Creates a MongoDB schema.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - Mongo host, e.g. "localhost"</dd>
<dd><code>credential</code> - Optional credentials (null for none)</dd>
<dd><code>options</code> - Mongo connection options</dd>
<dd><code>database</code> - Mongo database name, e.g. "foodmart"</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(com.mongodb.client.MongoDatabase)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MongoSchema</h4>
<pre>MongoSchema&#8203;(com.mongodb.client.MongoDatabase&nbsp;mongoDb)</pre>
<div class="block">Allows tests to inject their instance of the database.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mongoDb</code> - existing mongo database instance</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getTableMap()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTableMap</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;&nbsp;getTableMap()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../schema/impl/AbstractSchema.html#getTableMap()">AbstractSchema</a></code></span></div>
<div class="block">Returns a map of tables in this schema by name.
<p>The implementations of <a href="../../schema/impl/AbstractSchema.html#getTableNames()"><code>AbstractSchema.getTableNames()</code></a>
and <a href="../../schema/impl/AbstractSchema.html#getTable(java.lang.String)"><code>AbstractSchema.getTable(String)</code></a> depend on this map.
The default implementation of this method returns the empty map.
Override this method to change their behavior.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../schema/impl/AbstractSchema.html#getTableMap()">getTableMap</a></code>&nbsp;in class&nbsp;<code><a href="../../schema/impl/AbstractSchema.html" title="class in org.apache.calcite.schema.impl">AbstractSchema</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of tables in this schema by name</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/MongoSchema.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&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>