blob: 6a06d522d622093d52fa80cc1bee3e39e9cbaa34 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.adapter.mongodb (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.adapter.mongodb">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-declaration">
<script type="text/javascript">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 class="navBarCell1Rev">Package</li>
<li>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 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">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.adapter.mongodb</h1>
</div>
<div class="contentContainer">
<section class="packageDescription"><a id="package.description">
<!-- -->
</a>
<div class="block">Query provider based on a MongoDB database.</div>
</section>
<section class="summary">
<ul class="blockList">
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoRel.html" title="interface in org.apache.calcite.adapter.mongodb">MongoRel</a></th>
<td class="colLast">
<div class="block">Relational expression that uses Mongo calling convention.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoAggregate.html" title="class in org.apache.calcite.adapter.mongodb">MongoAggregate</a></th>
<td class="colLast">
<div class="block">Implementation of
<a href="../../rel/core/Aggregate.html" title="class in org.apache.calcite.rel.core"><code>Aggregate</code></a> relational expression
in MongoDB.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MongoFilter.html" title="class in org.apache.calcite.adapter.mongodb">MongoFilter</a></th>
<td class="colLast">
<div class="block">Implementation of a <a href="../../rel/core/Filter.html" title="class in org.apache.calcite.rel.core"><code>Filter</code></a>
relational expression in MongoDB.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoProject.html" title="class in org.apache.calcite.adapter.mongodb">MongoProject</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../../rel/core/Project.html" title="class in org.apache.calcite.rel.core"><code>Project</code></a>
relational expression in MongoDB.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb">MongoRel.Implementor</a></th>
<td class="colLast">
<div class="block">Callback for the implementation process that converts a tree of
<a href="MongoRel.html" title="interface in org.apache.calcite.adapter.mongodb"><code>MongoRel</code></a> nodes into a MongoDB query.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoRules.html" title="class in org.apache.calcite.adapter.mongodb">MongoRules</a></th>
<td class="colLast">
<div class="block">Rules and relational operators for
<a href="MongoRel.html#CONVENTION"><code>MONGO</code></a>
calling convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MongoSchema.html" title="class in org.apache.calcite.adapter.mongodb">MongoSchema</a></th>
<td class="colLast">
<div class="block">Schema mapped onto a directory of MONGO files.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoSchemaFactory.html" title="class in org.apache.calcite.adapter.mongodb">MongoSchemaFactory</a></th>
<td class="colLast">
<div class="block">Factory that creates a <a href="MongoSchema.html" title="class in org.apache.calcite.adapter.mongodb"><code>MongoSchema</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MongoSort.html" title="class in org.apache.calcite.adapter.mongodb">MongoSort</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="../../rel/core/Sort.html" title="class in org.apache.calcite.rel.core"><code>Sort</code></a>
relational expression in MongoDB.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoTable.html" title="class in org.apache.calcite.adapter.mongodb">MongoTable</a></th>
<td class="colLast">
<div class="block">Table based on a MongoDB collection.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MongoTable.MongoQueryable.html" title="class in org.apache.calcite.adapter.mongodb">MongoTable.MongoQueryable</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Implementation of <a href="../../linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> based on
a <a href="MongoTable.html" title="class in org.apache.calcite.adapter.mongodb"><code>MongoTable</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoTableScan.html" title="class in org.apache.calcite.adapter.mongodb">MongoTableScan</a></th>
<td class="colLast">
<div class="block">Relational expression representing a scan of a MongoDB collection.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MongoToEnumerableConverter.html" title="class in org.apache.calcite.adapter.mongodb">MongoToEnumerableConverter</a></th>
<td class="colLast">
<div class="block">Relational expression representing a scan of a table in a Mongo data source.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.mongodb">MongoToEnumerableConverterRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a relational expression from
<a href="MongoRel.html#CONVENTION"><code>MongoRel.CONVENTION</code></a> to <a href="../enumerable/EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable"><code>EnumerableConvention</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MongoMethod.html" title="enum in org.apache.calcite.adapter.mongodb">MongoMethod</a></th>
<td class="colLast">
<div class="block">Builtin methods in the MongoDB adapter.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
</div>
</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 class="navBarCell1Rev">Package</li>
<li>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>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>