http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html b/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html index e923722..c0e71c2 100644 --- a/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html +++ b/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":18,"i1":18,"i2":6,"i3":6}; +var methods = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":18,"i9":18,"i10":18,"i11":18,"i12":6,"i13":6,"i14":18,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":18,"i21":18,"i22":6,"i23":6,"i24":6,"i25":6,"i26":18,"i27":18,"i28":6,"i29":6,"i30":6,"i31":18,"i32":6,"i33":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/AsyncTable.html" target="_top">Frames</a></li> @@ -74,7 +74,7 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li>Nested | </li> +<li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> @@ -93,28 +93,23 @@ var activeTableTab = "activeTableTab"; <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">org.apache.hadoop.hbase.client</div> -<h2 title="Interface AsyncTable" class="title">Interface AsyncTable</h2> +<h2 title="Interface AsyncTable" class="title">Interface AsyncTable<C extends <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumerBase</a>></h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> -<dl> -<dt>All Superinterfaces:</dt> -<dd><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBase</a></dd> -</dl> <hr> <br> <pre>@InterfaceAudience.Public -public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.33">AsyncTable</a> -extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBase</a></pre> -<div class="block">The asynchronous table for normal users. +public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.50">AsyncTable</a><C extends <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumerBase</a>></pre> +<div class="block">The interface for asynchronous version of Table. Obtain an instance from a + <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncConnection</code></a>. <p> The implementation is required to be thread safe. <p> - The implementation should make sure that user can do everything they want to the returned - <code>CompletableFuture</code> without breaking anything. Usually the implementation will require user - to provide a <code>ExecutorService</code>.</div> + Usually the implementation will not throw any exception directly. You need to get the exception + from the returned <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.0.0</dd> @@ -125,6 +120,27 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.ht <div class="summary"> <ul class="blockList"> <li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorCallback</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html" title="type parameter in AsyncTable.CoprocessorCallback">R</a>></span></code> +<div class="block">The callback when we want to execute a coprocessor call on a range of regions.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> @@ -138,39 +154,224 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.ht <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#append-org.apache.hadoop.hbase.client.Append-">append</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</code> +<div class="block">Appends values to one or more columns within a single row.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><T> <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><T>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#batch-java.util.List-">batch</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/hadoop/hbase/client/Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions)</code> +<div class="block">Method that does a batch call on Deletes, Gets, Puts, Increments and Appends.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>default <T> <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#batchAll-java.util.List-">batchAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/hadoop/hbase/client/Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions)</code> +<div class="block">A simple version of batch.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.hbase.client.AsyncTable.CheckAndMutateBuilder</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#checkAndMutate-byte:A-byte:A-">checkAndMutate</a></span>(byte[] row, + byte[] family)</code> +<div class="block">Atomically checks if a row/family/qualifier value matches the expected value.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><S,R> org.apache.hadoop.hbase.client.AsyncTable.CoprocessorServiceBuilder<S,R></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.ServiceCaller-org.apache.hadoop.hbase.client.AsyncTable.CoprocessorCallback-">coprocessorService</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true"; title="class or interface in java.util.function">Function</a><com.google.protobuf.RpcChannel,S> stubMaker, + <a href="../../../../../org/apache/hadoop/hbase/client/ServiceCaller.html" title="interface in org.apache.hadoop.hbase.client">ServiceCaller</a><S,R> callable, + <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorCallback</a><R> callback)</code> +<div class="block">Execute a coprocessor call on the regions which are covered by a range.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><S,R> <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><R></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.ServiceCaller-byte:A-">coprocessorService</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true"; title="class or interface in java.util.function">Function</a><com.google.protobuf.RpcChannel,S> stubMaker, + <a href="../../../../../org/apache/hadoop/hbase/client/ServiceCaller.html" title="interface in org.apache.hadoop.hbase.client">ServiceCaller</a><S,R> callable, + byte[] row)</code> +<div class="block">Execute the given coprocessor call on the region which contains the given <code>row</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#delete-org.apache.hadoop.hbase.client.Delete-">delete</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a> delete)</code> +<div class="block">Deletes the specified cells/row.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#delete-java.util.List-">delete</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a>> deletes)</code> +<div class="block">Deletes the specified cells/rows in bulk.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#deleteAll-java.util.List-">deleteAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a>> deletes)</code> +<div class="block">A simple version of batch delete.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#exists-org.apache.hadoop.hbase.client.Get-">exists</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</code> +<div class="block">Test for the existence of columns in the table, as specified by the Get.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#exists-java.util.List-">exists</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</code> +<div class="block">Test for the existence of columns in the table, as specified by the Gets.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#existsAll-java.util.List-">existsAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</code> +<div class="block">A simple version for batch exists.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#get-org.apache.hadoop.hbase.client.Get-">get</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</code> +<div class="block">Extracts certain cells from a given row.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#get-java.util.List-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</code> +<div class="block">Extracts certain cells from the given rows, in batch.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getAll-java.util.List-">getAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</code> +<div class="block">A simple version for batch get.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getConfiguration--">getConfiguration</a></span>()</code> +<div class="block">Returns the <code>Configuration</code> object used by this instance.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getName--">getName</a></span>()</code> +<div class="block">Gets the fully qualified table name instance of this table.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getOperationTimeout-java.util.concurrent.TimeUnit-">getOperationTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get timeout of each operation in Table instance.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getReadRpcTimeout-java.util.concurrent.TimeUnit-">getReadRpcTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get timeout of each rpc read request in this Table instance.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getRpcTimeout-java.util.concurrent.TimeUnit-">getRpcTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get timeout of each rpc request in this Table instance.</div> +</td> +</tr> +<tr id="i20" class="altColor"> <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getScanner-byte:A-">getScanner</a></span>(byte[] family)</code> <div class="block">Gets a scanner on the current table for the given family.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr id="i21" class="rowColor"> <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getScanner-byte:A-byte:A-">getScanner</a></span>(byte[] family, byte[] qualifier)</code> <div class="block">Gets a scanner on the current table for the given family and qualifier.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i22" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getScanner-org.apache.hadoop.hbase.client.Scan-">getScanner</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</code> <div class="block">Returns a scanner on the current table as specified by the <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getScanTimeout-java.util.concurrent.TimeUnit-">getScanTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get the timeout of a single operation in a scan.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getWriteRpcTimeout-java.util.concurrent.TimeUnit-">getWriteRpcTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get timeout of each rpc write request in this Table instance.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#increment-org.apache.hadoop.hbase.client.Increment-">increment</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Increment.html" title="class in org.apache.hadoop.hbase.client">Increment</a> increment)</code> +<div class="block">Increments one or more columns within a single row.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#incrementColumnValue-byte:A-byte:A-byte:A-long-">incrementColumnValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long amount)</code> +<div class="block">See <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#incrementColumnValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.client.Durability-"><code>incrementColumnValue(byte[], byte[], byte[], long, Durability)</code></a></div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#incrementColumnValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.client.Durability-">incrementColumnValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long amount, + <a href="../../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client">Durability</a> durability)</code> +<div class="block">Atomically increments a column value.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#mutateRow-org.apache.hadoop.hbase.client.RowMutations-">mutateRow</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RowMutations.html" title="class in org.apache.hadoop.hbase.client">RowMutations</a> mutation)</code> +<div class="block">Performs multiple mutations atomically on a single row.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#put-java.util.List-">put</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a>> puts)</code> +<div class="block">Puts some data in the table, in batch.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#put-org.apache.hadoop.hbase.client.Put-">put</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> put)</code> +<div class="block">Puts some data to the table.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#putAll-java.util.List-">putAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a>> puts)</code> +<div class="block">A simple version of batch put.</div> +</td> +</tr> +<tr id="i32" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#scan-org.apache.hadoop.hbase.client.Scan-org.apache.hadoop.hbase.client.ScanResultConsumer-">scan</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, - <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumer</a> consumer)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#scan-org.apache.hadoop.hbase.client.Scan-C-">scan</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, + <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="type parameter in AsyncTable">C</a> consumer)</code> <div class="block">The scan API uses the observer pattern.</div> </td> </tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#scanAll-org.apache.hadoop.hbase.client.Scan-">scanAll</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</code> +<div class="block">Return all the results that match the given scan object.</div> +</td> +</tr> </table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.AsyncTableBase"> -<!-- --> -</a> -<h3>Methods inherited from interface org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBase</a></h3> -<code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#append-org.apache.hadoop.hbase.client.Append-">append</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#batch-java.util.List-">batch</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#batchAll-java.util.List-">batchAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#checkAndMutate-byte:A-byte:A-">checkAndMutate</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#delete-org.apache.hadoop.hbase.client.Delete-">delete</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#delete-java.util.List-">delete</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#deleteAll-java.util.List-">deleteAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#exists-org.apache.hadoop.hbase.client.Get-">exists</a>, <a href="../.. /../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#exists-java.util.List-">exists</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#existsAll-java.util.List-">existsAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#get-org.apache.hadoop.hbase.client.Get-">get</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#get-java.util.List-">get</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getAll-java.util.List-">getAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getConfiguration--">getConfiguration</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getName--">getName</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getOperationTimeout-java.util.concurrent.TimeUnit-">getOperationTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html #getReadRpcTimeout-java.util.concurrent.TimeUnit-">getReadRpcTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getRpcTimeout-java.util.concurrent.TimeUnit-">getRpcTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getScanTimeout-java.util.concurrent.TimeUnit-">getScanTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getWriteRpcTimeout-java.util.concurrent.TimeUnit-">getWriteRpcTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#increment-org.apache.hadoop.hbase.client.Increment-">increment</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#incrementColumnValue-byte:A-byte:A-byte:A-long-">incrementColumnValue</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#incrementColumnValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.client.Durability-">incrementColumnValue</a>, <a hre f="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#mutateRow-org.apache.hadoop.hbase.client.RowMutations-">mutateRow</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#put-java.util.List-">put</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#put-org.apache.hadoop.hbase.client.Put-">put</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#putAll-java.util.List-">putAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#scanAll-org.apache.hadoop.hbase.client.Scan-">scanAll</a></code></li> -</ul> </li> </ul> </li> @@ -185,13 +386,355 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.ht <!-- --> </a> <h3>Method Detail</h3> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.55">getName</a>()</pre> +<div class="block">Gets the fully qualified table name instance of this table.</div> +</li> +</ul> +<a name="getConfiguration--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfiguration</h4> +<pre>org.apache.hadoop.conf.Configuration <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.62">getConfiguration</a>()</pre> +<div class="block">Returns the <code>Configuration</code> object used by this instance. + <p> + The reference returned is not a copy, so any change made to it will affect this instance.</div> +</li> +</ul> +<a name="getRpcTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRpcTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.72">getRpcTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get timeout of each rpc request in this Table instance. It will be overridden by a more + specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unit</code> - the unit of time the timeout to be represented in</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>rpc timeout in the specified time unit</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getReadRpcTimeout-java.util.concurrent.TimeUnit-"><code>getReadRpcTimeout(TimeUnit)</code></a>, +<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getWriteRpcTimeout-java.util.concurrent.TimeUnit-"><code>getWriteRpcTimeout(TimeUnit)</code></a></dd> +</dl> +</li> +</ul> +<a name="getReadRpcTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadRpcTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.79">getReadRpcTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get timeout of each rpc read request in this Table instance.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unit</code> - the unit of time the timeout to be represented in</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>read rpc timeout in the specified time unit</dd> +</dl> +</li> +</ul> +<a name="getWriteRpcTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteRpcTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.86">getWriteRpcTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get timeout of each rpc write request in this Table instance.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unit</code> - the unit of time the timeout to be represented in</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>write rpc timeout in the specified time unit</dd> +</dl> +</li> +</ul> +<a name="getOperationTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOperationTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.93">getOperationTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get timeout of each operation in Table instance.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unit</code> - the unit of time the timeout to be represented in</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>operation rpc timeout in the specified time unit</dd> +</dl> +</li> +</ul> +<a name="getScanTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScanTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.101">getScanTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get the timeout of a single operation in a scan. It works like operation timeout for other + operations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unit</code> - the unit of time the timeout to be represented in</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>scan rpc timeout in the specified time unit</dd> +</dl> +</li> +</ul> +<a name="exists-org.apache.hadoop.hbase.client.Get-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.112">exists</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</pre> +<div class="block">Test for the existence of columns in the table, as specified by the Get. + <p> + This will return true if the Get matches one or more keys, false if not. + <p> + This is a server-side call so it prevents any data from being transfered to the client.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the specified Get matches one or more keys, false if not. The return value will + be wrapped by a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="get-org.apache.hadoop.hbase.client.Get-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.124">get</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</pre> +<div class="block">Extracts certain cells from a given row.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>get</code> - The object that specifies what data to fetch and from which row.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The data coming from the specified row, if it exists. If the row specified doesn't + exist, the <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a> instance returned won't contain any + <code>KeyValue</code>, as indicated by <a href="../../../../../org/apache/hadoop/hbase/client/Result.html#isEmpty--"><code>Result.isEmpty()</code></a>. The + return value will be wrapped by a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="put-org.apache.hadoop.hbase.client.Put-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.131">put</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> put)</pre> +<div class="block">Puts some data to the table.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>put</code> - The data to put.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that always returns null when complete normally.</dd> +</dl> +</li> +</ul> +<a name="delete-org.apache.hadoop.hbase.client.Delete-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.138">delete</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a> delete)</pre> +<div class="block">Deletes the specified cells/row.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>delete</code> - The object that specifies what to delete.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that always returns null when complete normally.</dd> +</dl> +</li> +</ul> +<a name="append-org.apache.hadoop.hbase.client.Append-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.151">append</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</pre> +<div class="block">Appends values to one or more columns within a single row. + <p> + This operation does not appear atomic to readers. Appends are done under a single row lock, so + write operations to a row are synchronized, but readers do not take row locks so get and scan + operations can see this operation partially completed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>append</code> - object that specifies the columns and amounts to be used for the increment + operations</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>values of columns after the append operation (maybe null). The return value will be + wrapped by a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="increment-org.apache.hadoop.hbase.client.Increment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>increment</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.164">increment</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Increment.html" title="class in org.apache.hadoop.hbase.client">Increment</a> increment)</pre> +<div class="block">Increments one or more columns within a single row. + <p> + This operation does not appear atomic to readers. Increments are done under a single row lock, + so write operations to a row are synchronized, but readers do not take row locks so get and + scan operations can see this operation partially completed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>increment</code> - object that specifies the columns and amounts to be used for the increment + operations</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>values of columns after the increment. The return value will be wrapped by a + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="incrementColumnValue-byte:A-byte:A-byte:A-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>incrementColumnValue</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.177">incrementColumnValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + long amount)</pre> +<div class="block">See <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#incrementColumnValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.client.Durability-"><code>incrementColumnValue(byte[], byte[], byte[], long, Durability)</code></a> + <p> + The <a href="../../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client"><code>Durability</code></a> is defaulted to <a href="../../../../../org/apache/hadoop/hbase/client/Durability.html#SYNC_WAL"><code>Durability.SYNC_WAL</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - The row that contains the cell to increment.</dd> +<dd><code>family</code> - The column family of the cell to increment.</dd> +<dd><code>qualifier</code> - The column qualifier of the cell to increment.</dd> +<dd><code>amount</code> - The amount to increment the cell with (or decrement, if the amount is negative).</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The new value, post increment. The return value will be wrapped by a + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="incrementColumnValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.client.Durability-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>incrementColumnValue</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.197">incrementColumnValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + long amount, + <a href="../../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client">Durability</a> durability)</pre> +<div class="block">Atomically increments a column value. If the column value already exists and is not a + big-endian long, this could throw an exception. If the column value does not yet exist it is + initialized to <code>amount</code> and written to the specified column. + <p> + Setting durability to <a href="../../../../../org/apache/hadoop/hbase/client/Durability.html#SKIP_WAL"><code>Durability.SKIP_WAL</code></a> means that in a fail scenario you will lose + any increments that have not been flushed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - The row that contains the cell to increment.</dd> +<dd><code>family</code> - The column family of the cell to increment.</dd> +<dd><code>qualifier</code> - The column qualifier of the cell to increment.</dd> +<dd><code>amount</code> - The amount to increment the cell with (or decrement, if the amount is negative).</dd> +<dd><code>durability</code> - The persistence guarantee for this increment.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The new value, post increment. The return value will be wrapped by a + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="checkAndMutate-byte:A-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkAndMutate</h4> +<pre>org.apache.hadoop.hbase.client.AsyncTable.CheckAndMutateBuilder <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.226">checkAndMutate</a>(byte[] row, + byte[] family)</pre> +<div class="block">Atomically checks if a row/family/qualifier value matches the expected value. If it does, it + adds the Put/Delete/RowMutations. + <p> + Use the returned <code>AsyncTable.CheckAndMutateBuilder</code> to construct your request and then execute it. + This is a fluent style API, the code is like: + + <pre> + <code> + table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put) + .thenAccept(succ -> { + if (succ) { + System.out.println("Check and put succeeded"); + } else { + System.out.println("Check and put failed"); + } + }); + </code> + </pre></div> +</li> +</ul> +<a name="mutateRow-org.apache.hadoop.hbase.client.RowMutations-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mutateRow</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.281">mutateRow</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RowMutations.html" title="class in org.apache.hadoop.hbase.client">RowMutations</a> mutation)</pre> +<div class="block">Performs multiple mutations atomically on a single row. Currently <a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> and + <a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client"><code>Delete</code></a> are supported.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mutation</code> - object that specifies the set of mutations to perform atomically</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that always returns null when complete normally.</dd> +</dl> +</li> +</ul> +<a name="scan-org.apache.hadoop.hbase.client.Scan-org.apache.hadoop.hbase.client.ScanResultConsumerBase-"> +<!-- --> +</a><a name="scan-org.apache.hadoop.hbase.client.Scan-C-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scan</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.290">scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, + <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="type parameter in AsyncTable">C</a> consumer)</pre> +<div class="block">The scan API uses the observer pattern.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scan</code> - A configured <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object.</dd> +<dd><code>consumer</code> - the consumer used to receive results.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client"><code>ScanResultConsumer</code></a>, +<a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client"><code>AdvancedScanResultConsumer</code></a></dd> +</dl> +</li> +</ul> <a name="getScanner-byte:A-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getScanner</h4> -<pre>default <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.40">getScanner</a>(byte[] family)</pre> +<pre>default <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.297">getScanner</a>(byte[] family)</pre> <div class="block">Gets a scanner on the current table for the given family.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -207,7 +750,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.ht <ul class="blockList"> <li class="blockList"> <h4>getScanner</h4> -<pre>default <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.50">getScanner</a>(byte[] family, +<pre>default <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.307">getScanner</a>(byte[] family, byte[] qualifier)</pre> <div class="block">Gets a scanner on the current table for the given family and qualifier.</div> <dl> @@ -225,7 +768,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.ht <ul class="blockList"> <li class="blockList"> <h4>getScanner</h4> -<pre><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.59">getScanner</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</pre> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.316">getScanner</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</pre> <div class="block">Returns a scanner on the current table as specified by the <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -235,23 +778,290 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.ht </dl> </li> </ul> -<a name="scan-org.apache.hadoop.hbase.client.Scan-org.apache.hadoop.hbase.client.ScanResultConsumer-"> +<a name="scanAll-org.apache.hadoop.hbase.client.Scan-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scanAll</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.353">scanAll</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</pre> +<div class="block">Return all the results that match the given scan object. + <p> + Notice that usually you should use this method with a <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object that has limit set. + For example, if you want to get the closest row after a given row, you could do this: + <p> + + <pre> + <code> + table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -> { + if (results.isEmpty()) { + System.out.println("No row after " + Bytes.toStringBinary(row)); + } else { + System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is " + + Bytes.toStringBinary(results.stream().findFirst().get().getRow())); + } + }); + </code> + </pre> + <p> + If your result set is very large, you should use other scan method to get a scanner or use + callback to process the results. They will do chunking to prevent OOM. The scanAll method will + fetch all the results and store them in a List and then return the list to you. + <p> + The scan metrics will be collected background if you enable it but you have no way to get it. + Usually you can get scan metrics from <code>ResultScanner</code>, or through + <code>ScanResultConsumer.onScanMetricsCreated</code> but this method only returns a list of results. + So if you really care about scan metrics then you'd better use other scan methods which return + a <code>ResultScanner</code> or let you pass in a <code>ScanResultConsumer</code>. There is no + performance difference between these scan methods so do not worry.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scan</code> - A configured <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object. So if you use this method to fetch a really large + result set, it is likely to cause OOM.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The results of this small scan operation. The return value will be wrapped by a + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="exists-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.365">exists</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</pre> +<div class="block">Test for the existence of columns in the table, as specified by the Gets. + <p> + This will return a list of booleans. Each value will be true if the related Get matches one or + more keys, false if not. + <p> + This is a server-side call so it prevents any data from being transferred to the client.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>gets</code> - the Gets</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>s that represent the existence for each get.</dd> +</dl> +</li> +</ul> +<a name="existsAll-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>existsAll</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.376">existsAll</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</pre> +<div class="block">A simple version for batch exists. It will fail if there are any failures and you will get the + whole result boolean list at once if the operation is succeeded.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>gets</code> - the Gets</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that wrapper the result boolean list.</dd> +</dl> +</li> +</ul> +<a name="get-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.389">get</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</pre> +<div class="block">Extracts certain cells from the given rows, in batch. + <p> + Notice that you may not get all the results with this function, which means some of the + returned <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>s may succeed while some of the other returned + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>s may fail.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>gets</code> - The objects that specify what data to fetch and from which rows.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>s that represent the result for each get.</dd> +</dl> +</li> +</ul> +<a name="getAll-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAll</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.397">getAll</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</pre> +<div class="block">A simple version for batch get. It will fail if there are any failures and you will get the + whole result list at once if the operation is succeeded.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>gets</code> - The objects that specify what data to fetch and from which rows.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that wrapper the result list.</dd> +</dl> +</li> +</ul> +<a name="put-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.406">put</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a>> puts)</pre> +<div class="block">Puts some data in the table, in batch.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>puts</code> - The list of mutations to apply.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>s that represent the result for each put.</dd> +</dl> +</li> +</ul> +<a name="putAll-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAll</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.413">putAll</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a>> puts)</pre> +<div class="block">A simple version of batch put. It will fail if there are any failures.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>puts</code> - The list of mutations to apply.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that always returns null when complete normally.</dd> +</dl> +</li> +</ul> +<a name="delete-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.422">delete</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a>> deletes)</pre> +<div class="block">Deletes the specified cells/rows in bulk.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deletes</code> - list of things to delete.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>s that represent the result for each delete.</dd> +</dl> +</li> +</ul> +<a name="deleteAll-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.429">deleteAll</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a>> deletes)</pre> +<div class="block">A simple version of batch delete. It will fail if there are any failures.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deletes</code> - list of things to delete.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that always returns null when complete normally.</dd> +</dl> +</li> +</ul> +<a name="batch-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>batch</h4> +<pre><T> <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><T>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.441">batch</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/hadoop/hbase/client/Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions)</pre> +<div class="block">Method that does a batch call on Deletes, Gets, Puts, Increments and Appends. The ordering of + execution of the actions is not defined. Meaning if you do a Put and a Get in the same + <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#batch-java.util.List-"><code>batch(java.util.List<? extends org.apache.hadoop.hbase.client.Row>)</code></a> call, you will not necessarily be guaranteed that the Get returns what the Put + had put.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>actions</code> - list of Get, Put, Delete, Increment, Append objects</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>s that represent the result for each action.</dd> +</dl> +</li> +</ul> +<a name="batchAll-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>batchAll</h4> +<pre>default <T> <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.449">batchAll</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><? extends <a href="../../../../../org/apache/hadoop/hbase/client/Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions)</pre> +<div class="block">A simple version of batch. It will fail if there are any failures and you will get the whole + result list at once if the operation is succeeded.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>actions</code> - list of Get, Put, Delete, Increment, Append objects</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of the result for the actions. Wrapped by a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +</dl> +</li> +</ul> +<a name="coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.ServiceCaller-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>coprocessorService</h4> +<pre><S,R> <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><R> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.474">coprocessorService</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true"; title="class or interface in java.util.function">Function</a><com.google.protobuf.RpcChannel,S> stubMaker, + <a href="../../../../../org/apache/hadoop/hbase/client/ServiceCaller.html" title="interface in org.apache.hadoop.hbase.client">ServiceCaller</a><S,R> callable, + byte[] row)</pre> +<div class="block">Execute the given coprocessor call on the region which contains the given <code>row</code>. + <p> + The <code>stubMaker</code> is just a delegation to the <code>newStub</code> call. Usually it is only a + one line lambda expression, like: + + <pre> + <code> + channel -> xxxService.newStub(channel) + </code> + </pre></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>S</code> - the type of the asynchronous stub</dd> +<dd><code>R</code> - the type of the return value</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stubMaker</code> - a delegation to the actual <code>newStub</code> call.</dd> +<dd><code>callable</code> - a delegation to the actual protobuf rpc call. See the comment of + <a href="../../../../../org/apache/hadoop/hbase/client/ServiceCaller.html" title="interface in org.apache.hadoop.hbase.client"><code>ServiceCaller</code></a> for more details.</dd> +<dd><code>row</code> - The row key used to identify the remote region location</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the return value of the protobuf rpc call, wrapped by a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/client/ServiceCaller.html" title="interface in org.apache.hadoop.hbase.client"><code>ServiceCaller</code></a></dd> +</dl> +</li> +</ul> +<a name="coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.ServiceCaller-org.apache.hadoop.hbase.client.AsyncTable.CoprocessorCallback-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>scan</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.70">scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, - <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumer</a> consumer)</pre> -<div class="block">The scan API uses the observer pattern. All results that match the given scan object will be - passed to the given <code>consumer</code> by calling <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result-"><code>ScanResultConsumer.onNext(Result)</code></a>. - <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html#onComplete--"><code>ScanResultConsumer.onComplete()</code></a> means the scan is finished, and - <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultC
<TRUNCATED>
