deploy: oxia-db/oxia-client-java@0e5a693

Author: mattisonchao

public/oxia-client-java/apidocs/latest/allclasses-index.html

@@ -87,6 +87,11 @@ <h2 class="title" id="I:B">B</h2>
 </dl>
 <h2 class="title" id="I:C">C</h2>
 <dl class="index">
+<dt><a href="io/oxia/client/api/CancelableRangeScanConsumer.html" class="type-name-link" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a> - Interface in <a href="io/oxia/client/api/package-summary.html">io.oxia.client.api</a></dt>
+<dd>
+<div class="block">Callback used by <a href="io/oxia/client/api/AsyncOxiaClient.html#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer)"><code>AsyncOxiaClient.rangeScanWithCancellation(String, String, CancelableRangeScanConsumer)</code></a> to deliver records while allowing callers to stop a streaming range
+ scan early.</div>
+</dd>
 <dt><a href="io/oxia/client/api/Version.html#clientIdentifier()" class="member-name-link">clientIdentifier()</a> - Method in record class <a href="io/oxia/client/api/Version.html" title="class in io.oxia.client.api">Version</a></dt>
 <dd>
 <div class="block">Returns the value of the <a href="./io/oxia/client/api/Version.html#param-clientIdentifier"><code>clientIdentifier</code></a> record component.</div>
@@ -506,14 +511,26 @@ <h2 class="title" id="I:N">N</h2>
 </dl>
 <h2 class="title" id="I:O">O</h2>
 <dl class="index">
+<dt><a href="io/oxia/client/api/CancelableRangeScanConsumer.html#onCompleted()" class="member-name-link">onCompleted()</a> - Method in interface <a href="io/oxia/client/api/CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a></dt>
+<dd>
+<div class="block">Invoked when the range scan operation completes.</div>
+</dd>
 <dt><a href="io/oxia/client/api/RangeScanConsumer.html#onCompleted()" class="member-name-link">onCompleted()</a> - Method in interface <a href="io/oxia/client/api/RangeScanConsumer.html" title="interface in io.oxia.client.api">RangeScanConsumer</a></dt>
 <dd>
 <div class="block">Invoked when the range scan operation completes.</div>
 </dd>
+<dt><a href="io/oxia/client/api/CancelableRangeScanConsumer.html#onError(java.lang.Throwable)" class="member-name-link">onError(Throwable)</a> - Method in interface <a href="io/oxia/client/api/CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a></dt>
+<dd>
+<div class="block">Invoked when an error occurs during the range scan operation.</div>
+</dd>
 <dt><a href="io/oxia/client/api/RangeScanConsumer.html#onError(java.lang.Throwable)" class="member-name-link">onError(Throwable)</a> - Method in interface <a href="io/oxia/client/api/RangeScanConsumer.html" title="interface in io.oxia.client.api">RangeScanConsumer</a></dt>
 <dd>
 <div class="block">Invoked when an error occurs during the range scan operation.</div>
 </dd>
+<dt><a href="io/oxia/client/api/CancelableRangeScanConsumer.html#onNext(io.oxia.client.api.GetResult)" class="member-name-link">onNext(GetResult)</a> - Method in interface <a href="io/oxia/client/api/CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a></dt>
+<dd>
+<div class="block">Invoked for each record returned by the range scan operation.</div>
+</dd>
 <dt><a href="io/oxia/client/api/RangeScanConsumer.html#onNext(io.oxia.client.api.GetResult)" class="member-name-link">onNext(GetResult)</a> - Method in interface <a href="io/oxia/client/api/RangeScanConsumer.html" title="interface in io.oxia.client.api">RangeScanConsumer</a></dt>
 <dd>
 <div class="block">Invoked for each record returned by the range scan operation.</div>
@@ -620,6 +637,16 @@ <h2 class="title" id="I:R">R</h2>
 <dd>
 <div class="block">Scan any existing records within the specified range of keys.</div>
 </dd>
+<dt><a href="io/oxia/client/api/SyncOxiaClient.html#rangeScanCloseable(java.lang.String,java.lang.String)" class="member-name-link">rangeScanCloseable(String, String)</a> - Method in interface <a href="io/oxia/client/api/SyncOxiaClient.html" title="interface in io.oxia.client.api">SyncOxiaClient</a></dt>
+<dd>
+<div class="block">Scan any existing records within the specified range of keys, returning an iterable that can be
+ closed when iteration is abandoned before completion.</div>
+</dd>
+<dt><a href="io/oxia/client/api/SyncOxiaClient.html#rangeScanCloseable(java.lang.String,java.lang.String,java.util.Set)" class="member-name-link">rangeScanCloseable(String, String, Set&lt;RangeScanOption&gt;)</a> - Method in interface <a href="io/oxia/client/api/SyncOxiaClient.html" title="interface in io.oxia.client.api">SyncOxiaClient</a></dt>
+<dd>
+<div class="block">Scan any existing records within the specified range of keys, returning an iterable that can be
+ closed when iteration is abandoned before completion.</div>
+</dd>
 <dt><a href="io/oxia/client/api/RangeScanConsumer.html" class="type-name-link" title="interface in io.oxia.client.api">RangeScanConsumer</a> - Interface in <a href="io/oxia/client/api/package-summary.html">io.oxia.client.api</a></dt>
 <dd>
 <div class="block">Callback used by <a href="io/oxia/client/api/AsyncOxiaClient.html#rangeScan(java.lang.String,java.lang.String,io.oxia.client.api.RangeScanConsumer)"><code>AsyncOxiaClient.rangeScan(String, String, RangeScanConsumer)</code></a> to deliver
