blob: 79ddb2ced564589d5e89cefc4247987b4d98284f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.client, interface: AsyncTable, interface: CheckAndMutateBuilder">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static java.util.stream.Collectors.toList;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.client.ConnectionUtils.toCheckExistenceOnly;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.apache.hadoop.hbase.util.FutureUtils.allOf;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">import java.util.List;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.Map;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.function.Function;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.commons.lang3.NotImplementedException;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.CompareOperator;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.filter.Filter;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.io.TimeRange;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">037</span><span id="line-37"></span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel;</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41">/**</span>
<span class="source-line-no">042</span><span id="line-42"> * The interface for asynchronous version of Table. Obtain an instance from a</span>
<span class="source-line-no">043</span><span id="line-43"> * {@link AsyncConnection}.</span>
<span class="source-line-no">044</span><span id="line-44"> * &lt;p&gt;</span>
<span class="source-line-no">045</span><span id="line-45"> * The implementation is required to be thread safe.</span>
<span class="source-line-no">046</span><span id="line-46"> * &lt;p&gt;</span>
<span class="source-line-no">047</span><span id="line-47"> * Usually the implementation will not throw any exception directly. You need to get the exception</span>
<span class="source-line-no">048</span><span id="line-48"> * from the returned {@link CompletableFuture}.</span>
<span class="source-line-no">049</span><span id="line-49"> * @since 2.0.0</span>
<span class="source-line-no">050</span><span id="line-50"> */</span>
<span class="source-line-no">051</span><span id="line-51">@InterfaceAudience.Public</span>
<span class="source-line-no">052</span><span id="line-52">public interface AsyncTable&lt;C extends ScanResultConsumerBase&gt; {</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> /**</span>
<span class="source-line-no">055</span><span id="line-55"> * Gets the fully qualified table name instance of this table.</span>
<span class="source-line-no">056</span><span id="line-56"> */</span>
<span class="source-line-no">057</span><span id="line-57"> TableName getName();</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> /**</span>
<span class="source-line-no">060</span><span id="line-60"> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.</span>
<span class="source-line-no">061</span><span id="line-61"> * &lt;p&gt;</span>
<span class="source-line-no">062</span><span id="line-62"> * The reference returned is not a copy, so any change made to it will affect this instance.</span>
<span class="source-line-no">063</span><span id="line-63"> */</span>
<span class="source-line-no">064</span><span id="line-64"> Configuration getConfiguration();</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> /**</span>
<span class="source-line-no">067</span><span id="line-67"> * Gets the {@link TableDescriptor} for this table.</span>
<span class="source-line-no">068</span><span id="line-68"> */</span>
<span class="source-line-no">069</span><span id="line-69"> CompletableFuture&lt;TableDescriptor&gt; getDescriptor();</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> /**</span>
<span class="source-line-no">072</span><span id="line-72"> * Gets the {@link AsyncTableRegionLocator} for this table.</span>
<span class="source-line-no">073</span><span id="line-73"> */</span>
<span class="source-line-no">074</span><span id="line-74"> AsyncTableRegionLocator getRegionLocator();</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> /**</span>
<span class="source-line-no">077</span><span id="line-77"> * Get timeout of each rpc request in this Table instance. It will be overridden by a more</span>
<span class="source-line-no">078</span><span id="line-78"> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.</span>
<span class="source-line-no">079</span><span id="line-79"> * @see #getReadRpcTimeout(TimeUnit)</span>
<span class="source-line-no">080</span><span id="line-80"> * @see #getWriteRpcTimeout(TimeUnit)</span>
<span class="source-line-no">081</span><span id="line-81"> * @param unit the unit of time the timeout to be represented in</span>
<span class="source-line-no">082</span><span id="line-82"> * @return rpc timeout in the specified time unit</span>
<span class="source-line-no">083</span><span id="line-83"> */</span>
<span class="source-line-no">084</span><span id="line-84"> long getRpcTimeout(TimeUnit unit);</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> /**</span>
<span class="source-line-no">087</span><span id="line-87"> * Get timeout of each rpc read request in this Table instance.</span>
<span class="source-line-no">088</span><span id="line-88"> * @param unit the unit of time the timeout to be represented in</span>
<span class="source-line-no">089</span><span id="line-89"> * @return read rpc timeout in the specified time unit</span>
<span class="source-line-no">090</span><span id="line-90"> */</span>
<span class="source-line-no">091</span><span id="line-91"> long getReadRpcTimeout(TimeUnit unit);</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> /**</span>
<span class="source-line-no">094</span><span id="line-94"> * Get timeout of each rpc write request in this Table instance.</span>
<span class="source-line-no">095</span><span id="line-95"> * @param unit the unit of time the timeout to be represented in</span>
<span class="source-line-no">096</span><span id="line-96"> * @return write rpc timeout in the specified time unit</span>
<span class="source-line-no">097</span><span id="line-97"> */</span>
<span class="source-line-no">098</span><span id="line-98"> long getWriteRpcTimeout(TimeUnit unit);</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> /**</span>
<span class="source-line-no">101</span><span id="line-101"> * Get timeout of each operation in Table instance.</span>
<span class="source-line-no">102</span><span id="line-102"> * @param unit the unit of time the timeout to be represented in</span>
<span class="source-line-no">103</span><span id="line-103"> * @return operation rpc timeout in the specified time unit</span>
<span class="source-line-no">104</span><span id="line-104"> */</span>
<span class="source-line-no">105</span><span id="line-105"> long getOperationTimeout(TimeUnit unit);</span>
<span class="source-line-no">106</span><span id="line-106"></span>
<span class="source-line-no">107</span><span id="line-107"> /**</span>
<span class="source-line-no">108</span><span id="line-108"> * Get the timeout of a single operation in a scan. It works like operation timeout for other</span>
<span class="source-line-no">109</span><span id="line-109"> * operations.</span>
<span class="source-line-no">110</span><span id="line-110"> * @param unit the unit of time the timeout to be represented in</span>
<span class="source-line-no">111</span><span id="line-111"> * @return scan rpc timeout in the specified time unit</span>
<span class="source-line-no">112</span><span id="line-112"> */</span>
<span class="source-line-no">113</span><span id="line-113"> long getScanTimeout(TimeUnit unit);</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> /**</span>
<span class="source-line-no">116</span><span id="line-116"> * Get the map of request attributes</span>
<span class="source-line-no">117</span><span id="line-117"> * @return a map of request attributes supplied by the client</span>
<span class="source-line-no">118</span><span id="line-118"> */</span>
<span class="source-line-no">119</span><span id="line-119"> default Map&lt;String, byte[]&gt; getRequestAttributes() {</span>
<span class="source-line-no">120</span><span id="line-120"> throw new NotImplementedException("Add an implementation!");</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"></span>
<span class="source-line-no">123</span><span id="line-123"> /**</span>
<span class="source-line-no">124</span><span id="line-124"> * Test for the existence of columns in the table, as specified by the Get.</span>
<span class="source-line-no">125</span><span id="line-125"> * &lt;p&gt;</span>
<span class="source-line-no">126</span><span id="line-126"> * This will return true if the Get matches one or more keys, false if not.</span>
<span class="source-line-no">127</span><span id="line-127"> * &lt;p&gt;</span>
<span class="source-line-no">128</span><span id="line-128"> * This is a server-side call so it prevents any data from being transfered to the client.</span>
<span class="source-line-no">129</span><span id="line-129"> * @return true if the specified Get matches one or more keys, false if not. The return value will</span>
<span class="source-line-no">130</span><span id="line-130"> * be wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">131</span><span id="line-131"> */</span>
<span class="source-line-no">132</span><span id="line-132"> default CompletableFuture&lt;Boolean&gt; exists(Get get) {</span>
<span class="source-line-no">133</span><span id="line-133"> return get(toCheckExistenceOnly(get)).thenApply(r -&gt; r.getExists());</span>
<span class="source-line-no">134</span><span id="line-134"> }</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> /**</span>
<span class="source-line-no">137</span><span id="line-137"> * Extracts certain cells from a given row.</span>
<span class="source-line-no">138</span><span id="line-138"> * @param get The object that specifies what data to fetch and from which row.</span>
<span class="source-line-no">139</span><span id="line-139"> * @return The data coming from the specified row, if it exists. If the row specified doesn't</span>
<span class="source-line-no">140</span><span id="line-140"> * exist, the {@link Result} instance returned won't contain any</span>
<span class="source-line-no">141</span><span id="line-141"> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}. The</span>
<span class="source-line-no">142</span><span id="line-142"> * return value will be wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">143</span><span id="line-143"> */</span>
<span class="source-line-no">144</span><span id="line-144"> CompletableFuture&lt;Result&gt; get(Get get);</span>
<span class="source-line-no">145</span><span id="line-145"></span>
<span class="source-line-no">146</span><span id="line-146"> /**</span>
<span class="source-line-no">147</span><span id="line-147"> * Puts some data to the table.</span>
<span class="source-line-no">148</span><span id="line-148"> * @param put The data to put.</span>
<span class="source-line-no">149</span><span id="line-149"> * @return A {@link CompletableFuture} that always returns null when complete normally.</span>
<span class="source-line-no">150</span><span id="line-150"> */</span>
<span class="source-line-no">151</span><span id="line-151"> CompletableFuture&lt;Void&gt; put(Put put);</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> /**</span>
<span class="source-line-no">154</span><span id="line-154"> * Deletes the specified cells/row.</span>
<span class="source-line-no">155</span><span id="line-155"> * @param delete The object that specifies what to delete.</span>
<span class="source-line-no">156</span><span id="line-156"> * @return A {@link CompletableFuture} that always returns null when complete normally.</span>
<span class="source-line-no">157</span><span id="line-157"> */</span>
<span class="source-line-no">158</span><span id="line-158"> CompletableFuture&lt;Void&gt; delete(Delete delete);</span>
<span class="source-line-no">159</span><span id="line-159"></span>
<span class="source-line-no">160</span><span id="line-160"> /**</span>
<span class="source-line-no">161</span><span id="line-161"> * Appends values to one or more columns within a single row.</span>
<span class="source-line-no">162</span><span id="line-162"> * &lt;p&gt;</span>
<span class="source-line-no">163</span><span id="line-163"> * This operation does not appear atomic to readers. Appends are done under a single row lock, so</span>
<span class="source-line-no">164</span><span id="line-164"> * write operations to a row are synchronized, but readers do not take row locks so get and scan</span>
<span class="source-line-no">165</span><span id="line-165"> * operations can see this operation partially completed.</span>
<span class="source-line-no">166</span><span id="line-166"> * @param append object that specifies the columns and amounts to be used for the increment</span>
<span class="source-line-no">167</span><span id="line-167"> * operations</span>
<span class="source-line-no">168</span><span id="line-168"> * @return values of columns after the append operation (maybe null). The return value will be</span>
<span class="source-line-no">169</span><span id="line-169"> * wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">170</span><span id="line-170"> */</span>
<span class="source-line-no">171</span><span id="line-171"> CompletableFuture&lt;Result&gt; append(Append append);</span>
<span class="source-line-no">172</span><span id="line-172"></span>
<span class="source-line-no">173</span><span id="line-173"> /**</span>
<span class="source-line-no">174</span><span id="line-174"> * Increments one or more columns within a single row.</span>
<span class="source-line-no">175</span><span id="line-175"> * &lt;p&gt;</span>
<span class="source-line-no">176</span><span id="line-176"> * This operation does not appear atomic to readers. Increments are done under a single row lock,</span>
<span class="source-line-no">177</span><span id="line-177"> * so write operations to a row are synchronized, but readers do not take row locks so get and</span>
<span class="source-line-no">178</span><span id="line-178"> * scan operations can see this operation partially completed.</span>
<span class="source-line-no">179</span><span id="line-179"> * @param increment object that specifies the columns and amounts to be used for the increment</span>
<span class="source-line-no">180</span><span id="line-180"> * operations</span>
<span class="source-line-no">181</span><span id="line-181"> * @return values of columns after the increment. The return value will be wrapped by a</span>
<span class="source-line-no">182</span><span id="line-182"> * {@link CompletableFuture}.</span>
<span class="source-line-no">183</span><span id="line-183"> */</span>
<span class="source-line-no">184</span><span id="line-184"> CompletableFuture&lt;Result&gt; increment(Increment increment);</span>
<span class="source-line-no">185</span><span id="line-185"></span>
<span class="source-line-no">186</span><span id="line-186"> /**</span>
<span class="source-line-no">187</span><span id="line-187"> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}</span>
<span class="source-line-no">188</span><span id="line-188"> * &lt;p&gt;</span>
<span class="source-line-no">189</span><span id="line-189"> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.</span>
<span class="source-line-no">190</span><span id="line-190"> * @param row The row that contains the cell to increment.</span>
<span class="source-line-no">191</span><span id="line-191"> * @param family The column family of the cell to increment.</span>
<span class="source-line-no">192</span><span id="line-192"> * @param qualifier The column qualifier of the cell to increment.</span>
<span class="source-line-no">193</span><span id="line-193"> * @param amount The amount to increment the cell with (or decrement, if the amount is</span>
<span class="source-line-no">194</span><span id="line-194"> * negative).</span>
<span class="source-line-no">195</span><span id="line-195"> * @return The new value, post increment. The return value will be wrapped by a</span>
<span class="source-line-no">196</span><span id="line-196"> * {@link CompletableFuture}.</span>
<span class="source-line-no">197</span><span id="line-197"> */</span>
<span class="source-line-no">198</span><span id="line-198"> default CompletableFuture&lt;Long&gt; incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,</span>
<span class="source-line-no">199</span><span id="line-199"> long amount) {</span>
<span class="source-line-no">200</span><span id="line-200"> return incrementColumnValue(row, family, qualifier, amount, Durability.SYNC_WAL);</span>
<span class="source-line-no">201</span><span id="line-201"> }</span>
<span class="source-line-no">202</span><span id="line-202"></span>
<span class="source-line-no">203</span><span id="line-203"> /**</span>
<span class="source-line-no">204</span><span id="line-204"> * Atomically increments a column value. If the column value already exists and is not a</span>
<span class="source-line-no">205</span><span id="line-205"> * big-endian long, this could throw an exception. If the column value does not yet exist it is</span>
<span class="source-line-no">206</span><span id="line-206"> * initialized to &lt;code&gt;amount&lt;/code&gt; and written to the specified column.</span>
<span class="source-line-no">207</span><span id="line-207"> * &lt;p&gt;</span>
<span class="source-line-no">208</span><span id="line-208"> * Setting durability to {@link Durability#SKIP_WAL} means that in a fail scenario you will lose</span>
<span class="source-line-no">209</span><span id="line-209"> * any increments that have not been flushed.</span>
<span class="source-line-no">210</span><span id="line-210"> * @param row The row that contains the cell to increment.</span>
<span class="source-line-no">211</span><span id="line-211"> * @param family The column family of the cell to increment.</span>
<span class="source-line-no">212</span><span id="line-212"> * @param qualifier The column qualifier of the cell to increment.</span>
<span class="source-line-no">213</span><span id="line-213"> * @param amount The amount to increment the cell with (or decrement, if the amount is</span>
<span class="source-line-no">214</span><span id="line-214"> * negative).</span>
<span class="source-line-no">215</span><span id="line-215"> * @param durability The persistence guarantee for this increment.</span>
<span class="source-line-no">216</span><span id="line-216"> * @return The new value, post increment. The return value will be wrapped by a</span>
<span class="source-line-no">217</span><span id="line-217"> * {@link CompletableFuture}.</span>
<span class="source-line-no">218</span><span id="line-218"> */</span>
<span class="source-line-no">219</span><span id="line-219"> default CompletableFuture&lt;Long&gt; incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,</span>
<span class="source-line-no">220</span><span id="line-220"> long amount, Durability durability) {</span>
<span class="source-line-no">221</span><span id="line-221"> Preconditions.checkNotNull(row, "row is null");</span>
<span class="source-line-no">222</span><span id="line-222"> Preconditions.checkNotNull(family, "family is null");</span>
<span class="source-line-no">223</span><span id="line-223"> return increment(</span>
<span class="source-line-no">224</span><span id="line-224"> new Increment(row).addColumn(family, qualifier, amount).setDurability(durability))</span>
<span class="source-line-no">225</span><span id="line-225"> .thenApply(r -&gt; Bytes.toLong(r.getValue(family, qualifier)));</span>
<span class="source-line-no">226</span><span id="line-226"> }</span>
<span class="source-line-no">227</span><span id="line-227"></span>
<span class="source-line-no">228</span><span id="line-228"> /**</span>
<span class="source-line-no">229</span><span id="line-229"> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it</span>
<span class="source-line-no">230</span><span id="line-230"> * adds the Put/Delete/RowMutations.</span>
<span class="source-line-no">231</span><span id="line-231"> * &lt;p&gt;</span>
<span class="source-line-no">232</span><span id="line-232"> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.</span>
<span class="source-line-no">233</span><span id="line-233"> * This is a fluent style API, the code is like:</span>
<span class="source-line-no">234</span><span id="line-234"> *</span>
<span class="source-line-no">235</span><span id="line-235"> * &lt;pre&gt;</span>
<span class="source-line-no">236</span><span id="line-236"> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put)</span>
<span class="source-line-no">237</span><span id="line-237"> * .thenAccept(succ -&amp;gt; {</span>
<span class="source-line-no">238</span><span id="line-238"> * if (succ) {</span>
<span class="source-line-no">239</span><span id="line-239"> * System.out.println("Check and put succeeded");</span>
<span class="source-line-no">240</span><span id="line-240"> * } else {</span>
<span class="source-line-no">241</span><span id="line-241"> * System.out.println("Check and put failed");</span>
<span class="source-line-no">242</span><span id="line-242"> * }</span>
<span class="source-line-no">243</span><span id="line-243"> * });</span>
<span class="source-line-no">244</span><span id="line-244"> * &lt;/pre&gt;</span>
<span class="source-line-no">245</span><span id="line-245"> *</span>
<span class="source-line-no">246</span><span id="line-246"> * @deprecated Since 3.0.0, will be removed in 4.0.0. For internal test use only, do not use it</span>
<span class="source-line-no">247</span><span id="line-247"> * any more.</span>
<span class="source-line-no">248</span><span id="line-248"> */</span>
<span class="source-line-no">249</span><span id="line-249"> @Deprecated</span>
<span class="source-line-no">250</span><span id="line-250"> CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family);</span>
<span class="source-line-no">251</span><span id="line-251"></span>
<span class="source-line-no">252</span><span id="line-252"> /**</span>
<span class="source-line-no">253</span><span id="line-253"> * A helper class for sending checkAndMutate request.</span>
<span class="source-line-no">254</span><span id="line-254"> * @deprecated Since 3.0.0, will be removed in 4.0.0. For internal test use only, do not use it</span>
<span class="source-line-no">255</span><span id="line-255"> * any more.</span>
<span class="source-line-no">256</span><span id="line-256"> */</span>
<span class="source-line-no">257</span><span id="line-257"> @Deprecated</span>
<span class="source-line-no">258</span><span id="line-258"> interface CheckAndMutateBuilder {</span>
<span class="source-line-no">259</span><span id="line-259"></span>
<span class="source-line-no">260</span><span id="line-260"> /**</span>
<span class="source-line-no">261</span><span id="line-261"> * Match a qualifier.</span>
<span class="source-line-no">262</span><span id="line-262"> * @param qualifier column qualifier to check.</span>
<span class="source-line-no">263</span><span id="line-263"> */</span>
<span class="source-line-no">264</span><span id="line-264"> CheckAndMutateBuilder qualifier(byte[] qualifier);</span>
<span class="source-line-no">265</span><span id="line-265"></span>
<span class="source-line-no">266</span><span id="line-266"> /**</span>
<span class="source-line-no">267</span><span id="line-267"> * Match a timerange.</span>
<span class="source-line-no">268</span><span id="line-268"> * @param timeRange time range to check.</span>
<span class="source-line-no">269</span><span id="line-269"> */</span>
<span class="source-line-no">270</span><span id="line-270"> CheckAndMutateBuilder timeRange(TimeRange timeRange);</span>
<span class="source-line-no">271</span><span id="line-271"></span>
<span class="source-line-no">272</span><span id="line-272"> /**</span>
<span class="source-line-no">273</span><span id="line-273"> * Check for lack of column.</span>
<span class="source-line-no">274</span><span id="line-274"> */</span>
<span class="source-line-no">275</span><span id="line-275"> CheckAndMutateBuilder ifNotExists();</span>
<span class="source-line-no">276</span><span id="line-276"></span>
<span class="source-line-no">277</span><span id="line-277"> /**</span>
<span class="source-line-no">278</span><span id="line-278"> * Check for equality.</span>
<span class="source-line-no">279</span><span id="line-279"> * @param value the expected value</span>
<span class="source-line-no">280</span><span id="line-280"> */</span>
<span class="source-line-no">281</span><span id="line-281"> default CheckAndMutateBuilder ifEquals(byte[] value) {</span>
<span class="source-line-no">282</span><span id="line-282"> return ifMatches(CompareOperator.EQUAL, value);</span>
<span class="source-line-no">283</span><span id="line-283"> }</span>
<span class="source-line-no">284</span><span id="line-284"></span>
<span class="source-line-no">285</span><span id="line-285"> /**</span>
<span class="source-line-no">286</span><span id="line-286"> * Compare a value</span>
<span class="source-line-no">287</span><span id="line-287"> * @param compareOp comparison operator to use</span>
<span class="source-line-no">288</span><span id="line-288"> * @param value the expected value</span>
<span class="source-line-no">289</span><span id="line-289"> */</span>
<span class="source-line-no">290</span><span id="line-290"> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] value);</span>
<span class="source-line-no">291</span><span id="line-291"></span>
<span class="source-line-no">292</span><span id="line-292"> /**</span>
<span class="source-line-no">293</span><span id="line-293"> * Specify a Put to commit if the check succeeds.</span>
<span class="source-line-no">294</span><span id="line-294"> * @param put data to put if check succeeds</span>
<span class="source-line-no">295</span><span id="line-295"> * @return {@code true} if the new put was executed, {@code false} otherwise. The return value</span>
<span class="source-line-no">296</span><span id="line-296"> * will be wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">297</span><span id="line-297"> */</span>
<span class="source-line-no">298</span><span id="line-298"> CompletableFuture&lt;Boolean&gt; thenPut(Put put);</span>
<span class="source-line-no">299</span><span id="line-299"></span>
<span class="source-line-no">300</span><span id="line-300"> /**</span>
<span class="source-line-no">301</span><span id="line-301"> * Specify a Delete to commit if the check succeeds.</span>
<span class="source-line-no">302</span><span id="line-302"> * @param delete data to delete if check succeeds</span>
<span class="source-line-no">303</span><span id="line-303"> * @return {@code true} if the new delete was executed, {@code false} otherwise. The return</span>
<span class="source-line-no">304</span><span id="line-304"> * value will be wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">305</span><span id="line-305"> */</span>
<span class="source-line-no">306</span><span id="line-306"> CompletableFuture&lt;Boolean&gt; thenDelete(Delete delete);</span>
<span class="source-line-no">307</span><span id="line-307"></span>
<span class="source-line-no">308</span><span id="line-308"> /**</span>
<span class="source-line-no">309</span><span id="line-309"> * Specify a RowMutations to commit if the check succeeds.</span>
<span class="source-line-no">310</span><span id="line-310"> * @param mutation mutations to perform if check succeeds</span>
<span class="source-line-no">311</span><span id="line-311"> * @return true if the new mutation was executed, false otherwise. The return value will be</span>
<span class="source-line-no">312</span><span id="line-312"> * wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">313</span><span id="line-313"> */</span>
<span class="source-line-no">314</span><span id="line-314"> CompletableFuture&lt;Boolean&gt; thenMutate(RowMutations mutation);</span>
<span class="source-line-no">315</span><span id="line-315"> }</span>
<span class="source-line-no">316</span><span id="line-316"></span>
<span class="source-line-no">317</span><span id="line-317"> /**</span>
<span class="source-line-no">318</span><span id="line-318"> * Atomically checks if a row matches the specified filter. If it does, it adds the</span>
<span class="source-line-no">319</span><span id="line-319"> * Put/Delete/RowMutations.</span>
<span class="source-line-no">320</span><span id="line-320"> * &lt;p&gt;</span>
<span class="source-line-no">321</span><span id="line-321"> * Use the returned {@link CheckAndMutateWithFilterBuilder} to construct your request and then</span>
<span class="source-line-no">322</span><span id="line-322"> * execute it. This is a fluent style API, the code is like:</span>
<span class="source-line-no">323</span><span id="line-323"> *</span>
<span class="source-line-no">324</span><span id="line-324"> * &lt;pre&gt;</span>
<span class="source-line-no">325</span><span id="line-325"> * table.checkAndMutate(row, filter).thenPut(put).thenAccept(succ -&amp;gt; {</span>
<span class="source-line-no">326</span><span id="line-326"> * if (succ) {</span>
<span class="source-line-no">327</span><span id="line-327"> * System.out.println("Check and put succeeded");</span>
<span class="source-line-no">328</span><span id="line-328"> * } else {</span>
<span class="source-line-no">329</span><span id="line-329"> * System.out.println("Check and put failed");</span>
<span class="source-line-no">330</span><span id="line-330"> * }</span>
<span class="source-line-no">331</span><span id="line-331"> * });</span>
<span class="source-line-no">332</span><span id="line-332"> * &lt;/pre&gt;</span>
<span class="source-line-no">333</span><span id="line-333"> *</span>
<span class="source-line-no">334</span><span id="line-334"> * @deprecated Since 3.0.0, will be removed in 4.0.0. For internal test use only, do not use it</span>
<span class="source-line-no">335</span><span id="line-335"> * any more.</span>
<span class="source-line-no">336</span><span id="line-336"> */</span>
<span class="source-line-no">337</span><span id="line-337"> @Deprecated</span>
<span class="source-line-no">338</span><span id="line-338"> CheckAndMutateWithFilterBuilder checkAndMutate(byte[] row, Filter filter);</span>
<span class="source-line-no">339</span><span id="line-339"></span>
<span class="source-line-no">340</span><span id="line-340"> /**</span>
<span class="source-line-no">341</span><span id="line-341"> * A helper class for sending checkAndMutate request with a filter.</span>
<span class="source-line-no">342</span><span id="line-342"> * @deprecated Since 3.0.0, will be removed in 4.0.0. For internal test use only, do not use it</span>
<span class="source-line-no">343</span><span id="line-343"> * any more.</span>
<span class="source-line-no">344</span><span id="line-344"> */</span>
<span class="source-line-no">345</span><span id="line-345"> @Deprecated</span>
<span class="source-line-no">346</span><span id="line-346"> interface CheckAndMutateWithFilterBuilder {</span>
<span class="source-line-no">347</span><span id="line-347"></span>
<span class="source-line-no">348</span><span id="line-348"> /**</span>
<span class="source-line-no">349</span><span id="line-349"> * Match a timerange.</span>
<span class="source-line-no">350</span><span id="line-350"> * @param timeRange time range to check.</span>
<span class="source-line-no">351</span><span id="line-351"> */</span>
<span class="source-line-no">352</span><span id="line-352"> CheckAndMutateWithFilterBuilder timeRange(TimeRange timeRange);</span>
<span class="source-line-no">353</span><span id="line-353"></span>
<span class="source-line-no">354</span><span id="line-354"> /**</span>
<span class="source-line-no">355</span><span id="line-355"> * Specify a Put to commit if the check succeeds.</span>
<span class="source-line-no">356</span><span id="line-356"> * @param put data to put if check succeeds</span>
<span class="source-line-no">357</span><span id="line-357"> * @return {@code true} if the new put was executed, {@code false} otherwise. The return value</span>
<span class="source-line-no">358</span><span id="line-358"> * will be wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">359</span><span id="line-359"> */</span>
<span class="source-line-no">360</span><span id="line-360"> CompletableFuture&lt;Boolean&gt; thenPut(Put put);</span>
<span class="source-line-no">361</span><span id="line-361"></span>
<span class="source-line-no">362</span><span id="line-362"> /**</span>
<span class="source-line-no">363</span><span id="line-363"> * Specify a Delete to commit if the check succeeds.</span>
<span class="source-line-no">364</span><span id="line-364"> * @param delete data to delete if check succeeds</span>
<span class="source-line-no">365</span><span id="line-365"> * @return {@code true} if the new delete was executed, {@code false} otherwise. The return</span>
<span class="source-line-no">366</span><span id="line-366"> * value will be wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">367</span><span id="line-367"> */</span>
<span class="source-line-no">368</span><span id="line-368"> CompletableFuture&lt;Boolean&gt; thenDelete(Delete delete);</span>
<span class="source-line-no">369</span><span id="line-369"></span>
<span class="source-line-no">370</span><span id="line-370"> /**</span>
<span class="source-line-no">371</span><span id="line-371"> * Specify a RowMutations to commit if the check succeeds.</span>
<span class="source-line-no">372</span><span id="line-372"> * @param mutation mutations to perform if check succeeds</span>
<span class="source-line-no">373</span><span id="line-373"> * @return true if the new mutation was executed, false otherwise. The return value will be</span>
<span class="source-line-no">374</span><span id="line-374"> * wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">375</span><span id="line-375"> */</span>
<span class="source-line-no">376</span><span id="line-376"> CompletableFuture&lt;Boolean&gt; thenMutate(RowMutations mutation);</span>
<span class="source-line-no">377</span><span id="line-377"> }</span>
<span class="source-line-no">378</span><span id="line-378"></span>
<span class="source-line-no">379</span><span id="line-379"> /**</span>
<span class="source-line-no">380</span><span id="line-380"> * checkAndMutate that atomically checks if a row matches the specified condition. If it does, it</span>
<span class="source-line-no">381</span><span id="line-381"> * performs the specified action.</span>
<span class="source-line-no">382</span><span id="line-382"> * @param checkAndMutate The CheckAndMutate object.</span>
<span class="source-line-no">383</span><span id="line-383"> * @return A {@link CompletableFuture}s that represent the result for the CheckAndMutate.</span>
<span class="source-line-no">384</span><span id="line-384"> */</span>
<span class="source-line-no">385</span><span id="line-385"> CompletableFuture&lt;CheckAndMutateResult&gt; checkAndMutate(CheckAndMutate checkAndMutate);</span>
<span class="source-line-no">386</span><span id="line-386"></span>
<span class="source-line-no">387</span><span id="line-387"> /**</span>
<span class="source-line-no">388</span><span id="line-388"> * Batch version of checkAndMutate. The specified CheckAndMutates are batched only in the sense</span>
<span class="source-line-no">389</span><span id="line-389"> * that they are sent to a RS in one RPC, but each CheckAndMutate operation is still executed</span>
<span class="source-line-no">390</span><span id="line-390"> * atomically (and thus, each may fail independently of others).</span>
<span class="source-line-no">391</span><span id="line-391"> * @param checkAndMutates The list of CheckAndMutate.</span>
<span class="source-line-no">392</span><span id="line-392"> * @return A list of {@link CompletableFuture}s that represent the result for each CheckAndMutate.</span>
<span class="source-line-no">393</span><span id="line-393"> */</span>
<span class="source-line-no">394</span><span id="line-394"> List&lt;CompletableFuture&lt;CheckAndMutateResult&gt;&gt;</span>
<span class="source-line-no">395</span><span id="line-395"> checkAndMutate(List&lt;CheckAndMutate&gt; checkAndMutates);</span>
<span class="source-line-no">396</span><span id="line-396"></span>
<span class="source-line-no">397</span><span id="line-397"> /**</span>
<span class="source-line-no">398</span><span id="line-398"> * A simple version of batch checkAndMutate. It will fail if there are any failures.</span>
<span class="source-line-no">399</span><span id="line-399"> * @param checkAndMutates The list of rows to apply.</span>
<span class="source-line-no">400</span><span id="line-400"> * @return A {@link CompletableFuture} that wrapper the result list.</span>
<span class="source-line-no">401</span><span id="line-401"> */</span>
<span class="source-line-no">402</span><span id="line-402"> default CompletableFuture&lt;List&lt;CheckAndMutateResult&gt;&gt;</span>
<span class="source-line-no">403</span><span id="line-403"> checkAndMutateAll(List&lt;CheckAndMutate&gt; checkAndMutates) {</span>
<span class="source-line-no">404</span><span id="line-404"> return allOf(checkAndMutate(checkAndMutates));</span>
<span class="source-line-no">405</span><span id="line-405"> }</span>
<span class="source-line-no">406</span><span id="line-406"></span>
<span class="source-line-no">407</span><span id="line-407"> /**</span>
<span class="source-line-no">408</span><span id="line-408"> * Performs multiple mutations atomically on a single row. Currently {@link Put} and</span>
<span class="source-line-no">409</span><span id="line-409"> * {@link Delete} are supported.</span>
<span class="source-line-no">410</span><span id="line-410"> * @param mutation object that specifies the set of mutations to perform atomically</span>
<span class="source-line-no">411</span><span id="line-411"> * @return A {@link CompletableFuture} that returns results of Increment/Append operations</span>
<span class="source-line-no">412</span><span id="line-412"> */</span>
<span class="source-line-no">413</span><span id="line-413"> CompletableFuture&lt;Result&gt; mutateRow(RowMutations mutation);</span>
<span class="source-line-no">414</span><span id="line-414"></span>
<span class="source-line-no">415</span><span id="line-415"> /**</span>
<span class="source-line-no">416</span><span id="line-416"> * The scan API uses the observer pattern.</span>
<span class="source-line-no">417</span><span id="line-417"> * @param scan A configured {@link Scan} object.</span>
<span class="source-line-no">418</span><span id="line-418"> * @param consumer the consumer used to receive results.</span>
<span class="source-line-no">419</span><span id="line-419"> * @see ScanResultConsumer</span>
<span class="source-line-no">420</span><span id="line-420"> * @see AdvancedScanResultConsumer</span>
<span class="source-line-no">421</span><span id="line-421"> */</span>
<span class="source-line-no">422</span><span id="line-422"> void scan(Scan scan, C consumer);</span>
<span class="source-line-no">423</span><span id="line-423"></span>
<span class="source-line-no">424</span><span id="line-424"> /**</span>
<span class="source-line-no">425</span><span id="line-425"> * Gets a scanner on the current table for the given family.</span>
<span class="source-line-no">426</span><span id="line-426"> * @param family The column family to scan.</span>
<span class="source-line-no">427</span><span id="line-427"> * @return A scanner.</span>
<span class="source-line-no">428</span><span id="line-428"> */</span>
<span class="source-line-no">429</span><span id="line-429"> default ResultScanner getScanner(byte[] family) {</span>
<span class="source-line-no">430</span><span id="line-430"> return getScanner(new Scan().addFamily(family));</span>
<span class="source-line-no">431</span><span id="line-431"> }</span>
<span class="source-line-no">432</span><span id="line-432"></span>
<span class="source-line-no">433</span><span id="line-433"> /**</span>
<span class="source-line-no">434</span><span id="line-434"> * Gets a scanner on the current table for the given family and qualifier.</span>
<span class="source-line-no">435</span><span id="line-435"> * @param family The column family to scan.</span>
<span class="source-line-no">436</span><span id="line-436"> * @param qualifier The column qualifier to scan.</span>
<span class="source-line-no">437</span><span id="line-437"> * @return A scanner.</span>
<span class="source-line-no">438</span><span id="line-438"> */</span>
<span class="source-line-no">439</span><span id="line-439"> default ResultScanner getScanner(byte[] family, byte[] qualifier) {</span>
<span class="source-line-no">440</span><span id="line-440"> return getScanner(new Scan().addColumn(family, qualifier));</span>
<span class="source-line-no">441</span><span id="line-441"> }</span>
<span class="source-line-no">442</span><span id="line-442"></span>
<span class="source-line-no">443</span><span id="line-443"> /**</span>
<span class="source-line-no">444</span><span id="line-444"> * Returns a scanner on the current table as specified by the {@link Scan} object.</span>
<span class="source-line-no">445</span><span id="line-445"> * @param scan A configured {@link Scan} object.</span>
<span class="source-line-no">446</span><span id="line-446"> * @return A scanner.</span>
<span class="source-line-no">447</span><span id="line-447"> */</span>
<span class="source-line-no">448</span><span id="line-448"> ResultScanner getScanner(Scan scan);</span>
<span class="source-line-no">449</span><span id="line-449"></span>
<span class="source-line-no">450</span><span id="line-450"> /**</span>
<span class="source-line-no">451</span><span id="line-451"> * Return all the results that match the given scan object.</span>
<span class="source-line-no">452</span><span id="line-452"> * &lt;p&gt;</span>
<span class="source-line-no">453</span><span id="line-453"> * Notice that usually you should use this method with a {@link Scan} object that has limit set.</span>
<span class="source-line-no">454</span><span id="line-454"> * For example, if you want to get the closest row after a given row, you could do this:</span>
<span class="source-line-no">455</span><span id="line-455"> * &lt;p&gt;</span>
<span class="source-line-no">456</span><span id="line-456"> *</span>
<span class="source-line-no">457</span><span id="line-457"> * &lt;pre&gt;</span>
<span class="source-line-no">458</span><span id="line-458"> * table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -&amp;gt; {</span>
<span class="source-line-no">459</span><span id="line-459"> * if (results.isEmpty()) {</span>
<span class="source-line-no">460</span><span id="line-460"> * System.out.println("No row after " + Bytes.toStringBinary(row));</span>
<span class="source-line-no">461</span><span id="line-461"> * } else {</span>
<span class="source-line-no">462</span><span id="line-462"> * System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is "</span>
<span class="source-line-no">463</span><span id="line-463"> * + Bytes.toStringBinary(results.stream().findFirst().get().getRow()));</span>
<span class="source-line-no">464</span><span id="line-464"> * }</span>
<span class="source-line-no">465</span><span id="line-465"> * });</span>
<span class="source-line-no">466</span><span id="line-466"> * &lt;/pre&gt;</span>
<span class="source-line-no">467</span><span id="line-467"> * &lt;p&gt;</span>
<span class="source-line-no">468</span><span id="line-468"> * If your result set is very large, you should use other scan method to get a scanner or use</span>
<span class="source-line-no">469</span><span id="line-469"> * callback to process the results. They will do chunking to prevent OOM. The scanAll method will</span>
<span class="source-line-no">470</span><span id="line-470"> * fetch all the results and store them in a List and then return the list to you.</span>
<span class="source-line-no">471</span><span id="line-471"> * &lt;p&gt;</span>
<span class="source-line-no">472</span><span id="line-472"> * The scan metrics will be collected background if you enable it but you have no way to get it.</span>
<span class="source-line-no">473</span><span id="line-473"> * Usually you can get scan metrics from {@code ResultScanner}, or through</span>
<span class="source-line-no">474</span><span id="line-474"> * {@code ScanResultConsumer.onScanMetricsCreated} but this method only returns a list of results.</span>
<span class="source-line-no">475</span><span id="line-475"> * So if you really care about scan metrics then you'd better use other scan methods which return</span>
<span class="source-line-no">476</span><span id="line-476"> * a {@code ResultScanner} or let you pass in a {@code ScanResultConsumer}. There is no</span>
<span class="source-line-no">477</span><span id="line-477"> * performance difference between these scan methods so do not worry.</span>
<span class="source-line-no">478</span><span id="line-478"> * @param scan A configured {@link Scan} object. So if you use this method to fetch a really large</span>
<span class="source-line-no">479</span><span id="line-479"> * result set, it is likely to cause OOM.</span>
<span class="source-line-no">480</span><span id="line-480"> * @return The results of this small scan operation. The return value will be wrapped by a</span>
<span class="source-line-no">481</span><span id="line-481"> * {@link CompletableFuture}.</span>
<span class="source-line-no">482</span><span id="line-482"> */</span>
<span class="source-line-no">483</span><span id="line-483"> CompletableFuture&lt;List&lt;Result&gt;&gt; scanAll(Scan scan);</span>
<span class="source-line-no">484</span><span id="line-484"></span>
<span class="source-line-no">485</span><span id="line-485"> /**</span>
<span class="source-line-no">486</span><span id="line-486"> * Test for the existence of columns in the table, as specified by the Gets.</span>
<span class="source-line-no">487</span><span id="line-487"> * &lt;p&gt;</span>
<span class="source-line-no">488</span><span id="line-488"> * This will return a list of booleans. Each value will be true if the related Get matches one or</span>
<span class="source-line-no">489</span><span id="line-489"> * more keys, false if not.</span>
<span class="source-line-no">490</span><span id="line-490"> * &lt;p&gt;</span>
<span class="source-line-no">491</span><span id="line-491"> * This is a server-side call so it prevents any data from being transferred to the client.</span>
<span class="source-line-no">492</span><span id="line-492"> * @param gets the Gets</span>
<span class="source-line-no">493</span><span id="line-493"> * @return A list of {@link CompletableFuture}s that represent the existence for each get.</span>
<span class="source-line-no">494</span><span id="line-494"> */</span>
<span class="source-line-no">495</span><span id="line-495"> default List&lt;CompletableFuture&lt;Boolean&gt;&gt; exists(List&lt;Get&gt; gets) {</span>
<span class="source-line-no">496</span><span id="line-496"> return get(toCheckExistenceOnly(gets)).stream()</span>
<span class="source-line-no">497</span><span id="line-497"> .&lt;CompletableFuture&lt;Boolean&gt;&gt; map(f -&gt; f.thenApply(r -&gt; r.getExists())).collect(toList());</span>
<span class="source-line-no">498</span><span id="line-498"> }</span>
<span class="source-line-no">499</span><span id="line-499"></span>
<span class="source-line-no">500</span><span id="line-500"> /**</span>
<span class="source-line-no">501</span><span id="line-501"> * A simple version for batch exists. It will fail if there are any failures and you will get the</span>
<span class="source-line-no">502</span><span id="line-502"> * whole result boolean list at once if the operation is succeeded.</span>
<span class="source-line-no">503</span><span id="line-503"> * @param gets the Gets</span>
<span class="source-line-no">504</span><span id="line-504"> * @return A {@link CompletableFuture} that wrapper the result boolean list.</span>
<span class="source-line-no">505</span><span id="line-505"> */</span>
<span class="source-line-no">506</span><span id="line-506"> default CompletableFuture&lt;List&lt;Boolean&gt;&gt; existsAll(List&lt;Get&gt; gets) {</span>
<span class="source-line-no">507</span><span id="line-507"> return allOf(exists(gets));</span>
<span class="source-line-no">508</span><span id="line-508"> }</span>
<span class="source-line-no">509</span><span id="line-509"></span>
<span class="source-line-no">510</span><span id="line-510"> /**</span>
<span class="source-line-no">511</span><span id="line-511"> * Extracts certain cells from the given rows, in batch.</span>
<span class="source-line-no">512</span><span id="line-512"> * &lt;p&gt;</span>
<span class="source-line-no">513</span><span id="line-513"> * Notice that you may not get all the results with this function, which means some of the</span>
<span class="source-line-no">514</span><span id="line-514"> * returned {@link CompletableFuture}s may succeed while some of the other returned</span>
<span class="source-line-no">515</span><span id="line-515"> * {@link CompletableFuture}s may fail.</span>
<span class="source-line-no">516</span><span id="line-516"> * @param gets The objects that specify what data to fetch and from which rows.</span>
<span class="source-line-no">517</span><span id="line-517"> * @return A list of {@link CompletableFuture}s that represent the result for each get.</span>
<span class="source-line-no">518</span><span id="line-518"> */</span>
<span class="source-line-no">519</span><span id="line-519"> List&lt;CompletableFuture&lt;Result&gt;&gt; get(List&lt;Get&gt; gets);</span>
<span class="source-line-no">520</span><span id="line-520"></span>
<span class="source-line-no">521</span><span id="line-521"> /**</span>
<span class="source-line-no">522</span><span id="line-522"> * A simple version for batch get. It will fail if there are any failures and you will get the</span>
<span class="source-line-no">523</span><span id="line-523"> * whole result list at once if the operation is succeeded.</span>
<span class="source-line-no">524</span><span id="line-524"> * @param gets The objects that specify what data to fetch and from which rows.</span>
<span class="source-line-no">525</span><span id="line-525"> * @return A {@link CompletableFuture} that wrapper the result list.</span>
<span class="source-line-no">526</span><span id="line-526"> */</span>
<span class="source-line-no">527</span><span id="line-527"> default CompletableFuture&lt;List&lt;Result&gt;&gt; getAll(List&lt;Get&gt; gets) {</span>
<span class="source-line-no">528</span><span id="line-528"> return allOf(get(gets));</span>
<span class="source-line-no">529</span><span id="line-529"> }</span>
<span class="source-line-no">530</span><span id="line-530"></span>
<span class="source-line-no">531</span><span id="line-531"> /**</span>
<span class="source-line-no">532</span><span id="line-532"> * Puts some data in the table, in batch.</span>
<span class="source-line-no">533</span><span id="line-533"> * @param puts The list of mutations to apply.</span>
<span class="source-line-no">534</span><span id="line-534"> * @return A list of {@link CompletableFuture}s that represent the result for each put.</span>
<span class="source-line-no">535</span><span id="line-535"> */</span>
<span class="source-line-no">536</span><span id="line-536"> List&lt;CompletableFuture&lt;Void&gt;&gt; put(List&lt;Put&gt; puts);</span>
<span class="source-line-no">537</span><span id="line-537"></span>
<span class="source-line-no">538</span><span id="line-538"> /**</span>
<span class="source-line-no">539</span><span id="line-539"> * A simple version of batch put. It will fail if there are any failures.</span>
<span class="source-line-no">540</span><span id="line-540"> * @param puts The list of mutations to apply.</span>
<span class="source-line-no">541</span><span id="line-541"> * @return A {@link CompletableFuture} that always returns null when complete normally.</span>
<span class="source-line-no">542</span><span id="line-542"> */</span>
<span class="source-line-no">543</span><span id="line-543"> default CompletableFuture&lt;Void&gt; putAll(List&lt;Put&gt; puts) {</span>
<span class="source-line-no">544</span><span id="line-544"> return allOf(put(puts)).thenApply(r -&gt; null);</span>
<span class="source-line-no">545</span><span id="line-545"> }</span>
<span class="source-line-no">546</span><span id="line-546"></span>
<span class="source-line-no">547</span><span id="line-547"> /**</span>
<span class="source-line-no">548</span><span id="line-548"> * Deletes the specified cells/rows in bulk.</span>
<span class="source-line-no">549</span><span id="line-549"> * @param deletes list of things to delete.</span>
<span class="source-line-no">550</span><span id="line-550"> * @return A list of {@link CompletableFuture}s that represent the result for each delete.</span>
<span class="source-line-no">551</span><span id="line-551"> */</span>
<span class="source-line-no">552</span><span id="line-552"> List&lt;CompletableFuture&lt;Void&gt;&gt; delete(List&lt;Delete&gt; deletes);</span>
<span class="source-line-no">553</span><span id="line-553"></span>
<span class="source-line-no">554</span><span id="line-554"> /**</span>
<span class="source-line-no">555</span><span id="line-555"> * A simple version of batch delete. It will fail if there are any failures.</span>
<span class="source-line-no">556</span><span id="line-556"> * @param deletes list of things to delete.</span>
<span class="source-line-no">557</span><span id="line-557"> * @return A {@link CompletableFuture} that always returns null when complete normally.</span>
<span class="source-line-no">558</span><span id="line-558"> */</span>
<span class="source-line-no">559</span><span id="line-559"> default CompletableFuture&lt;Void&gt; deleteAll(List&lt;Delete&gt; deletes) {</span>
<span class="source-line-no">560</span><span id="line-560"> return allOf(delete(deletes)).thenApply(r -&gt; null);</span>
<span class="source-line-no">561</span><span id="line-561"> }</span>
<span class="source-line-no">562</span><span id="line-562"></span>
<span class="source-line-no">563</span><span id="line-563"> /**</span>
<span class="source-line-no">564</span><span id="line-564"> * Method that does a batch call on Deletes, Gets, Puts, Increments, Appends and RowMutations. The</span>
<span class="source-line-no">565</span><span id="line-565"> * ordering of execution of the actions is not defined. Meaning if you do a Put and a Get in the</span>
<span class="source-line-no">566</span><span id="line-566"> * same {@link #batch} call, you will not necessarily be guaranteed that the Get returns what the</span>
<span class="source-line-no">567</span><span id="line-567"> * Put had put.</span>
<span class="source-line-no">568</span><span id="line-568"> * @param actions list of Get, Put, Delete, Increment, Append, and RowMutations objects</span>
<span class="source-line-no">569</span><span id="line-569"> * @return A list of {@link CompletableFuture}s that represent the result for each action.</span>
<span class="source-line-no">570</span><span id="line-570"> */</span>
<span class="source-line-no">571</span><span id="line-571"> &lt;T&gt; List&lt;CompletableFuture&lt;T&gt;&gt; batch(List&lt;? extends Row&gt; actions);</span>
<span class="source-line-no">572</span><span id="line-572"></span>
<span class="source-line-no">573</span><span id="line-573"> /**</span>
<span class="source-line-no">574</span><span id="line-574"> * A simple version of batch. It will fail if there are any failures and you will get the whole</span>
<span class="source-line-no">575</span><span id="line-575"> * result list at once if the operation is succeeded.</span>
<span class="source-line-no">576</span><span id="line-576"> * @param actions list of Get, Put, Delete, Increment, Append and RowMutations objects</span>
<span class="source-line-no">577</span><span id="line-577"> * @return A list of the result for the actions. Wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">578</span><span id="line-578"> */</span>
<span class="source-line-no">579</span><span id="line-579"> default &lt;T&gt; CompletableFuture&lt;List&lt;T&gt;&gt; batchAll(List&lt;? extends Row&gt; actions) {</span>
<span class="source-line-no">580</span><span id="line-580"> return allOf(batch(actions));</span>
<span class="source-line-no">581</span><span id="line-581"> }</span>
<span class="source-line-no">582</span><span id="line-582"></span>
<span class="source-line-no">583</span><span id="line-583"> /**</span>
<span class="source-line-no">584</span><span id="line-584"> * Execute the given coprocessor call on the region which contains the given {@code row}.</span>
<span class="source-line-no">585</span><span id="line-585"> * &lt;p&gt;</span>
<span class="source-line-no">586</span><span id="line-586"> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a</span>
<span class="source-line-no">587</span><span id="line-587"> * one line lambda expression, like:</span>
<span class="source-line-no">588</span><span id="line-588"> *</span>
<span class="source-line-no">589</span><span id="line-589"> * &lt;pre&gt;</span>
<span class="source-line-no">590</span><span id="line-590"> * channel -&amp;gt; xxxService.newStub(channel)</span>
<span class="source-line-no">591</span><span id="line-591"> * &lt;/pre&gt;</span>
<span class="source-line-no">592</span><span id="line-592"> *</span>
<span class="source-line-no">593</span><span id="line-593"> * @param stubMaker a delegation to the actual {@code newStub} call.</span>
<span class="source-line-no">594</span><span id="line-594"> * @param callable a delegation to the actual protobuf rpc call. See the comment of</span>
<span class="source-line-no">595</span><span id="line-595"> * {@link ServiceCaller} for more details.</span>
<span class="source-line-no">596</span><span id="line-596"> * @param row The row key used to identify the remote region location</span>
<span class="source-line-no">597</span><span id="line-597"> * @param &lt;S&gt; the type of the asynchronous stub</span>
<span class="source-line-no">598</span><span id="line-598"> * @param &lt;R&gt; the type of the return value</span>
<span class="source-line-no">599</span><span id="line-599"> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.</span>
<span class="source-line-no">600</span><span id="line-600"> * @see ServiceCaller</span>
<span class="source-line-no">601</span><span id="line-601"> */</span>
<span class="source-line-no">602</span><span id="line-602"> &lt;S, R&gt; CompletableFuture&lt;R&gt; coprocessorService(Function&lt;RpcChannel, S&gt; stubMaker,</span>
<span class="source-line-no">603</span><span id="line-603"> ServiceCaller&lt;S, R&gt; callable, byte[] row);</span>
<span class="source-line-no">604</span><span id="line-604"></span>
<span class="source-line-no">605</span><span id="line-605"> /**</span>
<span class="source-line-no">606</span><span id="line-606"> * The callback when we want to execute a coprocessor call on a range of regions.</span>
<span class="source-line-no">607</span><span id="line-607"> * &lt;p&gt;</span>
<span class="source-line-no">608</span><span id="line-608"> * As the locating itself also takes some time, the implementation may want to send rpc calls on</span>
<span class="source-line-no">609</span><span id="line-609"> * the fly, which means we do not know how many regions we have when we get the return value of</span>
<span class="source-line-no">610</span><span id="line-610"> * the rpc calls, so we need an {@link #onComplete()} which is used to tell you that we have</span>
<span class="source-line-no">611</span><span id="line-611"> * passed all the return values to you(through the {@link #onRegionComplete(RegionInfo, Object)}</span>
<span class="source-line-no">612</span><span id="line-612"> * or {@link #onRegionError(RegionInfo, Throwable)} calls), i.e, there will be no</span>
<span class="source-line-no">613</span><span id="line-613"> * {@link #onRegionComplete(RegionInfo, Object)} or {@link #onRegionError(RegionInfo, Throwable)}</span>
<span class="source-line-no">614</span><span id="line-614"> * calls in the future.</span>
<span class="source-line-no">615</span><span id="line-615"> * &lt;p&gt;</span>
<span class="source-line-no">616</span><span id="line-616"> * Here is a pseudo code to describe a typical implementation of a range coprocessor service</span>
<span class="source-line-no">617</span><span id="line-617"> * method to help you better understand how the {@link CoprocessorCallback} will be called. The</span>
<span class="source-line-no">618</span><span id="line-618"> * {@code callback} in the pseudo code is our {@link CoprocessorCallback}. And notice that the</span>
<span class="source-line-no">619</span><span id="line-619"> * {@code whenComplete} is {@code CompletableFuture.whenComplete}.</span>
<span class="source-line-no">620</span><span id="line-620"> *</span>
<span class="source-line-no">621</span><span id="line-621"> * &lt;pre&gt;</span>
<span class="source-line-no">622</span><span id="line-622"> * locateThenCall(byte[] row) {</span>
<span class="source-line-no">623</span><span id="line-623"> * locate(row).whenComplete((location, locateError) -&amp;gt; {</span>
<span class="source-line-no">624</span><span id="line-624"> * if (locateError != null) {</span>
<span class="source-line-no">625</span><span id="line-625"> * callback.onError(locateError);</span>
<span class="source-line-no">626</span><span id="line-626"> * return;</span>
<span class="source-line-no">627</span><span id="line-627"> * }</span>
<span class="source-line-no">628</span><span id="line-628"> * incPendingCall();</span>
<span class="source-line-no">629</span><span id="line-629"> * region = location.getRegion();</span>
<span class="source-line-no">630</span><span id="line-630"> * if (region.getEndKey() &gt; endKey) {</span>
<span class="source-line-no">631</span><span id="line-631"> * locateEnd = true;</span>
<span class="source-line-no">632</span><span id="line-632"> * } else {</span>
<span class="source-line-no">633</span><span id="line-633"> * locateThenCall(region.getEndKey());</span>
<span class="source-line-no">634</span><span id="line-634"> * }</span>
<span class="source-line-no">635</span><span id="line-635"> * sendCall().whenComplete((resp, error) -&amp;gt; {</span>
<span class="source-line-no">636</span><span id="line-636"> * if (error != null) {</span>
<span class="source-line-no">637</span><span id="line-637"> * callback.onRegionError(region, error);</span>
<span class="source-line-no">638</span><span id="line-638"> * } else {</span>
<span class="source-line-no">639</span><span id="line-639"> * callback.onRegionComplete(region, resp);</span>
<span class="source-line-no">640</span><span id="line-640"> * }</span>
<span class="source-line-no">641</span><span id="line-641"> * if (locateEnd &amp;&amp; decPendingCallAndGet() == 0) {</span>
<span class="source-line-no">642</span><span id="line-642"> * callback.onComplete();</span>
<span class="source-line-no">643</span><span id="line-643"> * }</span>
<span class="source-line-no">644</span><span id="line-644"> * });</span>
<span class="source-line-no">645</span><span id="line-645"> * });</span>
<span class="source-line-no">646</span><span id="line-646"> * }</span>
<span class="source-line-no">647</span><span id="line-647"> * &lt;/pre&gt;</span>
<span class="source-line-no">648</span><span id="line-648"> */</span>
<span class="source-line-no">649</span><span id="line-649"> @InterfaceAudience.Public</span>
<span class="source-line-no">650</span><span id="line-650"> interface CoprocessorCallback&lt;R&gt; {</span>
<span class="source-line-no">651</span><span id="line-651"></span>
<span class="source-line-no">652</span><span id="line-652"> /**</span>
<span class="source-line-no">653</span><span id="line-653"> * Indicate that the respose of a region is available</span>
<span class="source-line-no">654</span><span id="line-654"> * @param region the region that the response belongs to</span>
<span class="source-line-no">655</span><span id="line-655"> * @param resp the response of the coprocessor call</span>
<span class="source-line-no">656</span><span id="line-656"> */</span>
<span class="source-line-no">657</span><span id="line-657"> void onRegionComplete(RegionInfo region, R resp);</span>
<span class="source-line-no">658</span><span id="line-658"></span>
<span class="source-line-no">659</span><span id="line-659"> /**</span>
<span class="source-line-no">660</span><span id="line-660"> * Indicate that the error for a region is available</span>
<span class="source-line-no">661</span><span id="line-661"> * @param region the region that the error belongs to</span>
<span class="source-line-no">662</span><span id="line-662"> * @param error the response error of the coprocessor call</span>
<span class="source-line-no">663</span><span id="line-663"> */</span>
<span class="source-line-no">664</span><span id="line-664"> void onRegionError(RegionInfo region, Throwable error);</span>
<span class="source-line-no">665</span><span id="line-665"></span>
<span class="source-line-no">666</span><span id="line-666"> /**</span>
<span class="source-line-no">667</span><span id="line-667"> * Indicate that all responses of the regions have been notified by calling</span>
<span class="source-line-no">668</span><span id="line-668"> * {@link #onRegionComplete(RegionInfo, Object)} or</span>
<span class="source-line-no">669</span><span id="line-669"> * {@link #onRegionError(RegionInfo, Throwable)}.</span>
<span class="source-line-no">670</span><span id="line-670"> */</span>
<span class="source-line-no">671</span><span id="line-671"> void onComplete();</span>
<span class="source-line-no">672</span><span id="line-672"></span>
<span class="source-line-no">673</span><span id="line-673"> /**</span>
<span class="source-line-no">674</span><span id="line-674"> * Indicate that we got an error which does not belong to any regions. Usually a locating error.</span>
<span class="source-line-no">675</span><span id="line-675"> */</span>
<span class="source-line-no">676</span><span id="line-676"> void onError(Throwable error);</span>
<span class="source-line-no">677</span><span id="line-677"> }</span>
<span class="source-line-no">678</span><span id="line-678"></span>
<span class="source-line-no">679</span><span id="line-679"> /**</span>
<span class="source-line-no">680</span><span id="line-680"> * Helper class for sending coprocessorService request that executes a coprocessor call on regions</span>
<span class="source-line-no">681</span><span id="line-681"> * which are covered by a range.</span>
<span class="source-line-no">682</span><span id="line-682"> * &lt;p&gt;</span>
<span class="source-line-no">683</span><span id="line-683"> * If {@code fromRow} is not specified the selection will start with the first table region. If</span>
<span class="source-line-no">684</span><span id="line-684"> * {@code toRow} is not specified the selection will continue through the last table region.</span>
<span class="source-line-no">685</span><span id="line-685"> * @param &lt;S&gt; the type of the protobuf Service you want to call.</span>
<span class="source-line-no">686</span><span id="line-686"> * @param &lt;R&gt; the type of the return value.</span>
<span class="source-line-no">687</span><span id="line-687"> */</span>
<span class="source-line-no">688</span><span id="line-688"> interface CoprocessorServiceBuilder&lt;S, R&gt; {</span>
<span class="source-line-no">689</span><span id="line-689"></span>
<span class="source-line-no">690</span><span id="line-690"> /**</span>
<span class="source-line-no">691</span><span id="line-691"> * Specify a start row</span>
<span class="source-line-no">692</span><span id="line-692"> * @param startKey start region selection with region containing this row, inclusive.</span>
<span class="source-line-no">693</span><span id="line-693"> */</span>
<span class="source-line-no">694</span><span id="line-694"> default CoprocessorServiceBuilder&lt;S, R&gt; fromRow(byte[] startKey) {</span>
<span class="source-line-no">695</span><span id="line-695"> return fromRow(startKey, true);</span>
<span class="source-line-no">696</span><span id="line-696"> }</span>
<span class="source-line-no">697</span><span id="line-697"></span>
<span class="source-line-no">698</span><span id="line-698"> /**</span>
<span class="source-line-no">699</span><span id="line-699"> * Specify a start row</span>
<span class="source-line-no">700</span><span id="line-700"> * @param startKey start region selection with region containing this row</span>
<span class="source-line-no">701</span><span id="line-701"> * @param inclusive whether to include the startKey</span>
<span class="source-line-no">702</span><span id="line-702"> */</span>
<span class="source-line-no">703</span><span id="line-703"> CoprocessorServiceBuilder&lt;S, R&gt; fromRow(byte[] startKey, boolean inclusive);</span>
<span class="source-line-no">704</span><span id="line-704"></span>
<span class="source-line-no">705</span><span id="line-705"> /**</span>
<span class="source-line-no">706</span><span id="line-706"> * Specify a stop row</span>
<span class="source-line-no">707</span><span id="line-707"> * @param endKey select regions up to and including the region containing this row, exclusive.</span>
<span class="source-line-no">708</span><span id="line-708"> */</span>
<span class="source-line-no">709</span><span id="line-709"> default CoprocessorServiceBuilder&lt;S, R&gt; toRow(byte[] endKey) {</span>
<span class="source-line-no">710</span><span id="line-710"> return toRow(endKey, false);</span>
<span class="source-line-no">711</span><span id="line-711"> }</span>
<span class="source-line-no">712</span><span id="line-712"></span>
<span class="source-line-no">713</span><span id="line-713"> /**</span>
<span class="source-line-no">714</span><span id="line-714"> * Specify a stop row</span>
<span class="source-line-no">715</span><span id="line-715"> * @param endKey select regions up to and including the region containing this row</span>
<span class="source-line-no">716</span><span id="line-716"> * @param inclusive whether to include the endKey</span>
<span class="source-line-no">717</span><span id="line-717"> */</span>
<span class="source-line-no">718</span><span id="line-718"> CoprocessorServiceBuilder&lt;S, R&gt; toRow(byte[] endKey, boolean inclusive);</span>
<span class="source-line-no">719</span><span id="line-719"></span>
<span class="source-line-no">720</span><span id="line-720"> /**</span>
<span class="source-line-no">721</span><span id="line-721"> * Execute the coprocessorService request. You can get the response through the</span>
<span class="source-line-no">722</span><span id="line-722"> * {@link CoprocessorCallback}.</span>
<span class="source-line-no">723</span><span id="line-723"> */</span>
<span class="source-line-no">724</span><span id="line-724"> void execute();</span>
<span class="source-line-no">725</span><span id="line-725"> }</span>
<span class="source-line-no">726</span><span id="line-726"></span>
<span class="source-line-no">727</span><span id="line-727"> /**</span>
<span class="source-line-no">728</span><span id="line-728"> * Execute a coprocessor call on the regions which are covered by a range.</span>
<span class="source-line-no">729</span><span id="line-729"> * &lt;p&gt;</span>
<span class="source-line-no">730</span><span id="line-730"> * Use the returned {@link CoprocessorServiceBuilder} construct your request and then execute it.</span>
<span class="source-line-no">731</span><span id="line-731"> * &lt;p&gt;</span>
<span class="source-line-no">732</span><span id="line-732"> * The {@code stubMaker} is just a delegation to the {@code xxxService.newStub} call. Usually it</span>
<span class="source-line-no">733</span><span id="line-733"> * is only a one line lambda expression, like:</span>
<span class="source-line-no">734</span><span id="line-734"> *</span>
<span class="source-line-no">735</span><span id="line-735"> * &lt;pre&gt;</span>
<span class="source-line-no">736</span><span id="line-736"> * channel -&amp;gt; xxxService.newStub(channel)</span>
<span class="source-line-no">737</span><span id="line-737"> * &lt;/pre&gt;</span>
<span class="source-line-no">738</span><span id="line-738"> *</span>
<span class="source-line-no">739</span><span id="line-739"> * @param stubMaker a delegation to the actual {@code newStub} call.</span>
<span class="source-line-no">740</span><span id="line-740"> * @param callable a delegation to the actual protobuf rpc call. See the comment of</span>
<span class="source-line-no">741</span><span id="line-741"> * {@link ServiceCaller} for more details.</span>
<span class="source-line-no">742</span><span id="line-742"> * @param callback callback to get the response. See the comment of {@link CoprocessorCallback}</span>
<span class="source-line-no">743</span><span id="line-743"> * for more details.</span>
<span class="source-line-no">744</span><span id="line-744"> */</span>
<span class="source-line-no">745</span><span id="line-745"> &lt;S, R&gt; CoprocessorServiceBuilder&lt;S, R&gt; coprocessorService(Function&lt;RpcChannel, S&gt; stubMaker,</span>
<span class="source-line-no">746</span><span id="line-746"> ServiceCaller&lt;S, R&gt; callable, CoprocessorCallback&lt;R&gt; callback);</span>
<span class="source-line-no">747</span><span id="line-747">}</span>
</pre>
</div>
</main>
</body>
</html>