| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>RangeQuery (kafka 4.0.1 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.kafka.streams.query, class: RangeQuery"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.streams.query</a></div> |
| <h1 title="Class RangeQuery" class="title">Class RangeQuery<K,<wbr>V></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.kafka.streams.query.RangeQuery<K,<wbr>V></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - Type of keys</dd> |
| <dd><code>V</code> - Type of values</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Query.html" title="interface in org.apache.kafka.streams.query">Query</a><<a href="../state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><K,<wbr>V>></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../../common/annotation/InterfaceStability.Evolving.html" title="annotation interface in org.apache.kafka.common.annotation">@Evolving</a> |
| </span><span class="modifiers">public final class </span><span class="element-name type-name-label">RangeQuery<K,<wbr>V></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="Query.html" title="interface in org.apache.kafka.streams.query">Query</a><<a href="../state/KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><K,<wbr>V>></span></div> |
| <div class="block">Interactive query for issuing range queries and scans over KeyValue stores. |
| <p> |
| A range query retrieves a set of records, specified using an upper and/or lower bound on the keys. |
| <p> |
| A scan query retrieves all records contained in the store. |
| <p> |
| Keys' order is based on the serialized byte[] of the keys, not the 'logical' key order.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerBound()" class="member-name-link">getLowerBound</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The lower bound of the query, if specified.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperBound()" class="member-name-link">getUpperBound</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The upper bound of the query, if specified</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ResultOrder.html" title="enum class in org.apache.kafka.streams.query">ResultOrder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resultOrder()" class="member-name-link">resultOrder</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines if the serialized byte[] of the keys in ascending or descending or unordered order.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><wbr><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>,<wbr><a href="RangeQuery.html" title="type parameter in RangeQuery">V</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withAscendingKeys()" class="member-name-link">withAscendingKeys</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the query to return the serialized byte[] of the keys in ascending order.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><wbr><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>,<wbr><a href="RangeQuery.html" title="type parameter in RangeQuery">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withDescendingKeys()" class="member-name-link">withDescendingKeys</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the query to return the serialized byte[] of the keys in descending order.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <K,<wbr> |
| V> <a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><wbr><K,<wbr>V></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#withLowerBound(K)" class="member-name-link">withLowerBound</a><wbr>(K lower)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Interactive range query using a lower bound to filter the keys returned.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <K,<wbr> |
| V> <a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><wbr><K,<wbr>V></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#withNoBounds()" class="member-name-link">withNoBounds</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Interactive scan query that returns all records in the store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <K,<wbr> |
| V> <a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><wbr><K,<wbr>V></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#withRange(K,K)" class="member-name-link">withRange</a><wbr>(K lower, |
| K upper)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Interactive range query using a lower and upper bound to filter the keys returned.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <K,<wbr> |
| V> <a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><wbr><K,<wbr>V></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#withUpperBound(K)" class="member-name-link">withUpperBound</a><wbr>(K upper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Interactive range query using an upper bound to filter the keys returned.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="withRange(K,K)"> |
| <h3 id="withRange(java.lang.Object,java.lang.Object)">withRange</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,<wbr> |
| V></span> <span class="return-type"><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><K,<wbr>V></span> <span class="element-name">withRange</span><wbr><span class="parameters">(K lower, |
| K upper)</span></div> |
| <div class="block">Interactive range query using a lower and upper bound to filter the keys returned.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - The key type</dd> |
| <dd><code>V</code> - The value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>lower</code> - The key that specifies the lower bound of the range</dd> |
| <dd><code>upper</code> - The key that specifies the upper bound of the range</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resultOrder()"> |
| <h3>resultOrder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ResultOrder.html" title="enum class in org.apache.kafka.streams.query">ResultOrder</a></span> <span class="element-name">resultOrder</span>()</div> |
| <div class="block">Determines if the serialized byte[] of the keys in ascending or descending or unordered order. |
| Order is based on the serialized byte[] of the keys, not the 'logical' key order.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>return the order of returned records based on the serialized byte[] of the keys (can be unordered, or in ascending or in descending order).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withDescendingKeys()"> |
| <h3>withDescendingKeys</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>,<wbr><a href="RangeQuery.html" title="type parameter in RangeQuery">V</a>></span> <span class="element-name">withDescendingKeys</span>()</div> |
| <div class="block">Set the query to return the serialized byte[] of the keys in descending order. |
| Order is based on the serialized byte[] of the keys, not the 'logical' key order.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new RangeQuery instance with descending flag set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withAscendingKeys()"> |
| <h3>withAscendingKeys</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>,<wbr><a href="RangeQuery.html" title="type parameter in RangeQuery">V</a>></span> <span class="element-name">withAscendingKeys</span>()</div> |
| <div class="block">Set the query to return the serialized byte[] of the keys in ascending order. |
| Order is based on the serialized byte[] of the keys, not the 'logical' key order.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new RangeQuery instance with ascending flag set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withUpperBound(K)"> |
| <h3 id="withUpperBound(java.lang.Object)">withUpperBound</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,<wbr> |
| V></span> <span class="return-type"><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><K,<wbr>V></span> <span class="element-name">withUpperBound</span><wbr><span class="parameters">(K upper)</span></div> |
| <div class="block">Interactive range query using an upper bound to filter the keys returned. |
| If both <code><K,V></code> are null, RangQuery returns a full range scan.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - The key type</dd> |
| <dd><code>V</code> - The value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>upper</code> - The key that specifies the upper bound of the range</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withLowerBound(K)"> |
| <h3 id="withLowerBound(java.lang.Object)">withLowerBound</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,<wbr> |
| V></span> <span class="return-type"><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><K,<wbr>V></span> <span class="element-name">withLowerBound</span><wbr><span class="parameters">(K lower)</span></div> |
| <div class="block">Interactive range query using a lower bound to filter the keys returned.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - The key type</dd> |
| <dd><code>V</code> - The value type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>lower</code> - The key that specifies the lower bound of the range</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withNoBounds()"> |
| <h3>withNoBounds</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><K,<wbr> |
| V></span> <span class="return-type"><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><K,<wbr>V></span> <span class="element-name">withNoBounds</span>()</div> |
| <div class="block">Interactive scan query that returns all records in the store.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - The key type</dd> |
| <dd><code>V</code> - The value type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLowerBound()"> |
| <h3>getLowerBound</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>></span> <span class="element-name">getLowerBound</span>()</div> |
| <div class="block">The lower bound of the query, if specified.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUpperBound()"> |
| <h3>getUpperBound</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RangeQuery.html" title="type parameter in RangeQuery">K</a>></span> <span class="element-name">getUpperBound</span>()</div> |
| <div class="block">The upper bound of the query, if specified</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
