http://git-wip-us.apache.org/repos/asf/hbase-site/blob/16541468/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html index 9bf7a7c..8103475 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html @@ -30,601 +30,605 @@ <span class="sourceLineNo">022</span>import static org.apache.hadoop.hbase.client.ConnectionUtils.toCheckExistenceOnly;<a name="line.22"></a> <span class="sourceLineNo">023</span><a name="line.23"></a> <span class="sourceLineNo">024</span>import com.google.protobuf.RpcChannel;<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import java.util.concurrent.CompletableFuture;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import java.util.concurrent.TimeUnit;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import java.util.function.Function;<a name="line.29"></a> -<span class="sourceLineNo">030</span><a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.conf.Configuration;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.TableName;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.35"></a> -<span class="sourceLineNo">036</span><a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span>/**<a name="line.39"></a> -<span class="sourceLineNo">040</span> * The interface for asynchronous version of Table. Obtain an instance from a<a name="line.40"></a> -<span class="sourceLineNo">041</span> * {@link AsyncConnection}.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> -<span class="sourceLineNo">043</span> * The implementation is required to be thread safe.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> -<span class="sourceLineNo">045</span> * Usually the implementation will not throw any exception directly. You need to get the exception<a name="line.45"></a> -<span class="sourceLineNo">046</span> * from the returned {@link CompletableFuture}.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * @since 2.0.0<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span>@InterfaceAudience.Public<a name="line.49"></a> -<span class="sourceLineNo">050</span>public interface AsyncTable<C extends ScanResultConsumerBase> {<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * Gets the fully qualified table name instance of this table.<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> TableName getName();<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> /**<a name="line.57"></a> -<span class="sourceLineNo">058</span> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * <p><a name="line.59"></a> -<span class="sourceLineNo">060</span> * The reference returned is not a copy, so any change made to it will affect this instance.<a name="line.60"></a> -<span class="sourceLineNo">061</span> */<a name="line.61"></a> -<span class="sourceLineNo">062</span> Configuration getConfiguration();<a name="line.62"></a> -<span class="sourceLineNo">063</span><a name="line.63"></a> -<span class="sourceLineNo">064</span> /**<a name="line.64"></a> -<span class="sourceLineNo">065</span> * Get timeout of each rpc request in this Table instance. It will be overridden by a more<a name="line.65"></a> -<span class="sourceLineNo">066</span> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @see #getReadRpcTimeout(TimeUnit)<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @see #getWriteRpcTimeout(TimeUnit)<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @param unit the unit of time the timeout to be represented in<a name="line.69"></a> -<span class="sourceLineNo">070</span> * @return rpc timeout in the specified time unit<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> long getRpcTimeout(TimeUnit unit);<a name="line.72"></a> -<span class="sourceLineNo">073</span><a name="line.73"></a> -<span class="sourceLineNo">074</span> /**<a name="line.74"></a> -<span class="sourceLineNo">075</span> * Get timeout of each rpc read request in this Table instance.<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param unit the unit of time the timeout to be represented in<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @return read rpc timeout in the specified time unit<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> long getReadRpcTimeout(TimeUnit unit);<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * Get timeout of each rpc write request in this Table instance.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param unit the unit of time the timeout to be represented in<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @return write rpc timeout in the specified time unit<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> long getWriteRpcTimeout(TimeUnit unit);<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * Get timeout of each operation in Table instance.<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @param unit the unit of time the timeout to be represented in<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @return operation rpc timeout in the specified time unit<a name="line.91"></a> -<span class="sourceLineNo">092</span> */<a name="line.92"></a> -<span class="sourceLineNo">093</span> long getOperationTimeout(TimeUnit unit);<a name="line.93"></a> -<span class="sourceLineNo">094</span><a name="line.94"></a> -<span class="sourceLineNo">095</span> /**<a name="line.95"></a> -<span class="sourceLineNo">096</span> * Get the timeout of a single operation in a scan. It works like operation timeout for other<a name="line.96"></a> -<span class="sourceLineNo">097</span> * operations.<a name="line.97"></a> -<span class="sourceLineNo">098</span> * @param unit the unit of time the timeout to be represented in<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @return scan rpc timeout in the specified time unit<a name="line.99"></a> -<span class="sourceLineNo">100</span> */<a name="line.100"></a> -<span class="sourceLineNo">101</span> long getScanTimeout(TimeUnit unit);<a name="line.101"></a> -<span class="sourceLineNo">102</span><a name="line.102"></a> -<span class="sourceLineNo">103</span> /**<a name="line.103"></a> -<span class="sourceLineNo">104</span> * Test for the existence of columns in the table, as specified by the Get.<a name="line.104"></a> -<span class="sourceLineNo">105</span> * <p><a name="line.105"></a> -<span class="sourceLineNo">106</span> * This will return true if the Get matches one or more keys, false if not.<a name="line.106"></a> -<span class="sourceLineNo">107</span> * <p><a name="line.107"></a> -<span class="sourceLineNo">108</span> * This is a server-side call so it prevents any data from being transfered to the client.<a name="line.108"></a> -<span class="sourceLineNo">109</span> * @return true if the specified Get matches one or more keys, false if not. The return value will<a name="line.109"></a> -<span class="sourceLineNo">110</span> * be wrapped by a {@link CompletableFuture}.<a name="line.110"></a> -<span class="sourceLineNo">111</span> */<a name="line.111"></a> -<span class="sourceLineNo">112</span> default CompletableFuture<Boolean> exists(Get get) {<a name="line.112"></a> -<span class="sourceLineNo">113</span> return get(toCheckExistenceOnly(get)).thenApply(r -> r.getExists());<a name="line.113"></a> -<span class="sourceLineNo">114</span> }<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> -<span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * Extracts certain cells from a given row.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @param get The object that specifies what data to fetch and from which row.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @return The data coming from the specified row, if it exists. If the row specified doesn't<a name="line.119"></a> -<span class="sourceLineNo">120</span> * exist, the {@link Result} instance returned won't contain any<a name="line.120"></a> -<span class="sourceLineNo">121</span> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}. The<a name="line.121"></a> -<span class="sourceLineNo">122</span> * return value will be wrapped by a {@link CompletableFuture}.<a name="line.122"></a> -<span class="sourceLineNo">123</span> */<a name="line.123"></a> -<span class="sourceLineNo">124</span> CompletableFuture<Result> get(Get get);<a name="line.124"></a> -<span class="sourceLineNo">125</span><a name="line.125"></a> -<span class="sourceLineNo">126</span> /**<a name="line.126"></a> -<span class="sourceLineNo">127</span> * Puts some data to the table.<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @param put The data to put.<a name="line.128"></a> -<span class="sourceLineNo">129</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.129"></a> -<span class="sourceLineNo">130</span> */<a name="line.130"></a> -<span class="sourceLineNo">131</span> CompletableFuture<Void> put(Put put);<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> /**<a name="line.133"></a> -<span class="sourceLineNo">134</span> * Deletes the specified cells/row.<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @param delete The object that specifies what to delete.<a name="line.135"></a> -<span class="sourceLineNo">136</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.136"></a> -<span class="sourceLineNo">137</span> */<a name="line.137"></a> -<span class="sourceLineNo">138</span> CompletableFuture<Void> delete(Delete delete);<a name="line.138"></a> -<span class="sourceLineNo">139</span><a name="line.139"></a> -<span class="sourceLineNo">140</span> /**<a name="line.140"></a> -<span class="sourceLineNo">141</span> * Appends values to one or more columns within a single row.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * <p><a name="line.142"></a> -<span class="sourceLineNo">143</span> * This operation does not appear atomic to readers. Appends are done under a single row lock, so<a name="line.143"></a> -<span class="sourceLineNo">144</span> * write operations to a row are synchronized, but readers do not take row locks so get and scan<a name="line.144"></a> -<span class="sourceLineNo">145</span> * operations can see this operation partially completed.<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @param append object that specifies the columns and amounts to be used for the increment<a name="line.146"></a> -<span class="sourceLineNo">147</span> * operations<a name="line.147"></a> -<span class="sourceLineNo">148</span> * @return values of columns after the append operation (maybe null). The return value will be<a name="line.148"></a> -<span class="sourceLineNo">149</span> * wrapped by a {@link CompletableFuture}.<a name="line.149"></a> -<span class="sourceLineNo">150</span> */<a name="line.150"></a> -<span class="sourceLineNo">151</span> CompletableFuture<Result> append(Append append);<a name="line.151"></a> -<span class="sourceLineNo">152</span><a name="line.152"></a> -<span class="sourceLineNo">153</span> /**<a name="line.153"></a> -<span class="sourceLineNo">154</span> * Increments one or more columns within a single row.<a name="line.154"></a> -<span class="sourceLineNo">155</span> * <p><a name="line.155"></a> -<span class="sourceLineNo">156</span> * This operation does not appear atomic to readers. Increments are done under a single row lock,<a name="line.156"></a> -<span class="sourceLineNo">157</span> * so write operations to a row are synchronized, but readers do not take row locks so get and<a name="line.157"></a> -<span class="sourceLineNo">158</span> * scan operations can see this operation partially completed.<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @param increment object that specifies the columns and amounts to be used for the increment<a name="line.159"></a> -<span class="sourceLineNo">160</span> * operations<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @return values of columns after the increment. The return value will be wrapped by a<a name="line.161"></a> -<span class="sourceLineNo">162</span> * {@link CompletableFuture}.<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> CompletableFuture<Result> increment(Increment increment);<a name="line.164"></a> -<span class="sourceLineNo">165</span><a name="line.165"></a> -<span class="sourceLineNo">166</span> /**<a name="line.166"></a> -<span class="sourceLineNo">167</span> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.167"></a> -<span class="sourceLineNo">168</span> * <p><a name="line.168"></a> -<span class="sourceLineNo">169</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @param row The row that contains the cell to increment.<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @param family The column family of the cell to increment.<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.172"></a> -<span class="sourceLineNo">173</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.173"></a> -<span class="sourceLineNo">174</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.174"></a> -<span class="sourceLineNo">175</span> * {@link CompletableFuture}.<a name="line.175"></a> -<span class="sourceLineNo">176</span> */<a name="line.176"></a> -<span class="sourceLineNo">177</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.177"></a> -<span class="sourceLineNo">178</span> long amount) {<a name="line.178"></a> -<span class="sourceLineNo">179</span> return incrementColumnValue(row, family, qualifier, amount, Durability.SYNC_WAL);<a name="line.179"></a> -<span class="sourceLineNo">180</span> }<a name="line.180"></a> -<span class="sourceLineNo">181</span><a name="line.181"></a> -<span class="sourceLineNo">182</span> /**<a name="line.182"></a> -<span class="sourceLineNo">183</span> * Atomically increments a column value. If the column value already exists and is not a<a name="line.183"></a> -<span class="sourceLineNo">184</span> * big-endian long, this could throw an exception. If the column value does not yet exist it is<a name="line.184"></a> -<span class="sourceLineNo">185</span> * initialized to <code>amount</code> and written to the specified column.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * <p><a name="line.186"></a> -<span class="sourceLineNo">187</span> * Setting durability to {@link Durability#SKIP_WAL} means that in a fail scenario you will lose<a name="line.187"></a> -<span class="sourceLineNo">188</span> * any increments that have not been flushed.<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @param row The row that contains the cell to increment.<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @param family The column family of the cell to increment.<a name="line.190"></a> -<span class="sourceLineNo">191</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @param durability The persistence guarantee for this increment.<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.194"></a> -<span class="sourceLineNo">195</span> * {@link CompletableFuture}.<a name="line.195"></a> -<span class="sourceLineNo">196</span> */<a name="line.196"></a> -<span class="sourceLineNo">197</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.197"></a> -<span class="sourceLineNo">198</span> long amount, Durability durability) {<a name="line.198"></a> -<span class="sourceLineNo">199</span> Preconditions.checkNotNull(row, "row is null");<a name="line.199"></a> -<span class="sourceLineNo">200</span> Preconditions.checkNotNull(family, "family is null");<a name="line.200"></a> -<span class="sourceLineNo">201</span> return increment(<a name="line.201"></a> -<span class="sourceLineNo">202</span> new Increment(row).addColumn(family, qualifier, amount).setDurability(durability))<a name="line.202"></a> -<span class="sourceLineNo">203</span> .thenApply(r -> Bytes.toLong(r.getValue(family, qualifier)));<a name="line.203"></a> -<span class="sourceLineNo">204</span> }<a name="line.204"></a> -<span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> /**<a name="line.206"></a> -<span class="sourceLineNo">207</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.207"></a> -<span class="sourceLineNo">208</span> * adds the Put/Delete/RowMutations.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * <p><a name="line.209"></a> -<span class="sourceLineNo">210</span> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.<a name="line.210"></a> -<span class="sourceLineNo">211</span> * This is a fluent style API, the code is like:<a name="line.211"></a> -<span class="sourceLineNo">212</span> *<a name="line.212"></a> -<span class="sourceLineNo">213</span> * <pre><a name="line.213"></a> -<span class="sourceLineNo">214</span> * <code><a name="line.214"></a> -<span class="sourceLineNo">215</span> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put)<a name="line.215"></a> -<span class="sourceLineNo">216</span> * .thenAccept(succ -> {<a name="line.216"></a> -<span class="sourceLineNo">217</span> * if (succ) {<a name="line.217"></a> -<span class="sourceLineNo">218</span> * System.out.println("Check and put succeeded");<a name="line.218"></a> -<span class="sourceLineNo">219</span> * } else {<a name="line.219"></a> -<span class="sourceLineNo">220</span> * System.out.println("Check and put failed");<a name="line.220"></a> -<span class="sourceLineNo">221</span> * }<a name="line.221"></a> -<span class="sourceLineNo">222</span> * });<a name="line.222"></a> -<span class="sourceLineNo">223</span> * </code><a name="line.223"></a> -<span class="sourceLineNo">224</span> * </pre><a name="line.224"></a> -<span class="sourceLineNo">225</span> */<a name="line.225"></a> -<span class="sourceLineNo">226</span> CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family);<a name="line.226"></a> -<span class="sourceLineNo">227</span><a name="line.227"></a> -<span class="sourceLineNo">228</span> /**<a name="line.228"></a> -<span class="sourceLineNo">229</span> * A helper class for sending checkAndMutate request.<a name="line.229"></a> -<span class="sourceLineNo">230</span> */<a name="line.230"></a> -<span class="sourceLineNo">231</span> interface CheckAndMutateBuilder {<a name="line.231"></a> -<span class="sourceLineNo">232</span><a name="line.232"></a> -<span class="sourceLineNo">233</span> /**<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @param qualifier column qualifier to check.<a name="line.234"></a> -<span class="sourceLineNo">235</span> */<a name="line.235"></a> -<span class="sourceLineNo">236</span> CheckAndMutateBuilder qualifier(byte[] qualifier);<a name="line.236"></a> -<span class="sourceLineNo">237</span><a name="line.237"></a> -<span class="sourceLineNo">238</span> /**<a name="line.238"></a> -<span class="sourceLineNo">239</span> * Check for lack of column.<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> CheckAndMutateBuilder ifNotExists();<a name="line.241"></a> -<span class="sourceLineNo">242</span><a name="line.242"></a> -<span class="sourceLineNo">243</span> /**<a name="line.243"></a> -<span class="sourceLineNo">244</span> * Check for equality.<a name="line.244"></a> -<span class="sourceLineNo">245</span> * @param value the expected value<a name="line.245"></a> -<span class="sourceLineNo">246</span> */<a name="line.246"></a> -<span class="sourceLineNo">247</span> default CheckAndMutateBuilder ifEquals(byte[] value) {<a name="line.247"></a> -<span class="sourceLineNo">248</span> return ifMatches(CompareOperator.EQUAL, value);<a name="line.248"></a> -<span class="sourceLineNo">249</span> }<a name="line.249"></a> -<span class="sourceLineNo">250</span><a name="line.250"></a> -<span class="sourceLineNo">251</span> /**<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param compareOp comparison operator to use<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @param value the expected value<a name="line.253"></a> -<span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] value);<a name="line.255"></a> -<span class="sourceLineNo">256</span><a name="line.256"></a> -<span class="sourceLineNo">257</span> /**<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @param put data to put if check succeeds<a name="line.258"></a> -<span class="sourceLineNo">259</span> * @return {@code true} if the new put was executed, {@code false} otherwise. The return value<a name="line.259"></a> -<span class="sourceLineNo">260</span> * will be wrapped by a {@link CompletableFuture}.<a name="line.260"></a> -<span class="sourceLineNo">261</span> */<a name="line.261"></a> -<span class="sourceLineNo">262</span> CompletableFuture<Boolean> thenPut(Put put);<a name="line.262"></a> -<span class="sourceLineNo">263</span><a name="line.263"></a> -<span class="sourceLineNo">264</span> /**<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @param delete data to delete if check succeeds<a name="line.265"></a> -<span class="sourceLineNo">266</span> * @return {@code true} if the new delete was executed, {@code false} otherwise. The return<a name="line.266"></a> -<span class="sourceLineNo">267</span> * value will be wrapped by a {@link CompletableFuture}.<a name="line.267"></a> -<span class="sourceLineNo">268</span> */<a name="line.268"></a> -<span class="sourceLineNo">269</span> CompletableFuture<Boolean> thenDelete(Delete delete);<a name="line.269"></a> -<span class="sourceLineNo">270</span><a name="line.270"></a> -<span class="sourceLineNo">271</span> /**<a name="line.271"></a> -<span class="sourceLineNo">272</span> * @param mutation mutations to perform if check succeeds<a name="line.272"></a> -<span class="sourceLineNo">273</span> * @return true if the new mutation was executed, false otherwise. The return value will be<a name="line.273"></a> -<span class="sourceLineNo">274</span> * wrapped by a {@link CompletableFuture}.<a name="line.274"></a> -<span class="sourceLineNo">275</span> */<a name="line.275"></a> -<span class="sourceLineNo">276</span> CompletableFuture<Boolean> thenMutate(RowMutations mutation);<a name="line.276"></a> -<span class="sourceLineNo">277</span> }<a name="line.277"></a> -<span class="sourceLineNo">278</span><a name="line.278"></a> -<span class="sourceLineNo">279</span> /**<a name="line.279"></a> -<span class="sourceLineNo">280</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.280"></a> -<span class="sourceLineNo">281</span> * {@link Delete} are supported.<a name="line.281"></a> -<span class="sourceLineNo">282</span> * @param mutation object that specifies the set of mutations to perform atomically<a name="line.282"></a> -<span class="sourceLineNo">283</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.283"></a> -<span class="sourceLineNo">284</span> */<a name="line.284"></a> -<span class="sourceLineNo">285</span> CompletableFuture<Void> mutateRow(RowMutations mutation);<a name="line.285"></a> -<span class="sourceLineNo">286</span><a name="line.286"></a> -<span class="sourceLineNo">287</span> /**<a name="line.287"></a> -<span class="sourceLineNo">288</span> * The scan API uses the observer pattern.<a name="line.288"></a> -<span class="sourceLineNo">289</span> * @param scan A configured {@link Scan} object.<a name="line.289"></a> -<span class="sourceLineNo">290</span> * @param consumer the consumer used to receive results.<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @see ScanResultConsumer<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @see AdvancedScanResultConsumer<a name="line.292"></a> -<span class="sourceLineNo">293</span> */<a name="line.293"></a> -<span class="sourceLineNo">294</span> void scan(Scan scan, C consumer);<a name="line.294"></a> -<span class="sourceLineNo">295</span><a name="line.295"></a> -<span class="sourceLineNo">296</span> /**<a name="line.296"></a> -<span class="sourceLineNo">297</span> * Gets a scanner on the current table for the given family.<a name="line.297"></a> -<span class="sourceLineNo">298</span> * @param family The column family to scan.<a name="line.298"></a> -<span class="sourceLineNo">299</span> * @return A scanner.<a name="line.299"></a> -<span class="sourceLineNo">300</span> */<a name="line.300"></a> -<span class="sourceLineNo">301</span> default ResultScanner getScanner(byte[] family) {<a name="line.301"></a> -<span class="sourceLineNo">302</span> return getScanner(new Scan().addFamily(family));<a name="line.302"></a> -<span class="sourceLineNo">303</span> }<a name="line.303"></a> -<span class="sourceLineNo">304</span><a name="line.304"></a> -<span class="sourceLineNo">305</span> /**<a name="line.305"></a> -<span class="sourceLineNo">306</span> * Gets a scanner on the current table for the given family and qualifier.<a name="line.306"></a> -<span class="sourceLineNo">307</span> * @param family The column family to scan.<a name="line.307"></a> -<span class="sourceLineNo">308</span> * @param qualifier The column qualifier to scan.<a name="line.308"></a> -<span class="sourceLineNo">309</span> * @return A scanner.<a name="line.309"></a> -<span class="sourceLineNo">310</span> */<a name="line.310"></a> -<span class="sourceLineNo">311</span> default ResultScanner getScanner(byte[] family, byte[] qualifier) {<a name="line.311"></a> -<span class="sourceLineNo">312</span> return getScanner(new Scan().addColumn(family, qualifier));<a name="line.312"></a> -<span class="sourceLineNo">313</span> }<a name="line.313"></a> -<span class="sourceLineNo">314</span><a name="line.314"></a> -<span class="sourceLineNo">315</span> /**<a name="line.315"></a> -<span class="sourceLineNo">316</span> * Returns a scanner on the current table as specified by the {@link Scan} object.<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @param scan A configured {@link Scan} object.<a name="line.317"></a> -<span class="sourceLineNo">318</span> * @return A scanner.<a name="line.318"></a> -<span class="sourceLineNo">319</span> */<a name="line.319"></a> -<span class="sourceLineNo">320</span> ResultScanner getScanner(Scan scan);<a name="line.320"></a> -<span class="sourceLineNo">321</span><a name="line.321"></a> -<span class="sourceLineNo">322</span> /**<a name="line.322"></a> -<span class="sourceLineNo">323</span> * Return all the results that match the given scan object.<a name="line.323"></a> -<span class="sourceLineNo">324</span> * <p><a name="line.324"></a> -<span class="sourceLineNo">325</span> * Notice that usually you should use this method with a {@link Scan} object that has limit set.<a name="line.325"></a> -<span class="sourceLineNo">326</span> * For example, if you want to get the closest row after a given row, you could do this:<a name="line.326"></a> -<span class="sourceLineNo">327</span> * <p><a name="line.327"></a> -<span class="sourceLineNo">328</span> *<a name="line.328"></a> -<span class="sourceLineNo">329</span> * <pre><a name="line.329"></a> -<span class="sourceLineNo">330</span> * <code><a name="line.330"></a> -<span class="sourceLineNo">331</span> * table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -> {<a name="line.331"></a> -<span class="sourceLineNo">332</span> * if (results.isEmpty()) {<a name="line.332"></a> -<span class="sourceLineNo">333</span> * System.out.println("No row after " + Bytes.toStringBinary(row));<a name="line.333"></a> -<span class="sourceLineNo">334</span> * } else {<a name="line.334"></a> -<span class="sourceLineNo">335</span> * System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is "<a name="line.335"></a> -<span class="sourceLineNo">336</span> * + Bytes.toStringBinary(results.stream().findFirst().get().getRow()));<a name="line.336"></a> -<span class="sourceLineNo">337</span> * }<a name="line.337"></a> -<span class="sourceLineNo">338</span> * });<a name="line.338"></a> -<span class="sourceLineNo">339</span> * </code><a name="line.339"></a> -<span class="sourceLineNo">340</span> * </pre><a name="line.340"></a> -<span class="sourceLineNo">341</span> * <p><a name="line.341"></a> -<span class="sourceLineNo">342</span> * If your result set is very large, you should use other scan method to get a scanner or use<a name="line.342"></a> -<span class="sourceLineNo">343</span> * callback to process the results. They will do chunking to prevent OOM. The scanAll method will<a name="line.343"></a> -<span class="sourceLineNo">344</span> * fetch all the results and store them in a List and then return the list to you.<a name="line.344"></a> +<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.util.concurrent.CompletableFuture;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.concurrent.TimeUnit;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.util.function.Function;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.hadoop.conf.Configuration;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.TableName;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.io.TimeRange;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.34"></a> +<span class="sourceLineNo">035</span><a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span>/**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * The interface for asynchronous version of Table. Obtain an instance from a<a name="line.39"></a> +<span class="sourceLineNo">040</span> * {@link AsyncConnection}.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * The implementation is required to be thread safe.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <p><a name="line.43"></a> +<span class="sourceLineNo">044</span> * Usually the implementation will not throw any exception directly. You need to get the exception<a name="line.44"></a> +<span class="sourceLineNo">045</span> * from the returned {@link CompletableFuture}.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @since 2.0.0<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span>@InterfaceAudience.Public<a name="line.48"></a> +<span class="sourceLineNo">049</span>public interface AsyncTable<C extends ScanResultConsumerBase> {<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span> /**<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Gets the fully qualified table name instance of this table.<a name="line.52"></a> +<span class="sourceLineNo">053</span> */<a name="line.53"></a> +<span class="sourceLineNo">054</span> TableName getName();<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> /**<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <p><a name="line.58"></a> +<span class="sourceLineNo">059</span> * The reference returned is not a copy, so any change made to it will affect this instance.<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> Configuration getConfiguration();<a name="line.61"></a> +<span class="sourceLineNo">062</span><a name="line.62"></a> +<span class="sourceLineNo">063</span> /**<a name="line.63"></a> +<span class="sourceLineNo">064</span> * Get timeout of each rpc request in this Table instance. It will be overridden by a more<a name="line.64"></a> +<span class="sourceLineNo">065</span> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @see #getReadRpcTimeout(TimeUnit)<a name="line.66"></a> +<span class="sourceLineNo">067</span> * @see #getWriteRpcTimeout(TimeUnit)<a name="line.67"></a> +<span class="sourceLineNo">068</span> * @param unit the unit of time the timeout to be represented in<a name="line.68"></a> +<span class="sourceLineNo">069</span> * @return rpc timeout in the specified time unit<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> long getRpcTimeout(TimeUnit unit);<a name="line.71"></a> +<span class="sourceLineNo">072</span><a name="line.72"></a> +<span class="sourceLineNo">073</span> /**<a name="line.73"></a> +<span class="sourceLineNo">074</span> * Get timeout of each rpc read request in this Table instance.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @param unit the unit of time the timeout to be represented in<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @return read rpc timeout in the specified time unit<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> long getReadRpcTimeout(TimeUnit unit);<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * Get timeout of each rpc write request in this Table instance.<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @param unit the unit of time the timeout to be represented in<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return write rpc timeout in the specified time unit<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> long getWriteRpcTimeout(TimeUnit unit);<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * Get timeout of each operation in Table instance.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @param unit the unit of time the timeout to be represented in<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @return operation rpc timeout in the specified time unit<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> long getOperationTimeout(TimeUnit unit);<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span> /**<a name="line.94"></a> +<span class="sourceLineNo">095</span> * Get the timeout of a single operation in a scan. It works like operation timeout for other<a name="line.95"></a> +<span class="sourceLineNo">096</span> * operations.<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @param unit the unit of time the timeout to be represented in<a name="line.97"></a> +<span class="sourceLineNo">098</span> * @return scan rpc timeout in the specified time unit<a name="line.98"></a> +<span class="sourceLineNo">099</span> */<a name="line.99"></a> +<span class="sourceLineNo">100</span> long getScanTimeout(TimeUnit unit);<a name="line.100"></a> +<span class="sourceLineNo">101</span><a name="line.101"></a> +<span class="sourceLineNo">102</span> /**<a name="line.102"></a> +<span class="sourceLineNo">103</span> * Test for the existence of columns in the table, as specified by the Get.<a name="line.103"></a> +<span class="sourceLineNo">104</span> * <p><a name="line.104"></a> +<span class="sourceLineNo">105</span> * This will return true if the Get matches one or more keys, false if not.<a name="line.105"></a> +<span class="sourceLineNo">106</span> * <p><a name="line.106"></a> +<span class="sourceLineNo">107</span> * This is a server-side call so it prevents any data from being transfered to the client.<a name="line.107"></a> +<span class="sourceLineNo">108</span> * @return true if the specified Get matches one or more keys, false if not. The return value will<a name="line.108"></a> +<span class="sourceLineNo">109</span> * be wrapped by a {@link CompletableFuture}.<a name="line.109"></a> +<span class="sourceLineNo">110</span> */<a name="line.110"></a> +<span class="sourceLineNo">111</span> default CompletableFuture<Boolean> exists(Get get) {<a name="line.111"></a> +<span class="sourceLineNo">112</span> return get(toCheckExistenceOnly(get)).thenApply(r -> r.getExists());<a name="line.112"></a> +<span class="sourceLineNo">113</span> }<a name="line.113"></a> +<span class="sourceLineNo">114</span><a name="line.114"></a> +<span class="sourceLineNo">115</span> /**<a name="line.115"></a> +<span class="sourceLineNo">116</span> * Extracts certain cells from a given row.<a name="line.116"></a> +<span class="sourceLineNo">117</span> * @param get The object that specifies what data to fetch and from which row.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @return The data coming from the specified row, if it exists. If the row specified doesn't<a name="line.118"></a> +<span class="sourceLineNo">119</span> * exist, the {@link Result} instance returned won't contain any<a name="line.119"></a> +<span class="sourceLineNo">120</span> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}. The<a name="line.120"></a> +<span class="sourceLineNo">121</span> * return value will be wrapped by a {@link CompletableFuture}.<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> CompletableFuture<Result> get(Get get);<a name="line.123"></a> +<span class="sourceLineNo">124</span><a name="line.124"></a> +<span class="sourceLineNo">125</span> /**<a name="line.125"></a> +<span class="sourceLineNo">126</span> * Puts some data to the table.<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @param put The data to put.<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.128"></a> +<span class="sourceLineNo">129</span> */<a name="line.129"></a> +<span class="sourceLineNo">130</span> CompletableFuture<Void> put(Put put);<a name="line.130"></a> +<span class="sourceLineNo">131</span><a name="line.131"></a> +<span class="sourceLineNo">132</span> /**<a name="line.132"></a> +<span class="sourceLineNo">133</span> * Deletes the specified cells/row.<a name="line.133"></a> +<span class="sourceLineNo">134</span> * @param delete The object that specifies what to delete.<a name="line.134"></a> +<span class="sourceLineNo">135</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.135"></a> +<span class="sourceLineNo">136</span> */<a name="line.136"></a> +<span class="sourceLineNo">137</span> CompletableFuture<Void> delete(Delete delete);<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> /**<a name="line.139"></a> +<span class="sourceLineNo">140</span> * Appends values to one or more columns within a single row.<a name="line.140"></a> +<span class="sourceLineNo">141</span> * <p><a name="line.141"></a> +<span class="sourceLineNo">142</span> * This operation does not appear atomic to readers. Appends are done under a single row lock, so<a name="line.142"></a> +<span class="sourceLineNo">143</span> * write operations to a row are synchronized, but readers do not take row locks so get and scan<a name="line.143"></a> +<span class="sourceLineNo">144</span> * operations can see this operation partially completed.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param append object that specifies the columns and amounts to be used for the increment<a name="line.145"></a> +<span class="sourceLineNo">146</span> * operations<a name="line.146"></a> +<span class="sourceLineNo">147</span> * @return values of columns after the append operation (maybe null). The return value will be<a name="line.147"></a> +<span class="sourceLineNo">148</span> * wrapped by a {@link CompletableFuture}.<a name="line.148"></a> +<span class="sourceLineNo">149</span> */<a name="line.149"></a> +<span class="sourceLineNo">150</span> CompletableFuture<Result> append(Append append);<a name="line.150"></a> +<span class="sourceLineNo">151</span><a name="line.151"></a> +<span class="sourceLineNo">152</span> /**<a name="line.152"></a> +<span class="sourceLineNo">153</span> * Increments one or more columns within a single row.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <p><a name="line.154"></a> +<span class="sourceLineNo">155</span> * This operation does not appear atomic to readers. Increments are done under a single row lock,<a name="line.155"></a> +<span class="sourceLineNo">156</span> * so write operations to a row are synchronized, but readers do not take row locks so get and<a name="line.156"></a> +<span class="sourceLineNo">157</span> * scan operations can see this operation partially completed.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @param increment object that specifies the columns and amounts to be used for the increment<a name="line.158"></a> +<span class="sourceLineNo">159</span> * operations<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @return values of columns after the increment. The return value will be wrapped by a<a name="line.160"></a> +<span class="sourceLineNo">161</span> * {@link CompletableFuture}.<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> CompletableFuture<Result> increment(Increment increment);<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> +<span class="sourceLineNo">168</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @param row The row that contains the cell to increment.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * @param family The column family of the cell to increment.<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.173"></a> +<span class="sourceLineNo">174</span> * {@link CompletableFuture}.<a name="line.174"></a> +<span class="sourceLineNo">175</span> */<a name="line.175"></a> +<span class="sourceLineNo">176</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.176"></a> +<span class="sourceLineNo">177</span> long amount) {<a name="line.177"></a> +<span class="sourceLineNo">178</span> return incrementColumnValue(row, family, qualifier, amount, Durability.SYNC_WAL);<a name="line.178"></a> +<span class="sourceLineNo">179</span> }<a name="line.179"></a> +<span class="sourceLineNo">180</span><a name="line.180"></a> +<span class="sourceLineNo">181</span> /**<a name="line.181"></a> +<span class="sourceLineNo">182</span> * Atomically increments a column value. If the column value already exists and is not a<a name="line.182"></a> +<span class="sourceLineNo">183</span> * big-endian long, this could throw an exception. If the column value does not yet exist it is<a name="line.183"></a> +<span class="sourceLineNo">184</span> * initialized to <code>amount</code> and written to the specified column.<a name="line.184"></a> +<span class="sourceLineNo">185</span> * <p><a name="line.185"></a> +<span class="sourceLineNo">186</span> * Setting durability to {@link Durability#SKIP_WAL} means that in a fail scenario you will lose<a name="line.186"></a> +<span class="sourceLineNo">187</span> * any increments that have not been flushed.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param row The row that contains the cell to increment.<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @param family The column family of the cell to increment.<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param durability The persistence guarantee for this increment.<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.193"></a> +<span class="sourceLineNo">194</span> * {@link CompletableFuture}.<a name="line.194"></a> +<span class="sourceLineNo">195</span> */<a name="line.195"></a> +<span class="sourceLineNo">196</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.196"></a> +<span class="sourceLineNo">197</span> long amount, Durability durability) {<a name="line.197"></a> +<span class="sourceLineNo">198</span> Preconditions.checkNotNull(row, "row is null");<a name="line.198"></a> +<span class="sourceLineNo">199</span> Preconditions.checkNotNull(family, "family is null");<a name="line.199"></a> +<span class="sourceLineNo">200</span> return increment(<a name="line.200"></a> +<span class="sourceLineNo">201</span> new Increment(row).addColumn(family, qualifier, amount).setDurability(durability))<a name="line.201"></a> +<span class="sourceLineNo">202</span> .thenApply(r -> Bytes.toLong(r.getValue(family, qualifier)));<a name="line.202"></a> +<span class="sourceLineNo">203</span> }<a name="line.203"></a> +<span class="sourceLineNo">204</span><a name="line.204"></a> +<span class="sourceLineNo">205</span> /**<a name="line.205"></a> +<span class="sourceLineNo">206</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.206"></a> +<span class="sourceLineNo">207</span> * adds the Put/Delete/RowMutations.<a name="line.207"></a> +<span class="sourceLineNo">208</span> * <p><a name="line.208"></a> +<span class="sourceLineNo">209</span> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * This is a fluent style API, the code is like:<a name="line.210"></a> +<span class="sourceLineNo">211</span> *<a name="line.211"></a> +<span class="sourceLineNo">212</span> * <pre><a name="line.212"></a> +<span class="sourceLineNo">213</span> * <code><a name="line.213"></a> +<span class="sourceLineNo">214</span> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put)<a name="line.214"></a> +<span class="sourceLineNo">215</span> * .thenAccept(succ -> {<a name="line.215"></a> +<span class="sourceLineNo">216</span> * if (succ) {<a name="line.216"></a> +<span class="sourceLineNo">217</span> * System.out.println("Check and put succeeded");<a name="line.217"></a> +<span class="sourceLineNo">218</span> * } else {<a name="line.218"></a> +<span class="sourceLineNo">219</span> * System.out.println("Check and put failed");<a name="line.219"></a> +<span class="sourceLineNo">220</span> * }<a name="line.220"></a> +<span class="sourceLineNo">221</span> * });<a name="line.221"></a> +<span class="sourceLineNo">222</span> * </code><a name="line.222"></a> +<span class="sourceLineNo">223</span> * </pre><a name="line.223"></a> +<span class="sourceLineNo">224</span> */<a name="line.224"></a> +<span class="sourceLineNo">225</span> CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family);<a name="line.225"></a> +<span class="sourceLineNo">226</span><a name="line.226"></a> +<span class="sourceLineNo">227</span> /**<a name="line.227"></a> +<span class="sourceLineNo">228</span> * A helper class for sending checkAndMutate request.<a name="line.228"></a> +<span class="sourceLineNo">229</span> */<a name="line.229"></a> +<span class="sourceLineNo">230</span> interface CheckAndMutateBuilder {<a name="line.230"></a> +<span class="sourceLineNo">231</span><a name="line.231"></a> +<span class="sourceLineNo">232</span> /**<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param qualifier column qualifier to check.<a name="line.233"></a> +<span class="sourceLineNo">234</span> */<a name="line.234"></a> +<span class="sourceLineNo">235</span> CheckAndMutateBuilder qualifier(byte[] qualifier);<a name="line.235"></a> +<span class="sourceLineNo">236</span><a name="line.236"></a> +<span class="sourceLineNo">237</span> /**<a name="line.237"></a> +<span class="sourceLineNo">238</span> * @param timeRange time range to check.<a name="line.238"></a> +<span class="sourceLineNo">239</span> */<a name="line.239"></a> +<span class="sourceLineNo">240</span> CheckAndMutateBuilder timeRange(TimeRange timeRange);<a name="line.240"></a> +<span class="sourceLineNo">241</span><a name="line.241"></a> +<span class="sourceLineNo">242</span> /**<a name="line.242"></a> +<span class="sourceLineNo">243</span> * Check for lack of column.<a name="line.243"></a> +<span class="sourceLineNo">244</span> */<a name="line.244"></a> +<span class="sourceLineNo">245</span> CheckAndMutateBuilder ifNotExists();<a name="line.245"></a> +<span class="sourceLineNo">246</span><a name="line.246"></a> +<span class="sourceLineNo">247</span> /**<a name="line.247"></a> +<span class="sourceLineNo">248</span> * Check for equality.<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @param value the expected value<a name="line.249"></a> +<span class="sourceLineNo">250</span> */<a name="line.250"></a> +<span class="sourceLineNo">251</span> default CheckAndMutateBuilder ifEquals(byte[] value) {<a name="line.251"></a> +<span class="sourceLineNo">252</span> return ifMatches(CompareOperator.EQUAL, value);<a name="line.252"></a> +<span class="sourceLineNo">253</span> }<a name="line.253"></a> +<span class="sourceLineNo">254</span><a name="line.254"></a> +<span class="sourceLineNo">255</span> /**<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @param compareOp comparison operator to use<a name="line.256"></a> +<span class="sourceLineNo">257</span> * @param value the expected value<a name="line.257"></a> +<span class="sourceLineNo">258</span> */<a name="line.258"></a> +<span class="sourceLineNo">259</span> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] value);<a name="line.259"></a> +<span class="sourceLineNo">260</span><a name="line.260"></a> +<span class="sourceLineNo">261</span> /**<a name="line.261"></a> +<span class="sourceLineNo">262</span> * @param put data to put if check succeeds<a name="line.262"></a> +<span class="sourceLineNo">263</span> * @return {@code true} if the new put was executed, {@code false} otherwise. The return value<a name="line.263"></a> +<span class="sourceLineNo">264</span> * will be wrapped by a {@link CompletableFuture}.<a name="line.264"></a> +<span class="sourceLineNo">265</span> */<a name="line.265"></a> +<span class="sourceLineNo">266</span> CompletableFuture<Boolean> thenPut(Put put);<a name="line.266"></a> +<span class="sourceLineNo">267</span><a name="line.267"></a> +<span class="sourceLineNo">268</span> /**<a name="line.268"></a> +<span class="sourceLineNo">269</span> * @param delete data to delete if check succeeds<a name="line.269"></a> +<span class="sourceLineNo">270</span> * @return {@code true} if the new delete was executed, {@code false} otherwise. The return<a name="line.270"></a> +<span class="sourceLineNo">271</span> * value will be wrapped by a {@link CompletableFuture}.<a name="line.271"></a> +<span class="sourceLineNo">272</span> */<a name="line.272"></a> +<span class="sourceLineNo">273</span> CompletableFuture<Boolean> thenDelete(Delete delete);<a name="line.273"></a> +<span class="sourceLineNo">274</span><a name="line.274"></a> +<span class="sourceLineNo">275</span> /**<a name="line.275"></a> +<span class="sourceLineNo">276</span> * @param mutation mutations to perform if check succeeds<a name="line.276"></a> +<span class="sourceLineNo">277</span> * @return true if the new mutation was executed, false otherwise. The return value will be<a name="line.277"></a> +<span class="sourceLineNo">278</span> * wrapped by a {@link CompletableFuture}.<a name="line.278"></a> +<span class="sourceLineNo">279</span> */<a name="line.279"></a> +<span class="sourceLineNo">280</span> CompletableFuture<Boolean> thenMutate(RowMutations mutation);<a name="line.280"></a> +<span class="sourceLineNo">281</span> }<a name="line.281"></a> +<span class="sourceLineNo">282</span><a name="line.282"></a> +<span class="sourceLineNo">283</span> /**<a name="line.283"></a> +<span class="sourceLineNo">284</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.284"></a> +<span class="sourceLineNo">285</span> * {@link Delete} are supported.<a name="line.285"></a> +<span class="sourceLineNo">286</span> * @param mutation object that specifies the set of mutations to perform atomically<a name="line.286"></a> +<span class="sourceLineNo">287</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.287"></a> +<span class="sourceLineNo">288</span> */<a name="line.288"></a> +<span class="sourceLineNo">289</span> CompletableFuture<Void> mutateRow(RowMutations mutation);<a name="line.289"></a> +<span class="sourceLineNo">290</span><a name="line.290"></a> +<span class="sourceLineNo">291</span> /**<a name="line.291"></a> +<span class="sourceLineNo">292</span> * The scan API uses the observer pattern.<a name="line.292"></a> +<span class="sourceLineNo">293</span> * @param scan A configured {@link Scan} object.<a name="line.293"></a> +<span class="sourceLineNo">294</span> * @param consumer the consumer used to receive results.<a name="line.294"></a> +<span class="sourceLineNo">295</span> * @see ScanResultConsumer<a name="line.295"></a> +<span class="sourceLineNo">296</span> * @see AdvancedScanResultConsumer<a name="line.296"></a> +<span class="sourceLineNo">297</span> */<a name="line.297"></a> +<span class="sourceLineNo">298</span> void scan(Scan scan, C consumer);<a name="line.298"></a> +<span class="sourceLineNo">299</span><a name="line.299"></a> +<span class="sourceLineNo">300</span> /**<a name="line.300"></a> +<span class="sourceLineNo">301</span> * Gets a scanner on the current table for the given family.<a name="line.301"></a> +<span class="sourceLineNo">302</span> * @param family The column family to scan.<a name="line.302"></a> +<span class="sourceLineNo">303</span> * @return A scanner.<a name="line.303"></a> +<span class="sourceLineNo">304</span> */<a name="line.304"></a> +<span class="sourceLineNo">305</span> default ResultScanner getScanner(byte[] family) {<a name="line.305"></a> +<span class="sourceLineNo">306</span> return getScanner(new Scan().addFamily(family));<a name="line.306"></a> +<span class="sourceLineNo">307</span> }<a name="line.307"></a> +<span class="sourceLineNo">308</span><a name="line.308"></a> +<span class="sourceLineNo">309</span> /**<a name="line.309"></a> +<span class="sourceLineNo">310</span> * Gets a scanner on the current table for the given family and qualifier.<a name="line.310"></a> +<span class="sourceLineNo">311</span> * @param family The column family to scan.<a name="line.311"></a> +<span class="sourceLineNo">312</span> * @param qualifier The column qualifier to scan.<a name="line.312"></a> +<span class="sourceLineNo">313</span> * @return A scanner.<a name="line.313"></a> +<span class="sourceLineNo">314</span> */<a name="line.314"></a> +<span class="sourceLineNo">315</span> default ResultScanner getScanner(byte[] family, byte[] qualifier) {<a name="line.315"></a> +<span class="sourceLineNo">316</span> return getScanner(new Scan().addColumn(family, qualifier));<a name="line.316"></a> +<span class="sourceLineNo">317</span> }<a name="line.317"></a> +<span class="sourceLineNo">318</span><a name="line.318"></a> +<span class="sourceLineNo">319</span> /**<a name="line.319"></a> +<span class="sourceLineNo">320</span> * Returns a scanner on the current table as specified by the {@link Scan} object.<a name="line.320"></a> +<span class="sourceLineNo">321</span> * @param scan A configured {@link Scan} object.<a name="line.321"></a> +<span class="sourceLineNo">322</span> * @return A scanner.<a name="line.322"></a> +<span class="sourceLineNo">323</span> */<a name="line.323"></a> +<span class="sourceLineNo">324</span> ResultScanner getScanner(Scan scan);<a name="line.324"></a> +<span class="sourceLineNo">325</span><a name="line.325"></a> +<span class="sourceLineNo">326</span> /**<a name="line.326"></a> +<span class="sourceLineNo">327</span> * Return all the results that match the given scan object.<a name="line.327"></a> +<span class="sourceLineNo">328</span> * <p><a name="line.328"></a> +<span class="sourceLineNo">329</span> * Notice that usually you should use this method with a {@link Scan} object that has limit set.<a name="line.329"></a> +<span class="sourceLineNo">330</span> * For example, if you want to get the closest row after a given row, you could do this:<a name="line.330"></a> +<span class="sourceLineNo">331</span> * <p><a name="line.331"></a> +<span class="sourceLineNo">332</span> *<a name="line.332"></a> +<span class="sourceLineNo">333</span> * <pre><a name="line.333"></a> +<span class="sourceLineNo">334</span> * <code><a name="line.334"></a> +<span class="sourceLineNo">335</span> * table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -> {<a name="line.335"></a> +<span class="sourceLineNo">336</span> * if (results.isEmpty()) {<a name="line.336"></a> +<span class="sourceLineNo">337</span> * System.out.println("No row after " + Bytes.toStringBinary(row));<a name="line.337"></a> +<span class="sourceLineNo">338</span> * } else {<a name="line.338"></a> +<span class="sourceLineNo">339</span> * System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is "<a name="line.339"></a> +<span class="sourceLineNo">340</span> * + Bytes.toStringBinary(results.stream().findFirst().get().getRow()));<a name="line.340"></a> +<span class="sourceLineNo">341</span> * }<a name="line.341"></a> +<span class="sourceLineNo">342</span> * });<a name="line.342"></a> +<span class="sourceLineNo">343</span> * </code><a name="line.343"></a> +<span class="sourceLineNo">344</span> * </pre><a name="line.344"></a> <span class="sourceLineNo">345</span> * <p><a name="line.345"></a> -<span class="sourceLineNo">346</span> * The scan metrics will be collected background if you enable it but you have no way to get it.<a name="line.346"></a> -<span class="sourceLineNo">347</span> * Usually you can get scan metrics from {@code ResultScanner}, or through<a name="line.347"></a> -<span class="sourceLineNo">348</span> * {@code ScanResultConsumer.onScanMetricsCreated} but this method only returns a list of results.<a name="line.348"></a> -<span class="sourceLineNo">349</span> * So if you really care about scan metrics then you'd better use other scan methods which return<a name="line.349"></a> -<span class="sourceLineNo">350</span> * a {@code ResultScanner} or let you pass in a {@code ScanResultConsumer}. There is no<a name="line.350"></a> -<span class="sourceLineNo">351</span> * performance difference between these scan methods so do not worry.<a name="line.351"></a> -<span class="sourceLineNo">352</span> * @param scan A configured {@link Scan} object. So if you use this method to fetch a really large<a name="line.352"></a> -<span class="sourceLineNo">353</span> * result set, it is likely to cause OOM.<a name="line.353"></a> -<span class="sourceLineNo">354</span> * @return The results of this small scan operation. The return value will be wrapped by a<a name="line.354"></a> -<span class="sourceLineNo">355</span> * {@link CompletableFuture}.<a name="line.355"></a> -<span class="sourceLineNo">356</span> */<a name="line.356"></a> -<span class="sourceLineNo">357</span> CompletableFuture<List<Result>> scanAll(Scan scan);<a name="line.357"></a> -<span class="sourceLineNo">358</span><a name="line.358"></a> -<span class="sourceLineNo">359</span> /**<a name="line.359"></a> -<span class="sourceLineNo">360</span> * Test for the existence of columns in the table, as specified by the Gets.<a name="line.360"></a> -<span class="sourceLineNo">361</span> * <p><a name="line.361"></a> -<span class="sourceLineNo">362</span> * This will return a list of booleans. Each value will be true if the related Get matches one or<a name="line.362"></a> -<span class="sourceLineNo">363</span> * more keys, false if not.<a name="line.363"></a> -<span class="sourceLineNo">364</span> * <p><a name="line.364"></a> -<span class="sourceLineNo">365</span> * This is a server-side call so it prevents any data from being transferred to the client.<a name="line.365"></a> -<span class="sourceLineNo">366</span> * @param gets the Gets<a name="line.366"></a> -<span class="sourceLineNo">367</span> * @return A list of {@link CompletableFuture}s that represent the existence for each get.<a name="line.367"></a> -<span class="sourceLineNo">368</span> */<a name="line.368"></a> -<span class="sourceLineNo">369</span> default List<CompletableFuture<Boolean>> exists(List<Get> gets) {<a name="line.369"></a> -<span class="sourceLineNo">370</span> return get(toCheckExistenceOnly(gets)).stream()<a name="line.370"></a> -<span class="sourceLineNo">371</span> .<CompletableFuture<Boolean>> map(f -> f.thenApply(r -> r.getExists())).collect(toList());<a name="line.371"></a> -<span class="sourceLineNo">372</span> }<a name="line.372"></a> -<span class="sourceLineNo">373</span><a name="line.373"></a> -<span class="sourceLineNo">374</span> /**<a name="line.374"></a> -<span class="sourceLineNo">375</span> * A simple version for batch exists. It will fail if there are any failures and you will get the<a name="line.375"></a> -<span class="sourceLineNo">376</span> * whole result boolean list at once if the operation is succeeded.<a name="line.376"></a> -<span class="sourceLineNo">377</span> * @param gets the Gets<a name="line.377"></a> -<span class="sourceLineNo">378</span> * @return A {@link CompletableFuture} that wrapper the result boolean list.<a name="line.378"></a> -<span class="sourceLineNo">379</span> */<a name="line.379"></a> -<span class="sourceLineNo">380</span> default CompletableFuture<List<Boolean>> existsAll(List<Get> gets) {<a name="line.380"></a> -<span class="sourceLineNo">381</span> return allOf(exists(gets));<a name="line.381"></a> -<span class="sourceLineNo">382</span> }<a name="line.382"></a> -<span class="sourceLineNo">383</span><a name="line.383"></a> -<span class="sourceLineNo">384</span> /**<a name="line.384"></a> -<span class="sourceLineNo">385</span> * Extracts certain cells from the given rows, in batch.<a name="line.385"></a> -<span class="sourceLineNo">386</span> * <p><a name="line.386"></a> -<span class="sourceLineNo">387</span> * Notice that you may not get all the results with this function, which means some of the<a name="line.387"></a> -<span class="sourceLineNo">388</span> * returned {@link CompletableFuture}s may succeed while some of the other returned<a name="line.388"></a> -<span class="sourceLineNo">389</span> * {@link CompletableFuture}s may fail.<a name="line.389"></a> -<span class="sourceLineNo">390</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.390"></a> -<span class="sourceLineNo">391</span> * @return A list of {@link CompletableFuture}s that represent the result for each get.<a name="line.391"></a> -<span class="sourceLineNo">392</span> */<a name="line.392"></a> -<span class="sourceLineNo">393</span> List<CompletableFuture<Result>> get(List<Get> gets);<a name="line.393"></a> -<span class="sourceLineNo">394</span><a name="line.394"></a> -<span class="sourceLineNo">395</span> /**<a name="line.395"></a> -<span class="sourceLineNo">396</span> * A simple version for batch get. It will fail if there are any failures and you will get the<a name="line.396"></a> -<span class="sourceLineNo">397</span> * whole result list at once if the operation is succeeded.<a name="line.397"></a> -<span class="sourceLineNo">398</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.398"></a> -<span class="sourceLineNo">399</span> * @return A {@link CompletableFuture} that wrapper the result list.<a name="line.399"></a> -<span class="sourceLineNo">400</span> */<a name="line.400"></a> -<span class="sourceLineNo">401</span> default CompletableFuture<List<Result>> getAll(List<Get> gets) {<a name="line.401"></a> -<span class="sourceLineNo">402</span> return allOf(get(gets));<a name="line.402"></a> -<span class="sourceLineNo">403</span> }<a name="line.403"></a> -<span class="sourceLineNo">404</span><a name="line.404"></a> -<span class="sourceLineNo">405</span> /**<a name="line.405"></a> -<span class="sourceLineNo">406</span> * Puts some data in the table, in batch.<a name="line.406"></a> -<span class="sourceLineNo">407</span> * @param puts The list of mutations to apply.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * @return A list of {@link CompletableFuture}s that represent the result for each put.<a name="line.408"></a> -<span class="sourceLineNo">409</span> */<a name="line.409"></a> -<span class="sourceLineNo">410</span> List<CompletableFuture<Void>> put(List<Put> puts);<a name="line.410"></a> -<span class="sourceLineNo">411</span><a name="line.411"></a> -<span class="sourceLineNo">412</span> /**<a name="line.412"></a> -<span class="sourceLineNo">413</span> * A simple version of batch put. It will fail if there are any failures.<a name="line.413"></a> -<span class="sourceLineNo">414</span> * @param puts The list of mutations to apply.<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.415"></a> -<span class="sourceLineNo">416</span> */<a name="line.416"></a> -<span class="sourceLineNo">417</span> default CompletableFuture<Void> putAll(List<Put> puts) {<a name="line.417"></a> -<span class="sourceLineNo">418</span> return allOf(put(puts)).thenApply(r -> null);<a name="line.418"></a> -<span class="sourceLineNo">419</span> }<a name="line.419"></a> -<span class="sourceLineNo">420</span><a name="line.420"></a> -<span class="sourceLineNo">421</span> /**<a name="line.421"></a> -<span class="sourceLineNo">422</span> * Deletes the specified cells/rows in bulk.<a name="line.422"></a> -<span class="sourceLineNo">423</span> * @param deletes list of things to delete.<a name="line.423"></a> -<span class="sourceLineNo">424</span> * @return A list of {@link CompletableFuture}s that represent the result for each delete.<a name="line.424"></a> -<span class="sourceLineNo">425</span> */<a name="line.425"></a> -<span class="sourceLineNo">426</span> List<CompletableFuture<Void>> delete(List<Delete> deletes);<a name="line.426"></a> -<span class="sourceLineNo">427</span><a name="line.427"></a> -<span class="sourceLineNo">428</span> /**<a name="line.428"></a> -<span class="sourceLineNo">429</span> * A simple version of batch delete. It will fail if there are any failures.<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param deletes list of things to delete.<a name="line.430"></a> -<span class="sourceLineNo">431</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.431"></a> -<span class="sourceLineNo">432</span> */<a name="line.432"></a> -<span class="sourceLineNo">433</span> default CompletableFuture<Void> deleteAll(List<Delete> deletes) {<a name="line.433"></a> -<span class="sourceLineNo">434</span> return allOf(delete(deletes)).thenApply(r -> null);<a name="line.434"></a> -<span class="sourceLineNo">435</span> }<a name="line.435"></a> -<span class="sourceLineNo">436</span><a name="line.436"></a> -<span class="sourceLineNo">437</span> /**<a name="line.437"></a> -<span class="sourceLineNo">438</span> * Method that does a batch call on Deletes, Gets, Puts, Increments, Appends and RowMutations. The<a name="line.438"></a> -<span class="sourceLineNo">439</span> * ordering of execution of the actions is not defined. Meaning if you do a Put and a Get in the<a name="line.439"></a> -<span class="sourceLineNo">440</span> * same {@link #batch} call, you will not necessarily be guaranteed that the Get returns what the<a name="line.440"></a> -<span class="sourceLineNo">441</span> * Put had put.<a name="line.441"></a> -<span class="sourceLineNo">442</span> * @param actions list of Get, Put, Delete, Increment, Append, and RowMutations objects<a name="line.442"></a> -<span class="sourceLineNo">443</span> * @return A list of {@link CompletableFuture}s that represent the result for each action.<a name="line.443"></a> -<span class="sourceLineNo">444</span> */<a name="line.444"></a> -<span class="sourceLineNo">445</span> <T> List<CompletableFuture<T>> batch(List<? extends Row> actions);<a name="line.445"></a> -<span class="sourceLineNo">446</span><a name="line.446"></a> -<span class="sourceLineNo">447</span> /**<a name="line.447"></a> -<span class="sourceLineNo">448</span> * A simple version of batch. It will fail if there are any failures and you will get the whole<a name="line.448"></a> -<span class="sourceLineNo">449</span> * result list at once if the operation is succeeded.<a name="line.449"></a> -<span class="sourceLineNo">450</span> * @param actions list of Get, Put, Delete, Increment, Append and RowMutations objects<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @return A list of the result for the actions. Wrapped by a {@link CompletableFuture}.<a name="line.451"></a> -<span class="sourceLineNo">452</span> */<a name="line.452"></a> -<span class="sourceLineNo">453</span> default <T> CompletableFuture<List<T>> batchAll(List<? extends Row> actions) {<a name="line.453"></a> -<span class="sourceLineNo">454</span> return allOf(batch(actions));<a name="line.454"></a> -<span class="sourceLineNo">455</span> }<a name="line.455"></a> -<span class="sourceLineNo">456</span><a name="line.456"></a> -<span class="sourceLineNo">457</span> /**<a name="line.457"></a> -<span class="sourceLineNo">458</span> * Execute the given coprocessor call on the region which contains the given {@code row}.<a name="line.458"></a> -<span class="sourceLineNo">459</span> * <p><a name="line.459"></a> -<span class="sourceLineNo">460</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.460"></a> -<span class="sourceLineNo">461</span> * one line lambda expression, like:<a name="line.461"></a> -<span class="sourceLineNo">462</span> *<a name="line.462"></a> -<span class="sourceLineNo">463</span> * <pre><a name="line.463"></a> -<span class="sourceLineNo">464</span> * <code><a name="line.464"></a> -<span class="sourceLineNo">465</span> * channel -> xxxService.newStub(channel)<a name="line.465"></a> -<span class="sourceLineNo">466</span> * </code><a name="line.466"></a> -<span class="sourceLineNo">467</span> * </pre><a name="line.467"></a> -<span class="sourceLineNo">468</span> *<a name="line.468"></a> -<span class="sourceLineNo">469</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.469"></a> -<span class="sourceLineNo">470</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.470"></a> -<span class="sourceLineNo">471</span> * {@link ServiceCaller} for more details.<a name="line.471"></a> -<span class="sourceLineNo">472</span> * @param row The row key used to identify the remote region location<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @param <S> the type of the asynchronous stub<a name="line.473"></a> -<span class="sourceLineNo">474</span> * @param <R> the type of the return value<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.475"></a> -<span class="sourceLineNo">476</span> * @see ServiceCaller<a name="line.476"></a> -<span class="sourceLineNo">477</span> */<a name="line.477"></a> -<span class="sourceLineNo">478</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.478"></a> -<span class="sourceLineNo">479</span> ServiceCaller<S, R> callable, byte[] row);<a name="line.479"></a> -<span class="sourceLineNo">480</span><a name="line.480"></a> -<span class="sourceLineNo">481</span> /**<a name="line.481"></a> -<span class="sourceLineNo">482</span> * The callback when we want to execute a coprocessor call on a range of regions.<a name="line.482"></a> -<span class="sourceLineNo">483</span> * <p><a name="line.483"></a> -<span class="sourceLineNo">484</span> * As the locating itself also takes some time, the implementation may want to send rpc calls on<a name="line.484"></a> -<span class="sourceLineNo">485</span> * the fly, which means we do not know how many regions we have when we get the return value of<a name="line.485"></a> -<span class="sourceLineNo">486</span> * the rpc calls, so we need an {@link #onComplete()} which is used to tell you that we have<a name="line.486"></a> -<span class="sourceLineNo">487</span> * passed all the return values to you(through the {@link #onRegionComplete(RegionInfo, Object)}<a name="line.487"></a> -<span class="sourceLineNo">488</span> * or {@link #onRegionError(RegionInfo, Throwable)} calls), i.e, there will be no<a name="line.488"></a> -<span class="sourceLineNo">489</span> * {@link #onRegionComplete(RegionInfo, Object)} or {@link #onRegionError(RegionInfo, Throwable)}<a name="line.489"></a> -<span class="sourceLineNo">490</span> * calls in the future.<a name="line.490"></a> -<span class="sourceLineNo">491</span> * <p><a name="line.491"></a> -<span class="sourceLineNo">492</span> * Here is a pseudo code to describe a typical implementation of a range coprocessor service<a name="line.492"></a> -<span class="sourceLineNo">493</span> * method to help you better understand how the {@link CoprocessorCallback} will be called. The<a name="line.493"></a> -<span class="sourceLineNo">494</span> * {@code callback} in the pseudo code is our {@link CoprocessorCallback}. And notice that the<a name="line.494"></a> -<span class="sourceLineNo">495</span> * {@code whenComplete} is {@code CompletableFuture.whenComplete}.<a name="line.495"></a> -<span class="sourceLineNo">496</span> *<a name="line.496"></a> -<span class="sourceLineNo">497</span> * <pre><a name="line.497"></a> -<span class="sourceLineNo">498</span> * locateThenCall(byte[] row) {<a name="line.498"></a> -<span class="sourceLineNo">499</span> * locate(row).whenComplete((location, locateError) -> {<a name="line.499"></a> -<span class="sourceLineNo">500</span> * if (locateError != null) {<a name="line.500"></a> -<span class="sourceLineNo">501</span> * callback.onError(locateError);<a name="line.501"></a> -<span class="sourceLineNo">502</span> * return;<a name="line.502"></a> -<span class="sourceLineNo">503</span> * }<a name="line.503"></a> -<span class="sourceLineNo">504</span> * incPendingCall();<a name="line.504"></a> -<span class="sourceLineNo">505</span> * region = location.getRegion();<a name="line.505"></a> -<span class="sourceLineNo">506</span> * if (region.getEndKey() > endKey) {<a name="line.506"></a> -<span class="sourceLineNo">507</span> * locateEnd = true;<a name="line.507"></a> -<span class="sourceLineNo">508</span> * } else {<a name="line.508"></a> -<span class="sourceLineNo">509</span> * locateThenCall(region.getEndKey());<a name="line.509"></a> -<span class="sourceLineNo">510</span> * }<a name="line.510"></a> -<span class="sourceLineNo">511</span> * sendCall().whenComplete((resp, error) -> {<a name="line.511"></a> -<span class="sourceLineNo">512</span> * if (error != null) {<a name="line.512"></a> -<span class="sourceLineNo">513</span> * callback.onRegionError(region, error);<a name="line.513"></a> -<span class="sourceLineNo">514</span> * } else {<a name="line.514"></a> -<span class="sourceLineNo">515</span> * callback.onRegionComplete(region, resp);<a name="line.515"></a> -<span class="sourceLineNo">516</span> * }<a name="line.516"></a> -<span class="sourceLineNo">517</span> * if (locateEnd && decPendingCallAndGet() == 0) {<a name="line.517"></a> -<span class="sourceLineNo">518</span> * callback.onComplete();<a name="line.518"></a> -<span class="sourceLineNo">519</span> * }<a name="line.519"></a> -<span class="sourceLineNo">520</span> * });<a name="line.520"></a> -<span class="sourceLineNo">521</span> * });<a name="line.521"></a> -<span class="sourceLineNo">522</span> * }<a name="line.522"></a> -<span class="sourceLineNo">523</span> * </pre><a name="line.523"></a> -<span class="sourceLineNo">524</span> */<a name="line.524"></a> -<span class="sourceLineNo">525</span> @InterfaceAudience.Public<a name="line.525"></a> -<span class="sourceLineNo">526</span> interface CoprocessorCallback<R> {<a name="line.526"></a> -<span class="sourceLineNo">527</span><a name="line.527"></a> -<span class="sourceLineNo">528</span> /**<a name="line.528"></a> -<span class="sourceLineNo">529</span> * @param region the region that the response belongs to<a name="line.529"></a> -<span class="sourceLineNo">530</span> * @param resp the response of the coprocessor call<a name="line.530"></a> -<span class="sourceLineNo">531</span> */<a name="line.531"></a> -<span class="sourceLineNo">532</span> void onRegionComplete(RegionInfo region, R resp);<a name="line.532"></a> -<span class="sourceLineNo">533</span><a name="line.533"></a> -<span class="sourceLineNo">534</span> /**<a name="line.534"></a> -<span class="sourceLineNo">535</span> * @param region the region that the error belongs to<a name="line.535"></a> -<span class="sourceLineNo">536</span> * @param error the response error of the coprocessor call<a name="line.536"></a> -<span class="sourceLineNo">537</span> */<a name="line.537"></a> -<span class="sourceLineNo">538</span> void onRegionError(RegionInfo region, Throwable error);<a name="line.538"></a> -<span class="sourceLineNo">539</span><a name="line.539"></a> -<span class="sourceLineNo">540</span> /**<a name="line.540"></a> -<span class="sourceLineNo">541</span> * Indicate that all responses of the regions have been notified by calling<a name="line.541"></a> -<span class="sourceLineNo">542</span> * {@link #onRegionComplete(RegionInfo, Object)} or<a name="line.542"></a> -<span class="sourceLineNo">543</span> * {@link #onRegionError(RegionInfo, Throwable)}.<a name="line.543"></a> -<span class="sourceLineNo">544</span> */<a name="line.544"></a> -<span class="sourceLineNo">545</span> void onComplete();<a name="line.545"></a> -<span class="sourceLineNo">546</span><a name="line.546"></a> -<span class="sourceLineNo">547</span> /**<a name="line.547"></a> -<span class="sourceLineNo">548</span> * Indicate that we got an error which does not belong to any regions. Usually a locating error.<a name="line.548"></a> -<span class="sourceLineNo">549</span> */<a name="line.549"></a> -<span class="sourceLineNo">550</span> void onError(Throwable error);<a name="line.550"></a> -<span class="sourceLineNo">551</span> }<a name="line.551"></a> -<span class="sourceLineNo">552</span><a name="line.552"></a> -<span class="sourceLineNo">553</span> /**<a name="line.553"></a> -<span class="sourceLineNo">554</span> * Helper class for sending coprocessorService request that executes a coprocessor call on regions<a name="line.554"></a> -<span class="sourceLineNo">555</span> * which are covered by a range.<a name="line.555"></a> -<span class="sourceLineNo">556</span> * <p><a name="line.556"></a> -<span class="sourceLineNo">557</span> * If {@code fromRow} is not specified the selection will start with the first table region. If<a name="line.557"></a> -<span class="sourceLineNo">558</span> * {@code toRow} is not specified the selection will continue through the last table region.<a name="line.558"></a> -<span class="sourceLineNo">559</span> * @param <S> the type of the protobuf Service you want to call.<a name="line.559"></a> -<span class="sourceLineNo">560</span> * @param <R> the type of the return value.<a name="line.560"></a> -<span class="sourceLineNo">561</span> */<a name="line.561"></a> -<span class="sourceLineNo">562</span> interface CoprocessorServiceBuilder<S, R> {<a name="line.562"></a> -<span class="sourceLineNo">563</span><a name="line.563"></a> -<span class="sourceLineNo">564</span> /**<a name="line.564"></a> -<span class="sourceLineNo">565</span> * @param startKey start region selection with region containing this row, inclusive.<a name="line.565"></a> -<span class="sourceLineNo">566</span> */<a name="line.566"></a> -<span class="sourceLineNo">567</span> default CoprocessorServiceBuilder<S, R> fromRow(byte[] startKey) {<a name="line.567"></a> -<span class="sourceLineNo">568</span> return fromRow(startKey, true);<a name="line.568"></a> -<span class="sourceLineNo">569</span> }<a name="line.569"></a> -<span class="sourceLineNo">570</span><a name="line.570"></a> -<span class="sourceLineNo">571</span> /**<a name="line.571"></a> -<span class="sourceLineNo">572</span> * @param startKey start region selection with region containing this row<a name="line.572"></a> -<span class="sourceLineNo">573</span> * @param inclusive whether to include the startKey<a name="line.573"></a> -<span class="sourceLineNo">574</span> */<a name="line.574"></a> -<span class="sourceLineNo">575</span> CoprocessorServiceBuilder<S, R> fromRow(byte[] startKey, boolean inclusive);<a name="line.575"></a> -<span class="s
<TRUNCATED>