blob: d0bc1324ccab03583bff8161e5a0ef3e06c5271c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_291) on Mon Jan 10 11:05:29 MSK 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.ignite.cache.query (Ignite 2.12.0)</title>
<meta name="date" content="2022-01-10">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.ignite.cache.query (Ignite 2.12.0)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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">
<li><a href="../../../../../org/apache/ignite/cache/jta/websphere/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/ignite/cache/query/annotations/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/cache/query/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.ignite.cache.query</h1>
<div class="docSummary">
<div class="block">Contains APIs for creating and executing cache queries.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/ContinuousQueryWithTransformer.EventListener.html" title="interface in org.apache.ignite.cache.query">ContinuousQueryWithTransformer.EventListener</a><span class='angle_bracket'>&lt;</span>T<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">Interface for local listener of <a href="../../../../../org/apache/ignite/cache/query/ContinuousQueryWithTransformer.html" title="class in org.apache.ignite.cache.query"><code>ContinuousQueryWithTransformer</code></a> to implement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/FieldsQueryCursor.html" title="interface in org.apache.ignite.cache.query">FieldsQueryCursor</a><span class='angle_bracket'>&lt;</span>T<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">SQL query result cursor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query">IndexQueryCriterion</a></td>
<td class="colLast">
<div class="block">Basic interface for <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query"><code>IndexQuery</code></a> criterion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/QueryCursor.html" title="interface in org.apache.ignite.cache.query">QueryCursor</a><span class='angle_bracket'>&lt;</span>T<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">Query result cursor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/QueryDetailMetrics.html" title="interface in org.apache.ignite.cache.query">QueryDetailMetrics</a></td>
<td class="colLast">
<div class="block">Query metrics aggregated by query type and its textual representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/QueryMetrics.html" title="interface in org.apache.ignite.cache.query">QueryMetrics</a></td>
<td class="colLast">
<div class="block">Cache query metrics used to obtain statistics on query.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</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">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/AbstractContinuousQuery.html" title="class in org.apache.ignite.cache.query">AbstractContinuousQuery</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">Base class for continuous query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/BulkLoadContextCursor.html" title="class in org.apache.ignite.cache.query">BulkLoadContextCursor</a></td>
<td class="colLast">
<div class="block">A special FieldsQueryCursor subclass that is used as a sentinel to transfer data from bulk load
(COPY) command to the JDBC or other client-facing driver: the bulk load batch processor
and parameters to send to the client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/CacheQueryEntryEvent.html" title="class in org.apache.ignite.cache.query">CacheQueryEntryEvent</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">A Cache continuous query entry event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/ContinuousQuery.html" title="class in org.apache.ignite.cache.query">ContinuousQuery</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">API for configuring continuous cache queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/ContinuousQueryWithTransformer.html" title="class in org.apache.ignite.cache.query">ContinuousQueryWithTransformer</a><span class='angle_bracket'>&lt;</span>K,V,T<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">API for configuring continuous cache queries with transformer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query">IndexQuery</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">Index queries work over distributed indexes and retrieve cache entries that match the specified criteria.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriteriaBuilder.html" title="class in org.apache.ignite.cache.query">IndexQueryCriteriaBuilder</a></td>
<td class="colLast">
<div class="block">Factory of <a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query"><code>IndexQueryCriterion</code></a> for <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query"><code>IndexQuery</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><span class='angle_bracket'>&lt;</span>R<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">Main API for configuring and executing cache queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/ScanQuery.html" title="class in org.apache.ignite.cache.query">ScanQuery</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">Scan query over cache entries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/SpiQuery.html" title="class in org.apache.ignite.cache.query">SpiQuery</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block">Query to be used by <a href="../../../../../org/apache/ignite/spi/indexing/IndexingSpi.html" title="interface in org.apache.ignite.spi.indexing"><code>IndexingSpi</code></a> implementations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query">SqlFieldsQuery</a></td>
<td class="colLast">
<div class="block">SQL Fields query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/SqlQuery.html" title="class in org.apache.ignite.cache.query">SqlQuery</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Since 2.8, please use <a href="../../../../../org/apache/ignite/cache/query/SqlFieldsQuery.html" title="class in org.apache.ignite.cache.query"><code>SqlFieldsQuery</code></a> instead.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></td>
<td class="colLast">
<div class="block"><h1 class="header">Full Text Queries
Ignite supports full text queries based on Apache Lucene engine.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/QueryCancelledException.html" title="class in org.apache.ignite.cache.query">QueryCancelledException</a></td>
<td class="colLast">
<div class="block">The exception is thrown if a query was cancelled or timed out while executing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/ignite/cache/query/QueryRetryException.html" title="class in org.apache.ignite.cache.query">QueryRetryException</a></td>
<td class="colLast">
<div class="block">The exception is thrown if a query was cancelled or timed out while executing.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.ignite.cache.query Description">Package org.apache.ignite.cache.query Description</h2>
<div class="block">Contains APIs for creating and executing cache queries.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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">
<li><a href="../../../../../org/apache/ignite/cache/jta/websphere/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/ignite/cache/query/annotations/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/cache/query/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2022 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.12.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; January 10 2022 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>