http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html index f5f24c5..40ba9ea 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html @@ -71,345 +71,355 @@ <span class="sourceLineNo">063</span> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.<a name="line.63"></a> <span class="sourceLineNo">064</span> * @see #getReadRpcTimeout(TimeUnit)<a name="line.64"></a> <span class="sourceLineNo">065</span> * @see #getWriteRpcTimeout(TimeUnit)<a name="line.65"></a> -<span class="sourceLineNo">066</span> */<a name="line.66"></a> -<span class="sourceLineNo">067</span> long getRpcTimeout(TimeUnit unit);<a name="line.67"></a> -<span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> /**<a name="line.69"></a> -<span class="sourceLineNo">070</span> * Get timeout of each rpc read request in this Table instance.<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> long getReadRpcTimeout(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 write request in this Table instance.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> long getWriteRpcTimeout(TimeUnit unit);<a name="line.77"></a> -<span class="sourceLineNo">078</span><a name="line.78"></a> -<span class="sourceLineNo">079</span> /**<a name="line.79"></a> -<span class="sourceLineNo">080</span> * Get timeout of each operation in Table instance.<a name="line.80"></a> -<span class="sourceLineNo">081</span> */<a name="line.81"></a> -<span class="sourceLineNo">082</span> long getOperationTimeout(TimeUnit unit);<a name="line.82"></a> -<span class="sourceLineNo">083</span><a name="line.83"></a> -<span class="sourceLineNo">084</span> /**<a name="line.84"></a> -<span class="sourceLineNo">085</span> * Get the timeout of a single operation in a scan. It works like operation timeout for other<a name="line.85"></a> -<span class="sourceLineNo">086</span> * operations.<a name="line.86"></a> -<span class="sourceLineNo">087</span> */<a name="line.87"></a> -<span class="sourceLineNo">088</span> long getScanTimeout(TimeUnit unit);<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> /**<a name="line.90"></a> -<span class="sourceLineNo">091</span> * Test for the existence of columns in the table, as specified by the Get.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * <p><a name="line.92"></a> -<span class="sourceLineNo">093</span> * This will return true if the Get matches one or more keys, false if not.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * <p><a name="line.94"></a> -<span class="sourceLineNo">095</span> * This is a server-side call so it prevents any data from being transfered to the client.<a name="line.95"></a> -<span class="sourceLineNo">096</span> * @return true if the specified Get matches one or more keys, false if not. The return value will<a name="line.96"></a> -<span class="sourceLineNo">097</span> * be wrapped by a {@link CompletableFuture}.<a name="line.97"></a> -<span class="sourceLineNo">098</span> */<a name="line.98"></a> -<span class="sourceLineNo">099</span> default CompletableFuture<Boolean> exists(Get get) {<a name="line.99"></a> -<span class="sourceLineNo">100</span> return get(toCheckExistenceOnly(get)).thenApply(r -> r.getExists());<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> /**<a name="line.103"></a> -<span class="sourceLineNo">104</span> * Extracts certain cells from a given row.<a name="line.104"></a> -<span class="sourceLineNo">105</span> * @param get The object that specifies what data to fetch and from which row.<a name="line.105"></a> -<span class="sourceLineNo">106</span> * @return The data coming from the specified row, if it exists. If the row specified doesn't<a name="line.106"></a> -<span class="sourceLineNo">107</span> * exist, the {@link Result} instance returned won't contain any<a name="line.107"></a> -<span class="sourceLineNo">108</span> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}. The<a name="line.108"></a> -<span class="sourceLineNo">109</span> * return value will 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> CompletableFuture<Result> get(Get get);<a name="line.111"></a> +<span class="sourceLineNo">066</span> * @param unit the unit of time the timeout to be represented in<a name="line.66"></a> +<span class="sourceLineNo">067</span> * @return rpc timeout in the specified time unit<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> long getRpcTimeout(TimeUnit unit);<a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> /**<a name="line.71"></a> +<span class="sourceLineNo">072</span> * Get timeout of each rpc read request in this Table instance.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param unit the unit of time the timeout to be represented in<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @return read rpc timeout in the specified time unit<a name="line.74"></a> +<span class="sourceLineNo">075</span> */<a name="line.75"></a> +<span class="sourceLineNo">076</span> long getReadRpcTimeout(TimeUnit unit);<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> /**<a name="line.78"></a> +<span class="sourceLineNo">079</span> * Get timeout of each rpc write request in this Table instance.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * @param unit the unit of time the timeout to be represented in<a name="line.80"></a> +<span class="sourceLineNo">081</span> * @return write rpc timeout in the specified time unit<a name="line.81"></a> +<span class="sourceLineNo">082</span> */<a name="line.82"></a> +<span class="sourceLineNo">083</span> long getWriteRpcTimeout(TimeUnit unit);<a name="line.83"></a> +<span class="sourceLineNo">084</span><a name="line.84"></a> +<span class="sourceLineNo">085</span> /**<a name="line.85"></a> +<span class="sourceLineNo">086</span> * Get timeout of each operation in Table instance.<a name="line.86"></a> +<span class="sourceLineNo">087</span> * @param unit the unit of time the timeout to be represented in<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @return operation rpc timeout in the specified time unit<a name="line.88"></a> +<span class="sourceLineNo">089</span> */<a name="line.89"></a> +<span class="sourceLineNo">090</span> long getOperationTimeout(TimeUnit unit);<a name="line.90"></a> +<span class="sourceLineNo">091</span><a name="line.91"></a> +<span class="sourceLineNo">092</span> /**<a name="line.92"></a> +<span class="sourceLineNo">093</span> * Get the timeout of a single operation in a scan. It works like operation timeout for other<a name="line.93"></a> +<span class="sourceLineNo">094</span> * operations.<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @param unit the unit of time the timeout to be represented in<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @return scan rpc timeout in the specified time unit<a name="line.96"></a> +<span class="sourceLineNo">097</span> */<a name="line.97"></a> +<span class="sourceLineNo">098</span> long getScanTimeout(TimeUnit unit);<a name="line.98"></a> +<span class="sourceLineNo">099</span><a name="line.99"></a> +<span class="sourceLineNo">100</span> /**<a name="line.100"></a> +<span class="sourceLineNo">101</span> * Test for the existence of columns in the table, as specified by the Get.<a name="line.101"></a> +<span class="sourceLineNo">102</span> * <p><a name="line.102"></a> +<span class="sourceLineNo">103</span> * This will return true if the Get matches one or more keys, false if not.<a name="line.103"></a> +<span class="sourceLineNo">104</span> * <p><a name="line.104"></a> +<span class="sourceLineNo">105</span> * This is a server-side call so it prevents any data from being transfered to the client.<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @return true if the specified Get matches one or more keys, false if not. The return value will<a name="line.106"></a> +<span class="sourceLineNo">107</span> * be wrapped by a {@link CompletableFuture}.<a name="line.107"></a> +<span class="sourceLineNo">108</span> */<a name="line.108"></a> +<span class="sourceLineNo">109</span> default CompletableFuture<Boolean> exists(Get get) {<a name="line.109"></a> +<span class="sourceLineNo">110</span> return get(toCheckExistenceOnly(get)).thenApply(r -> r.getExists());<a name="line.110"></a> +<span class="sourceLineNo">111</span> }<a name="line.111"></a> <span class="sourceLineNo">112</span><a name="line.112"></a> <span class="sourceLineNo">113</span> /**<a name="line.113"></a> -<span class="sourceLineNo">114</span> * Puts some data to the table.<a name="line.114"></a> -<span class="sourceLineNo">115</span> * @param put The data to put.<a name="line.115"></a> -<span class="sourceLineNo">116</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.116"></a> -<span class="sourceLineNo">117</span> */<a name="line.117"></a> -<span class="sourceLineNo">118</span> CompletableFuture<Void> put(Put put);<a name="line.118"></a> -<span class="sourceLineNo">119</span><a name="line.119"></a> -<span class="sourceLineNo">120</span> /**<a name="line.120"></a> -<span class="sourceLineNo">121</span> * Deletes the specified cells/row.<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @param delete The object that specifies what to delete.<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> CompletableFuture<Void> delete(Delete delete);<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> /**<a name="line.127"></a> -<span class="sourceLineNo">128</span> * Appends values to one or more columns within a single row.<a name="line.128"></a> -<span class="sourceLineNo">129</span> * <p><a name="line.129"></a> -<span class="sourceLineNo">130</span> * This operation does not appear atomic to readers. Appends are done under a single row lock, so<a name="line.130"></a> -<span class="sourceLineNo">131</span> * write operations to a row are synchronized, but readers do not take row locks so get and scan<a name="line.131"></a> -<span class="sourceLineNo">132</span> * operations can see this operation partially completed.<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @param append object that specifies the columns and amounts to be used for the increment<a name="line.133"></a> -<span class="sourceLineNo">134</span> * operations<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @return values of columns after the append operation (maybe null). The return value will be<a name="line.135"></a> -<span class="sourceLineNo">136</span> * wrapped by a {@link CompletableFuture}.<a name="line.136"></a> -<span class="sourceLineNo">137</span> */<a name="line.137"></a> -<span class="sourceLineNo">138</span> CompletableFuture<Result> append(Append append);<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> * Increments 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. Increments are done under a single row lock,<a name="line.143"></a> -<span class="sourceLineNo">144</span> * so write operations to a row are synchronized, but readers do not take row locks so get and<a name="line.144"></a> -<span class="sourceLineNo">145</span> * scan operations can see this operation partially completed.<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @param increment 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 increment. The return value will be wrapped by a<a name="line.148"></a> -<span class="sourceLineNo">149</span> * {@link CompletableFuture}.<a name="line.149"></a> -<span class="sourceLineNo">150</span> */<a name="line.150"></a> -<span class="sourceLineNo">151</span> CompletableFuture<Result> increment(Increment increment);<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> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.154"></a> -<span class="sourceLineNo">155</span> * <p><a name="line.155"></a> -<span class="sourceLineNo">156</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param row The row that contains the cell to increment.<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @param family The column family of the cell to increment.<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.159"></a> -<span class="sourceLineNo">160</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @return The new value, post 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> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.164"></a> -<span class="sourceLineNo">165</span> long amount) {<a name="line.165"></a> -<span class="sourceLineNo">166</span> return incrementColumnValue(row, family, qualifier, amount, Durability.SYNC_WAL);<a name="line.166"></a> -<span class="sourceLineNo">167</span> }<a name="line.167"></a> -<span class="sourceLineNo">168</span><a name="line.168"></a> -<span class="sourceLineNo">169</span> /**<a name="line.169"></a> -<span class="sourceLineNo">170</span> * Atomically increments a column value. If the column value already exists and is not a<a name="line.170"></a> -<span class="sourceLineNo">171</span> * big-endian long, this could throw an exception. If the column value does not yet exist it is<a name="line.171"></a> -<span class="sourceLineNo">172</span> * initialized to <code>amount</code> and written to the specified column.<a name="line.172"></a> -<span class="sourceLineNo">173</span> * <p><a name="line.173"></a> -<span class="sourceLineNo">174</span> * Setting durability to {@link Durability#SKIP_WAL} means that in a fail scenario you will lose<a name="line.174"></a> -<span class="sourceLineNo">175</span> * any increments that have not been flushed.<a name="line.175"></a> -<span class="sourceLineNo">176</span> * @param row The row that contains the cell to increment.<a name="line.176"></a> -<span class="sourceLineNo">177</span> * @param family The column family of the cell to increment.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @param durability The persistence guarantee for this increment.<a name="line.180"></a> -<span class="sourceLineNo">181</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.181"></a> -<span class="sourceLineNo">182</span> * {@link CompletableFuture}.<a name="line.182"></a> -<span class="sourceLineNo">183</span> */<a name="line.183"></a> -<span class="sourceLineNo">184</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.184"></a> -<span class="sourceLineNo">185</span> long amount, Durability durability) {<a name="line.185"></a> -<span class="sourceLineNo">186</span> Preconditions.checkNotNull(row, "row is null");<a name="line.186"></a> -<span class="sourceLineNo">187</span> Preconditions.checkNotNull(family, "family is null");<a name="line.187"></a> -<span class="sourceLineNo">188</span> return increment(<a name="line.188"></a> -<span class="sourceLineNo">189</span> new Increment(row).addColumn(family, qualifier, amount).setDurability(durability))<a name="line.189"></a> -<span class="sourceLineNo">190</span> .thenApply(r -> Bytes.toLong(r.getValue(family, qualifier)));<a name="line.190"></a> -<span class="sourceLineNo">191</span> }<a name="line.191"></a> -<span class="sourceLineNo">192</span><a name="line.192"></a> -<span class="sourceLineNo">193</span> /**<a name="line.193"></a> -<span class="sourceLineNo">194</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.194"></a> -<span class="sourceLineNo">195</span> * adds the Put/Delete/RowMutations.<a name="line.195"></a> -<span class="sourceLineNo">196</span> * <p><a name="line.196"></a> -<span class="sourceLineNo">197</span> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.<a name="line.197"></a> -<span class="sourceLineNo">198</span> * This is a fluent style API, the code is like:<a name="line.198"></a> -<span class="sourceLineNo">199</span> *<a name="line.199"></a> -<span class="sourceLineNo">200</span> * <pre><a name="line.200"></a> -<span class="sourceLineNo">201</span> * <code><a name="line.201"></a> -<span class="sourceLineNo">202</span> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put)<a name="line.202"></a> -<span class="sourceLineNo">203</span> * .thenAccept(succ -> {<a name="line.203"></a> -<span class="sourceLineNo">204</span> * if (succ) {<a name="line.204"></a> -<span class="sourceLineNo">205</span> * System.out.println("Check and put succeeded");<a name="line.205"></a> -<span class="sourceLineNo">206</span> * } else {<a name="line.206"></a> -<span class="sourceLineNo">207</span> * System.out.println("Check and put failed");<a name="line.207"></a> -<span class="sourceLineNo">208</span> * }<a name="line.208"></a> -<span class="sourceLineNo">209</span> * });<a name="line.209"></a> -<span class="sourceLineNo">210</span> * </code><a name="line.210"></a> -<span class="sourceLineNo">211</span> * </pre><a name="line.211"></a> -<span class="sourceLineNo">212</span> */<a name="line.212"></a> -<span class="sourceLineNo">213</span> CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family);<a name="line.213"></a> -<span class="sourceLineNo">214</span><a name="line.214"></a> -<span class="sourceLineNo">215</span> /**<a name="line.215"></a> -<span class="sourceLineNo">216</span> * A helper class for sending checkAndMutate request.<a name="line.216"></a> -<span class="sourceLineNo">217</span> */<a name="line.217"></a> -<span class="sourceLineNo">218</span> interface CheckAndMutateBuilder {<a name="line.218"></a> -<span class="sourceLineNo">219</span><a name="line.219"></a> -<span class="sourceLineNo">220</span> /**<a name="line.220"></a> -<span class="sourceLineNo">221</span> * @param qualifier column qualifier to check.<a name="line.221"></a> -<span class="sourceLineNo">222</span> */<a name="line.222"></a> -<span class="sourceLineNo">223</span> CheckAndMutateBuilder qualifier(byte[] qualifier);<a name="line.223"></a> +<span class="sourceLineNo">114</span> * Extracts certain cells from a given row.<a name="line.114"></a> +<span class="sourceLineNo">115</span> * @param get The object that specifies what data to fetch and from which row.<a name="line.115"></a> +<span class="sourceLineNo">116</span> * @return The data coming from the specified row, if it exists. If the row specified doesn't<a name="line.116"></a> +<span class="sourceLineNo">117</span> * exist, the {@link Result} instance returned won't contain any<a name="line.117"></a> +<span class="sourceLineNo">118</span> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}. The<a name="line.118"></a> +<span class="sourceLineNo">119</span> * return value will be wrapped by a {@link CompletableFuture}.<a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> CompletableFuture<Result> get(Get get);<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> /**<a name="line.123"></a> +<span class="sourceLineNo">124</span> * Puts some data to the table.<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @param put The data to put.<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.126"></a> +<span class="sourceLineNo">127</span> */<a name="line.127"></a> +<span class="sourceLineNo">128</span> CompletableFuture<Void> put(Put put);<a name="line.128"></a> +<span class="sourceLineNo">129</span><a name="line.129"></a> +<span class="sourceLineNo">130</span> /**<a name="line.130"></a> +<span class="sourceLineNo">131</span> * Deletes the specified cells/row.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @param delete The object that specifies what to delete.<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.133"></a> +<span class="sourceLineNo">134</span> */<a name="line.134"></a> +<span class="sourceLineNo">135</span> CompletableFuture<Void> delete(Delete delete);<a name="line.135"></a> +<span class="sourceLineNo">136</span><a name="line.136"></a> +<span class="sourceLineNo">137</span> /**<a name="line.137"></a> +<span class="sourceLineNo">138</span> * Appends values to one or more columns within a single row.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <p><a name="line.139"></a> +<span class="sourceLineNo">140</span> * This operation does not appear atomic to readers. Appends are done under a single row lock, so<a name="line.140"></a> +<span class="sourceLineNo">141</span> * write operations to a row are synchronized, but readers do not take row locks so get and scan<a name="line.141"></a> +<span class="sourceLineNo">142</span> * operations can see this operation partially completed.<a name="line.142"></a> +<span class="sourceLineNo">143</span> * @param append object that specifies the columns and amounts to be used for the increment<a name="line.143"></a> +<span class="sourceLineNo">144</span> * operations<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @return values of columns after the append operation (maybe null). The return value will be<a name="line.145"></a> +<span class="sourceLineNo">146</span> * wrapped by a {@link CompletableFuture}.<a name="line.146"></a> +<span class="sourceLineNo">147</span> */<a name="line.147"></a> +<span class="sourceLineNo">148</span> CompletableFuture<Result> append(Append append);<a name="line.148"></a> +<span class="sourceLineNo">149</span><a name="line.149"></a> +<span class="sourceLineNo">150</span> /**<a name="line.150"></a> +<span class="sourceLineNo">151</span> * Increments one or more columns within a single row.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * <p><a name="line.152"></a> +<span class="sourceLineNo">153</span> * This operation does not appear atomic to readers. Increments are done under a single row lock,<a name="line.153"></a> +<span class="sourceLineNo">154</span> * so write operations to a row are synchronized, but readers do not take row locks so get and<a name="line.154"></a> +<span class="sourceLineNo">155</span> * scan operations can see this operation partially completed.<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @param increment object that specifies the columns and amounts to be used for the increment<a name="line.156"></a> +<span class="sourceLineNo">157</span> * operations<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @return values of columns after the increment. The return value will be wrapped by a<a name="line.158"></a> +<span class="sourceLineNo">159</span> * {@link CompletableFuture}.<a name="line.159"></a> +<span class="sourceLineNo">160</span> */<a name="line.160"></a> +<span class="sourceLineNo">161</span> CompletableFuture<Result> increment(Increment increment);<a name="line.161"></a> +<span class="sourceLineNo">162</span><a name="line.162"></a> +<span class="sourceLineNo">163</span> /**<a name="line.163"></a> +<span class="sourceLineNo">164</span> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <p><a name="line.165"></a> +<span class="sourceLineNo">166</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @param row The row that contains the cell to increment.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param family The column family of the cell to increment.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.171"></a> +<span class="sourceLineNo">172</span> * {@link CompletableFuture}.<a name="line.172"></a> +<span class="sourceLineNo">173</span> */<a name="line.173"></a> +<span class="sourceLineNo">174</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.174"></a> +<span class="sourceLineNo">175</span> long amount) {<a name="line.175"></a> +<span class="sourceLineNo">176</span> return incrementColumnValue(row, family, qualifier, amount, Durability.SYNC_WAL);<a name="line.176"></a> +<span class="sourceLineNo">177</span> }<a name="line.177"></a> +<span class="sourceLineNo">178</span><a name="line.178"></a> +<span class="sourceLineNo">179</span> /**<a name="line.179"></a> +<span class="sourceLineNo">180</span> * Atomically increments a column value. If the column value already exists and is not a<a name="line.180"></a> +<span class="sourceLineNo">181</span> * big-endian long, this could throw an exception. If the column value does not yet exist it is<a name="line.181"></a> +<span class="sourceLineNo">182</span> * initialized to <code>amount</code> and written to the specified column.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * <p><a name="line.183"></a> +<span class="sourceLineNo">184</span> * Setting durability to {@link Durability#SKIP_WAL} means that in a fail scenario you will lose<a name="line.184"></a> +<span class="sourceLineNo">185</span> * any increments that have not been flushed.<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param row The row that contains the cell to increment.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @param family The column family of the cell to increment.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @param durability The persistence guarantee for this increment.<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.191"></a> +<span class="sourceLineNo">192</span> * {@link CompletableFuture}.<a name="line.192"></a> +<span class="sourceLineNo">193</span> */<a name="line.193"></a> +<span class="sourceLineNo">194</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.194"></a> +<span class="sourceLineNo">195</span> long amount, Durability durability) {<a name="line.195"></a> +<span class="sourceLineNo">196</span> Preconditions.checkNotNull(row, "row is null");<a name="line.196"></a> +<span class="sourceLineNo">197</span> Preconditions.checkNotNull(family, "family is null");<a name="line.197"></a> +<span class="sourceLineNo">198</span> return increment(<a name="line.198"></a> +<span class="sourceLineNo">199</span> new Increment(row).addColumn(family, qualifier, amount).setDurability(durability))<a name="line.199"></a> +<span class="sourceLineNo">200</span> .thenApply(r -> Bytes.toLong(r.getValue(family, qualifier)));<a name="line.200"></a> +<span class="sourceLineNo">201</span> }<a name="line.201"></a> +<span class="sourceLineNo">202</span><a name="line.202"></a> +<span class="sourceLineNo">203</span> /**<a name="line.203"></a> +<span class="sourceLineNo">204</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.204"></a> +<span class="sourceLineNo">205</span> * adds the Put/Delete/RowMutations.<a name="line.205"></a> +<span class="sourceLineNo">206</span> * <p><a name="line.206"></a> +<span class="sourceLineNo">207</span> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.<a name="line.207"></a> +<span class="sourceLineNo">208</span> * This is a fluent style API, the code is like:<a name="line.208"></a> +<span class="sourceLineNo">209</span> *<a name="line.209"></a> +<span class="sourceLineNo">210</span> * <pre><a name="line.210"></a> +<span class="sourceLineNo">211</span> * <code><a name="line.211"></a> +<span class="sourceLineNo">212</span> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put)<a name="line.212"></a> +<span class="sourceLineNo">213</span> * .thenAccept(succ -> {<a name="line.213"></a> +<span class="sourceLineNo">214</span> * if (succ) {<a name="line.214"></a> +<span class="sourceLineNo">215</span> * System.out.println("Check and put succeeded");<a name="line.215"></a> +<span class="sourceLineNo">216</span> * } else {<a name="line.216"></a> +<span class="sourceLineNo">217</span> * System.out.println("Check and put failed");<a name="line.217"></a> +<span class="sourceLineNo">218</span> * }<a name="line.218"></a> +<span class="sourceLineNo">219</span> * });<a name="line.219"></a> +<span class="sourceLineNo">220</span> * </code><a name="line.220"></a> +<span class="sourceLineNo">221</span> * </pre><a name="line.221"></a> +<span class="sourceLineNo">222</span> */<a name="line.222"></a> +<span class="sourceLineNo">223</span> CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family);<a name="line.223"></a> <span class="sourceLineNo">224</span><a name="line.224"></a> -<span class="sourceLineNo">225</span> /**<a name="line.225"></a> -<span class="sourceLineNo">226</span> * Check for lack of column.<a name="line.226"></a> -<span class="sourceLineNo">227</span> */<a name="line.227"></a> -<span class="sourceLineNo">228</span> CheckAndMutateBuilder ifNotExists();<a name="line.228"></a> +<span class="sourceLineNo">225</span> /**<a name="line.225"></a> +<span class="sourceLineNo">226</span> * A helper class for sending checkAndMutate request.<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> interface CheckAndMutateBuilder {<a name="line.228"></a> <span class="sourceLineNo">229</span><a name="line.229"></a> -<span class="sourceLineNo">230</span> default CheckAndMutateBuilder ifEquals(byte[] value) {<a name="line.230"></a> -<span class="sourceLineNo">231</span> return ifMatches(CompareOperator.EQUAL, value);<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> /**<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @param compareOp comparison operator to use<a name="line.235"></a> -<span class="sourceLineNo">236</span> * @param value the expected value<a name="line.236"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @param qualifier column qualifier to check.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> CheckAndMutateBuilder qualifier(byte[] qualifier);<a name="line.233"></a> +<span class="sourceLineNo">234</span><a name="line.234"></a> +<span class="sourceLineNo">235</span> /**<a name="line.235"></a> +<span class="sourceLineNo">236</span> * Check for lack of column.<a name="line.236"></a> <span class="sourceLineNo">237</span> */<a name="line.237"></a> -<span class="sourceLineNo">238</span> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] value);<a name="line.238"></a> +<span class="sourceLineNo">238</span> CheckAndMutateBuilder ifNotExists();<a name="line.238"></a> <span class="sourceLineNo">239</span><a name="line.239"></a> -<span class="sourceLineNo">240</span> /**<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @param put data to put if check succeeds<a name="line.241"></a> -<span class="sourceLineNo">242</span> * @return {@code true} if the new put was executed, {@code false} otherwise. The return value<a name="line.242"></a> -<span class="sourceLineNo">243</span> * will be wrapped by a {@link CompletableFuture}.<a name="line.243"></a> -<span class="sourceLineNo">244</span> */<a name="line.244"></a> -<span class="sourceLineNo">245</span> CompletableFuture<Boolean> thenPut(Put put);<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> * @param delete data to delete if check succeeds<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @return {@code true} if the new delete was executed, {@code false} otherwise. The return<a name="line.249"></a> -<span class="sourceLineNo">250</span> * value will be wrapped by a {@link CompletableFuture}.<a name="line.250"></a> -<span class="sourceLineNo">251</span> */<a name="line.251"></a> -<span class="sourceLineNo">252</span> CompletableFuture<Boolean> thenDelete(Delete delete);<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> * @param mutation mutations to perform if check succeeds<a name="line.255"></a> -<span class="sourceLineNo">256</span> * @return true if the new mutation was executed, false otherwise. The return value will be<a name="line.256"></a> -<span class="sourceLineNo">257</span> * wrapped by a {@link CompletableFuture}.<a name="line.257"></a> -<span class="sourceLineNo">258</span> */<a name="line.258"></a> -<span class="sourceLineNo">259</span> CompletableFuture<Boolean> thenMutate(RowMutations mutation);<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> /**<a name="line.262"></a> -<span class="sourceLineNo">263</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.263"></a> -<span class="sourceLineNo">264</span> * {@link Delete} are supported.<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @param mutation object that specifies the set of mutations to perform atomically<a name="line.265"></a> -<span class="sourceLineNo">266</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.266"></a> -<span class="sourceLineNo">267</span> */<a name="line.267"></a> -<span class="sourceLineNo">268</span> CompletableFuture<Void> mutateRow(RowMutations mutation);<a name="line.268"></a> -<span class="sourceLineNo">269</span><a name="line.269"></a> -<span class="sourceLineNo">270</span> /**<a name="line.270"></a> -<span class="sourceLineNo">271</span> * Return all the results that match the given scan object.<a name="line.271"></a> -<span class="sourceLineNo">272</span> * <p><a name="line.272"></a> -<span class="sourceLineNo">273</span> * Notice that usually you should use this method with a {@link Scan} object that has limit set.<a name="line.273"></a> -<span class="sourceLineNo">274</span> * For example, if you want to get the closest row after a given row, you could do this:<a name="line.274"></a> -<span class="sourceLineNo">275</span> * <p><a name="line.275"></a> -<span class="sourceLineNo">276</span> *<a name="line.276"></a> -<span class="sourceLineNo">277</span> * <pre><a name="line.277"></a> -<span class="sourceLineNo">278</span> * <code><a name="line.278"></a> -<span class="sourceLineNo">279</span> * table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -> {<a name="line.279"></a> -<span class="sourceLineNo">280</span> * if (results.isEmpty()) {<a name="line.280"></a> -<span class="sourceLineNo">281</span> * System.out.println("No row after " + Bytes.toStringBinary(row));<a name="line.281"></a> -<span class="sourceLineNo">282</span> * } else {<a name="line.282"></a> -<span class="sourceLineNo">283</span> * System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is "<a name="line.283"></a> -<span class="sourceLineNo">284</span> * + Bytes.toStringBinary(results.stream().findFirst().get().getRow()));<a name="line.284"></a> -<span class="sourceLineNo">285</span> * }<a name="line.285"></a> -<span class="sourceLineNo">286</span> * });<a name="line.286"></a> -<span class="sourceLineNo">287</span> * </code><a name="line.287"></a> -<span class="sourceLineNo">288</span> * </pre><a name="line.288"></a> -<span class="sourceLineNo">289</span> * <p><a name="line.289"></a> -<span class="sourceLineNo">290</span> * If your result set is very large, you should use other scan method to get a scanner or use<a name="line.290"></a> -<span class="sourceLineNo">291</span> * callback to process the results. They will do chunking to prevent OOM. The scanAll method will<a name="line.291"></a> -<span class="sourceLineNo">292</span> * fetch all the results and store them in a List and then return the list to you.<a name="line.292"></a> -<span class="sourceLineNo">293</span> * <p><a name="line.293"></a> -<span class="sourceLineNo">294</span> * The scan metrics will be collected background if you enable it but you have no way to get it.<a name="line.294"></a> -<span class="sourceLineNo">295</span> * Usually you can get scan metrics from {@code ResultScanner}, or through<a name="line.295"></a> -<span class="sourceLineNo">296</span> * {@code ScanResultConsumer.onScanMetricsCreated} but this method only returns a list of results.<a name="line.296"></a> -<span class="sourceLineNo">297</span> * So if you really care about scan metrics then you'd better use other scan methods which return<a name="line.297"></a> -<span class="sourceLineNo">298</span> * a {@code ResultScanner} or let you pass in a {@code ScanResultConsumer}. There is no<a name="line.298"></a> -<span class="sourceLineNo">299</span> * performance difference between these scan methods so do not worry.<a name="line.299"></a> -<span class="sourceLineNo">300</span> * @param scan A configured {@link Scan} object. So if you use this method to fetch a really large<a name="line.300"></a> -<span class="sourceLineNo">301</span> * result set, it is likely to cause OOM.<a name="line.301"></a> -<span class="sourceLineNo">302</span> * @return The results of this small scan operation. The return value will be wrapped by a<a name="line.302"></a> -<span class="sourceLineNo">303</span> * {@link CompletableFuture}.<a name="line.303"></a> -<span class="sourceLineNo">304</span> */<a name="line.304"></a> -<span class="sourceLineNo">305</span> CompletableFuture<List<Result>> scanAll(Scan scan);<a name="line.305"></a> -<span class="sourceLineNo">306</span><a name="line.306"></a> -<span class="sourceLineNo">307</span> /**<a name="line.307"></a> -<span class="sourceLineNo">308</span> * Test for the existence of columns in the table, as specified by the Gets.<a name="line.308"></a> -<span class="sourceLineNo">309</span> * <p><a name="line.309"></a> -<span class="sourceLineNo">310</span> * This will return a list of booleans. Each value will be true if the related Get matches one or<a name="line.310"></a> -<span class="sourceLineNo">311</span> * more keys, false if not.<a name="line.311"></a> -<span class="sourceLineNo">312</span> * <p><a name="line.312"></a> -<span class="sourceLineNo">313</span> * This is a server-side call so it prevents any data from being transferred to the client.<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @param gets the Gets<a name="line.314"></a> -<span class="sourceLineNo">315</span> * @return A list of {@link CompletableFuture}s that represent the existence for each get.<a name="line.315"></a> -<span class="sourceLineNo">316</span> */<a name="line.316"></a> -<span class="sourceLineNo">317</span> default List<CompletableFuture<Boolean>> exists(List<Get> gets) {<a name="line.317"></a> -<span class="sourceLineNo">318</span> return get(toCheckExistenceOnly(gets)).stream()<a name="line.318"></a> -<span class="sourceLineNo">319</span> .<CompletableFuture<Boolean>> map(f -> f.thenApply(r -> r.getExists())).collect(toList());<a name="line.319"></a> -<span class="sourceLineNo">320</span> }<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> * A simple version for batch exists. It will fail if there are any failures and you will get the<a name="line.323"></a> -<span class="sourceLineNo">324</span> * whole result boolean list at once if the operation is succeeded.<a name="line.324"></a> -<span class="sourceLineNo">325</span> * @param gets the Gets<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @return A {@link CompletableFuture} that wrapper the result boolean list.<a name="line.326"></a> -<span class="sourceLineNo">327</span> */<a name="line.327"></a> -<span class="sourceLineNo">328</span> default CompletableFuture<List<Boolean>> existsAll(List<Get> gets) {<a name="line.328"></a> -<span class="sourceLineNo">329</span> return allOf(exists(gets));<a name="line.329"></a> +<span class="sourceLineNo">240</span> default CheckAndMutateBuilder ifEquals(byte[] value) {<a name="line.240"></a> +<span class="sourceLineNo">241</span> return ifMatches(CompareOperator.EQUAL, value);<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> /**<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @param compareOp comparison operator to use<a name="line.245"></a> +<span class="sourceLineNo">246</span> * @param value the expected value<a name="line.246"></a> +<span class="sourceLineNo">247</span> */<a name="line.247"></a> +<span class="sourceLineNo">248</span> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] 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> * @param put data to put if check succeeds<a name="line.251"></a> +<span class="sourceLineNo">252</span> * @return {@code true} if the new put was executed, {@code false} otherwise. The return value<a name="line.252"></a> +<span class="sourceLineNo">253</span> * will be wrapped by a {@link CompletableFuture}.<a name="line.253"></a> +<span class="sourceLineNo">254</span> */<a name="line.254"></a> +<span class="sourceLineNo">255</span> CompletableFuture<Boolean> thenPut(Put put);<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 delete data to delete if check succeeds<a name="line.258"></a> +<span class="sourceLineNo">259</span> * @return {@code true} if the new delete was executed, {@code false} otherwise. The return<a name="line.259"></a> +<span class="sourceLineNo">260</span> * value 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> thenDelete(Delete delete);<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 mutation mutations to perform if check succeeds<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return true if the new mutation was executed, false otherwise. The return value will be<a name="line.266"></a> +<span class="sourceLineNo">267</span> * 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> thenMutate(RowMutations mutation);<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> /**<a name="line.272"></a> +<span class="sourceLineNo">273</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.273"></a> +<span class="sourceLineNo">274</span> * {@link Delete} are supported.<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @param mutation object that specifies the set of mutations to perform atomically<a name="line.275"></a> +<span class="sourceLineNo">276</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.276"></a> +<span class="sourceLineNo">277</span> */<a name="line.277"></a> +<span class="sourceLineNo">278</span> CompletableFuture<Void> mutateRow(RowMutations mutation);<a name="line.278"></a> +<span class="sourceLineNo">279</span><a name="line.279"></a> +<span class="sourceLineNo">280</span> /**<a name="line.280"></a> +<span class="sourceLineNo">281</span> * Return all the results that match the given scan object.<a name="line.281"></a> +<span class="sourceLineNo">282</span> * <p><a name="line.282"></a> +<span class="sourceLineNo">283</span> * Notice that usually you should use this method with a {@link Scan} object that has limit set.<a name="line.283"></a> +<span class="sourceLineNo">284</span> * For example, if you want to get the closest row after a given row, you could do this:<a name="line.284"></a> +<span class="sourceLineNo">285</span> * <p><a name="line.285"></a> +<span class="sourceLineNo">286</span> *<a name="line.286"></a> +<span class="sourceLineNo">287</span> * <pre><a name="line.287"></a> +<span class="sourceLineNo">288</span> * <code><a name="line.288"></a> +<span class="sourceLineNo">289</span> * table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -> {<a name="line.289"></a> +<span class="sourceLineNo">290</span> * if (results.isEmpty()) {<a name="line.290"></a> +<span class="sourceLineNo">291</span> * System.out.println("No row after " + Bytes.toStringBinary(row));<a name="line.291"></a> +<span class="sourceLineNo">292</span> * } else {<a name="line.292"></a> +<span class="sourceLineNo">293</span> * System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is "<a name="line.293"></a> +<span class="sourceLineNo">294</span> * + Bytes.toStringBinary(results.stream().findFirst().get().getRow()));<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> * </code><a name="line.297"></a> +<span class="sourceLineNo">298</span> * </pre><a name="line.298"></a> +<span class="sourceLineNo">299</span> * <p><a name="line.299"></a> +<span class="sourceLineNo">300</span> * If your result set is very large, you should use other scan method to get a scanner or use<a name="line.300"></a> +<span class="sourceLineNo">301</span> * callback to process the results. They will do chunking to prevent OOM. The scanAll method will<a name="line.301"></a> +<span class="sourceLineNo">302</span> * fetch all the results and store them in a List and then return the list to you.<a name="line.302"></a> +<span class="sourceLineNo">303</span> * <p><a name="line.303"></a> +<span class="sourceLineNo">304</span> * The scan metrics will be collected background if you enable it but you have no way to get it.<a name="line.304"></a> +<span class="sourceLineNo">305</span> * Usually you can get scan metrics from {@code ResultScanner}, or through<a name="line.305"></a> +<span class="sourceLineNo">306</span> * {@code ScanResultConsumer.onScanMetricsCreated} but this method only returns a list of results.<a name="line.306"></a> +<span class="sourceLineNo">307</span> * So if you really care about scan metrics then you'd better use other scan methods which return<a name="line.307"></a> +<span class="sourceLineNo">308</span> * a {@code ResultScanner} or let you pass in a {@code ScanResultConsumer}. There is no<a name="line.308"></a> +<span class="sourceLineNo">309</span> * performance difference between these scan methods so do not worry.<a name="line.309"></a> +<span class="sourceLineNo">310</span> * @param scan A configured {@link Scan} object. So if you use this method to fetch a really large<a name="line.310"></a> +<span class="sourceLineNo">311</span> * result set, it is likely to cause OOM.<a name="line.311"></a> +<span class="sourceLineNo">312</span> * @return The results of this small scan operation. The return value will be wrapped by a<a name="line.312"></a> +<span class="sourceLineNo">313</span> * {@link CompletableFuture}.<a name="line.313"></a> +<span class="sourceLineNo">314</span> */<a name="line.314"></a> +<span class="sourceLineNo">315</span> CompletableFuture<List<Result>> scanAll(Scan scan);<a name="line.315"></a> +<span class="sourceLineNo">316</span><a name="line.316"></a> +<span class="sourceLineNo">317</span> /**<a name="line.317"></a> +<span class="sourceLineNo">318</span> * Test for the existence of columns in the table, as specified by the Gets.<a name="line.318"></a> +<span class="sourceLineNo">319</span> * <p><a name="line.319"></a> +<span class="sourceLineNo">320</span> * This will return a list of booleans. Each value will be true if the related Get matches one or<a name="line.320"></a> +<span class="sourceLineNo">321</span> * more keys, false if not.<a name="line.321"></a> +<span class="sourceLineNo">322</span> * <p><a name="line.322"></a> +<span class="sourceLineNo">323</span> * This is a server-side call so it prevents any data from being transferred to the client.<a name="line.323"></a> +<span class="sourceLineNo">324</span> * @param gets the Gets<a name="line.324"></a> +<span class="sourceLineNo">325</span> * @return A list of {@link CompletableFuture}s that represent the existence for each get.<a name="line.325"></a> +<span class="sourceLineNo">326</span> */<a name="line.326"></a> +<span class="sourceLineNo">327</span> default List<CompletableFuture<Boolean>> exists(List<Get> gets) {<a name="line.327"></a> +<span class="sourceLineNo">328</span> return get(toCheckExistenceOnly(gets)).stream()<a name="line.328"></a> +<span class="sourceLineNo">329</span> .<CompletableFuture<Boolean>> map(f -> f.thenApply(r -> r.getExists())).collect(toList());<a name="line.329"></a> <span class="sourceLineNo">330</span> }<a name="line.330"></a> <span class="sourceLineNo">331</span><a name="line.331"></a> <span class="sourceLineNo">332</span> /**<a name="line.332"></a> -<span class="sourceLineNo">333</span> * Extracts certain cells from the given rows, in batch.<a name="line.333"></a> -<span class="sourceLineNo">334</span> * <p><a name="line.334"></a> -<span class="sourceLineNo">335</span> * Notice that you may not get all the results with this function, which means some of the<a name="line.335"></a> -<span class="sourceLineNo">336</span> * returned {@link CompletableFuture}s may succeed while some of the other returned<a name="line.336"></a> -<span class="sourceLineNo">337</span> * {@link CompletableFuture}s may fail.<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @return A list of {@link CompletableFuture}s that represent the result for each get.<a name="line.339"></a> -<span class="sourceLineNo">340</span> */<a name="line.340"></a> -<span class="sourceLineNo">341</span> List<CompletableFuture<Result>> get(List<Get> gets);<a name="line.341"></a> -<span class="sourceLineNo">342</span><a name="line.342"></a> -<span class="sourceLineNo">343</span> /**<a name="line.343"></a> -<span class="sourceLineNo">344</span> * A simple version for batch get. It will fail if there are any failures and you will get the<a name="line.344"></a> -<span class="sourceLineNo">345</span> * whole result list at once if the operation is succeeded.<a name="line.345"></a> -<span class="sourceLineNo">346</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.346"></a> -<span class="sourceLineNo">347</span> * @return A {@link CompletableFuture} that wrapper the result list.<a name="line.347"></a> -<span class="sourceLineNo">348</span> */<a name="line.348"></a> -<span class="sourceLineNo">349</span> default CompletableFuture<List<Result>> getAll(List<Get> gets) {<a name="line.349"></a> -<span class="sourceLineNo">350</span> return allOf(get(gets));<a name="line.350"></a> -<span class="sourceLineNo">351</span> }<a name="line.351"></a> +<span class="sourceLineNo">333</span> * A simple version for batch exists. It will fail if there are any failures and you will get the<a name="line.333"></a> +<span class="sourceLineNo">334</span> * whole result boolean list at once if the operation is succeeded.<a name="line.334"></a> +<span class="sourceLineNo">335</span> * @param gets the Gets<a name="line.335"></a> +<span class="sourceLineNo">336</span> * @return A {@link CompletableFuture} that wrapper the result boolean list.<a name="line.336"></a> +<span class="sourceLineNo">337</span> */<a name="line.337"></a> +<span class="sourceLineNo">338</span> default CompletableFuture<List<Boolean>> existsAll(List<Get> gets) {<a name="line.338"></a> +<span class="sourceLineNo">339</span> return allOf(exists(gets));<a name="line.339"></a> +<span class="sourceLineNo">340</span> }<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> * Extracts certain cells from the given rows, in batch.<a name="line.343"></a> +<span class="sourceLineNo">344</span> * <p><a name="line.344"></a> +<span class="sourceLineNo">345</span> * Notice that you may not get all the results with this function, which means some of the<a name="line.345"></a> +<span class="sourceLineNo">346</span> * returned {@link CompletableFuture}s may succeed while some of the other returned<a name="line.346"></a> +<span class="sourceLineNo">347</span> * {@link CompletableFuture}s may fail.<a name="line.347"></a> +<span class="sourceLineNo">348</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.348"></a> +<span class="sourceLineNo">349</span> * @return A list of {@link CompletableFuture}s that represent the result for each get.<a name="line.349"></a> +<span class="sourceLineNo">350</span> */<a name="line.350"></a> +<span class="sourceLineNo">351</span> List<CompletableFuture<Result>> get(List<Get> gets);<a name="line.351"></a> <span class="sourceLineNo">352</span><a name="line.352"></a> <span class="sourceLineNo">353</span> /**<a name="line.353"></a> -<span class="sourceLineNo">354</span> * Puts some data in the table, in batch.<a name="line.354"></a> -<span class="sourceLineNo">355</span> * @param puts The list of mutations to apply.<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @return A list of {@link CompletableFuture}s that represent the result for each put.<a name="line.356"></a> -<span class="sourceLineNo">357</span> */<a name="line.357"></a> -<span class="sourceLineNo">358</span> List<CompletableFuture<Void>> put(List<Put> puts);<a name="line.358"></a> -<span class="sourceLineNo">359</span><a name="line.359"></a> -<span class="sourceLineNo">360</span> /**<a name="line.360"></a> -<span class="sourceLineNo">361</span> * A simple version of batch put. It will fail if there are any failures.<a name="line.361"></a> -<span class="sourceLineNo">362</span> * @param puts The list of mutations to apply.<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.363"></a> -<span class="sourceLineNo">364</span> */<a name="line.364"></a> -<span class="sourceLineNo">365</span> default CompletableFuture<Void> putAll(List<Put> puts) {<a name="line.365"></a> -<span class="sourceLineNo">366</span> return allOf(put(puts)).thenApply(r -> null);<a name="line.366"></a> -<span class="sourceLineNo">367</span> }<a name="line.367"></a> -<span class="sourceLineNo">368</span><a name="line.368"></a> -<span class="sourceLineNo">369</span> /**<a name="line.369"></a> -<span class="sourceLineNo">370</span> * Deletes the specified cells/rows in bulk.<a name="line.370"></a> -<span class="sourceLineNo">371</span> * @param deletes list of things to delete.<a name="line.371"></a> -<span class="sourceLineNo">372</span> * @return A list of {@link CompletableFuture}s that represent the result for each delete.<a name="line.372"></a> -<span class="sourceLineNo">373</span> */<a name="line.373"></a> -<span class="sourceLineNo">374</span> List<CompletableFuture<Void>> delete(List<Delete> deletes);<a name="line.374"></a> -<span class="sourceLineNo">375</span><a name="line.375"></a> -<span class="sourceLineNo">376</span> /**<a name="line.376"></a> -<span class="sourceLineNo">377</span> * A simple version of batch delete. It will fail if there are any failures.<a name="line.377"></a> -<span class="sourceLineNo">378</span> * @param deletes list of things to delete.<a name="line.378"></a> -<span class="sourceLineNo">379</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.379"></a> -<span class="sourceLineNo">380</span> */<a name="line.380"></a> -<span class="sourceLineNo">381</span> default CompletableFuture<Void> deleteAll(List<Delete> deletes) {<a name="line.381"></a> -<span class="sourceLineNo">382</span> return allOf(delete(deletes)).thenApply(r -> null);<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> /**<a name="line.385"></a> -<span class="sourceLineNo">386</span> * Method that does a batch call on Deletes, Gets, Puts, Increments and Appends. The ordering of<a name="line.386"></a> -<span class="sourceLineNo">387</span> * execution of the actions is not defined. Meaning if you do a Put and a Get in the same<a name="line.387"></a> -<span class="sourceLineNo">388</span> * {@link #batch} call, you will not necessarily be guaranteed that the Get returns what the Put<a name="line.388"></a> -<span class="sourceLineNo">389</span> * had put.<a name="line.389"></a> -<span class="sourceLineNo">390</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.390"></a> -<span class="sourceLineNo">391</span> * @return A list of {@link CompletableFuture}s that represent the result for each action.<a name="line.391"></a> -<span class="sourceLineNo">392</span> */<a name="line.392"></a> -<span class="sourceLineNo">393</span> <T> List<CompletableFuture<T>> batch(List<? extends Row> actions);<a name="line.393"></a> +<span class="sourceLineNo">354</span> * A simple version for batch get. It will fail if there are any failures and you will get the<a name="line.354"></a> +<span class="sourceLineNo">355</span> * whole result list at once if the operation is succeeded.<a name="line.355"></a> +<span class="sourceLineNo">356</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.356"></a> +<span class="sourceLineNo">357</span> * @return A {@link CompletableFuture} that wrapper the result list.<a name="line.357"></a> +<span class="sourceLineNo">358</span> */<a name="line.358"></a> +<span class="sourceLineNo">359</span> default CompletableFuture<List<Result>> getAll(List<Get> gets) {<a name="line.359"></a> +<span class="sourceLineNo">360</span> return allOf(get(gets));<a name="line.360"></a> +<span class="sourceLineNo">361</span> }<a name="line.361"></a> +<span class="sourceLineNo">362</span><a name="line.362"></a> +<span class="sourceLineNo">363</span> /**<a name="line.363"></a> +<span class="sourceLineNo">364</span> * Puts some data in the table, in batch.<a name="line.364"></a> +<span class="sourceLineNo">365</span> * @param puts The list of mutations to apply.<a name="line.365"></a> +<span class="sourceLineNo">366</span> * @return A list of {@link CompletableFuture}s that represent the result for each put.<a name="line.366"></a> +<span class="sourceLineNo">367</span> */<a name="line.367"></a> +<span class="sourceLineNo">368</span> List<CompletableFuture<Void>> put(List<Put> puts);<a name="line.368"></a> +<span class="sourceLineNo">369</span><a name="line.369"></a> +<span class="sourceLineNo">370</span> /**<a name="line.370"></a> +<span class="sourceLineNo">371</span> * A simple version of batch put. It will fail if there are any failures.<a name="line.371"></a> +<span class="sourceLineNo">372</span> * @param puts The list of mutations to apply.<a name="line.372"></a> +<span class="sourceLineNo">373</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.373"></a> +<span class="sourceLineNo">374</span> */<a name="line.374"></a> +<span class="sourceLineNo">375</span> default CompletableFuture<Void> putAll(List<Put> puts) {<a name="line.375"></a> +<span class="sourceLineNo">376</span> return allOf(put(puts)).thenApply(r -> null);<a name="line.376"></a> +<span class="sourceLineNo">377</span> }<a name="line.377"></a> +<span class="sourceLineNo">378</span><a name="line.378"></a> +<span class="sourceLineNo">379</span> /**<a name="line.379"></a> +<span class="sourceLineNo">380</span> * Deletes the specified cells/rows in bulk.<a name="line.380"></a> +<span class="sourceLineNo">381</span> * @param deletes list of things to delete.<a name="line.381"></a> +<span class="sourceLineNo">382</span> * @return A list of {@link CompletableFuture}s that represent the result for each delete.<a name="line.382"></a> +<span class="sourceLineNo">383</span> */<a name="line.383"></a> +<span class="sourceLineNo">384</span> List<CompletableFuture<Void>> delete(List<Delete> deletes);<a name="line.384"></a> +<span class="sourceLineNo">385</span><a name="line.385"></a> +<span class="sourceLineNo">386</span> /**<a name="line.386"></a> +<span class="sourceLineNo">387</span> * A simple version of batch delete. It will fail if there are any failures.<a name="line.387"></a> +<span class="sourceLineNo">388</span> * @param deletes list of things to delete.<a name="line.388"></a> +<span class="sourceLineNo">389</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.389"></a> +<span class="sourceLineNo">390</span> */<a name="line.390"></a> +<span class="sourceLineNo">391</span> default CompletableFuture<Void> deleteAll(List<Delete> deletes) {<a name="line.391"></a> +<span class="sourceLineNo">392</span> return allOf(delete(deletes)).thenApply(r -> null);<a name="line.392"></a> +<span class="sourceLineNo">393</span> }<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 of batch. It will fail if there are any failures and you will get the whole<a name="line.396"></a> -<span class="sourceLineNo">397</span> * result list at once if the operation is succeeded.<a name="line.397"></a> -<span class="sourceLineNo">398</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.398"></a> -<span class="sourceLineNo">399</span> * @return A list of the result for the actions. Wrapped by a {@link CompletableFuture}.<a name="line.399"></a> -<span class="sourceLineNo">400</span> */<a name="line.400"></a> -<span class="sourceLineNo">401</span> default <T> CompletableFuture<List<T>> batchAll(List<? extends Row> actions) {<a name="line.401"></a> -<span class="sourceLineNo">402</span> return allOf(batch(actions));<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">396</span> * Method that does a batch call on Deletes, Gets, Puts, Increments and Appends. The ordering of<a name="line.396"></a> +<span class="sourceLineNo">397</span> * execution of the actions is not defined. Meaning if you do a Put and a Get in the same<a name="line.397"></a> +<span class="sourceLineNo">398</span> * {@link #batch} call, you will not necessarily be guaranteed that the Get returns what the Put<a name="line.398"></a> +<span class="sourceLineNo">399</span> * had put.<a name="line.399"></a> +<span class="sourceLineNo">400</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.400"></a> +<span class="sourceLineNo">401</span> * @return A list of {@link CompletableFuture}s that represent the result for each action.<a name="line.401"></a> +<span class="sourceLineNo">402</span> */<a name="line.402"></a> +<span class="sourceLineNo">403</span> <T> List<CompletableFuture<T>> batch(List<? extends Row> actions);<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> * A simple version of batch. It will fail if there are any failures and you will get the whole<a name="line.406"></a> +<span class="sourceLineNo">407</span> * result list at once if the operation is succeeded.<a name="line.407"></a> +<span class="sourceLineNo">408</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.408"></a> +<span class="sourceLineNo">409</span> * @return A list of the result for the actions. Wrapped by a {@link CompletableFuture}.<a name="line.409"></a> +<span class="sourceLineNo">410</span> */<a name="line.410"></a> +<span class="sourceLineNo">411</span> default <T> CompletableFuture<List<T>> batchAll(List<? extends Row> actions) {<a name="line.411"></a> +<span class="sourceLineNo">412</span> return allOf(batch(actions));<a name="line.412"></a> +<span class="sourceLineNo">413</span> }<a name="line.413"></a> +<span class="sourceLineNo">414</span>}<a name="line.414"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html index f03bdda..6228f20 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html @@ -63,7 +63,7 @@ <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> * Apply the specified server-side filter when performing the Query. Only<a name="line.57"></a> -<span class="sourceLineNo">058</span> * {@link Filter#filterKeyValue(org.apache.hadoop.hbase.Cell)} is called AFTER all tests for ttl,<a name="line.58"></a> +<span class="sourceLineNo">058</span> * {@link Filter#filterCell(org.apache.hadoop.hbase.Cell)} is called AFTER all tests for ttl,<a name="line.58"></a> <span class="sourceLineNo">059</span> * column match, deletes and column family's max versions have been run.<a name="line.59"></a> <span class="sourceLineNo">060</span> * @param filter filter to run on the server<a name="line.60"></a> <span class="sourceLineNo">061</span> * @return this for invocation chaining<a name="line.61"></a>
