blob: 3283dc48ef1e4327b7ec25cd16bbcfe7a79c7baa [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.calcite.adapter.elasticsearch (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.adapter.elasticsearch">
<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.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="package-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 class="nav-bar-cell1-rev">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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li>Related Packages&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.calcite.adapter.elasticsearch" class="title">Package org.apache.calcite.adapter.elasticsearch</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.calcite.adapter.elasticsearch</span></div>
<section class="package-description" id="package-description">
<div class="block">Query provider based on an Elasticsearch2 DB.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchAggregate.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchAggregate</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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
for ElasticSearch.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ElasticsearchFilter.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchFilter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<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 Elasticsearch.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchProject.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchProject</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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 Elasticsearch.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ElasticsearchRel.html" title="interface in org.apache.calcite.adapter.elasticsearch">ElasticsearchRel</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Relational expression that uses Elasticsearch calling convention.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchRel.Implementor.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchRel.Implementor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Callback for the implementation process that converts a tree of
<a href="ElasticsearchRel.html" title="interface in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchRel</code></a> nodes into an Elasticsearch query.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ElasticsearchSchema.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSchema</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Each table in the schema is an ELASTICSEARCH index.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchSchemaFactory.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSchemaFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Factory that creates an <a href="ElasticsearchSchema.html" title="class in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchSchema</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ElasticsearchSearchResult.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSearchResult</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Internal object used to parse elastic search result.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchSearchResult.SearchHit.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSearchResult.SearchHit</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Concrete result record which matched the query.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ElasticsearchSearchResult.SearchHits.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSearchResult.SearchHits</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Similar to <code>SearchHits</code> in ES.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchSort.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSort</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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 Elasticsearch.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ElasticsearchTable.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Table based on an Elasticsearch index.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchTable.ElasticsearchQueryable.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTable.ElasticsearchQueryable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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="ElasticsearchTable.html" title="class in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchTable</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ElasticsearchTableScan.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTableScan</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Relational expression representing a scan of an Elasticsearch type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ElasticsearchToEnumerableConverter.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchToEnumerableConverter</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Relational expression representing a scan of a table in an Elasticsearch data source.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ElasticsearchToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchToEnumerableConverterRule</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Rule to convert a relational expression from
<a href="ElasticsearchRel.html#CONVENTION"><code>ElasticsearchRel.CONVENTION</code></a> to <a href="../enumerable/EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable"><code>EnumerableConvention</code></a>.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>