@@ -630,6 +657,16 @@ <h2 class="title" id="I:R">R</h2>
 <div class="block">RangeScanOption is a sealed interface that represents options for controlling range scan
  operations.</div>
 </dd>
+<dt><a href="io/oxia/client/api/AsyncOxiaClient.html#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer)" class="member-name-link">rangeScanWithCancellation(String, String, CancelableRangeScanConsumer)</a> - Method in interface <a href="io/oxia/client/api/AsyncOxiaClient.html" title="interface in io.oxia.client.api">AsyncOxiaClient</a></dt>
+<dd>
+<div class="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
+ iteration early.</div>
+</dd>
+<dt><a href="io/oxia/client/api/AsyncOxiaClient.html#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer,java.util.Set)" class="member-name-link">rangeScanWithCancellation(String, String, CancelableRangeScanConsumer, Set&lt;RangeScanOption&gt;)</a> - Method in interface <a href="io/oxia/client/api/AsyncOxiaClient.html" title="interface in io.oxia.client.api">AsyncOxiaClient</a></dt>
+<dd>
+<div class="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
+ iteration early.</div>
+</dd>
 <dt><a href="io/oxia/client/api/OxiaClientBuilder.html#requestTimeout(java.time.Duration)" class="member-name-link">requestTimeout(Duration)</a> - Method in interface <a href="io/oxia/client/api/OxiaClientBuilder.html" title="interface in io.oxia.client.api">OxiaClientBuilder</a></dt>
 <dd>
 <div class="block">Specify a custom timeout for all requests.</div>

public/oxia-client-java/apidocs/latest/index-all.html

@@ -214,6 +214,23 @@ <h2>Method Summary</h2>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Scan any existing records within the specified range of keys.</div>
 </div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer)" class="member-name-link">rangeScanWithCancellation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;startKeyInclusive,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;endKeyExclusive,
+ <a href="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a>&nbsp;consumer)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
+ iteration early.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer,java.util.Set)" class="member-name-link">rangeScanWithCancellation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;startKeyInclusive,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;endKeyExclusive,
+ <a href="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a>&nbsp;consumer,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="options/RangeScanOption.html" title="interface in io.oxia.client.api.options">RangeScanOption</a>&gt;&nbsp;options)</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
+<div class="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
+ iteration early.</div>
+</div>
 </div>
 </div>
 </div>
@@ -454,6 +471,46 @@ <h3>rangeScan</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer)">
+<h3>rangeScanWithCancellation</h3>
+<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">rangeScanWithCancellation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;startKeyInclusive,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;endKeyExclusive,
+ <a href="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a>&nbsp;consumer)</span></div>
+<div class="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
+ iteration early.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>startKeyInclusive</code> - The key that declares start of the range, and is <b>included</b> from
+     the range.</dd>
+<dd><code>endKeyExclusive</code> - The key that declares the end of the range, and is <b>excluded</b> from
+     the range.</dd>
+<dd><code>consumer</code> - A <a href="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api"><code>CancelableRangeScanConsumer</code></a> that will be invoked with the records or
+     errors.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="rangeScanWithCancellation(java.lang.String,java.lang.String,io.oxia.client.api.CancelableRangeScanConsumer,java.util.Set)">
+<h3>rangeScanWithCancellation</h3>
+<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">rangeScanWithCancellation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;startKeyInclusive,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;endKeyExclusive,
+ <a href="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api">CancelableRangeScanConsumer</a>&nbsp;consumer,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="options/RangeScanOption.html" title="interface in io.oxia.client.api.options">RangeScanOption</a>&gt;&nbsp;options)</span></div>
+<div class="block">Scan any existing records within the specified range of keys, allowing the consumer to stop
+ iteration early.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>startKeyInclusive</code> - The key that declares start of the range, and is <b>included</b> from
+     the range.</dd>
+<dd><code>endKeyExclusive</code> - The key that declares the end of the range, and is <b>excluded</b> from
+     the range.</dd>
+<dd><code>consumer</code> - A <a href="CancelableRangeScanConsumer.html" title="interface in io.oxia.client.api"><code>CancelableRangeScanConsumer</code></a> that will be invoked with the records or
+     errors.</dd>
+<dd><code>options</code> - the range scan options</dd>
+</dl>
+</section>
+</li>
+<li>
 <section class="detail" id="notifications(java.util.function.Consumer)">
 <h3>notifications</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">notifications</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a>&lt;<a href="Notification.html" title="interface in io.oxia.client.api">Notification</a>&gt;&nbsp;notificationCallback)</span></div>