blob: 5df7739e43a733e094d32973b3b70fcfa5502536 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Package org.apache.calcite.adapter.elasticsearch (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="Uses of Package org.apache.calcite.adapter.elasticsearch (Apache Calcite API)";
}
}
catch(err) {
}
//-->
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</li>
<li class="navBarCell1Rev">Use</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>
<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>
<main role="main">
<div class="header">
<h1 title="Uses of Package org.apache.calcite.adapter.elasticsearch" class="title">Uses of Package<br>org.apache.calcite.adapter.elasticsearch</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="package-summary.html">org.apache.calcite.adapter.elasticsearch</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.calcite.adapter.elasticsearch">org.apache.calcite.adapter.elasticsearch</a></th>
<td class="colLast">
<div class="block">Query provider based on an Elasticsearch2 DB.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a id="org.apache.calcite.adapter.elasticsearch">
<!-- -->
</a>
<table class="useSummary">
<caption><span>Classes in <a href="package-summary.html">org.apache.calcite.adapter.elasticsearch</a> used by <a href="package-summary.html">org.apache.calcite.adapter.elasticsearch</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.Aggregation.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.Aggregation</a></th>
<td class="colLast">
<div class="block">Identifies all aggregations</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.Aggregations.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.Aggregations</a></th>
<td class="colLast">
<div class="block"><a href="ElasticsearchJson.Aggregation.html" title="interface in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchJson.Aggregation</code></a> container.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.Bucket.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.Bucket</a></th>
<td class="colLast">
<div class="block">A bucket represents a criteria to which all documents that fall in it adhere to.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.GroupValue.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.GroupValue</a></th>
<td class="colLast">
<div class="block">Distinguishes from <a href="ElasticsearchJson.MultiValue.html" title="class in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchJson.MultiValue</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.HasAggregations.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.HasAggregations</a></th>
<td class="colLast">
<div class="block">Allows traversing aggregations tree</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.MultiValue.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.MultiValue</a></th>
<td class="colLast">
<div class="block">Multi value aggregatoin like
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html">Stats</a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.Result.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.Result</a></th>
<td class="colLast">
<div class="block">Response from Elastic</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.RowKey.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.RowKey</a></th>
<td class="colLast">
<div class="block">Identifies a calcite row (as in relational algebra)</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.SearchHit.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.SearchHit</a></th>
<td class="colLast">
<div class="block">Concrete result record which matched the query.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.SearchHits.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.SearchHits</a></th>
<td class="colLast">
<div class="block">Similar to <code>SearchHits</code> in ES.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchJson.SearchTotal.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchJson.SearchTotal</a></th>
<td class="colLast">
<div class="block">Container for total hits</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchMapping.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchMapping</a></th>
<td class="colLast">
<div class="block">Stores Elasticsearch
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html">
mapping</a> information for particular index.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchMapping.Datatype.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchMapping.Datatype</a></th>
<td class="colLast">
<div class="block">Represents elastic data-type, like <code>long</code>, <code>keyword</code>,
<code>date</code> etc.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchMethod.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchMethod</a></th>
<td class="colLast">
<div class="block">Builtin methods in the Elasticsearch adapter.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchRel.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchRel</a></th>
<td class="colLast">
<div class="block">Relational expression that uses Elasticsearch calling convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchRel.Implementor.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchRel.Implementor</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchRules.ElasticsearchConverterRule.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchRules.ElasticsearchConverterRule</a></th>
<td class="colLast">
<div class="block">Base class for planner rules that convert a relational expression to
Elasticsearch calling convention.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchRules.ElasticsearchFilterRule.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchRules.ElasticsearchFilterRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/logical/LogicalFilter.html" title="class in org.apache.calcite.rel.logical"><code>LogicalFilter</code></a> to an
<a href="ElasticsearchFilter.html" title="class in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchFilter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchRules.ElasticsearchProjectRule.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchRules.ElasticsearchProjectRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/logical/LogicalProject.html" title="class in org.apache.calcite.rel.logical"><code>LogicalProject</code></a>
to an <a href="ElasticsearchProject.html" title="class in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchProject</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchRules.ElasticsearchSortRule.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchRules.ElasticsearchSortRule</a></th>
<td class="colLast">
<div class="block">Rule to convert a <a href="../../rel/core/Sort.html" title="class in org.apache.calcite.rel.core"><code>Sort</code></a> to an
<a href="ElasticsearchSort.html" title="class in org.apache.calcite.adapter.elasticsearch"><code>ElasticsearchSort</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchSearchResult.SearchHit.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchSearchResult.SearchHit</a></th>
<td class="colLast">
<div class="block">Concrete result record which matched the query.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchSearchResult.SearchHits.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchSearchResult.SearchHits</a></th>
<td class="colLast">
<div class="block">Similar to <code>SearchHits</code> in ES.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchTable.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchTable</a></th>
<td class="colLast">
<div class="block">Table based on an Elasticsearch index.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchTransport.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchTransport</a></th>
<td class="colLast">
<div class="block">Set of predefined functions for REST interaction with elastic search API.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/ElasticsearchVersion.html#org.apache.calcite.adapter.elasticsearch">ElasticsearchVersion</a></th>
<td class="colLast">
<div class="block">Identifies current ES version at runtime.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/MapProjectionFieldVisitor.html#org.apache.calcite.adapter.elasticsearch">MapProjectionFieldVisitor</a></th>
<td class="colLast">
<div class="block">Visitor that extracts the actual field name from an item expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.CastExpression.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.CastExpression</a></th>
<td class="colLast">
<div class="block">SQL cast: <code>cast(col as INTEGER)</code></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.CompoundQueryExpression.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.CompoundQueryExpression</a></th>
<td class="colLast">
<div class="block">Builds conjunctions / disjunctions based on existing expressions</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.Expression.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.Expression</a></th>
<td class="colLast">
<div class="block">Empty interface; exists only to define type hierarchy</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.ExpressionNotAnalyzableException.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.ExpressionNotAnalyzableException</a></th>
<td class="colLast">
<div class="block">Thrown when <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> expression can't be processed
(or converted into ES query)</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.LiteralExpression.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.LiteralExpression</a></th>
<td class="colLast">
<div class="block">Literal like <code>'foo' or 42 or true</code> etc.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.NamedFieldExpression.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.NamedFieldExpression</a></th>
<td class="colLast">
<div class="block">Used for bind variables</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.QueryExpression.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.QueryExpression</a></th>
<td class="colLast">
<div class="block">Main expression operators (like <code>equals</code>, <code>gt</code>, <code>exists</code> etc.)</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.TerminalExpression.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.TerminalExpression</a></th>
<td class="colLast">
<div class="block">Empty interface; exists only to define type hierarchy</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/PredicateAnalyzer.Visitor.SwapResult.html#org.apache.calcite.adapter.elasticsearch">PredicateAnalyzer.Visitor.SwapResult</a></th>
<td class="colLast">
<div class="block">Holder class for a pair of expressions.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.BoolQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.BoolQueryBuilder</a></th>
<td class="colLast">
<div class="block">Query for boolean logic</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.ConstantScoreQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.ConstantScoreQueryBuilder</a></th>
<td class="colLast">
<div class="block">A query that wraps a filter and simply returns a constant score equal to the
query boost for every document in the filter.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.ExistsQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.ExistsQueryBuilder</a></th>
<td class="colLast">
<div class="block">Constructs a query that only match on documents that the field has a value in them.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.MatchAllQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.MatchAllQueryBuilder</a></th>
<td class="colLast">
<div class="block">A query that matches on all documents.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.QueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.QueryBuilder</a></th>
<td class="colLast">
<div class="block">Base class to build ES queries</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.RangeQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.RangeQueryBuilder</a></th>
<td class="colLast">
<div class="block">A Query that matches documents within an range of terms.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.RegexpQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.RegexpQueryBuilder</a></th>
<td class="colLast">
<div class="block">A Query that does fuzzy matching for a specific value.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.TermQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.TermQueryBuilder</a></th>
<td class="colLast">
<div class="block">A Query that matches documents containing a term.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="class-use/QueryBuilders.TermsQueryBuilder.html#org.apache.calcite.adapter.elasticsearch">QueryBuilders.TermsQueryBuilder</a></th>
<td class="colLast">
<div class="block">A filter for a field based on several terms matching on any of them.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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>
<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>