http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/apidocs/src-html/org/apache/hadoop/hbase/client/Append.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Append.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Append.html index 28a04b5..6de6c3e 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Append.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Append.html @@ -131,7 +131,7 @@ <span class="sourceLineNo">123</span> byte [] family = CellUtil.cloneFamily(cell);<a name="line.123"></a> <span class="sourceLineNo">124</span> List<Cell> list = this.familyMap.get(family);<a name="line.124"></a> <span class="sourceLineNo">125</span> if (list == null) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> list = new ArrayList<Cell>();<a name="line.126"></a> +<span class="sourceLineNo">126</span> list = new ArrayList<Cell>(1);<a name="line.126"></a> <span class="sourceLineNo">127</span> }<a name="line.127"></a> <span class="sourceLineNo">128</span> // find where the new entry should be placed in the List<a name="line.128"></a> <span class="sourceLineNo">129</span> list.add(cell);<a name="line.129"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncConnection.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncConnection.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncConnection.html index f040f1e..177410b 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncConnection.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncConnection.html @@ -58,30 +58,62 @@ <span class="sourceLineNo">050</span> AsyncTableRegionLocator getRegionLocator(TableName tableName);<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> * Retrieve an RawAsyncTable implementation for accessing a table. The returned Table is not<a name="line.53"></a> -<span class="sourceLineNo">054</span> * thread safe, a new instance should be created for each using thread. This is a lightweight<a name="line.54"></a> -<span class="sourceLineNo">055</span> * operation, pooling or caching of the returned AsyncTable is neither required nor desired.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> -<span class="sourceLineNo">057</span> * This method no longer checks table existence. An exception will be thrown if the table does not<a name="line.57"></a> -<span class="sourceLineNo">058</span> * exist only when the first operation is attempted.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param tableName the name of the table<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @return an RawAsyncTable to use for interactions with this table<a name="line.60"></a> -<span class="sourceLineNo">061</span> */<a name="line.61"></a> -<span class="sourceLineNo">062</span> RawAsyncTable getRawTable(TableName tableName);<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> * Retrieve an AsyncTable implementation for accessing a table. The returned Table is not thread<a name="line.65"></a> -<span class="sourceLineNo">066</span> * safe, a new instance should be created for each using thread. This is a lightweight operation,<a name="line.66"></a> -<span class="sourceLineNo">067</span> * pooling or caching of the returned AsyncTable is neither required nor desired.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * <p><a name="line.68"></a> -<span class="sourceLineNo">069</span> * This method no longer checks table existence. An exception will be thrown if the table does not<a name="line.69"></a> -<span class="sourceLineNo">070</span> * exist only when the first operation is attempted.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * @param tableName the name of the table<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @param pool the thread pool to use for executing callback<a name="line.72"></a> -<span class="sourceLineNo">073</span> * @return an AsyncTable to use for interactions with this table<a name="line.73"></a> +<span class="sourceLineNo">053</span> * Retrieve an {@link RawAsyncTable} implementation for accessing a table.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> +<span class="sourceLineNo">055</span> * The returned instance will use default configs. Use {@link #getRawTableBuilder(TableName)} if you<a name="line.55"></a> +<span class="sourceLineNo">056</span> * want to customize some configs.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <p><a name="line.57"></a> +<span class="sourceLineNo">058</span> * This method no longer checks table existence. An exception will be thrown if the table does not<a name="line.58"></a> +<span class="sourceLineNo">059</span> * exist only when the first operation is attempted.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param tableName the name of the table<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @return an RawAsyncTable to use for interactions with this table<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @see #getRawTableBuilder(TableName)<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span> default RawAsyncTable getRawTable(TableName tableName) {<a name="line.64"></a> +<span class="sourceLineNo">065</span> return getRawTableBuilder(tableName).build();<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> /**<a name="line.68"></a> +<span class="sourceLineNo">069</span> * Returns an {@link AsyncTableBuilder} for creating {@link RawAsyncTable}.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * <p><a name="line.70"></a> +<span class="sourceLineNo">071</span> * This method no longer checks table existence. An exception will be thrown if the table does not<a name="line.71"></a> +<span class="sourceLineNo">072</span> * exist only when the first operation is attempted.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param tableName the name of the table<a name="line.73"></a> <span class="sourceLineNo">074</span> */<a name="line.74"></a> -<span class="sourceLineNo">075</span> AsyncTable getTable(TableName tableName, ExecutorService pool);<a name="line.75"></a> -<span class="sourceLineNo">076</span>}<a name="line.76"></a> +<span class="sourceLineNo">075</span> AsyncTableBuilder<RawAsyncTable> getRawTableBuilder(TableName tableName);<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> /**<a name="line.77"></a> +<span class="sourceLineNo">078</span> * Retrieve an AsyncTable implementation for accessing a table.<a name="line.78"></a> +<span class="sourceLineNo">079</span> * <p><a name="line.79"></a> +<span class="sourceLineNo">080</span> * This method no longer checks table existence. An exception will be thrown if the table does not<a name="line.80"></a> +<span class="sourceLineNo">081</span> * exist only when the first operation is attempted.<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @param tableName the name of the table<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @param pool the thread pool to use for executing callback<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @return an AsyncTable to use for interactions with this table<a name="line.84"></a> +<span class="sourceLineNo">085</span> */<a name="line.85"></a> +<span class="sourceLineNo">086</span> default AsyncTable getTable(TableName tableName, ExecutorService pool) {<a name="line.86"></a> +<span class="sourceLineNo">087</span> return getTableBuilder(tableName, pool).build();<a name="line.87"></a> +<span class="sourceLineNo">088</span> }<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> * Returns an {@link AsyncTableBuilder} for creating {@link AsyncTable}.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * <p><a name="line.92"></a> +<span class="sourceLineNo">093</span> * This method no longer checks table existence. An exception will be thrown if the table does not<a name="line.93"></a> +<span class="sourceLineNo">094</span> * exist only when the first operation is attempted.<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @param tableName the name of the table<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @param pool the thread pool to use for executing callback<a name="line.96"></a> +<span class="sourceLineNo">097</span> */<a name="line.97"></a> +<span class="sourceLineNo">098</span> AsyncTableBuilder<AsyncTable> getTableBuilder(TableName tableName, ExecutorService pool);<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> * Retrieve an AsyncAdmin implementation to administer an HBase cluster. The returned AsyncAdmin<a name="line.101"></a> +<span class="sourceLineNo">102</span> * is not guaranteed to be thread-safe. A new instance should be created for each using thread.<a name="line.102"></a> +<span class="sourceLineNo">103</span> * This is a lightweight operation. Pooling or caching of the returned AsyncAdmin is not<a name="line.103"></a> +<span class="sourceLineNo">104</span> * recommended.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @return an AsyncAdmin instance for cluster administration<a name="line.105"></a> +<span class="sourceLineNo">106</span> */<a name="line.106"></a> +<span class="sourceLineNo">107</span> AsyncAdmin getAdmin();<a name="line.107"></a> +<span class="sourceLineNo">108</span>}<a name="line.108"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/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 505e3a4..6ed3f4c 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTable.html @@ -31,51 +31,53 @@ <span class="sourceLineNo">023</span>/**<a name="line.23"></a> <span class="sourceLineNo">024</span> * The asynchronous table for normal users.<a name="line.24"></a> <span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * The implementation should make sure that user can do everything they want to the returned<a name="line.26"></a> -<span class="sourceLineNo">027</span> * {@code CompletableFuture} without break anything. Usually the implementation will require user to<a name="line.27"></a> -<span class="sourceLineNo">028</span> * provide a {@code ExecutorService}.<a name="line.28"></a> -<span class="sourceLineNo">029</span> */<a name="line.29"></a> -<span class="sourceLineNo">030</span>@InterfaceAudience.Public<a name="line.30"></a> -<span class="sourceLineNo">031</span>@InterfaceStability.Unstable<a name="line.31"></a> -<span class="sourceLineNo">032</span>public interface AsyncTable extends AsyncTableBase {<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> * Gets a scanner on the current table for the given family.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * @param family The column family to scan.<a name="line.36"></a> -<span class="sourceLineNo">037</span> * @return A scanner.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span> default ResultScanner getScanner(byte[] family) {<a name="line.39"></a> -<span class="sourceLineNo">040</span> return getScanner(new Scan().addFamily(family));<a name="line.40"></a> -<span class="sourceLineNo">041</span> }<a name="line.41"></a> -<span class="sourceLineNo">042</span><a name="line.42"></a> -<span class="sourceLineNo">043</span> /**<a name="line.43"></a> -<span class="sourceLineNo">044</span> * Gets a scanner on the current table for the given family and qualifier.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * @param family The column family to scan.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * @param qualifier The column qualifier to scan.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * @return A scanner.<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span> default ResultScanner getScanner(byte[] family, byte[] qualifier) {<a name="line.49"></a> -<span class="sourceLineNo">050</span> return getScanner(new Scan().addColumn(family, qualifier));<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> /**<a name="line.53"></a> -<span class="sourceLineNo">054</span> * Returns a scanner on the current table as specified by the {@link Scan} object.<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @param scan A configured {@link Scan} object.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @return A scanner.<a name="line.56"></a> -<span class="sourceLineNo">057</span> */<a name="line.57"></a> -<span class="sourceLineNo">058</span> ResultScanner getScanner(Scan scan);<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> /**<a name="line.60"></a> -<span class="sourceLineNo">061</span> * The scan API uses the observer pattern. All results that match the given scan object will be<a name="line.61"></a> -<span class="sourceLineNo">062</span> * passed to the given {@code consumer} by calling {@link ScanResultConsumer#onNext(Result)}.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * {@link ScanResultConsumer#onComplete()} means the scan is finished, and<a name="line.63"></a> -<span class="sourceLineNo">064</span> * {@link ScanResultConsumer#onError(Throwable)} means we hit an unrecoverable error and the scan<a name="line.64"></a> -<span class="sourceLineNo">065</span> * is terminated.<a name="line.65"></a> -<span class="sourceLineNo">066</span> * @param scan A configured {@link Scan} object.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @param consumer the consumer used to receive results.<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> void scan(Scan scan, ScanResultConsumer consumer);<a name="line.69"></a> -<span class="sourceLineNo">070</span>}<a name="line.70"></a> +<span class="sourceLineNo">026</span> * The implementation is required to be thread safe.<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * The implementation should make sure that user can do everything they want to the returned<a name="line.28"></a> +<span class="sourceLineNo">029</span> * {@code CompletableFuture} without breaking anything. Usually the implementation will require user<a name="line.29"></a> +<span class="sourceLineNo">030</span> * to provide a {@code ExecutorService}.<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span>@InterfaceAudience.Public<a name="line.32"></a> +<span class="sourceLineNo">033</span>@InterfaceStability.Unstable<a name="line.33"></a> +<span class="sourceLineNo">034</span>public interface AsyncTable extends AsyncTableBase {<a name="line.34"></a> +<span class="sourceLineNo">035</span><a name="line.35"></a> +<span class="sourceLineNo">036</span> /**<a name="line.36"></a> +<span class="sourceLineNo">037</span> * Gets a scanner on the current table for the given family.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * @param family The column family to scan.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * @return A scanner.<a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span> default ResultScanner getScanner(byte[] family) {<a name="line.41"></a> +<span class="sourceLineNo">042</span> return getScanner(new Scan().addFamily(family));<a name="line.42"></a> +<span class="sourceLineNo">043</span> }<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> /**<a name="line.45"></a> +<span class="sourceLineNo">046</span> * Gets a scanner on the current table for the given family and qualifier.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @param family The column family to scan.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @param qualifier The column qualifier to scan.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * @return A scanner.<a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span> default ResultScanner getScanner(byte[] family, byte[] qualifier) {<a name="line.51"></a> +<span class="sourceLineNo">052</span> return getScanner(new Scan().addColumn(family, qualifier));<a name="line.52"></a> +<span class="sourceLineNo">053</span> }<a name="line.53"></a> +<span class="sourceLineNo">054</span><a name="line.54"></a> +<span class="sourceLineNo">055</span> /**<a name="line.55"></a> +<span class="sourceLineNo">056</span> * Returns a scanner on the current table as specified by the {@link Scan} object.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param scan A configured {@link Scan} object.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @return A scanner.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> ResultScanner getScanner(Scan scan);<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> * The scan API uses the observer pattern. All results that match the given scan object will be<a name="line.63"></a> +<span class="sourceLineNo">064</span> * passed to the given {@code consumer} by calling {@link ScanResultConsumer#onNext(Result)}.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * {@link ScanResultConsumer#onComplete()} means the scan is finished, and<a name="line.65"></a> +<span class="sourceLineNo">066</span> * {@link ScanResultConsumer#onError(Throwable)} means we hit an unrecoverable error and the scan<a name="line.66"></a> +<span class="sourceLineNo">067</span> * is terminated.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * @param scan A configured {@link Scan} object.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * @param consumer the consumer used to receive results.<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> void scan(Scan scan, ScanResultConsumer consumer);<a name="line.71"></a> +<span class="sourceLineNo">072</span>}<a name="line.72"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html b/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html index 737e410..b05f9a2 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html @@ -72,81 +72,86 @@ <span class="sourceLineNo">064</span>@InterfaceStability.Evolving<a name="line.64"></a> <span class="sourceLineNo">065</span>public interface BufferedMutator extends Closeable {<a name="line.65"></a> <span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * Gets the fully qualified table name instance of the table that this BufferedMutator writes to.<a name="line.67"></a> +<span class="sourceLineNo">067</span> * Key to use setting non-default BufferedMutator implementation in Configuration.<a name="line.67"></a> <span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> TableName getName();<a name="line.69"></a> +<span class="sourceLineNo">069</span> public static final String CLASSNAME_KEY = "hbase.client.bufferedmutator.classname";<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> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * The reference returned is not a copy, so any change made to it will<a name="line.74"></a> -<span class="sourceLineNo">075</span> * affect this instance.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> Configuration getConfiguration();<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> * Sends a {@link Mutation} to the table. The mutations will be buffered and sent over the<a name="line.80"></a> -<span class="sourceLineNo">081</span> * wire as part of a batch. Currently only supports {@link Put} and {@link Delete} mutations.<a name="line.81"></a> -<span class="sourceLineNo">082</span> *<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param mutation The data to send.<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @throws IOException if a remote or network exception occurs.<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> void mutate(Mutation mutation) throws IOException;<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * Send some {@link Mutation}s to the table. The mutations will be buffered and sent over the<a name="line.89"></a> -<span class="sourceLineNo">090</span> * wire as part of a batch. There is no guarantee of sending entire content of {@code mutations}<a name="line.90"></a> -<span class="sourceLineNo">091</span> * in a single batch; it will be broken up according to the write buffer capacity.<a name="line.91"></a> -<span class="sourceLineNo">092</span> *<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @param mutations The data to send.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @throws IOException if a remote or network exception occurs.<a name="line.94"></a> -<span class="sourceLineNo">095</span> */<a name="line.95"></a> -<span class="sourceLineNo">096</span> void mutate(List<? extends Mutation> mutations) throws IOException;<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * Performs a {@link #flush()} and releases any resources held.<a name="line.99"></a> -<span class="sourceLineNo">100</span> *<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @throws IOException if a remote or network exception occurs.<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> @Override<a name="line.103"></a> -<span class="sourceLineNo">104</span> void close() throws IOException;<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> * Executes all the buffered, asynchronous {@link Mutation} operations and waits until they<a name="line.107"></a> -<span class="sourceLineNo">108</span> * are done.<a name="line.108"></a> -<span class="sourceLineNo">109</span> *<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @throws IOException if a remote or network exception occurs.<a name="line.110"></a> -<span class="sourceLineNo">111</span> */<a name="line.111"></a> -<span class="sourceLineNo">112</span> void flush() throws IOException;<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * Returns the maximum size in bytes of the write buffer for this HTable.<a name="line.115"></a> -<span class="sourceLineNo">116</span> * <p><a name="line.116"></a> -<span class="sourceLineNo">117</span> * The default value comes from the configuration parameter {@code hbase.client.write.buffer}.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @return The size of the write buffer in bytes.<a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span> long getWriteBufferSize();<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> /**<a name="line.122"></a> -<span class="sourceLineNo">123</span> * Set rpc timeout for this mutator instance<a name="line.123"></a> +<span class="sourceLineNo">072</span> * Gets the fully qualified table name instance of the table that this BufferedMutator writes to.<a name="line.72"></a> +<span class="sourceLineNo">073</span> */<a name="line.73"></a> +<span class="sourceLineNo">074</span> TableName getName();<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> /**<a name="line.76"></a> +<span class="sourceLineNo">077</span> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * <p><a name="line.78"></a> +<span class="sourceLineNo">079</span> * The reference returned is not a copy, so any change made to it will<a name="line.79"></a> +<span class="sourceLineNo">080</span> * affect this instance.<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> Configuration getConfiguration();<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> * Sends a {@link Mutation} to the table. The mutations will be buffered and sent over the<a name="line.85"></a> +<span class="sourceLineNo">086</span> * wire as part of a batch. Currently only supports {@link Put} and {@link Delete} mutations.<a name="line.86"></a> +<span class="sourceLineNo">087</span> *<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @param mutation The data to send.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @throws IOException if a remote or network exception occurs.<a name="line.89"></a> +<span class="sourceLineNo">090</span> */<a name="line.90"></a> +<span class="sourceLineNo">091</span> void mutate(Mutation mutation) throws IOException;<a name="line.91"></a> +<span class="sourceLineNo">092</span><a name="line.92"></a> +<span class="sourceLineNo">093</span> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * Send some {@link Mutation}s to the table. The mutations will be buffered and sent over the<a name="line.94"></a> +<span class="sourceLineNo">095</span> * wire as part of a batch. There is no guarantee of sending entire content of {@code mutations}<a name="line.95"></a> +<span class="sourceLineNo">096</span> * in a single batch; it will be broken up according to the write buffer capacity.<a name="line.96"></a> +<span class="sourceLineNo">097</span> *<a name="line.97"></a> +<span class="sourceLineNo">098</span> * @param mutations The data to send.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @throws IOException if a remote or network exception occurs.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void mutate(List<? extends Mutation> mutations) throws IOException;<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> * Performs a {@link #flush()} and releases any resources held.<a name="line.104"></a> +<span class="sourceLineNo">105</span> *<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @throws IOException if a remote or network exception occurs.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> @Override<a name="line.108"></a> +<span class="sourceLineNo">109</span> void close() throws IOException;<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> * Executes all the buffered, asynchronous {@link Mutation} operations and waits until they<a name="line.112"></a> +<span class="sourceLineNo">113</span> * are done.<a name="line.113"></a> +<span class="sourceLineNo">114</span> *<a name="line.114"></a> +<span class="sourceLineNo">115</span> * @throws IOException if a remote or network exception occurs.<a name="line.115"></a> +<span class="sourceLineNo">116</span> */<a name="line.116"></a> +<span class="sourceLineNo">117</span> void flush() throws IOException;<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> * Returns the maximum size in bytes of the write buffer for this HTable.<a name="line.120"></a> +<span class="sourceLineNo">121</span> * <p><a name="line.121"></a> +<span class="sourceLineNo">122</span> * The default value comes from the configuration parameter {@code hbase.client.write.buffer}.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @return The size of the write buffer in bytes.<a name="line.123"></a> <span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> void setRpcTimeout(int timeout);<a name="line.125"></a> +<span class="sourceLineNo">125</span> long getWriteBufferSize();<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> * Set operation timeout for this mutator instance<a name="line.128"></a> +<span class="sourceLineNo">128</span> * Set rpc timeout for this mutator instance<a name="line.128"></a> <span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> void setOperationTimeout(int timeout);<a name="line.130"></a> +<span class="sourceLineNo">130</span> void setRpcTimeout(int timeout);<a name="line.130"></a> <span class="sourceLineNo">131</span><a name="line.131"></a> <span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * Listens for asynchronous exceptions on a {@link BufferedMutator}.<a name="line.133"></a> +<span class="sourceLineNo">133</span> * Set operation timeout for this mutator instance<a name="line.133"></a> <span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> @InterfaceAudience.Public<a name="line.135"></a> -<span class="sourceLineNo">136</span> @InterfaceStability.Evolving<a name="line.136"></a> -<span class="sourceLineNo">137</span> interface ExceptionListener {<a name="line.137"></a> -<span class="sourceLineNo">138</span> public void onException(RetriesExhaustedWithDetailsException exception,<a name="line.138"></a> -<span class="sourceLineNo">139</span> BufferedMutator mutator) throws RetriesExhaustedWithDetailsException;<a name="line.139"></a> -<span class="sourceLineNo">140</span> }<a name="line.140"></a> -<span class="sourceLineNo">141</span>}<a name="line.141"></a> +<span class="sourceLineNo">135</span> void setOperationTimeout(int timeout);<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> * Listens for asynchronous exceptions on a {@link BufferedMutator}.<a name="line.138"></a> +<span class="sourceLineNo">139</span> */<a name="line.139"></a> +<span class="sourceLineNo">140</span> @InterfaceAudience.Public<a name="line.140"></a> +<span class="sourceLineNo">141</span> @InterfaceStability.Evolving<a name="line.141"></a> +<span class="sourceLineNo">142</span> interface ExceptionListener {<a name="line.142"></a> +<span class="sourceLineNo">143</span> public void onException(RetriesExhaustedWithDetailsException exception,<a name="line.143"></a> +<span class="sourceLineNo">144</span> BufferedMutator mutator) throws RetriesExhaustedWithDetailsException;<a name="line.144"></a> +<span class="sourceLineNo">145</span> }<a name="line.145"></a> +<span class="sourceLineNo">146</span>}<a name="line.146"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.html b/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.html index 737e410..b05f9a2 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutator.html @@ -72,81 +72,86 @@ <span class="sourceLineNo">064</span>@InterfaceStability.Evolving<a name="line.64"></a> <span class="sourceLineNo">065</span>public interface BufferedMutator extends Closeable {<a name="line.65"></a> <span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * Gets the fully qualified table name instance of the table that this BufferedMutator writes to.<a name="line.67"></a> +<span class="sourceLineNo">067</span> * Key to use setting non-default BufferedMutator implementation in Configuration.<a name="line.67"></a> <span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> TableName getName();<a name="line.69"></a> +<span class="sourceLineNo">069</span> public static final String CLASSNAME_KEY = "hbase.client.bufferedmutator.classname";<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> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * The reference returned is not a copy, so any change made to it will<a name="line.74"></a> -<span class="sourceLineNo">075</span> * affect this instance.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> Configuration getConfiguration();<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> * Sends a {@link Mutation} to the table. The mutations will be buffered and sent over the<a name="line.80"></a> -<span class="sourceLineNo">081</span> * wire as part of a batch. Currently only supports {@link Put} and {@link Delete} mutations.<a name="line.81"></a> -<span class="sourceLineNo">082</span> *<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param mutation The data to send.<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @throws IOException if a remote or network exception occurs.<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> void mutate(Mutation mutation) throws IOException;<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * Send some {@link Mutation}s to the table. The mutations will be buffered and sent over the<a name="line.89"></a> -<span class="sourceLineNo">090</span> * wire as part of a batch. There is no guarantee of sending entire content of {@code mutations}<a name="line.90"></a> -<span class="sourceLineNo">091</span> * in a single batch; it will be broken up according to the write buffer capacity.<a name="line.91"></a> -<span class="sourceLineNo">092</span> *<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @param mutations The data to send.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @throws IOException if a remote or network exception occurs.<a name="line.94"></a> -<span class="sourceLineNo">095</span> */<a name="line.95"></a> -<span class="sourceLineNo">096</span> void mutate(List<? extends Mutation> mutations) throws IOException;<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * Performs a {@link #flush()} and releases any resources held.<a name="line.99"></a> -<span class="sourceLineNo">100</span> *<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @throws IOException if a remote or network exception occurs.<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> @Override<a name="line.103"></a> -<span class="sourceLineNo">104</span> void close() throws IOException;<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> * Executes all the buffered, asynchronous {@link Mutation} operations and waits until they<a name="line.107"></a> -<span class="sourceLineNo">108</span> * are done.<a name="line.108"></a> -<span class="sourceLineNo">109</span> *<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @throws IOException if a remote or network exception occurs.<a name="line.110"></a> -<span class="sourceLineNo">111</span> */<a name="line.111"></a> -<span class="sourceLineNo">112</span> void flush() throws IOException;<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * Returns the maximum size in bytes of the write buffer for this HTable.<a name="line.115"></a> -<span class="sourceLineNo">116</span> * <p><a name="line.116"></a> -<span class="sourceLineNo">117</span> * The default value comes from the configuration parameter {@code hbase.client.write.buffer}.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @return The size of the write buffer in bytes.<a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span> long getWriteBufferSize();<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> /**<a name="line.122"></a> -<span class="sourceLineNo">123</span> * Set rpc timeout for this mutator instance<a name="line.123"></a> +<span class="sourceLineNo">072</span> * Gets the fully qualified table name instance of the table that this BufferedMutator writes to.<a name="line.72"></a> +<span class="sourceLineNo">073</span> */<a name="line.73"></a> +<span class="sourceLineNo">074</span> TableName getName();<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> /**<a name="line.76"></a> +<span class="sourceLineNo">077</span> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * <p><a name="line.78"></a> +<span class="sourceLineNo">079</span> * The reference returned is not a copy, so any change made to it will<a name="line.79"></a> +<span class="sourceLineNo">080</span> * affect this instance.<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> Configuration getConfiguration();<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> * Sends a {@link Mutation} to the table. The mutations will be buffered and sent over the<a name="line.85"></a> +<span class="sourceLineNo">086</span> * wire as part of a batch. Currently only supports {@link Put} and {@link Delete} mutations.<a name="line.86"></a> +<span class="sourceLineNo">087</span> *<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @param mutation The data to send.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @throws IOException if a remote or network exception occurs.<a name="line.89"></a> +<span class="sourceLineNo">090</span> */<a name="line.90"></a> +<span class="sourceLineNo">091</span> void mutate(Mutation mutation) throws IOException;<a name="line.91"></a> +<span class="sourceLineNo">092</span><a name="line.92"></a> +<span class="sourceLineNo">093</span> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * Send some {@link Mutation}s to the table. The mutations will be buffered and sent over the<a name="line.94"></a> +<span class="sourceLineNo">095</span> * wire as part of a batch. There is no guarantee of sending entire content of {@code mutations}<a name="line.95"></a> +<span class="sourceLineNo">096</span> * in a single batch; it will be broken up according to the write buffer capacity.<a name="line.96"></a> +<span class="sourceLineNo">097</span> *<a name="line.97"></a> +<span class="sourceLineNo">098</span> * @param mutations The data to send.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @throws IOException if a remote or network exception occurs.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> void mutate(List<? extends Mutation> mutations) throws IOException;<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> * Performs a {@link #flush()} and releases any resources held.<a name="line.104"></a> +<span class="sourceLineNo">105</span> *<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @throws IOException if a remote or network exception occurs.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> @Override<a name="line.108"></a> +<span class="sourceLineNo">109</span> void close() throws IOException;<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> * Executes all the buffered, asynchronous {@link Mutation} operations and waits until they<a name="line.112"></a> +<span class="sourceLineNo">113</span> * are done.<a name="line.113"></a> +<span class="sourceLineNo">114</span> *<a name="line.114"></a> +<span class="sourceLineNo">115</span> * @throws IOException if a remote or network exception occurs.<a name="line.115"></a> +<span class="sourceLineNo">116</span> */<a name="line.116"></a> +<span class="sourceLineNo">117</span> void flush() throws IOException;<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> * Returns the maximum size in bytes of the write buffer for this HTable.<a name="line.120"></a> +<span class="sourceLineNo">121</span> * <p><a name="line.121"></a> +<span class="sourceLineNo">122</span> * The default value comes from the configuration parameter {@code hbase.client.write.buffer}.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @return The size of the write buffer in bytes.<a name="line.123"></a> <span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> void setRpcTimeout(int timeout);<a name="line.125"></a> +<span class="sourceLineNo">125</span> long getWriteBufferSize();<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> * Set operation timeout for this mutator instance<a name="line.128"></a> +<span class="sourceLineNo">128</span> * Set rpc timeout for this mutator instance<a name="line.128"></a> <span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> void setOperationTimeout(int timeout);<a name="line.130"></a> +<span class="sourceLineNo">130</span> void setRpcTimeout(int timeout);<a name="line.130"></a> <span class="sourceLineNo">131</span><a name="line.131"></a> <span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * Listens for asynchronous exceptions on a {@link BufferedMutator}.<a name="line.133"></a> +<span class="sourceLineNo">133</span> * Set operation timeout for this mutator instance<a name="line.133"></a> <span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> @InterfaceAudience.Public<a name="line.135"></a> -<span class="sourceLineNo">136</span> @InterfaceStability.Evolving<a name="line.136"></a> -<span class="sourceLineNo">137</span> interface ExceptionListener {<a name="line.137"></a> -<span class="sourceLineNo">138</span> public void onException(RetriesExhaustedWithDetailsException exception,<a name="line.138"></a> -<span class="sourceLineNo">139</span> BufferedMutator mutator) throws RetriesExhaustedWithDetailsException;<a name="line.139"></a> -<span class="sourceLineNo">140</span> }<a name="line.140"></a> -<span class="sourceLineNo">141</span>}<a name="line.141"></a> +<span class="sourceLineNo">135</span> void setOperationTimeout(int timeout);<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> * Listens for asynchronous exceptions on a {@link BufferedMutator}.<a name="line.138"></a> +<span class="sourceLineNo">139</span> */<a name="line.139"></a> +<span class="sourceLineNo">140</span> @InterfaceAudience.Public<a name="line.140"></a> +<span class="sourceLineNo">141</span> @InterfaceStability.Evolving<a name="line.141"></a> +<span class="sourceLineNo">142</span> interface ExceptionListener {<a name="line.142"></a> +<span class="sourceLineNo">143</span> public void onException(RetriesExhaustedWithDetailsException exception,<a name="line.143"></a> +<span class="sourceLineNo">144</span> BufferedMutator mutator) throws RetriesExhaustedWithDetailsException;<a name="line.144"></a> +<span class="sourceLineNo">145</span> }<a name="line.145"></a> +<span class="sourceLineNo">146</span>}<a name="line.146"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutatorParams.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutatorParams.html b/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutatorParams.html index 107d5c3..2e987fd 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutatorParams.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/BufferedMutatorParams.html @@ -38,7 +38,7 @@ <span class="sourceLineNo">030</span> */<a name="line.30"></a> <span class="sourceLineNo">031</span>@InterfaceAudience.Public<a name="line.31"></a> <span class="sourceLineNo">032</span>@InterfaceStability.Evolving<a name="line.32"></a> -<span class="sourceLineNo">033</span>public class BufferedMutatorParams {<a name="line.33"></a> +<span class="sourceLineNo">033</span>public class BufferedMutatorParams implements Cloneable {<a name="line.33"></a> <span class="sourceLineNo">034</span><a name="line.34"></a> <span class="sourceLineNo">035</span> static final int UNSET = -1;<a name="line.35"></a> <span class="sourceLineNo">036</span><a name="line.36"></a> @@ -46,76 +46,131 @@ <span class="sourceLineNo">038</span> private long writeBufferSize = UNSET;<a name="line.38"></a> <span class="sourceLineNo">039</span> private int maxKeyValueSize = UNSET;<a name="line.39"></a> <span class="sourceLineNo">040</span> private ExecutorService pool = null;<a name="line.40"></a> -<span class="sourceLineNo">041</span> private BufferedMutator.ExceptionListener listener = new BufferedMutator.ExceptionListener() {<a name="line.41"></a> -<span class="sourceLineNo">042</span> @Override<a name="line.42"></a> -<span class="sourceLineNo">043</span> public void onException(RetriesExhaustedWithDetailsException exception,<a name="line.43"></a> -<span class="sourceLineNo">044</span> BufferedMutator bufferedMutator)<a name="line.44"></a> -<span class="sourceLineNo">045</span> throws RetriesExhaustedWithDetailsException {<a name="line.45"></a> -<span class="sourceLineNo">046</span> throw exception;<a name="line.46"></a> -<span class="sourceLineNo">047</span> }<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> public BufferedMutatorParams(TableName tableName) {<a name="line.50"></a> -<span class="sourceLineNo">051</span> this.tableName = tableName;<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> public TableName getTableName() {<a name="line.54"></a> -<span class="sourceLineNo">055</span> return tableName;<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> public long getWriteBufferSize() {<a name="line.58"></a> -<span class="sourceLineNo">059</span> return writeBufferSize;<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> /**<a name="line.62"></a> -<span class="sourceLineNo">063</span> * Override the write buffer size specified by the provided {@link Connection}'s<a name="line.63"></a> -<span class="sourceLineNo">064</span> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key<a name="line.64"></a> -<span class="sourceLineNo">065</span> * {@code hbase.client.write.buffer}.<a name="line.65"></a> -<span class="sourceLineNo">066</span> */<a name="line.66"></a> -<span class="sourceLineNo">067</span> public BufferedMutatorParams writeBufferSize(long writeBufferSize) {<a name="line.67"></a> -<span class="sourceLineNo">068</span> this.writeBufferSize = writeBufferSize;<a name="line.68"></a> -<span class="sourceLineNo">069</span> return this;<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> public int getMaxKeyValueSize() {<a name="line.72"></a> -<span class="sourceLineNo">073</span> return maxKeyValueSize;<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> /**<a name="line.76"></a> -<span class="sourceLineNo">077</span> * Override the maximum key-value size specified by the provided {@link Connection}'s<a name="line.77"></a> -<span class="sourceLineNo">078</span> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key<a name="line.78"></a> -<span class="sourceLineNo">079</span> * {@code hbase.client.keyvalue.maxsize}.<a name="line.79"></a> -<span class="sourceLineNo">080</span> */<a name="line.80"></a> -<span class="sourceLineNo">081</span> public BufferedMutatorParams maxKeyValueSize(int maxKeyValueSize) {<a name="line.81"></a> -<span class="sourceLineNo">082</span> this.maxKeyValueSize = maxKeyValueSize;<a name="line.82"></a> -<span class="sourceLineNo">083</span> return this;<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> public ExecutorService getPool() {<a name="line.86"></a> -<span class="sourceLineNo">087</span> return pool;<a name="line.87"></a> -<span class="sourceLineNo">088</span> }<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 the default executor pool defined by the {@code hbase.htable.threads.*}<a name="line.91"></a> -<span class="sourceLineNo">092</span> * configuration values.<a name="line.92"></a> -<span class="sourceLineNo">093</span> */<a name="line.93"></a> -<span class="sourceLineNo">094</span> public BufferedMutatorParams pool(ExecutorService pool) {<a name="line.94"></a> -<span class="sourceLineNo">095</span> this.pool = pool;<a name="line.95"></a> -<span class="sourceLineNo">096</span> return this;<a name="line.96"></a> -<span class="sourceLineNo">097</span> }<a name="line.97"></a> -<span class="sourceLineNo">098</span><a name="line.98"></a> -<span class="sourceLineNo">099</span> public BufferedMutator.ExceptionListener getListener() {<a name="line.99"></a> -<span class="sourceLineNo">100</span> return listener;<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> * Override the default error handler. Default handler simply rethrows the exception.<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> public BufferedMutatorParams listener(BufferedMutator.ExceptionListener listener) {<a name="line.106"></a> -<span class="sourceLineNo">107</span> this.listener = listener;<a name="line.107"></a> -<span class="sourceLineNo">108</span> return this;<a name="line.108"></a> +<span class="sourceLineNo">041</span> private String implementationClassName = null;<a name="line.41"></a> +<span class="sourceLineNo">042</span> private int rpcTimeout = UNSET;<a name="line.42"></a> +<span class="sourceLineNo">043</span> private int operationTimeout = UNSET;<a name="line.43"></a> +<span class="sourceLineNo">044</span> private BufferedMutator.ExceptionListener listener = new BufferedMutator.ExceptionListener() {<a name="line.44"></a> +<span class="sourceLineNo">045</span> @Override<a name="line.45"></a> +<span class="sourceLineNo">046</span> public void onException(RetriesExhaustedWithDetailsException exception,<a name="line.46"></a> +<span class="sourceLineNo">047</span> BufferedMutator bufferedMutator)<a name="line.47"></a> +<span class="sourceLineNo">048</span> throws RetriesExhaustedWithDetailsException {<a name="line.48"></a> +<span class="sourceLineNo">049</span> throw exception;<a name="line.49"></a> +<span class="sourceLineNo">050</span> }<a name="line.50"></a> +<span class="sourceLineNo">051</span> };<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> public BufferedMutatorParams(TableName tableName) {<a name="line.53"></a> +<span class="sourceLineNo">054</span> this.tableName = tableName;<a name="line.54"></a> +<span class="sourceLineNo">055</span> }<a name="line.55"></a> +<span class="sourceLineNo">056</span><a name="line.56"></a> +<span class="sourceLineNo">057</span> public TableName getTableName() {<a name="line.57"></a> +<span class="sourceLineNo">058</span> return tableName;<a name="line.58"></a> +<span class="sourceLineNo">059</span> }<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> public long getWriteBufferSize() {<a name="line.61"></a> +<span class="sourceLineNo">062</span> return writeBufferSize;<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> public BufferedMutatorParams rpcTimeout(final int rpcTimeout) {<a name="line.65"></a> +<span class="sourceLineNo">066</span> this.rpcTimeout = rpcTimeout;<a name="line.66"></a> +<span class="sourceLineNo">067</span> return this;<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> public int getRpcTimeout() {<a name="line.70"></a> +<span class="sourceLineNo">071</span> return rpcTimeout;<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> public BufferedMutatorParams opertationTimeout(final int operationTimeout) {<a name="line.74"></a> +<span class="sourceLineNo">075</span> this.operationTimeout = operationTimeout;<a name="line.75"></a> +<span class="sourceLineNo">076</span> return this;<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> public int getOperationTimeout() {<a name="line.79"></a> +<span class="sourceLineNo">080</span> return operationTimeout;<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span><a name="line.82"></a> +<span class="sourceLineNo">083</span> /**<a name="line.83"></a> +<span class="sourceLineNo">084</span> * Override the write buffer size specified by the provided {@link Connection}'s<a name="line.84"></a> +<span class="sourceLineNo">085</span> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key<a name="line.85"></a> +<span class="sourceLineNo">086</span> * {@code hbase.client.write.buffer}.<a name="line.86"></a> +<span class="sourceLineNo">087</span> */<a name="line.87"></a> +<span class="sourceLineNo">088</span> public BufferedMutatorParams writeBufferSize(long writeBufferSize) {<a name="line.88"></a> +<span class="sourceLineNo">089</span> this.writeBufferSize = writeBufferSize;<a name="line.89"></a> +<span class="sourceLineNo">090</span> return this;<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> public int getMaxKeyValueSize() {<a name="line.93"></a> +<span class="sourceLineNo">094</span> return maxKeyValueSize;<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> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * Override the maximum key-value size specified by the provided {@link Connection}'s<a name="line.98"></a> +<span class="sourceLineNo">099</span> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key<a name="line.99"></a> +<span class="sourceLineNo">100</span> * {@code hbase.client.keyvalue.maxsize}.<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> public BufferedMutatorParams maxKeyValueSize(int maxKeyValueSize) {<a name="line.102"></a> +<span class="sourceLineNo">103</span> this.maxKeyValueSize = maxKeyValueSize;<a name="line.103"></a> +<span class="sourceLineNo">104</span> return this;<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> public ExecutorService getPool() {<a name="line.107"></a> +<span class="sourceLineNo">108</span> return pool;<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">110</span><a name="line.110"></a> +<span class="sourceLineNo">111</span> /**<a name="line.111"></a> +<span class="sourceLineNo">112</span> * Override the default executor pool defined by the {@code hbase.htable.threads.*}<a name="line.112"></a> +<span class="sourceLineNo">113</span> * configuration values.<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> public BufferedMutatorParams pool(ExecutorService pool) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> this.pool = pool;<a name="line.116"></a> +<span class="sourceLineNo">117</span> return this;<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> /**<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @return Name of the class we will use when we construct a<a name="line.121"></a> +<span class="sourceLineNo">122</span> * {@link BufferedMutator} instance or null if default implementation.<a name="line.122"></a> +<span class="sourceLineNo">123</span> */<a name="line.123"></a> +<span class="sourceLineNo">124</span> public String getImplementationClassName() {<a name="line.124"></a> +<span class="sourceLineNo">125</span> return this.implementationClassName;<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> /**<a name="line.128"></a> +<span class="sourceLineNo">129</span> * Specify a BufferedMutator implementation other than the default.<a name="line.129"></a> +<span class="sourceLineNo">130</span> * @param implementationClassName Name of the BufferedMutator implementation class<a name="line.130"></a> +<span class="sourceLineNo">131</span> */<a name="line.131"></a> +<span class="sourceLineNo">132</span> public BufferedMutatorParams implementationClassName(String implementationClassName) {<a name="line.132"></a> +<span class="sourceLineNo">133</span> this.implementationClassName = implementationClassName;<a name="line.133"></a> +<span class="sourceLineNo">134</span> return this;<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> public BufferedMutator.ExceptionListener getListener() {<a name="line.137"></a> +<span class="sourceLineNo">138</span> return listener;<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> /**<a name="line.141"></a> +<span class="sourceLineNo">142</span> * Override the default error handler. Default handler simply rethrows the exception.<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> public BufferedMutatorParams listener(BufferedMutator.ExceptionListener listener) {<a name="line.144"></a> +<span class="sourceLineNo">145</span> this.listener = listener;<a name="line.145"></a> +<span class="sourceLineNo">146</span> return this;<a name="line.146"></a> +<span class="sourceLineNo">147</span> }<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span> /*<a name="line.149"></a> +<span class="sourceLineNo">150</span> * (non-Javadoc)<a name="line.150"></a> +<span class="sourceLineNo">151</span> *<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @see java.lang.Object#clone()<a name="line.152"></a> +<span class="sourceLineNo">153</span> */<a name="line.153"></a> +<span class="sourceLineNo">154</span> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="CN_IDIOM_NO_SUPER_CALL",<a name="line.154"></a> +<span class="sourceLineNo">155</span> justification="The clone below is complete")<a name="line.155"></a> +<span class="sourceLineNo">156</span> public BufferedMutatorParams clone() {<a name="line.156"></a> +<span class="sourceLineNo">157</span> BufferedMutatorParams clone = new BufferedMutatorParams(this.tableName);<a name="line.157"></a> +<span class="sourceLineNo">158</span> clone.writeBufferSize = this.writeBufferSize;<a name="line.158"></a> +<span class="sourceLineNo">159</span> clone.maxKeyValueSize = maxKeyValueSize;<a name="line.159"></a> +<span class="sourceLineNo">160</span> clone.pool = this.pool;<a name="line.160"></a> +<span class="sourceLineNo">161</span> clone.listener = this.listener;<a name="line.161"></a> +<span class="sourceLineNo">162</span> clone.implementationClassName = this.implementationClassName;<a name="line.162"></a> +<span class="sourceLineNo">163</span> return clone;<a name="line.163"></a> +<span class="sourceLineNo">164</span> }<a name="line.164"></a> +<span class="sourceLineNo">165</span>}<a name="line.165"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/apidocs/src-html/org/apache/hadoop/hbase/client/Connection.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Connection.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Connection.html index 9d0e8d9..ddc7417 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Connection.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Connection.html @@ -91,97 +91,108 @@ <span class="sourceLineNo">083</span> * @param tableName the name of the table<a name="line.83"></a> <span class="sourceLineNo">084</span> * @return a Table to use for interactions with this table<a name="line.84"></a> <span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> Table getTable(TableName tableName) throws IOException;<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * Retrieve a Table implementation for accessing a table.<a name="line.89"></a> -<span class="sourceLineNo">090</span> * The returned Table is not thread safe, a new instance should be created for each using thread.<a name="line.90"></a> -<span class="sourceLineNo">091</span> * This is a lightweight operation, pooling or caching of the returned Table<a name="line.91"></a> -<span class="sourceLineNo">092</span> * is neither required nor desired.<a name="line.92"></a> -<span class="sourceLineNo">093</span> * <p><a name="line.93"></a> -<span class="sourceLineNo">094</span> * The caller is responsible for calling {@link Table#close()} on the returned<a name="line.94"></a> -<span class="sourceLineNo">095</span> * table instance.<a name="line.95"></a> -<span class="sourceLineNo">096</span> * <p><a name="line.96"></a> -<span class="sourceLineNo">097</span> * Since 0.98.1 this method no longer checks table existence. An exception<a name="line.97"></a> -<span class="sourceLineNo">098</span> * will be thrown if the table does not exist only when the first operation is<a name="line.98"></a> -<span class="sourceLineNo">099</span> * attempted.<a name="line.99"></a> -<span class="sourceLineNo">100</span> *<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @param tableName the name of the table<a name="line.101"></a> -<span class="sourceLineNo">102</span> * @param pool The thread pool to use for batch operations, null to use a default pool.<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @return a Table to use for interactions with this table<a name="line.103"></a> -<span class="sourceLineNo">104</span> */<a name="line.104"></a> -<span class="sourceLineNo">105</span> Table getTable(TableName tableName, ExecutorService pool) throws IOException;<a name="line.105"></a> -<span class="sourceLineNo">106</span><a name="line.106"></a> -<span class="sourceLineNo">107</span> /**<a name="line.107"></a> -<span class="sourceLineNo">108</span> * <p><a name="line.108"></a> -<span class="sourceLineNo">109</span> * Retrieve a {@link BufferedMutator} for performing client-side buffering of writes. The<a name="line.109"></a> -<span class="sourceLineNo">110</span> * {@link BufferedMutator} returned by this method is thread-safe. This BufferedMutator will<a name="line.110"></a> -<span class="sourceLineNo">111</span> * use the Connection's ExecutorService. This object can be used for long lived operations.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * </p><a name="line.112"></a> -<span class="sourceLineNo">113</span> * <p><a name="line.113"></a> -<span class="sourceLineNo">114</span> * The caller is responsible for calling {@link BufferedMutator#close()} on<a name="line.114"></a> -<span class="sourceLineNo">115</span> * the returned {@link BufferedMutator} instance.<a name="line.115"></a> +<span class="sourceLineNo">086</span> default Table getTable(TableName tableName) throws IOException {<a name="line.86"></a> +<span class="sourceLineNo">087</span> return getTable(tableName, null);<a name="line.87"></a> +<span class="sourceLineNo">088</span> }<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> * Retrieve a Table implementation for accessing a table.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * The returned Table is not thread safe, a new instance should be created for each using thread.<a name="line.92"></a> +<span class="sourceLineNo">093</span> * This is a lightweight operation, pooling or caching of the returned Table<a name="line.93"></a> +<span class="sourceLineNo">094</span> * is neither required nor desired.<a name="line.94"></a> +<span class="sourceLineNo">095</span> * <p><a name="line.95"></a> +<span class="sourceLineNo">096</span> * The caller is responsible for calling {@link Table#close()} on the returned<a name="line.96"></a> +<span class="sourceLineNo">097</span> * table instance.<a name="line.97"></a> +<span class="sourceLineNo">098</span> * <p><a name="line.98"></a> +<span class="sourceLineNo">099</span> * Since 0.98.1 this method no longer checks table existence. An exception<a name="line.99"></a> +<span class="sourceLineNo">100</span> * will be thrown if the table does not exist only when the first operation is<a name="line.100"></a> +<span class="sourceLineNo">101</span> * attempted.<a name="line.101"></a> +<span class="sourceLineNo">102</span> *<a name="line.102"></a> +<span class="sourceLineNo">103</span> * @param tableName the name of the table<a name="line.103"></a> +<span class="sourceLineNo">104</span> * @param pool The thread pool to use for batch operations, null to use a default pool.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @return a Table to use for interactions with this table<a name="line.105"></a> +<span class="sourceLineNo">106</span> */<a name="line.106"></a> +<span class="sourceLineNo">107</span> default Table getTable(TableName tableName, ExecutorService pool) throws IOException {<a name="line.107"></a> +<span class="sourceLineNo">108</span> return getTableBuilder(tableName, pool).build();<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> * <p><a name="line.112"></a> +<span class="sourceLineNo">113</span> * Retrieve a {@link BufferedMutator} for performing client-side buffering of writes. The<a name="line.113"></a> +<span class="sourceLineNo">114</span> * {@link BufferedMutator} returned by this method is thread-safe. This BufferedMutator will<a name="line.114"></a> +<span class="sourceLineNo">115</span> * use the Connection's ExecutorService. This object can be used for long lived operations.<a name="line.115"></a> <span class="sourceLineNo">116</span> * </p><a name="line.116"></a> <span class="sourceLineNo">117</span> * <p><a name="line.117"></a> -<span class="sourceLineNo">118</span> * This accessor will use the connection's ExecutorService and will throw an<a name="line.118"></a> -<span class="sourceLineNo">119</span> * exception in the main thread when an asynchronous exception occurs.<a name="line.119"></a> -<span class="sourceLineNo">120</span> *<a name="line.120"></a> -<span class="sourceLineNo">121</span> * @param tableName the name of the table<a name="line.121"></a> -<span class="sourceLineNo">122</span> *<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @return a {@link BufferedMutator} for the supplied tableName.<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> BufferedMutator getBufferedMutator(TableName tableName) throws IOException;<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> * Retrieve a {@link BufferedMutator} for performing client-side buffering of writes. The<a name="line.128"></a> -<span class="sourceLineNo">129</span> * {@link BufferedMutator} returned by this method is thread-safe. This object can be used for<a name="line.129"></a> -<span class="sourceLineNo">130</span> * long lived table operations. The caller is responsible for calling<a name="line.130"></a> -<span class="sourceLineNo">131</span> * {@link BufferedMutator#close()} on the returned {@link BufferedMutator} instance.<a name="line.131"></a> -<span class="sourceLineNo">132</span> *<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @param params details on how to instantiate the {@code BufferedMutator}.<a name="line.133"></a> -<span class="sourceLineNo">134</span> * @return a {@link BufferedMutator} for the supplied tableName.<a name="line.134"></a> -<span class="sourceLineNo">135</span> */<a name="line.135"></a> -<span class="sourceLineNo">136</span> BufferedMutator getBufferedMutator(BufferedMutatorParams params) throws IOException;<a name="line.136"></a> -<span class="sourceLineNo">137</span><a name="line.137"></a> -<span class="sourceLineNo">138</span> /**<a name="line.138"></a> -<span class="sourceLineNo">139</span> * Retrieve a RegionLocator implementation to inspect region information on a table. The returned<a name="line.139"></a> -<span class="sourceLineNo">140</span> * RegionLocator is not thread-safe, so a new instance should be created for each using thread.<a name="line.140"></a> -<span class="sourceLineNo">141</span> *<a name="line.141"></a> -<span class="sourceLineNo">142</span> * This is a lightweight operation. Pooling or caching of the returned RegionLocator is neither<a name="line.142"></a> -<span class="sourceLineNo">143</span> * required nor desired.<a name="line.143"></a> -<span class="sourceLineNo">144</span> * <br><a name="line.144"></a> -<span class="sourceLineNo">145</span> * The caller is responsible for calling {@link RegionLocator#close()} on the returned<a name="line.145"></a> -<span class="sourceLineNo">146</span> * RegionLocator instance.<a name="line.146"></a> -<span class="sourceLineNo">147</span> *<a name="line.147"></a> -<span class="sourceLineNo">148</span> * RegionLocator needs to be unmanaged<a name="line.148"></a> -<span class="sourceLineNo">149</span> *<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param tableName Name of the table who's region is to be examined<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @return A RegionLocator instance<a name="line.151"></a> -<span class="sourceLineNo">152</span> */<a name="line.152"></a> -<span class="sourceLineNo">153</span> RegionLocator getRegionLocator(TableName tableName) throws IOException;<a name="line.153"></a> -<span class="sourceLineNo">154</span><a name="line.154"></a> -<span class="sourceLineNo">155</span> /**<a name="line.155"></a> -<span class="sourceLineNo">156</span> * Retrieve an Admin implementation to administer an HBase cluster.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * The returned Admin is not guaranteed to be thread-safe. A new instance should be created for<a name="line.157"></a> -<span class="sourceLineNo">158</span> * each using thread. This is a lightweight operation. Pooling or caching of the returned<a name="line.158"></a> -<span class="sourceLineNo">159</span> * Admin is not recommended.<a name="line.159"></a> -<span class="sourceLineNo">160</span> * <br><a name="line.160"></a> -<span class="sourceLineNo">161</span> * The caller is responsible for calling {@link Admin#close()} on the returned<a name="line.161"></a> -<span class="sourceLineNo">162</span> * Admin instance.<a name="line.162"></a> -<span class="sourceLineNo">163</span> *<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @return an Admin instance for cluster administration<a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> Admin getAdmin() throws IOException;<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> @Override<a name="line.168"></a> -<span class="sourceLineNo">169</span> void close() throws IOException;<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> /**<a name="line.171"></a> -<span class="sourceLineNo">172</span> * Returns whether the connection is closed or not.<a name="line.172"></a> -<span class="sourceLineNo">173</span> * @return true if this connection is closed<a name="line.173"></a> -<span class="sourceLineNo">174</span> */<a name="line.174"></a> -<span class="sourceLineNo">175</span> boolean isClosed();<a name="line.175"></a> -<span class="sourceLineNo">176</span>}<a name="line.176"></a> +<span class="sourceLineNo">118</span> * The caller is responsible for calling {@link BufferedMutator#close()} on<a name="line.118"></a> +<span class="sourceLineNo">119</span> * the returned {@link BufferedMutator} instance.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * </p><a name="line.120"></a> +<span class="sourceLineNo">121</span> * <p><a name="line.121"></a> +<span class="sourceLineNo">122</span> * This accessor will use the connection's ExecutorService and will throw an<a name="line.122"></a> +<span class="sourceLineNo">123</span> * exception in the main thread when an asynchronous exception occurs.<a name="line.123"></a> +<span class="sourceLineNo">124</span> *<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @param tableName the name of the table<a name="line.125"></a> +<span class="sourceLineNo">126</span> *<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @return a {@link BufferedMutator} for the supplied tableName.<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> BufferedMutator getBufferedMutator(TableName tableName) throws IOException;<a name="line.129"></a> +<span class="sourceLineNo">130</span><a name="line.130"></a> +<span class="sourceLineNo">131</span> /**<a name="line.131"></a> +<span class="sourceLineNo">132</span> * Retrieve a {@link BufferedMutator} for performing client-side buffering of writes. The<a name="line.132"></a> +<span class="sourceLineNo">133</span> * {@link BufferedMutator} returned by this method is thread-safe. This object can be used for<a name="line.133"></a> +<span class="sourceLineNo">134</span> * long lived table operations. The caller is responsible for calling<a name="line.134"></a> +<span class="sourceLineNo">135</span> * {@link BufferedMutator#close()} on the returned {@link BufferedMutator} instance.<a name="line.135"></a> +<span class="sourceLineNo">136</span> *<a name="line.136"></a> +<span class="sourceLineNo">137</span> * @param params details on how to instantiate the {@code BufferedMutator}.<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @return a {@link BufferedMutator} for the supplied tableName.<a name="line.138"></a> +<span class="sourceLineNo">139</span> */<a name="line.139"></a> +<span class="sourceLineNo">140</span> BufferedMutator getBufferedMutator(BufferedMutatorParams params) throws IOException;<a name="line.140"></a> +<span class="sourceLineNo">141</span><a name="line.141"></a> +<span class="sourceLineNo">142</span> /**<a name="line.142"></a> +<span class="sourceLineNo">143</span> * Retrieve a RegionLocator implementation to inspect region information on a table. The returned<a name="line.143"></a> +<span class="sourceLineNo">144</span> * RegionLocator is not thread-safe, so a new instance should be created for each using thread.<a name="line.144"></a> +<span class="sourceLineNo">145</span> *<a name="line.145"></a> +<span class="sourceLineNo">146</span> * This is a lightweight operation. Pooling or caching of the returned RegionLocator is neither<a name="line.146"></a> +<span class="sourceLineNo">147</span> * required nor desired.<a name="line.147"></a> +<span class="sourceLineNo">148</span> * <br><a name="line.148"></a> +<span class="sourceLineNo">149</span> * The caller is responsible for calling {@link RegionLocator#close()} on the returned<a name="line.149"></a> +<span class="sourceLineNo">150</span> * RegionLocator instance.<a name="line.150"></a> +<span class="sourceLineNo">151</span> *<a name="line.151"></a> +<span class="sourceLineNo">152</span> * RegionLocator needs to be unmanaged<a name="line.152"></a> +<span class="sourceLineNo">153</span> *<a name="line.153"></a> +<span class="sourceLineNo">154</span> * @param tableName Name of the table who's region is to be examined<a name="line.154"></a> +<span class="sourceLineNo">155</span> * @return A RegionLocator instance<a name="line.155"></a> +<span class="sourceLineNo">156</span> */<a name="line.156"></a> +<span class="sourceLineNo">157</span> RegionLocator getRegionLocator(TableName tableName) throws IOException;<a name="line.157"></a> +<span class="sourceLineNo">158</span><a name="line.158"></a> +<span class="sourceLineNo">159</span> /**<a name="line.159"></a> +<span class="sourceLineNo">160</span> * Retrieve an Admin implementation to administer an HBase cluster.<a name="line.160"></a> +<span class="sourceLineNo">161</span> * The returned Admin is not guaranteed to be thread-safe. A new instance should be created for<a name="line.161"></a> +<span class="sourceLineNo">162</span> * each using thread. This is a lightweight operation. Pooling or caching of the returned<a name="line.162"></a> +<span class="sourceLineNo">163</span> * Admin is not recommended.<a name="line.163"></a> +<span class="sourceLineNo">164</span> * <br><a name="line.164"></a> +<span class="sourceLineNo">165</span> * The caller is responsible for calling {@link Admin#close()} on the returned<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Admin instance.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return an Admin instance for cluster administration<a name="line.168"></a> +<span class="sourceLineNo">169</span> */<a name="line.169"></a> +<span class="sourceLineNo">170</span> Admin getAdmin() throws IOException;<a name="line.170"></a> +<span class="sourceLineNo">171</span><a name="line.171"></a> +<span class="sourceLineNo">172</span> @Override<a name="line.172"></a> +<span class="sourceLineNo">173</span> void close() throws IOException;<a name="line.173"></a> +<span class="sourceLineNo">174</span><a name="line.174"></a> +<span class="sourceLineNo">175</span> /**<a name="line.175"></a> +<span class="sourceLineNo">176</span> * Returns whether the connection is closed or not.<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @return true if this connection is closed<a name="line.177"></a> +<span class="sourceLineNo">178</span> */<a name="line.178"></a> +<span class="sourceLineNo">179</span> boolean isClosed();<a name="line.179"></a> +<span class="sourceLineNo">180</span><a name="line.180"></a> +<span class="sourceLineNo">181</span> /**<a name="line.181"></a> +<span class="sourceLineNo">182</span> * Returns an {@link TableBuilder} for creating {@link Table}.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @param tableName the name of the table<a name="line.183"></a> +<span class="sourceLineNo">184</span> * @param pool the thread pool to use for requests like batch and scan<a name="line.184"></a> +<span class="sourceLineNo">185</span> */<a name="line.185"></a> +<span class="sourceLineNo">186</span> TableBuilder getTableBuilder(TableName tableName, ExecutorService pool);<a name="line.186"></a> +<span class="sourceLineNo">187</span>}<a name="line.187"></a>
