http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f96628d5/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.html index 64c606e..b655608 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.html @@ -25,113 +25,325 @@ <span class="sourceLineNo">017</span> */<a name="line.17"></a> <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.util.concurrent.CompletableFuture;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.util.concurrent.TimeUnit;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.TableName;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.26"></a> -<span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span>/**<a name="line.28"></a> -<span class="sourceLineNo">029</span> * The asynchronous version of Table. Obtain an instance from a {@link AsyncConnection}.<a name="line.29"></a> -<span class="sourceLineNo">030</span> * <p><a name="line.30"></a> -<span class="sourceLineNo">031</span> * The implementation is NOT required to be thread safe. Do NOT access it from multiple threads<a name="line.31"></a> -<span class="sourceLineNo">032</span> * concurrently.<a name="line.32"></a> -<span class="sourceLineNo">033</span> * <p><a name="line.33"></a> -<span class="sourceLineNo">034</span> * Usually the implementations will not throw any exception directly, you need to get the exception<a name="line.34"></a> -<span class="sourceLineNo">035</span> * from the returned {@link CompletableFuture}.<a name="line.35"></a> -<span class="sourceLineNo">036</span> */<a name="line.36"></a> -<span class="sourceLineNo">037</span>@InterfaceAudience.Public<a name="line.37"></a> -<span class="sourceLineNo">038</span>@InterfaceStability.Unstable<a name="line.38"></a> -<span class="sourceLineNo">039</span>public interface AsyncTable {<a name="line.39"></a> -<span class="sourceLineNo">040</span><a name="line.40"></a> -<span class="sourceLineNo">041</span> /**<a name="line.41"></a> -<span class="sourceLineNo">042</span> * Gets the fully qualified table name instance of this table.<a name="line.42"></a> -<span class="sourceLineNo">043</span> */<a name="line.43"></a> -<span class="sourceLineNo">044</span> TableName getName();<a name="line.44"></a> -<span class="sourceLineNo">045</span><a name="line.45"></a> -<span class="sourceLineNo">046</span> /**<a name="line.46"></a> -<span class="sourceLineNo">047</span> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.47"></a> -<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> -<span class="sourceLineNo">049</span> * The reference returned is not a copy, so any change made to it will affect this instance.<a name="line.49"></a> -<span class="sourceLineNo">050</span> */<a name="line.50"></a> -<span class="sourceLineNo">051</span> Configuration getConfiguration();<a name="line.51"></a> -<span class="sourceLineNo">052</span><a name="line.52"></a> -<span class="sourceLineNo">053</span> /**<a name="line.53"></a> -<span class="sourceLineNo">054</span> * Set timeout of each rpc read request in operations of this Table instance, will override the<a name="line.54"></a> -<span class="sourceLineNo">055</span> * value of {@code hbase.rpc.read.timeout} in configuration. If a rpc read request waiting too<a name="line.55"></a> -<span class="sourceLineNo">056</span> * long, it will stop waiting and send a new request to retry until retries exhausted or operation<a name="line.56"></a> -<span class="sourceLineNo">057</span> * timeout reached.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> void setReadRpcTimeout(long timeout, TimeUnit unit);<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> /**<a name="line.61"></a> -<span class="sourceLineNo">062</span> * Get timeout of each rpc read request in this Table instance.<a name="line.62"></a> -<span class="sourceLineNo">063</span> */<a name="line.63"></a> -<span class="sourceLineNo">064</span> long getReadRpcTimeout(TimeUnit unit);<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * Set timeout of each rpc write request in operations of this Table instance, will override the<a name="line.67"></a> -<span class="sourceLineNo">068</span> * value of {@code hbase.rpc.write.timeout} in configuration. If a rpc write request waiting too<a name="line.68"></a> -<span class="sourceLineNo">069</span> * long, it will stop waiting and send a new request to retry until retries exhausted or operation<a name="line.69"></a> -<span class="sourceLineNo">070</span> * timeout reached.<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> void setWriteRpcTimeout(long timeout, 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> * Set timeout of each operation in this Table instance, will override the value of<a name="line.80"></a> -<span class="sourceLineNo">081</span> * {@code hbase.client.operation.timeout} in configuration.<a name="line.81"></a> -<span class="sourceLineNo">082</span> * <p><a name="line.82"></a> -<span class="sourceLineNo">083</span> * Operation timeout is a top-level restriction that makes sure an operation will not be blocked<a name="line.83"></a> -<span class="sourceLineNo">084</span> * more than this. In each operation, if rpc request fails because of timeout or other reason, it<a name="line.84"></a> -<span class="sourceLineNo">085</span> * will retry until success or throw a RetriesExhaustedException. But if the total time elapsed<a name="line.85"></a> -<span class="sourceLineNo">086</span> * reach the operation timeout before retries exhausted, it will break early and throw<a name="line.86"></a> -<span class="sourceLineNo">087</span> * SocketTimeoutException.<a name="line.87"></a> -<span class="sourceLineNo">088</span> */<a name="line.88"></a> -<span class="sourceLineNo">089</span> void setOperationTimeout(long timeout, TimeUnit unit);<a name="line.89"></a> -<span class="sourceLineNo">090</span><a name="line.90"></a> -<span class="sourceLineNo">091</span> /**<a name="line.91"></a> -<span class="sourceLineNo">092</span> * Get timeout of each operation in Table instance.<a name="line.92"></a> -<span class="sourceLineNo">093</span> */<a name="line.93"></a> -<span class="sourceLineNo">094</span> long getOperationTimeout(TimeUnit unit);<a name="line.94"></a> -<span class="sourceLineNo">095</span><a name="line.95"></a> -<span class="sourceLineNo">096</span> /**<a name="line.96"></a> -<span class="sourceLineNo">097</span> * Test for the existence of columns in the table, as specified by the Get.<a name="line.97"></a> -<span class="sourceLineNo">098</span> * <p><a name="line.98"></a> -<span class="sourceLineNo">099</span> * This will return true if the Get matches one or more keys, false if not.<a name="line.99"></a> -<span class="sourceLineNo">100</span> * <p><a name="line.100"></a> -<span class="sourceLineNo">101</span> * This is a server-side call so it prevents any data from being transfered to the client.<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> CompletableFuture<Boolean> exists(Get get);<a name="line.103"></a> -<span class="sourceLineNo">104</span><a name="line.104"></a> -<span class="sourceLineNo">105</span> /**<a name="line.105"></a> -<span class="sourceLineNo">106</span> * Extracts certain cells from a given row.<a name="line.106"></a> -<span class="sourceLineNo">107</span> * <p><a name="line.107"></a> -<span class="sourceLineNo">108</span> * Return the data coming from the specified row, if it exists. If the row specified doesn't<a name="line.108"></a> -<span class="sourceLineNo">109</span> * exist, the {@link Result} instance returned won't contain any<a name="line.109"></a> -<span class="sourceLineNo">110</span> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}.<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @param get The object that specifies what data to fetch and from which row.<a name="line.111"></a> -<span class="sourceLineNo">112</span> */<a name="line.112"></a> -<span class="sourceLineNo">113</span> CompletableFuture<Result> get(Get get);<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> * Puts some data to the table.<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param put The data to put.<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> CompletableFuture<Void> put(Put put);<a name="line.119"></a> -<span class="sourceLineNo">120</span><a name="line.120"></a> -<span class="sourceLineNo">121</span> /**<a name="line.121"></a> -<span class="sourceLineNo">122</span> * Deletes the specified cells/row.<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @param delete The object that specifies what to delete.<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">020</span>import com.google.common.base.Preconditions;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.util.concurrent.CompletableFuture;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.concurrent.TimeUnit;<a name="line.24"></a> +<span class="sourceLineNo">025</span><a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.TableName;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.filter.CompareFilter.CompareOp;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.util.ReflectionUtils;<a name="line.32"></a> +<span class="sourceLineNo">033</span><a name="line.33"></a> +<span class="sourceLineNo">034</span>/**<a name="line.34"></a> +<span class="sourceLineNo">035</span> * The asynchronous version of Table. Obtain an instance from a {@link AsyncConnection}.<a name="line.35"></a> +<span class="sourceLineNo">036</span> * <p><a name="line.36"></a> +<span class="sourceLineNo">037</span> * The implementation is NOT required to be thread safe. Do NOT access it from multiple threads<a name="line.37"></a> +<span class="sourceLineNo">038</span> * concurrently.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> +<span class="sourceLineNo">040</span> * Usually the implementations will not throw any exception directly, you need to get the exception<a name="line.40"></a> +<span class="sourceLineNo">041</span> * from the returned {@link CompletableFuture}.<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span>@InterfaceAudience.Public<a name="line.43"></a> +<span class="sourceLineNo">044</span>@InterfaceStability.Unstable<a name="line.44"></a> +<span class="sourceLineNo">045</span>public interface AsyncTable {<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Gets the fully qualified table name instance of this table.<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> TableName getName();<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> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> +<span class="sourceLineNo">055</span> * The reference returned is not a copy, so any change made to it will affect this instance.<a name="line.55"></a> +<span class="sourceLineNo">056</span> */<a name="line.56"></a> +<span class="sourceLineNo">057</span> Configuration getConfiguration();<a name="line.57"></a> +<span class="sourceLineNo">058</span><a name="line.58"></a> +<span class="sourceLineNo">059</span> /**<a name="line.59"></a> +<span class="sourceLineNo">060</span> * Set timeout of each rpc read request in operations of this Table instance, will override the<a name="line.60"></a> +<span class="sourceLineNo">061</span> * value of {@code hbase.rpc.read.timeout} in configuration. If a rpc read request waiting too<a name="line.61"></a> +<span class="sourceLineNo">062</span> * long, it will stop waiting and send a new request to retry until retries exhausted or operation<a name="line.62"></a> +<span class="sourceLineNo">063</span> * timeout reached.<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> void setReadRpcTimeout(long timeout, TimeUnit unit);<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * Get timeout of each rpc read request in this Table instance.<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> long getReadRpcTimeout(TimeUnit unit);<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> /**<a name="line.72"></a> +<span class="sourceLineNo">073</span> * Set timeout of each rpc write request in operations of this Table instance, will override the<a name="line.73"></a> +<span class="sourceLineNo">074</span> * value of {@code hbase.rpc.write.timeout} in configuration. If a rpc write request waiting too<a name="line.74"></a> +<span class="sourceLineNo">075</span> * long, it will stop waiting and send a new request to retry until retries exhausted or operation<a name="line.75"></a> +<span class="sourceLineNo">076</span> * timeout reached.<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> void setWriteRpcTimeout(long timeout, 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> */<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> * Set timeout of each operation in this Table instance, will override the value of<a name="line.86"></a> +<span class="sourceLineNo">087</span> * {@code hbase.client.operation.timeout} in configuration.<a name="line.87"></a> +<span class="sourceLineNo">088</span> * <p><a name="line.88"></a> +<span class="sourceLineNo">089</span> * Operation timeout is a top-level restriction that makes sure an operation will not be blocked<a name="line.89"></a> +<span class="sourceLineNo">090</span> * more than this. In each operation, if rpc request fails because of timeout or other reason, it<a name="line.90"></a> +<span class="sourceLineNo">091</span> * will retry until success or throw a RetriesExhaustedException. But if the total time elapsed<a name="line.91"></a> +<span class="sourceLineNo">092</span> * reach the operation timeout before retries exhausted, it will break early and throw<a name="line.92"></a> +<span class="sourceLineNo">093</span> * SocketTimeoutException.<a name="line.93"></a> +<span class="sourceLineNo">094</span> */<a name="line.94"></a> +<span class="sourceLineNo">095</span> void setOperationTimeout(long timeout, TimeUnit unit);<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Get timeout of each operation in Table instance.<a name="line.98"></a> +<span class="sourceLineNo">099</span> */<a name="line.99"></a> +<span class="sourceLineNo">100</span> long getOperationTimeout(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> if (!get.isCheckExistenceOnly()) {<a name="line.112"></a> +<span class="sourceLineNo">113</span> get = ReflectionUtils.newInstance(get.getClass(), get);<a name="line.113"></a> +<span class="sourceLineNo">114</span> get.setCheckExistenceOnly(true);<a name="line.114"></a> +<span class="sourceLineNo">115</span> }<a name="line.115"></a> +<span class="sourceLineNo">116</span> return get(get).thenApply(r -> r.getExists());<a name="line.116"></a> +<span class="sourceLineNo">117</span> }<a name="line.117"></a> +<span class="sourceLineNo">118</span><a name="line.118"></a> +<span class="sourceLineNo">119</span> /**<a name="line.119"></a> +<span class="sourceLineNo">120</span> * Extracts certain cells from a given row.<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @param get The object that specifies what data to fetch and from which row.<a name="line.121"></a> +<span class="sourceLineNo">122</span> * @return The data coming from the specified row, if it exists. If the row specified doesn't<a name="line.122"></a> +<span class="sourceLineNo">123</span> * exist, the {@link Result} instance returned won't contain any<a name="line.123"></a> +<span class="sourceLineNo">124</span> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}. The<a name="line.124"></a> +<span class="sourceLineNo">125</span> * return value will be wrapped by a {@link CompletableFuture}.<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> CompletableFuture<Result> get(Get get);<a name="line.127"></a> +<span class="sourceLineNo">128</span><a name="line.128"></a> +<span class="sourceLineNo">129</span> /**<a name="line.129"></a> +<span class="sourceLineNo">130</span> * Puts some data to the table.<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @param put The data to put.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> CompletableFuture<Void> put(Put put);<a name="line.134"></a> +<span class="sourceLineNo">135</span><a name="line.135"></a> +<span class="sourceLineNo">136</span> /**<a name="line.136"></a> +<span class="sourceLineNo">137</span> * Deletes the specified cells/row.<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @param delete The object that specifies what to delete.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> CompletableFuture<Void> delete(Delete delete);<a name="line.141"></a> +<span class="sourceLineNo">142</span><a name="line.142"></a> +<span class="sourceLineNo">143</span> /**<a name="line.143"></a> +<span class="sourceLineNo">144</span> * Appends values to one or more columns within a single row.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * <p><a name="line.145"></a> +<span class="sourceLineNo">146</span> * This operation does not appear atomic to readers. Appends are done under a single row lock, so<a name="line.146"></a> +<span class="sourceLineNo">147</span> * write operations to a row are synchronized, but readers do not take row locks so get and scan<a name="line.147"></a> +<span class="sourceLineNo">148</span> * operations can see this operation partially completed.<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @param append object that specifies the columns and amounts to be used for the increment<a name="line.149"></a> +<span class="sourceLineNo">150</span> * operations<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @return values of columns after the append operation (maybe null). The return value will be<a name="line.151"></a> +<span class="sourceLineNo">152</span> * wrapped by a {@link CompletableFuture}.<a name="line.152"></a> +<span class="sourceLineNo">153</span> */<a name="line.153"></a> +<span class="sourceLineNo">154</span> CompletableFuture<Result> append(Append append);<a name="line.154"></a> +<span class="sourceLineNo">155</span><a name="line.155"></a> +<span class="sourceLineNo">156</span> /**<a name="line.156"></a> +<span class="sourceLineNo">157</span> * Increments one or more columns within a single row.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * <p><a name="line.158"></a> +<span class="sourceLineNo">159</span> * This operation does not appear atomic to readers. Increments are done under a single row lock,<a name="line.159"></a> +<span class="sourceLineNo">160</span> * so write operations to a row are synchronized, but readers do not take row locks so get and<a name="line.160"></a> +<span class="sourceLineNo">161</span> * scan operations can see this operation partially completed.<a name="line.161"></a> +<span class="sourceLineNo">162</span> * @param increment object that specifies the columns and amounts to be used for the increment<a name="line.162"></a> +<span class="sourceLineNo">163</span> * operations<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @return values of columns after the increment. The return value will be wrapped by a<a name="line.164"></a> +<span class="sourceLineNo">165</span> * {@link CompletableFuture}.<a name="line.165"></a> +<span class="sourceLineNo">166</span> */<a name="line.166"></a> +<span class="sourceLineNo">167</span> CompletableFuture<Result> increment(Increment increment);<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> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.170"></a> +<span class="sourceLineNo">171</span> * <p><a name="line.171"></a> +<span class="sourceLineNo">172</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param row The row that contains the cell to increment.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @param family The column family of the cell to increment.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.177"></a> +<span class="sourceLineNo">178</span> * {@link CompletableFuture}.<a name="line.178"></a> +<span class="sourceLineNo">179</span> */<a name="line.179"></a> +<span class="sourceLineNo">180</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.180"></a> +<span class="sourceLineNo">181</span> long amount) {<a name="line.181"></a> +<span class="sourceLineNo">182</span> return incrementColumnValue(row, family, qualifier, amount, Durability.SYNC_WAL);<a name="line.182"></a> +<span class="sourceLineNo">183</span> }<a name="line.183"></a> +<span class="sourceLineNo">184</span><a name="line.184"></a> +<span class="sourceLineNo">185</span> /**<a name="line.185"></a> +<span class="sourceLineNo">186</span> * Atomically increments a column value. If the column value already exists and is not a<a name="line.186"></a> +<span class="sourceLineNo">187</span> * big-endian long, this could throw an exception. If the column value does not yet exist it is<a name="line.187"></a> +<span class="sourceLineNo">188</span> * initialized to <code>amount</code> and written to the specified column.<a name="line.188"></a> +<span class="sourceLineNo">189</span> * <p><a name="line.189"></a> +<span class="sourceLineNo">190</span> * Setting durability to {@link Durability#SKIP_WAL} means that in a fail scenario you will lose<a name="line.190"></a> +<span class="sourceLineNo">191</span> * any increments that have not been flushed.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param row The row that contains the cell to increment.<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param family The column family of the cell to increment.<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @param amount The amount to increment the cell with (or decrement, if the amount is negative).<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @param durability The persistence guarantee for this increment.<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @return The new value, post increment. The return value will be wrapped by a<a name="line.197"></a> +<span class="sourceLineNo">198</span> * {@link CompletableFuture}.<a name="line.198"></a> +<span class="sourceLineNo">199</span> */<a name="line.199"></a> +<span class="sourceLineNo">200</span> default CompletableFuture<Long> incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.200"></a> +<span class="sourceLineNo">201</span> long amount, Durability durability) {<a name="line.201"></a> +<span class="sourceLineNo">202</span> Preconditions.checkNotNull(row, "row is null");<a name="line.202"></a> +<span class="sourceLineNo">203</span> Preconditions.checkNotNull(family, "family is null");<a name="line.203"></a> +<span class="sourceLineNo">204</span> Preconditions.checkNotNull(qualifier, "qualifier is null");<a name="line.204"></a> +<span class="sourceLineNo">205</span> return increment(<a name="line.205"></a> +<span class="sourceLineNo">206</span> new Increment(row).addColumn(family, qualifier, amount).setDurability(durability))<a name="line.206"></a> +<span class="sourceLineNo">207</span> .thenApply(r -> Bytes.toLong(r.getValue(family, qualifier)));<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> /**<a name="line.210"></a> +<span class="sourceLineNo">211</span> * Atomically checks if a row/family/qualifier value equals to the expected value. If it does, it<a name="line.211"></a> +<span class="sourceLineNo">212</span> * adds the put. If the passed value is null, the check is for the lack of column (ie:<a name="line.212"></a> +<span class="sourceLineNo">213</span> * non-existence)<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @param row to check<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param family column family to check<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @param qualifier column qualifier to check<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @param value the expected value<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @param put data to put if check succeeds<a name="line.218"></a> +<span class="sourceLineNo">219</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.219"></a> +<span class="sourceLineNo">220</span> * a {@link CompletableFuture}.<a name="line.220"></a> +<span class="sourceLineNo">221</span> */<a name="line.221"></a> +<span class="sourceLineNo">222</span> default CompletableFuture<Boolean> checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.222"></a> +<span class="sourceLineNo">223</span> byte[] value, Put put) {<a name="line.223"></a> +<span class="sourceLineNo">224</span> return checkAndPut(row, family, qualifier, CompareOp.EQUAL, value, put);<a name="line.224"></a> +<span class="sourceLineNo">225</span> }<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> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.228"></a> +<span class="sourceLineNo">229</span> * adds the put. If the passed value is null, the check is for the lack of column (ie:<a name="line.229"></a> +<span class="sourceLineNo">230</span> * non-existence)<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @param row to check<a name="line.231"></a> +<span class="sourceLineNo">232</span> * @param family column family to check<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> * @param compareOp comparison operator to use<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @param value the expected value<a name="line.235"></a> +<span class="sourceLineNo">236</span> * @param put data to put if check succeeds<a name="line.236"></a> +<span class="sourceLineNo">237</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.237"></a> +<span class="sourceLineNo">238</span> * a {@link CompletableFuture}.<a name="line.238"></a> +<span class="sourceLineNo">239</span> */<a name="line.239"></a> +<span class="sourceLineNo">240</span> CompletableFuture<Boolean> checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.240"></a> +<span class="sourceLineNo">241</span> CompareOp compareOp, byte[] value, Put put);<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> * Atomically checks if a row/family/qualifier value equals to the expected value. If it does, it<a name="line.244"></a> +<span class="sourceLineNo">245</span> * adds the delete. If the passed value is null, the check is for the lack of column (ie:<a name="line.245"></a> +<span class="sourceLineNo">246</span> * non-existence)<a name="line.246"></a> +<span class="sourceLineNo">247</span> * @param row to check<a name="line.247"></a> +<span class="sourceLineNo">248</span> * @param family column family to check<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @param qualifier column qualifier to check<a name="line.249"></a> +<span class="sourceLineNo">250</span> * @param value the expected value<a name="line.250"></a> +<span class="sourceLineNo">251</span> * @param delete data to delete if check succeeds<a name="line.251"></a> +<span class="sourceLineNo">252</span> * @return true if the new delete was executed, false otherwise. The return value will be wrapped<a name="line.252"></a> +<span class="sourceLineNo">253</span> * by a {@link CompletableFuture}.<a name="line.253"></a> +<span class="sourceLineNo">254</span> */<a name="line.254"></a> +<span class="sourceLineNo">255</span> default CompletableFuture<Boolean> checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.255"></a> +<span class="sourceLineNo">256</span> byte[] value, Delete delete) {<a name="line.256"></a> +<span class="sourceLineNo">257</span> return checkAndDelete(row, family, qualifier, CompareOp.EQUAL, value, delete);<a name="line.257"></a> +<span class="sourceLineNo">258</span> }<a name="line.258"></a> +<span class="sourceLineNo">259</span><a name="line.259"></a> +<span class="sourceLineNo">260</span> /**<a name="line.260"></a> +<span class="sourceLineNo">261</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.261"></a> +<span class="sourceLineNo">262</span> * adds the delete. If the passed value is null, the check is for the lack of column (ie:<a name="line.262"></a> +<span class="sourceLineNo">263</span> * non-existence)<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @param row to check<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @param family column family to check<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @param qualifier column qualifier to check<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @param compareOp comparison operator to use<a name="line.267"></a> +<span class="sourceLineNo">268</span> * @param value the expected value<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 true if the new delete was executed, false otherwise. The return value will be wrapped<a name="line.270"></a> +<span class="sourceLineNo">271</span> * 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> checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.273"></a> +<span class="sourceLineNo">274</span> CompareOp compareOp, byte[] value, Delete delete);<a name="line.274"></a> +<span class="sourceLineNo">275</span><a name="line.275"></a> +<span class="sourceLineNo">276</span> /**<a name="line.276"></a> +<span class="sourceLineNo">277</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.277"></a> +<span class="sourceLineNo">278</span> * {@link Delete} are supported.<a name="line.278"></a> +<span class="sourceLineNo">279</span> * @param mutation object that specifies the set of mutations to perform atomically<a name="line.279"></a> +<span class="sourceLineNo">280</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.280"></a> +<span class="sourceLineNo">281</span> */<a name="line.281"></a> +<span class="sourceLineNo">282</span> CompletableFuture<Void> mutateRow(RowMutations mutation);<a name="line.282"></a> +<span class="sourceLineNo">283</span><a name="line.283"></a> +<span class="sourceLineNo">284</span> /**<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Atomically checks if a row/family/qualifier value equals to the expected value. If it does, it<a name="line.285"></a> +<span class="sourceLineNo">286</span> * performs the row mutations. If the passed value is null, the check is for the lack of column<a name="line.286"></a> +<span class="sourceLineNo">287</span> * (ie: non-existence)<a name="line.287"></a> +<span class="sourceLineNo">288</span> * @param row to check<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @param family column family to check<a name="line.289"></a> +<span class="sourceLineNo">290</span> * @param qualifier column qualifier to check<a name="line.290"></a> +<span class="sourceLineNo">291</span> * @param value the expected value<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @param mutation mutations to perform if check succeeds<a name="line.292"></a> +<span class="sourceLineNo">293</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.293"></a> +<span class="sourceLineNo">294</span> * a {@link CompletableFuture}.<a name="line.294"></a> +<span class="sourceLineNo">295</span> */<a name="line.295"></a> +<span class="sourceLineNo">296</span> default CompletableFuture<Boolean> checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.296"></a> +<span class="sourceLineNo">297</span> byte[] value, RowMutations mutation) {<a name="line.297"></a> +<span class="sourceLineNo">298</span> return checkAndMutate(row, family, qualifier, CompareOp.EQUAL, value, mutation);<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> /**<a name="line.301"></a> +<span class="sourceLineNo">302</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.302"></a> +<span class="sourceLineNo">303</span> * performs the row mutations. If the passed value is null, the check is for the lack of column<a name="line.303"></a> +<span class="sourceLineNo">304</span> * (ie: non-existence)<a name="line.304"></a> +<span class="sourceLineNo">305</span> * @param row to check<a name="line.305"></a> +<span class="sourceLineNo">306</span> * @param family column family to check<a name="line.306"></a> +<span class="sourceLineNo">307</span> * @param qualifier column qualifier to check<a name="line.307"></a> +<span class="sourceLineNo">308</span> * @param compareOp the comparison operator<a name="line.308"></a> +<span class="sourceLineNo">309</span> * @param value the expected value<a name="line.309"></a> +<span class="sourceLineNo">310</span> * @param mutation mutations to perform if check succeeds<a name="line.310"></a> +<span class="sourceLineNo">311</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.311"></a> +<span class="sourceLineNo">312</span> * a {@link CompletableFuture}.<a name="line.312"></a> +<span class="sourceLineNo">313</span> */<a name="line.313"></a> +<span class="sourceLineNo">314</span> CompletableFuture<Boolean> checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.314"></a> +<span class="sourceLineNo">315</span> CompareOp compareOp, byte[] value, RowMutations mutation);<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> * Just call {@link #smallScan(Scan, int)} with {@link Integer#MAX_VALUE}.<a name="line.318"></a> +<span class="sourceLineNo">319</span> * @see #smallScan(Scan, int)<a name="line.319"></a> +<span class="sourceLineNo">320</span> */<a name="line.320"></a> +<span class="sourceLineNo">321</span> default CompletableFuture<List<Result>> smallScan(Scan scan) {<a name="line.321"></a> +<span class="sourceLineNo">322</span> return smallScan(scan, Integer.MAX_VALUE);<a name="line.322"></a> +<span class="sourceLineNo">323</span> }<a name="line.323"></a> +<span class="sourceLineNo">324</span><a name="line.324"></a> +<span class="sourceLineNo">325</span> /**<a name="line.325"></a> +<span class="sourceLineNo">326</span> * Return all the results that match the given scan object. The number of the returned results<a name="line.326"></a> +<span class="sourceLineNo">327</span> * will not be greater than {@code limit}.<a name="line.327"></a> +<span class="sourceLineNo">328</span> * <p><a name="line.328"></a> +<span class="sourceLineNo">329</span> * Notice that the scan must be small, and should not use batch or allowPartialResults. The<a name="line.329"></a> +<span class="sourceLineNo">330</span> * {@code caching} property of the scan object is also ignored as we will use {@code limit}<a name="line.330"></a> +<span class="sourceLineNo">331</span> * instead.<a name="line.331"></a> +<span class="sourceLineNo">332</span> * @param scan A configured {@link Scan} object.<a name="line.332"></a> +<span class="sourceLineNo">333</span> * @param limit the limit of results count<a name="line.333"></a> +<span class="sourceLineNo">334</span> * @return The results of this small scan operation. The return value will be wrapped by a<a name="line.334"></a> +<span class="sourceLineNo">335</span> * {@link CompletableFuture}.<a name="line.335"></a> +<span class="sourceLineNo">336</span> */<a name="line.336"></a> +<span class="sourceLineNo">337</span> CompletableFuture<List<Result>> smallScan(Scan scan, int limit);<a name="line.337"></a> +<span class="sourceLineNo">338</span>}<a name="line.338"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f96628d5/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.HTableMultiplexerStatus.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.HTableMultiplexerStatus.html b/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.HTableMultiplexerStatus.html index 87668ac..0b439da 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.HTableMultiplexerStatus.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.HTableMultiplexerStatus.html @@ -586,11 +586,11 @@ <span class="sourceLineNo">578</span> // failedCount is decreased whenever a Put is success or resubmit.<a name="line.578"></a> <span class="sourceLineNo">579</span> failedCount = processingList.size();<a name="line.579"></a> <span class="sourceLineNo">580</span><a name="line.580"></a> -<span class="sourceLineNo">581</span> List<Action<Row>> retainedActions = new ArrayList<>(processingList.size());<a name="line.581"></a> -<span class="sourceLineNo">582</span> MultiAction<Row> actions = new MultiAction<>();<a name="line.582"></a> +<span class="sourceLineNo">581</span> List<Action> retainedActions = new ArrayList<>(processingList.size());<a name="line.581"></a> +<span class="sourceLineNo">582</span> MultiAction actions = new MultiAction();<a name="line.582"></a> <span class="sourceLineNo">583</span> for (int i = 0; i < processingList.size(); i++) {<a name="line.583"></a> <span class="sourceLineNo">584</span> PutStatus putStatus = processingList.get(i);<a name="line.584"></a> -<span class="sourceLineNo">585</span> Action<Row> action = new Action<Row>(putStatus.put, i);<a name="line.585"></a> +<span class="sourceLineNo">585</span> Action action = new Action(putStatus.put, i);<a name="line.585"></a> <span class="sourceLineNo">586</span> actions.add(putStatus.regionInfo.getRegionName(), action);<a name="line.586"></a> <span class="sourceLineNo">587</span> retainedActions.add(action);<a name="line.587"></a> <span class="sourceLineNo">588</span> }<a name="line.588"></a> @@ -599,7 +599,7 @@ <span class="sourceLineNo">591</span> List<PutStatus> failed = null;<a name="line.591"></a> <span class="sourceLineNo">592</span> Object[] results = new Object[actions.size()];<a name="line.592"></a> <span class="sourceLineNo">593</span> ServerName server = addr.getServerName();<a name="line.593"></a> -<span class="sourceLineNo">594</span> Map<ServerName, MultiAction<Row>> actionsByServer =<a name="line.594"></a> +<span class="sourceLineNo">594</span> Map<ServerName, MultiAction> actionsByServer =<a name="line.594"></a> <span class="sourceLineNo">595</span> Collections.singletonMap(server, actions);<a name="line.595"></a> <span class="sourceLineNo">596</span> try {<a name="line.596"></a> <span class="sourceLineNo">597</span> AsyncRequestFuture arf =<a name="line.597"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f96628d5/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.html b/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.html index 87668ac..0b439da 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/HTableMultiplexer.html @@ -586,11 +586,11 @@ <span class="sourceLineNo">578</span> // failedCount is decreased whenever a Put is success or resubmit.<a name="line.578"></a> <span class="sourceLineNo">579</span> failedCount = processingList.size();<a name="line.579"></a> <span class="sourceLineNo">580</span><a name="line.580"></a> -<span class="sourceLineNo">581</span> List<Action<Row>> retainedActions = new ArrayList<>(processingList.size());<a name="line.581"></a> -<span class="sourceLineNo">582</span> MultiAction<Row> actions = new MultiAction<>();<a name="line.582"></a> +<span class="sourceLineNo">581</span> List<Action> retainedActions = new ArrayList<>(processingList.size());<a name="line.581"></a> +<span class="sourceLineNo">582</span> MultiAction actions = new MultiAction();<a name="line.582"></a> <span class="sourceLineNo">583</span> for (int i = 0; i < processingList.size(); i++) {<a name="line.583"></a> <span class="sourceLineNo">584</span> PutStatus putStatus = processingList.get(i);<a name="line.584"></a> -<span class="sourceLineNo">585</span> Action<Row> action = new Action<Row>(putStatus.put, i);<a name="line.585"></a> +<span class="sourceLineNo">585</span> Action action = new Action(putStatus.put, i);<a name="line.585"></a> <span class="sourceLineNo">586</span> actions.add(putStatus.regionInfo.getRegionName(), action);<a name="line.586"></a> <span class="sourceLineNo">587</span> retainedActions.add(action);<a name="line.587"></a> <span class="sourceLineNo">588</span> }<a name="line.588"></a> @@ -599,7 +599,7 @@ <span class="sourceLineNo">591</span> List<PutStatus> failed = null;<a name="line.591"></a> <span class="sourceLineNo">592</span> Object[] results = new Object[actions.size()];<a name="line.592"></a> <span class="sourceLineNo">593</span> ServerName server = addr.getServerName();<a name="line.593"></a> -<span class="sourceLineNo">594</span> Map<ServerName, MultiAction<Row>> actionsByServer =<a name="line.594"></a> +<span class="sourceLineNo">594</span> Map<ServerName, MultiAction> actionsByServer =<a name="line.594"></a> <span class="sourceLineNo">595</span> Collections.singletonMap(server, actions);<a name="line.595"></a> <span class="sourceLineNo">596</span> try {<a name="line.596"></a> <span class="sourceLineNo">597</span> AsyncRequestFuture arf =<a name="line.597"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f96628d5/apidocs/src-html/org/apache/hadoop/hbase/client/RowMutations.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/RowMutations.html b/apidocs/src-html/org/apache/hadoop/hbase/client/RowMutations.html index a0dd502..5306c7e 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/RowMutations.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/RowMutations.html @@ -48,81 +48,87 @@ <span class="sourceLineNo">040</span>@InterfaceAudience.Public<a name="line.40"></a> <span class="sourceLineNo">041</span>@InterfaceStability.Evolving<a name="line.41"></a> <span class="sourceLineNo">042</span>public class RowMutations implements Row {<a name="line.42"></a> -<span class="sourceLineNo">043</span> private final List<Mutation> mutations = new ArrayList<Mutation>();<a name="line.43"></a> -<span class="sourceLineNo">044</span> private byte [] row;<a name="line.44"></a> +<span class="sourceLineNo">043</span> private final List<Mutation> mutations;<a name="line.43"></a> +<span class="sourceLineNo">044</span> private final byte [] row;<a name="line.44"></a> <span class="sourceLineNo">045</span><a name="line.45"></a> -<span class="sourceLineNo">046</span> /** Constructor for Writable. DO NOT USE */<a name="line.46"></a> -<span class="sourceLineNo">047</span> public RowMutations() {}<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">046</span> public RowMutations(byte [] row) {<a name="line.46"></a> +<span class="sourceLineNo">047</span> this(row, -1);<a name="line.47"></a> +<span class="sourceLineNo">048</span> }<a name="line.48"></a> <span class="sourceLineNo">049</span> /**<a name="line.49"></a> <span class="sourceLineNo">050</span> * Create an atomic mutation for the specified row.<a name="line.50"></a> <span class="sourceLineNo">051</span> * @param row row key<a name="line.51"></a> -<span class="sourceLineNo">052</span> */<a name="line.52"></a> -<span class="sourceLineNo">053</span> public RowMutations(byte [] row) {<a name="line.53"></a> -<span class="sourceLineNo">054</span> Mutation.checkRow(row);<a name="line.54"></a> -<span class="sourceLineNo">055</span> this.row = Bytes.copy(row);<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> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Add a {@link Put} operation to the list of mutations<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @param p The {@link Put} to add<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @throws IOException<a name="line.61"></a> -<span class="sourceLineNo">062</span> */<a name="line.62"></a> -<span class="sourceLineNo">063</span> public void add(Put p) throws IOException {<a name="line.63"></a> -<span class="sourceLineNo">064</span> internalAdd(p);<a name="line.64"></a> -<span class="sourceLineNo">065</span> }<a name="line.65"></a> -<span class="sourceLineNo">066</span><a name="line.66"></a> -<span class="sourceLineNo">067</span> /**<a name="line.67"></a> -<span class="sourceLineNo">068</span> * Add a {@link Delete} operation to the list of mutations<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @param d The {@link Delete} to add<a name="line.69"></a> -<span class="sourceLineNo">070</span> * @throws IOException<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> public void add(Delete d) throws IOException {<a name="line.72"></a> -<span class="sourceLineNo">073</span> internalAdd(d);<a name="line.73"></a> -<span class="sourceLineNo">074</span> }<a name="line.74"></a> -<span class="sourceLineNo">075</span><a name="line.75"></a> -<span class="sourceLineNo">076</span> private void internalAdd(Mutation m) throws IOException {<a name="line.76"></a> -<span class="sourceLineNo">077</span> int res = Bytes.compareTo(this.row, m.getRow());<a name="line.77"></a> -<span class="sourceLineNo">078</span> if (res != 0) {<a name="line.78"></a> -<span class="sourceLineNo">079</span> throw new WrongRowIOException("The row in the recently added Put/Delete <" +<a name="line.79"></a> -<span class="sourceLineNo">080</span> Bytes.toStringBinary(m.getRow()) + "> doesn't match the original one <" +<a name="line.80"></a> -<span class="sourceLineNo">081</span> Bytes.toStringBinary(this.row) + ">");<a name="line.81"></a> -<span class="sourceLineNo">082</span> }<a name="line.82"></a> -<span class="sourceLineNo">083</span> mutations.add(m);<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> @Override<a name="line.86"></a> -<span class="sourceLineNo">087</span> public int compareTo(Row i) {<a name="line.87"></a> -<span class="sourceLineNo">088</span> return Bytes.compareTo(this.getRow(), i.getRow());<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> @Override<a name="line.91"></a> -<span class="sourceLineNo">092</span> public boolean equals(Object obj) {<a name="line.92"></a> -<span class="sourceLineNo">093</span> if (obj == this) return true;<a name="line.93"></a> -<span class="sourceLineNo">094</span> if (obj instanceof RowMutations) {<a name="line.94"></a> -<span class="sourceLineNo">095</span> RowMutations other = (RowMutations)obj;<a name="line.95"></a> -<span class="sourceLineNo">096</span> return compareTo(other) == 0;<a name="line.96"></a> -<span class="sourceLineNo">097</span> }<a name="line.97"></a> -<span class="sourceLineNo">098</span> return false;<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> @Override<a name="line.101"></a> -<span class="sourceLineNo">102</span> public int hashCode(){<a name="line.102"></a> -<span class="sourceLineNo">103</span> return Arrays.hashCode(row);<a name="line.103"></a> -<span class="sourceLineNo">104</span> }<a name="line.104"></a> -<span class="sourceLineNo">105</span><a name="line.105"></a> -<span class="sourceLineNo">106</span> @Override<a name="line.106"></a> -<span class="sourceLineNo">107</span> public byte[] getRow() {<a name="line.107"></a> -<span class="sourceLineNo">108</span> return row;<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<a name="line.109"></a> -<span class="sourceLineNo">110</span><a name="line.110"></a> -<span class="sourceLineNo">111</span> /**<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @return An unmodifiable list of the current mutations.<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> public List<Mutation> getMutations() {<a name="line.114"></a> -<span class="sourceLineNo">115</span> return Collections.unmodifiableList(mutations);<a name="line.115"></a> -<span class="sourceLineNo">116</span> }<a name="line.116"></a> -<span class="sourceLineNo">117</span>}<a name="line.117"></a> +<span class="sourceLineNo">052</span> * @param initialCapacity the initial capacity of the RowMutations<a name="line.52"></a> +<span class="sourceLineNo">053</span> */<a name="line.53"></a> +<span class="sourceLineNo">054</span> public RowMutations(byte [] row, int initialCapacity) {<a name="line.54"></a> +<span class="sourceLineNo">055</span> Mutation.checkRow(row);<a name="line.55"></a> +<span class="sourceLineNo">056</span> this.row = Bytes.copy(row);<a name="line.56"></a> +<span class="sourceLineNo">057</span> if (initialCapacity <= 0) {<a name="line.57"></a> +<span class="sourceLineNo">058</span> this.mutations = new ArrayList<>();<a name="line.58"></a> +<span class="sourceLineNo">059</span> } else {<a name="line.59"></a> +<span class="sourceLineNo">060</span> this.mutations = new ArrayList<>(initialCapacity);<a name="line.60"></a> +<span class="sourceLineNo">061</span> }<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> /**<a name="line.64"></a> +<span class="sourceLineNo">065</span> * Add a {@link Put} operation to the list of mutations<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @param p The {@link Put} to add<a name="line.66"></a> +<span class="sourceLineNo">067</span> * @throws IOException<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> public void add(Put p) throws IOException {<a name="line.69"></a> +<span class="sourceLineNo">070</span> internalAdd(p);<a name="line.70"></a> +<span class="sourceLineNo">071</span> }<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> * Add a {@link Delete} operation to the list of mutations<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @param d The {@link Delete} to add<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @throws IOException<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> public void add(Delete d) throws IOException {<a name="line.78"></a> +<span class="sourceLineNo">079</span> internalAdd(d);<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> private void internalAdd(Mutation m) throws IOException {<a name="line.82"></a> +<span class="sourceLineNo">083</span> int res = Bytes.compareTo(this.row, m.getRow());<a name="line.83"></a> +<span class="sourceLineNo">084</span> if (res != 0) {<a name="line.84"></a> +<span class="sourceLineNo">085</span> throw new WrongRowIOException("The row in the recently added Put/Delete <" +<a name="line.85"></a> +<span class="sourceLineNo">086</span> Bytes.toStringBinary(m.getRow()) + "> doesn't match the original one <" +<a name="line.86"></a> +<span class="sourceLineNo">087</span> Bytes.toStringBinary(this.row) + ">");<a name="line.87"></a> +<span class="sourceLineNo">088</span> }<a name="line.88"></a> +<span class="sourceLineNo">089</span> mutations.add(m);<a name="line.89"></a> +<span class="sourceLineNo">090</span> }<a name="line.90"></a> +<span class="sourceLineNo">091</span><a name="line.91"></a> +<span class="sourceLineNo">092</span> @Override<a name="line.92"></a> +<span class="sourceLineNo">093</span> public int compareTo(Row i) {<a name="line.93"></a> +<span class="sourceLineNo">094</span> return Bytes.compareTo(this.getRow(), i.getRow());<a name="line.94"></a> +<span class="sourceLineNo">095</span> }<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> @Override<a name="line.97"></a> +<span class="sourceLineNo">098</span> public boolean equals(Object obj) {<a name="line.98"></a> +<span class="sourceLineNo">099</span> if (obj == this) return true;<a name="line.99"></a> +<span class="sourceLineNo">100</span> if (obj instanceof RowMutations) {<a name="line.100"></a> +<span class="sourceLineNo">101</span> RowMutations other = (RowMutations)obj;<a name="line.101"></a> +<span class="sourceLineNo">102</span> return compareTo(other) == 0;<a name="line.102"></a> +<span class="sourceLineNo">103</span> }<a name="line.103"></a> +<span class="sourceLineNo">104</span> return false;<a name="line.104"></a> +<span class="sourceLineNo">105</span> }<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> @Override<a name="line.107"></a> +<span class="sourceLineNo">108</span> public int hashCode(){<a name="line.108"></a> +<span class="sourceLineNo">109</span> return Arrays.hashCode(row);<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> @Override<a name="line.112"></a> +<span class="sourceLineNo">113</span> public byte[] getRow() {<a name="line.113"></a> +<span class="sourceLineNo">114</span> return row;<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> /**<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @return An unmodifiable list of the current mutations.<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> public List<Mutation> getMutations() {<a name="line.120"></a> +<span class="sourceLineNo">121</span> return Collections.unmodifiableList(mutations);<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>
