http://git-wip-us.apache.org/repos/asf/hbase-site/blob/e312f773/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html index 192f920..fbdec56 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html @@ -571,426 +571,425 @@ <span class="sourceLineNo">563</span> * under a single row lock, so write operations to a row are synchronized, and<a name="line.563"></a> <span class="sourceLineNo">564</span> * readers are guaranteed to see this operation fully completed.<a name="line.564"></a> <span class="sourceLineNo">565</span> *<a name="line.565"></a> -<span class="sourceLineNo">566</span> * @param append object that specifies the columns and amounts to be used<a name="line.566"></a> -<span class="sourceLineNo">567</span> * for the increment operations<a name="line.567"></a> -<span class="sourceLineNo">568</span> * @throws IOException e<a name="line.568"></a> -<span class="sourceLineNo">569</span> * @return values of columns after the append operation (maybe null)<a name="line.569"></a> -<span class="sourceLineNo">570</span> */<a name="line.570"></a> -<span class="sourceLineNo">571</span> default Result append(final Append append) throws IOException {<a name="line.571"></a> -<span class="sourceLineNo">572</span> throw new NotImplementedException("Add an implementation!");<a name="line.572"></a> -<span class="sourceLineNo">573</span> }<a name="line.573"></a> -<span class="sourceLineNo">574</span><a name="line.574"></a> -<span class="sourceLineNo">575</span> /**<a name="line.575"></a> -<span class="sourceLineNo">576</span> * Increments one or more columns within a single row.<a name="line.576"></a> -<span class="sourceLineNo">577</span> * <p><a name="line.577"></a> -<span class="sourceLineNo">578</span> * This operation ensures atomicity to readers. Increments are done<a name="line.578"></a> -<span class="sourceLineNo">579</span> * under a single row lock, so write operations to a row are synchronized, and<a name="line.579"></a> -<span class="sourceLineNo">580</span> * readers are guaranteed to see this operation fully completed.<a name="line.580"></a> -<span class="sourceLineNo">581</span> *<a name="line.581"></a> -<span class="sourceLineNo">582</span> * @param increment object that specifies the columns and amounts to be used<a name="line.582"></a> -<span class="sourceLineNo">583</span> * for the increment operations<a name="line.583"></a> -<span class="sourceLineNo">584</span> * @throws IOException e<a name="line.584"></a> -<span class="sourceLineNo">585</span> * @return values of columns after the increment<a name="line.585"></a> -<span class="sourceLineNo">586</span> */<a name="line.586"></a> -<span class="sourceLineNo">587</span> default Result increment(final Increment increment) throws IOException {<a name="line.587"></a> -<span class="sourceLineNo">588</span> throw new NotImplementedException("Add an implementation!");<a name="line.588"></a> -<span class="sourceLineNo">589</span> }<a name="line.589"></a> -<span class="sourceLineNo">590</span><a name="line.590"></a> -<span class="sourceLineNo">591</span> /**<a name="line.591"></a> -<span class="sourceLineNo">592</span> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.592"></a> -<span class="sourceLineNo">593</span> * <p><a name="line.593"></a> -<span class="sourceLineNo">594</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.594"></a> -<span class="sourceLineNo">595</span> * @param row The row that contains the cell to increment.<a name="line.595"></a> -<span class="sourceLineNo">596</span> * @param family The column family of the cell to increment.<a name="line.596"></a> -<span class="sourceLineNo">597</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.597"></a> -<span class="sourceLineNo">598</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.598"></a> -<span class="sourceLineNo">599</span> * amount is negative).<a name="line.599"></a> -<span class="sourceLineNo">600</span> * @return The new value, post increment.<a name="line.600"></a> -<span class="sourceLineNo">601</span> * @throws IOException if a remote or network exception occurs.<a name="line.601"></a> -<span class="sourceLineNo">602</span> */<a name="line.602"></a> -<span class="sourceLineNo">603</span> default long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)<a name="line.603"></a> -<span class="sourceLineNo">604</span> throws IOException {<a name="line.604"></a> -<span class="sourceLineNo">605</span> Increment increment = new Increment(row).addColumn(family, qualifier, amount);<a name="line.605"></a> -<span class="sourceLineNo">606</span> Cell cell = increment(increment).getColumnLatestCell(family, qualifier);<a name="line.606"></a> -<span class="sourceLineNo">607</span> return Bytes.toLong(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength());<a name="line.607"></a> -<span class="sourceLineNo">608</span> }<a name="line.608"></a> -<span class="sourceLineNo">609</span><a name="line.609"></a> -<span class="sourceLineNo">610</span> /**<a name="line.610"></a> -<span class="sourceLineNo">611</span> * Atomically increments a column value. If the column value already exists<a name="line.611"></a> -<span class="sourceLineNo">612</span> * and is not a big-endian long, this could throw an exception. If the column<a name="line.612"></a> -<span class="sourceLineNo">613</span> * value does not yet exist it is initialized to <code>amount</code> and<a name="line.613"></a> -<span class="sourceLineNo">614</span> * written to the specified column.<a name="line.614"></a> -<span class="sourceLineNo">615</span> *<a name="line.615"></a> -<span class="sourceLineNo">616</span> * <p>Setting durability to {@link Durability#SKIP_WAL} means that in a fail<a name="line.616"></a> -<span class="sourceLineNo">617</span> * scenario you will lose any increments that have not been flushed.<a name="line.617"></a> -<span class="sourceLineNo">618</span> * @param row The row that contains the cell to increment.<a name="line.618"></a> -<span class="sourceLineNo">619</span> * @param family The column family of the cell to increment.<a name="line.619"></a> -<span class="sourceLineNo">620</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.620"></a> -<span class="sourceLineNo">621</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.621"></a> -<span class="sourceLineNo">622</span> * amount is negative).<a name="line.622"></a> -<span class="sourceLineNo">623</span> * @param durability The persistence guarantee for this increment.<a name="line.623"></a> -<span class="sourceLineNo">624</span> * @return The new value, post increment.<a name="line.624"></a> -<span class="sourceLineNo">625</span> * @throws IOException if a remote or network exception occurs.<a name="line.625"></a> -<span class="sourceLineNo">626</span> */<a name="line.626"></a> -<span class="sourceLineNo">627</span> default long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.627"></a> -<span class="sourceLineNo">628</span> long amount, Durability durability) throws IOException {<a name="line.628"></a> -<span class="sourceLineNo">629</span> Increment increment = new Increment(row)<a name="line.629"></a> -<span class="sourceLineNo">630</span> .addColumn(family, qualifier, amount)<a name="line.630"></a> -<span class="sourceLineNo">631</span> .setDurability(durability);<a name="line.631"></a> -<span class="sourceLineNo">632</span> Cell cell = increment(increment).getColumnLatestCell(family, qualifier);<a name="line.632"></a> -<span class="sourceLineNo">633</span> return Bytes.toLong(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength());<a name="line.633"></a> -<span class="sourceLineNo">634</span> }<a name="line.634"></a> -<span class="sourceLineNo">635</span><a name="line.635"></a> -<span class="sourceLineNo">636</span> /**<a name="line.636"></a> -<span class="sourceLineNo">637</span> * Releases any resources held or pending changes in internal buffers.<a name="line.637"></a> -<span class="sourceLineNo">638</span> *<a name="line.638"></a> -<span class="sourceLineNo">639</span> * @throws IOException if a remote or network exception occurs.<a name="line.639"></a> -<span class="sourceLineNo">640</span> */<a name="line.640"></a> -<span class="sourceLineNo">641</span> @Override<a name="line.641"></a> -<span class="sourceLineNo">642</span> default void close() throws IOException {<a name="line.642"></a> -<span class="sourceLineNo">643</span> throw new NotImplementedException("Add an implementation!");<a name="line.643"></a> -<span class="sourceLineNo">644</span> }<a name="line.644"></a> -<span class="sourceLineNo">645</span><a name="line.645"></a> -<span class="sourceLineNo">646</span> /**<a name="line.646"></a> -<span class="sourceLineNo">647</span> * Creates and returns a {@link com.google.protobuf.RpcChannel} instance connected to the<a name="line.647"></a> -<span class="sourceLineNo">648</span> * table region containing the specified row. The row given does not actually have<a name="line.648"></a> -<span class="sourceLineNo">649</span> * to exist. Whichever region would contain the row based on start and end keys will<a name="line.649"></a> -<span class="sourceLineNo">650</span> * be used. Note that the {@code row} parameter is also not passed to the<a name="line.650"></a> -<span class="sourceLineNo">651</span> * coprocessor handler registered for this protocol, unless the {@code row}<a name="line.651"></a> -<span class="sourceLineNo">652</span> * is separately passed as an argument in the service request. The parameter<a name="line.652"></a> -<span class="sourceLineNo">653</span> * here is only used to locate the region used to handle the call.<a name="line.653"></a> -<span class="sourceLineNo">654</span> *<a name="line.654"></a> -<span class="sourceLineNo">655</span> * <p><a name="line.655"></a> -<span class="sourceLineNo">656</span> * The obtained {@link com.google.protobuf.RpcChannel} instance can be used to access a published<a name="line.656"></a> -<span class="sourceLineNo">657</span> * coprocessor {@link com.google.protobuf.Service} using standard protobuf service invocations:<a name="line.657"></a> -<span class="sourceLineNo">658</span> * </p><a name="line.658"></a> -<span class="sourceLineNo">659</span> *<a name="line.659"></a> -<span class="sourceLineNo">660</span> * <div style="background-color: #cccccc; padding: 2px"><a name="line.660"></a> -<span class="sourceLineNo">661</span> * <blockquote><pre><a name="line.661"></a> -<span class="sourceLineNo">662</span> * CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey);<a name="line.662"></a> -<span class="sourceLineNo">663</span> * MyService.BlockingInterface service = MyService.newBlockingStub(channel);<a name="line.663"></a> -<span class="sourceLineNo">664</span> * MyCallRequest request = MyCallRequest.newBuilder()<a name="line.664"></a> -<span class="sourceLineNo">665</span> * ...<a name="line.665"></a> -<span class="sourceLineNo">666</span> * .build();<a name="line.666"></a> -<span class="sourceLineNo">667</span> * MyCallResponse response = service.myCall(null, request);<a name="line.667"></a> -<span class="sourceLineNo">668</span> * </pre></blockquote></div><a name="line.668"></a> -<span class="sourceLineNo">669</span> *<a name="line.669"></a> -<span class="sourceLineNo">670</span> * @param row The row key used to identify the remote region location<a name="line.670"></a> -<span class="sourceLineNo">671</span> * @return A CoprocessorRpcChannel instance<a name="line.671"></a> -<span class="sourceLineNo">672</span> */<a name="line.672"></a> -<span class="sourceLineNo">673</span> default CoprocessorRpcChannel coprocessorService(byte[] row) {<a name="line.673"></a> -<span class="sourceLineNo">674</span> throw new NotImplementedException("Add an implementation!");<a name="line.674"></a> -<span class="sourceLineNo">675</span> }<a name="line.675"></a> -<span class="sourceLineNo">676</span><a name="line.676"></a> -<span class="sourceLineNo">677</span> /**<a name="line.677"></a> -<span class="sourceLineNo">678</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.678"></a> -<span class="sourceLineNo">679</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.679"></a> -<span class="sourceLineNo">680</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.680"></a> -<span class="sourceLineNo">681</span> * with each {@link com.google.protobuf.Service} instance.<a name="line.681"></a> -<span class="sourceLineNo">682</span> *<a name="line.682"></a> -<span class="sourceLineNo">683</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.683"></a> -<span class="sourceLineNo">684</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.684"></a> -<span class="sourceLineNo">685</span> * selection will start with the first table region.<a name="line.685"></a> -<span class="sourceLineNo">686</span> * @param endKey select regions up to and including the region containing this row. If<a name="line.686"></a> -<span class="sourceLineNo">687</span> * {@code null}, selection will continue through the last table region.<a name="line.687"></a> -<span class="sourceLineNo">688</span> * @param callable this instance's<a name="line.688"></a> -<span class="sourceLineNo">689</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call}<a name="line.689"></a> -<span class="sourceLineNo">690</span> * method will be invoked once per table region, using the {@link com.google.protobuf.Service}<a name="line.690"></a> -<span class="sourceLineNo">691</span> * instance connected to that region.<a name="line.691"></a> -<span class="sourceLineNo">692</span> * @param <T> the {@link com.google.protobuf.Service} subclass to connect to<a name="line.692"></a> -<span class="sourceLineNo">693</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.693"></a> -<span class="sourceLineNo">694</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.694"></a> -<span class="sourceLineNo">695</span> * @return a map of result values keyed by region name<a name="line.695"></a> -<span class="sourceLineNo">696</span> */<a name="line.696"></a> -<span class="sourceLineNo">697</span> default <T extends Service, R> Map<byte[],R> coprocessorService(final Class<T> service,<a name="line.697"></a> -<span class="sourceLineNo">698</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable)<a name="line.698"></a> -<span class="sourceLineNo">699</span> throws ServiceException, Throwable {<a name="line.699"></a> -<span class="sourceLineNo">700</span> throw new NotImplementedException("Add an implementation!");<a name="line.700"></a> -<span class="sourceLineNo">701</span> }<a name="line.701"></a> -<span class="sourceLineNo">702</span><a name="line.702"></a> -<span class="sourceLineNo">703</span> /**<a name="line.703"></a> -<span class="sourceLineNo">704</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.704"></a> -<span class="sourceLineNo">705</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.705"></a> -<span class="sourceLineNo">706</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.706"></a> -<span class="sourceLineNo">707</span> * with each {@link Service} instance.<a name="line.707"></a> -<span class="sourceLineNo">708</span> *<a name="line.708"></a> -<span class="sourceLineNo">709</span> * <p> The given<a name="line.709"></a> -<span class="sourceLineNo">710</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],byte[],Object)}<a name="line.710"></a> -<span class="sourceLineNo">711</span> * method will be called with the return value from each region's<a name="line.711"></a> -<span class="sourceLineNo">712</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} invocation. </p><a name="line.712"></a> -<span class="sourceLineNo">713</span> *<a name="line.713"></a> -<span class="sourceLineNo">714</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.714"></a> -<span class="sourceLineNo">715</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.715"></a> -<span class="sourceLineNo">716</span> * selection will start with the first table region.<a name="line.716"></a> -<span class="sourceLineNo">717</span> * @param endKey select regions up to and including the region containing this row. If<a name="line.717"></a> -<span class="sourceLineNo">718</span> * {@code null}, selection will continue through the last table region.<a name="line.718"></a> -<span class="sourceLineNo">719</span> * @param callable this instance's<a name="line.719"></a> -<span class="sourceLineNo">720</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call}<a name="line.720"></a> -<span class="sourceLineNo">721</span> * method will be invoked once per table region, using the {@link Service} instance connected to<a name="line.721"></a> -<span class="sourceLineNo">722</span> * that region.<a name="line.722"></a> -<span class="sourceLineNo">723</span> * @param <T> the {@link Service} subclass to connect to<a name="line.723"></a> -<span class="sourceLineNo">724</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.724"></a> -<span class="sourceLineNo">725</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.725"></a> -<span class="sourceLineNo">726</span> */<a name="line.726"></a> -<span class="sourceLineNo">727</span> default <T extends Service, R> void coprocessorService(final Class<T> service,<a name="line.727"></a> -<span class="sourceLineNo">728</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable,<a name="line.728"></a> -<span class="sourceLineNo">729</span> final Batch.Callback<R> callback) throws ServiceException, Throwable {<a name="line.729"></a> -<span class="sourceLineNo">730</span> throw new NotImplementedException("Add an implementation!");<a name="line.730"></a> -<span class="sourceLineNo">731</span> }<a name="line.731"></a> -<span class="sourceLineNo">732</span><a name="line.732"></a> -<span class="sourceLineNo">733</span> /**<a name="line.733"></a> -<span class="sourceLineNo">734</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.734"></a> -<span class="sourceLineNo">735</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), all<a name="line.735"></a> -<span class="sourceLineNo">736</span> * the invocations to the same region server will be batched into one call. The coprocessor<a name="line.736"></a> -<span class="sourceLineNo">737</span> * service is invoked according to the service instance, method name and parameters.<a name="line.737"></a> -<span class="sourceLineNo">738</span> *<a name="line.738"></a> -<span class="sourceLineNo">739</span> * @param methodDescriptor<a name="line.739"></a> -<span class="sourceLineNo">740</span> * the descriptor for the protobuf service method to call.<a name="line.740"></a> -<span class="sourceLineNo">741</span> * @param request<a name="line.741"></a> -<span class="sourceLineNo">742</span> * the method call parameters<a name="line.742"></a> -<span class="sourceLineNo">743</span> * @param startKey<a name="line.743"></a> -<span class="sourceLineNo">744</span> * start region selection with region containing this row. If {@code null}, the<a name="line.744"></a> -<span class="sourceLineNo">745</span> * selection will start with the first table region.<a name="line.745"></a> -<span class="sourceLineNo">746</span> * @param endKey<a name="line.746"></a> -<span class="sourceLineNo">747</span> * select regions up to and including the region containing this row. If {@code null},<a name="line.747"></a> -<span class="sourceLineNo">748</span> * selection will continue through the last table region.<a name="line.748"></a> -<span class="sourceLineNo">749</span> * @param responsePrototype<a name="line.749"></a> -<span class="sourceLineNo">750</span> * the proto type of the response of the method in Service.<a name="line.750"></a> -<span class="sourceLineNo">751</span> * @param <R><a name="line.751"></a> -<span class="sourceLineNo">752</span> * the response type for the coprocessor Service method<a name="line.752"></a> -<span class="sourceLineNo">753</span> * @return a map of result values keyed by region name<a name="line.753"></a> -<span class="sourceLineNo">754</span> */<a name="line.754"></a> -<span class="sourceLineNo">755</span> default <R extends Message> Map<byte[], R> batchCoprocessorService(<a name="line.755"></a> -<span class="sourceLineNo">756</span> Descriptors.MethodDescriptor methodDescriptor, Message request,<a name="line.756"></a> -<span class="sourceLineNo">757</span> byte[] startKey, byte[] endKey, R responsePrototype) throws ServiceException, Throwable {<a name="line.757"></a> -<span class="sourceLineNo">758</span> throw new NotImplementedException("Add an implementation!");<a name="line.758"></a> -<span class="sourceLineNo">759</span> }<a name="line.759"></a> -<span class="sourceLineNo">760</span><a name="line.760"></a> -<span class="sourceLineNo">761</span> /**<a name="line.761"></a> -<span class="sourceLineNo">762</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.762"></a> -<span class="sourceLineNo">763</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), all<a name="line.763"></a> -<span class="sourceLineNo">764</span> * the invocations to the same region server will be batched into one call. The coprocessor<a name="line.764"></a> -<span class="sourceLineNo">765</span> * service is invoked according to the service instance, method name and parameters.<a name="line.765"></a> -<span class="sourceLineNo">766</span> *<a name="line.766"></a> -<span class="sourceLineNo">767</span> * <p><a name="line.767"></a> -<span class="sourceLineNo">768</span> * The given<a name="line.768"></a> -<span class="sourceLineNo">769</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],byte[],Object)}<a name="line.769"></a> -<span class="sourceLineNo">770</span> * method will be called with the return value from each region's invocation.<a name="line.770"></a> -<span class="sourceLineNo">771</span> * </p><a name="line.771"></a> -<span class="sourceLineNo">772</span> *<a name="line.772"></a> -<span class="sourceLineNo">773</span> * @param methodDescriptor the descriptor for the protobuf service method to call.<a name="line.773"></a> -<span class="sourceLineNo">774</span> * @param request the method call parameters<a name="line.774"></a> -<span class="sourceLineNo">775</span> * @param startKey start region selection with region containing this row.<a name="line.775"></a> -<span class="sourceLineNo">776</span> * If {@code null}, the selection will start with the first table region.<a name="line.776"></a> -<span class="sourceLineNo">777</span> * @param endKey select regions up to and including the region containing this row.<a name="line.777"></a> -<span class="sourceLineNo">778</span> * If {@code null}, selection will continue through the last table region.<a name="line.778"></a> -<span class="sourceLineNo">779</span> * @param responsePrototype the proto type of the response of the method in Service.<a name="line.779"></a> -<span class="sourceLineNo">780</span> * @param callback callback to invoke with the response for each region<a name="line.780"></a> -<span class="sourceLineNo">781</span> * @param <R><a name="line.781"></a> -<span class="sourceLineNo">782</span> * the response type for the coprocessor Service method<a name="line.782"></a> -<span class="sourceLineNo">783</span> */<a name="line.783"></a> -<span class="sourceLineNo">784</span> default <R extends Message> void batchCoprocessorService(<a name="line.784"></a> -<span class="sourceLineNo">785</span> Descriptors.MethodDescriptor methodDescriptor, Message request, byte[] startKey,<a name="line.785"></a> -<span class="sourceLineNo">786</span> byte[] endKey, R responsePrototype, Batch.Callback<R> callback)<a name="line.786"></a> -<span class="sourceLineNo">787</span> throws ServiceException, Throwable {<a name="line.787"></a> -<span class="sourceLineNo">788</span> throw new NotImplementedException("Add an implementation!");<a name="line.788"></a> -<span class="sourceLineNo">789</span> }<a name="line.789"></a> -<span class="sourceLineNo">790</span><a name="line.790"></a> -<span class="sourceLineNo">791</span> /**<a name="line.791"></a> -<span class="sourceLineNo">792</span> * Atomically checks if a row/family/qualifier value matches the expected value.<a name="line.792"></a> -<span class="sourceLineNo">793</span> * If it does, it performs the row mutations. If the passed value is null, the check<a name="line.793"></a> -<span class="sourceLineNo">794</span> * is for the lack of column (ie: non-existence)<a name="line.794"></a> -<span class="sourceLineNo">795</span> *<a name="line.795"></a> -<span class="sourceLineNo">796</span> * The expected value argument of this call is on the left and the current<a name="line.796"></a> -<span class="sourceLineNo">797</span> * value of the cell is on the right side of the comparison operator.<a name="line.797"></a> -<span class="sourceLineNo">798</span> *<a name="line.798"></a> -<span class="sourceLineNo">799</span> * Ie. eg. GREATER operator means expected value > existing <=> perform row mutations.<a name="line.799"></a> -<span class="sourceLineNo">800</span> *<a name="line.800"></a> -<span class="sourceLineNo">801</span> * @param row to check<a name="line.801"></a> -<span class="sourceLineNo">802</span> * @param family column family to check<a name="line.802"></a> -<span class="sourceLineNo">803</span> * @param qualifier column qualifier to check<a name="line.803"></a> -<span class="sourceLineNo">804</span> * @param compareOp the comparison operator<a name="line.804"></a> -<span class="sourceLineNo">805</span> * @param value the expected value<a name="line.805"></a> -<span class="sourceLineNo">806</span> * @param mutation mutations to perform if check succeeds<a name="line.806"></a> -<span class="sourceLineNo">807</span> * @throws IOException e<a name="line.807"></a> -<span class="sourceLineNo">808</span> * @return true if the new put was executed, false otherwise<a name="line.808"></a> -<span class="sourceLineNo">809</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.809"></a> -<span class="sourceLineNo">810</span> */<a name="line.810"></a> -<span class="sourceLineNo">811</span> @Deprecated<a name="line.811"></a> -<span class="sourceLineNo">812</span> default boolean checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.812"></a> -<span class="sourceLineNo">813</span> CompareFilter.CompareOp compareOp, byte[] value, RowMutations mutation) throws IOException {<a name="line.813"></a> -<span class="sourceLineNo">814</span> throw new NotImplementedException("Add an implementation!");<a name="line.814"></a> -<span class="sourceLineNo">815</span> }<a name="line.815"></a> -<span class="sourceLineNo">816</span><a name="line.816"></a> -<span class="sourceLineNo">817</span> /**<a name="line.817"></a> -<span class="sourceLineNo">818</span> * Atomically checks if a row/family/qualifier value matches the expected value.<a name="line.818"></a> -<span class="sourceLineNo">819</span> * If it does, it performs the row mutations. If the passed value is null, the check<a name="line.819"></a> -<span class="sourceLineNo">820</span> * is for the lack of column (ie: non-existence)<a name="line.820"></a> -<span class="sourceLineNo">821</span> *<a name="line.821"></a> -<span class="sourceLineNo">822</span> * The expected value argument of this call is on the left and the current<a name="line.822"></a> -<span class="sourceLineNo">823</span> * value of the cell is on the right side of the comparison operator.<a name="line.823"></a> -<span class="sourceLineNo">824</span> *<a name="line.824"></a> -<span class="sourceLineNo">825</span> * Ie. eg. GREATER operator means expected value > existing <=> perform row mutations.<a name="line.825"></a> -<span class="sourceLineNo">826</span> *<a name="line.826"></a> -<span class="sourceLineNo">827</span> * @param row to check<a name="line.827"></a> -<span class="sourceLineNo">828</span> * @param family column family to check<a name="line.828"></a> -<span class="sourceLineNo">829</span> * @param qualifier column qualifier to check<a name="line.829"></a> -<span class="sourceLineNo">830</span> * @param op the comparison operator<a name="line.830"></a> -<span class="sourceLineNo">831</span> * @param value the expected value<a name="line.831"></a> -<span class="sourceLineNo">832</span> * @param mutation mutations to perform if check succeeds<a name="line.832"></a> -<span class="sourceLineNo">833</span> * @throws IOException e<a name="line.833"></a> -<span class="sourceLineNo">834</span> * @return true if the new put was executed, false otherwise<a name="line.834"></a> -<span class="sourceLineNo">835</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.835"></a> -<span class="sourceLineNo">836</span> */<a name="line.836"></a> -<span class="sourceLineNo">837</span> @Deprecated<a name="line.837"></a> -<span class="sourceLineNo">838</span> default boolean checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op,<a name="line.838"></a> -<span class="sourceLineNo">839</span> byte[] value, RowMutations mutation) throws IOException {<a name="line.839"></a> -<span class="sourceLineNo">840</span> throw new NotImplementedException("Add an implementation!");<a name="line.840"></a> -<span class="sourceLineNo">841</span> }<a name="line.841"></a> -<span class="sourceLineNo">842</span><a name="line.842"></a> -<span class="sourceLineNo">843</span> /**<a name="line.843"></a> -<span class="sourceLineNo">844</span> * Get timeout of each rpc request in this Table instance. It will be overridden by a more<a name="line.844"></a> -<span class="sourceLineNo">845</span> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.<a name="line.845"></a> -<span class="sourceLineNo">846</span> * @see #getReadRpcTimeout(TimeUnit)<a name="line.846"></a> -<span class="sourceLineNo">847</span> * @see #getWriteRpcTimeout(TimeUnit)<a name="line.847"></a> -<span class="sourceLineNo">848</span> * @param unit the unit of time the timeout to be represented in<a name="line.848"></a> -<span class="sourceLineNo">849</span> * @return rpc timeout in the specified time unit<a name="line.849"></a> -<span class="sourceLineNo">850</span> */<a name="line.850"></a> -<span class="sourceLineNo">851</span> default long getRpcTimeout(TimeUnit unit) {<a name="line.851"></a> -<span class="sourceLineNo">852</span> throw new NotImplementedException("Add an implementation!");<a name="line.852"></a> -<span class="sourceLineNo">853</span> }<a name="line.853"></a> -<span class="sourceLineNo">854</span><a name="line.854"></a> -<span class="sourceLineNo">855</span> /**<a name="line.855"></a> -<span class="sourceLineNo">856</span> * Get timeout (millisecond) of each rpc request in this Table instance.<a name="line.856"></a> -<span class="sourceLineNo">857</span> *<a name="line.857"></a> -<span class="sourceLineNo">858</span> * @return Currently configured read timeout<a name="line.858"></a> -<span class="sourceLineNo">859</span> * @deprecated use {@link #getReadRpcTimeout(TimeUnit)} or<a name="line.859"></a> -<span class="sourceLineNo">860</span> * {@link #getWriteRpcTimeout(TimeUnit)} instead<a name="line.860"></a> -<span class="sourceLineNo">861</span> */<a name="line.861"></a> -<span class="sourceLineNo">862</span> @Deprecated<a name="line.862"></a> -<span class="sourceLineNo">863</span> default int getRpcTimeout() {<a name="line.863"></a> -<span class="sourceLineNo">864</span> return (int)getRpcTimeout(TimeUnit.MILLISECONDS);<a name="line.864"></a> -<span class="sourceLineNo">865</span> }<a name="line.865"></a> -<span class="sourceLineNo">866</span><a name="line.866"></a> -<span class="sourceLineNo">867</span> /**<a name="line.867"></a> -<span class="sourceLineNo">868</span> * Set timeout (millisecond) of each rpc request in operations of this Table instance, will<a name="line.868"></a> -<span class="sourceLineNo">869</span> * override the value of hbase.rpc.timeout in configuration.<a name="line.869"></a> -<span class="sourceLineNo">870</span> * If a rpc request waiting too long, it will stop waiting and send a new request to retry until<a name="line.870"></a> -<span class="sourceLineNo">871</span> * retries exhausted or operation timeout reached.<a name="line.871"></a> -<span class="sourceLineNo">872</span> * <p><a name="line.872"></a> -<span class="sourceLineNo">873</span> * NOTE: This will set both the read and write timeout settings to the provided value.<a name="line.873"></a> -<span class="sourceLineNo">874</span> *<a name="line.874"></a> -<span class="sourceLineNo">875</span> * @param rpcTimeout the timeout of each rpc request in millisecond.<a name="line.875"></a> -<span class="sourceLineNo">876</span> *<a name="line.876"></a> -<span class="sourceLineNo">877</span> * @deprecated Use setReadRpcTimeout or setWriteRpcTimeout instead<a name="line.877"></a> -<span class="sourceLineNo">878</span> */<a name="line.878"></a> -<span class="sourceLineNo">879</span> @Deprecated<a name="line.879"></a> -<span class="sourceLineNo">880</span> default void setRpcTimeout(int rpcTimeout) {<a name="line.880"></a> -<span class="sourceLineNo">881</span> setReadRpcTimeout(rpcTimeout);<a name="line.881"></a> -<span class="sourceLineNo">882</span> setWriteRpcTimeout(rpcTimeout);<a name="line.882"></a> -<span class="sourceLineNo">883</span> }<a name="line.883"></a> -<span class="sourceLineNo">884</span><a name="line.884"></a> -<span class="sourceLineNo">885</span> /**<a name="line.885"></a> -<span class="sourceLineNo">886</span> * Get timeout of each rpc read request in this Table instance.<a name="line.886"></a> -<span class="sourceLineNo">887</span> * @param unit the unit of time the timeout to be represented in<a name="line.887"></a> -<span class="sourceLineNo">888</span> * @return read rpc timeout in the specified time unit<a name="line.888"></a> -<span class="sourceLineNo">889</span> */<a name="line.889"></a> -<span class="sourceLineNo">890</span> default long getReadRpcTimeout(TimeUnit unit) {<a name="line.890"></a> -<span class="sourceLineNo">891</span> throw new NotImplementedException("Add an implementation!");<a name="line.891"></a> -<span class="sourceLineNo">892</span> }<a name="line.892"></a> -<span class="sourceLineNo">893</span><a name="line.893"></a> -<span class="sourceLineNo">894</span> /**<a name="line.894"></a> -<span class="sourceLineNo">895</span> * Get timeout (millisecond) of each rpc read request in this Table instance.<a name="line.895"></a> -<span class="sourceLineNo">896</span> * @deprecated since 2.0 and will be removed in 3.0 version<a name="line.896"></a> -<span class="sourceLineNo">897</span> * use {@link #getReadRpcTimeout(TimeUnit)} instead<a name="line.897"></a> -<span class="sourceLineNo">898</span> */<a name="line.898"></a> -<span class="sourceLineNo">899</span> @Deprecated<a name="line.899"></a> -<span class="sourceLineNo">900</span> default int getReadRpcTimeout() {<a name="line.900"></a> -<span class="sourceLineNo">901</span> return (int)getReadRpcTimeout(TimeUnit.MILLISECONDS);<a name="line.901"></a> -<span class="sourceLineNo">902</span> }<a name="line.902"></a> -<span class="sourceLineNo">903</span><a name="line.903"></a> -<span class="sourceLineNo">904</span> /**<a name="line.904"></a> -<span class="sourceLineNo">905</span> * Set timeout (millisecond) of each rpc read request in operations of this Table instance, will<a name="line.905"></a> -<span class="sourceLineNo">906</span> * override the value of hbase.rpc.read.timeout in configuration.<a name="line.906"></a> -<span class="sourceLineNo">907</span> * If a rpc read request waiting too long, it will stop waiting and send a new request to retry<a name="line.907"></a> -<span class="sourceLineNo">908</span> * until retries exhausted or operation timeout reached.<a name="line.908"></a> -<span class="sourceLineNo">909</span> *<a name="line.909"></a> -<span class="sourceLineNo">910</span> * @param readRpcTimeout the timeout for read rpc request in milliseconds<a name="line.910"></a> -<span class="sourceLineNo">911</span> * @deprecated since 2.0.0, use {@link TableBuilder#setReadRpcTimeout} instead<a name="line.911"></a> -<span class="sourceLineNo">912</span> */<a name="line.912"></a> -<span class="sourceLineNo">913</span> @Deprecated<a name="line.913"></a> -<span class="sourceLineNo">914</span> default void setReadRpcTimeout(int readRpcTimeout) {<a name="line.914"></a> -<span class="sourceLineNo">915</span> throw new NotImplementedException("Add an implementation!");<a name="line.915"></a> -<span class="sourceLineNo">916</span> }<a name="line.916"></a> -<span class="sourceLineNo">917</span><a name="line.917"></a> -<span class="sourceLineNo">918</span> /**<a name="line.918"></a> -<span class="sourceLineNo">919</span> * Get timeout of each rpc write request in this Table instance.<a name="line.919"></a> -<span class="sourceLineNo">920</span> * @param unit the unit of time the timeout to be represented in<a name="line.920"></a> -<span class="sourceLineNo">921</span> * @return write rpc timeout in the specified time unit<a name="line.921"></a> -<span class="sourceLineNo">922</span> */<a name="line.922"></a> -<span class="sourceLineNo">923</span> default long getWriteRpcTimeout(TimeUnit unit) {<a name="line.923"></a> -<span class="sourceLineNo">924</span> throw new NotImplementedException("Add an implementation!");<a name="line.924"></a> -<span class="sourceLineNo">925</span> }<a name="line.925"></a> -<span class="sourceLineNo">926</span><a name="line.926"></a> -<span class="sourceLineNo">927</span> /**<a name="line.927"></a> -<span class="sourceLineNo">928</span> * Get timeout (millisecond) of each rpc write request in this Table instance.<a name="line.928"></a> -<span class="sourceLineNo">929</span> * @deprecated since 2.0 and will be removed in 3.0 version<a name="line.929"></a> -<span class="sourceLineNo">930</span> * use {@link #getWriteRpcTimeout(TimeUnit)} instead<a name="line.930"></a> -<span class="sourceLineNo">931</span> */<a name="line.931"></a> -<span class="sourceLineNo">932</span> @Deprecated<a name="line.932"></a> -<span class="sourceLineNo">933</span> default int getWriteRpcTimeout() {<a name="line.933"></a> -<span class="sourceLineNo">934</span> return (int)getWriteRpcTimeout(TimeUnit.MILLISECONDS);<a name="line.934"></a> -<span class="sourceLineNo">935</span> }<a name="line.935"></a> -<span class="sourceLineNo">936</span><a name="line.936"></a> -<span class="sourceLineNo">937</span> /**<a name="line.937"></a> -<span class="sourceLineNo">938</span> * Set timeout (millisecond) of each rpc write request in operations of this Table instance, will<a name="line.938"></a> -<span class="sourceLineNo">939</span> * override the value of hbase.rpc.write.timeout in configuration.<a name="line.939"></a> -<span class="sourceLineNo">940</span> * If a rpc write request waiting too long, it will stop waiting and send a new request to retry<a name="line.940"></a> -<span class="sourceLineNo">941</span> * until retries exhausted or operation timeout reached.<a name="line.941"></a> -<span class="sourceLineNo">942</span> *<a name="line.942"></a> -<span class="sourceLineNo">943</span> * @param writeRpcTimeout the timeout for write rpc request in milliseconds<a name="line.943"></a> -<span class="sourceLineNo">944</span> * @deprecated since 2.0.0, use {@link TableBuilder#setWriteRpcTimeout} instead<a name="line.944"></a> -<span class="sourceLineNo">945</span> */<a name="line.945"></a> -<span class="sourceLineNo">946</span> @Deprecated<a name="line.946"></a> -<span class="sourceLineNo">947</span> default void setWriteRpcTimeout(int writeRpcTimeout) {<a name="line.947"></a> -<span class="sourceLineNo">948</span> throw new NotImplementedException("Add an implementation!");<a name="line.948"></a> -<span class="sourceLineNo">949</span> }<a name="line.949"></a> -<span class="sourceLineNo">950</span><a name="line.950"></a> -<span class="sourceLineNo">951</span> /**<a name="line.951"></a> -<span class="sourceLineNo">952</span> * Get timeout of each operation in Table instance.<a name="line.952"></a> -<span class="sourceLineNo">953</span> * @param unit the unit of time the timeout to be represented in<a name="line.953"></a> -<span class="sourceLineNo">954</span> * @return operation rpc timeout in the specified time unit<a name="line.954"></a> -<span class="sourceLineNo">955</span> */<a name="line.955"></a> -<span class="sourceLineNo">956</span> default long getOperationTimeout(TimeUnit unit) {<a name="line.956"></a> -<span class="sourceLineNo">957</span> throw new NotImplementedException("Add an implementation!");<a name="line.957"></a> -<span class="sourceLineNo">958</span> }<a name="line.958"></a> -<span class="sourceLineNo">959</span><a name="line.959"></a> -<span class="sourceLineNo">960</span> /**<a name="line.960"></a> -<span class="sourceLineNo">961</span> * Get timeout (millisecond) of each operation for in Table instance.<a name="line.961"></a> -<span class="sourceLineNo">962</span> * @deprecated since 2.0 and will be removed in 3.0 version<a name="line.962"></a> -<span class="sourceLineNo">963</span> * use {@link #getOperationTimeout(TimeUnit)} instead<a name="line.963"></a> -<span class="sourceLineNo">964</span> */<a name="line.964"></a> -<span class="sourceLineNo">965</span> @Deprecated<a name="line.965"></a> -<span class="sourceLineNo">966</span> default int getOperationTimeout() {<a name="line.966"></a> -<span class="sourceLineNo">967</span> return (int)getOperationTimeout(TimeUnit.MILLISECONDS);<a name="line.967"></a> -<span class="sourceLineNo">968</span> }<a name="line.968"></a> -<span class="sourceLineNo">969</span><a name="line.969"></a> -<span class="sourceLineNo">970</span> /**<a name="line.970"></a> -<span class="sourceLineNo">971</span> * Set timeout (millisecond) of each operation in this Table instance, will override the value<a name="line.971"></a> -<span class="sourceLineNo">972</span> * of hbase.client.operation.timeout in configuration.<a name="line.972"></a> -<span class="sourceLineNo">973</span> * Operation timeout is a top-level restriction that makes sure a blocking method will not be<a name="line.973"></a> -<span class="sourceLineNo">974</span> * blocked more than this. In each operation, if rpc request fails because of timeout or<a name="line.974"></a> -<span class="sourceLineNo">975</span> * other reason, it will retry until success or throw a RetriesExhaustedException. But if the<a name="line.975"></a> -<span class="sourceLineNo">976</span> * total time being blocking reach the operation timeout before retries exhausted, it will break<a name="line.976"></a> -<span class="sourceLineNo">977</span> * early and throw SocketTimeoutException.<a name="line.977"></a> -<span class="sourceLineNo">978</span> * @param operationTimeout the total timeout of each operation in millisecond.<a name="line.978"></a> -<span class="sourceLineNo">979</span> * @deprecated since 2.0.0, use {@link TableBuilder#setOperationTimeout} instead<a name="line.979"></a> -<span class="sourceLineNo">980</span> */<a name="line.980"></a> -<span class="sourceLineNo">981</span> @Deprecated<a name="line.981"></a> -<span class="sourceLineNo">982</span> default void setOperationTimeout(int operationTimeout) {<a name="line.982"></a> -<span class="sourceLineNo">983</span> throw new NotImplementedException("Add an implementation!");<a name="line.983"></a> -<span class="sourceLineNo">984</span> }<a name="line.984"></a> -<span class="sourceLineNo">985</span>}<a name="line.985"></a> +<span class="sourceLineNo">566</span> * @param append object that specifies the columns and values to be appended<a name="line.566"></a> +<span class="sourceLineNo">567</span> * @throws IOException e<a name="line.567"></a> +<span class="sourceLineNo">568</span> * @return values of columns after the append operation (maybe null)<a name="line.568"></a> +<span class="sourceLineNo">569</span> */<a name="line.569"></a> +<span class="sourceLineNo">570</span> default Result append(final Append append) throws IOException {<a name="line.570"></a> +<span class="sourceLineNo">571</span> throw new NotImplementedException("Add an implementation!");<a name="line.571"></a> +<span class="sourceLineNo">572</span> }<a name="line.572"></a> +<span class="sourceLineNo">573</span><a name="line.573"></a> +<span class="sourceLineNo">574</span> /**<a name="line.574"></a> +<span class="sourceLineNo">575</span> * Increments one or more columns within a single row.<a name="line.575"></a> +<span class="sourceLineNo">576</span> * <p><a name="line.576"></a> +<span class="sourceLineNo">577</span> * This operation ensures atomicity to readers. Increments are done<a name="line.577"></a> +<span class="sourceLineNo">578</span> * under a single row lock, so write operations to a row are synchronized, and<a name="line.578"></a> +<span class="sourceLineNo">579</span> * readers are guaranteed to see this operation fully completed.<a name="line.579"></a> +<span class="sourceLineNo">580</span> *<a name="line.580"></a> +<span class="sourceLineNo">581</span> * @param increment object that specifies the columns and amounts to be used<a name="line.581"></a> +<span class="sourceLineNo">582</span> * for the increment operations<a name="line.582"></a> +<span class="sourceLineNo">583</span> * @throws IOException e<a name="line.583"></a> +<span class="sourceLineNo">584</span> * @return values of columns after the increment<a name="line.584"></a> +<span class="sourceLineNo">585</span> */<a name="line.585"></a> +<span class="sourceLineNo">586</span> default Result increment(final Increment increment) throws IOException {<a name="line.586"></a> +<span class="sourceLineNo">587</span> throw new NotImplementedException("Add an implementation!");<a name="line.587"></a> +<span class="sourceLineNo">588</span> }<a name="line.588"></a> +<span class="sourceLineNo">589</span><a name="line.589"></a> +<span class="sourceLineNo">590</span> /**<a name="line.590"></a> +<span class="sourceLineNo">591</span> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.591"></a> +<span class="sourceLineNo">592</span> * <p><a name="line.592"></a> +<span class="sourceLineNo">593</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.593"></a> +<span class="sourceLineNo">594</span> * @param row The row that contains the cell to increment.<a name="line.594"></a> +<span class="sourceLineNo">595</span> * @param family The column family of the cell to increment.<a name="line.595"></a> +<span class="sourceLineNo">596</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.596"></a> +<span class="sourceLineNo">597</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.597"></a> +<span class="sourceLineNo">598</span> * amount is negative).<a name="line.598"></a> +<span class="sourceLineNo">599</span> * @return The new value, post increment.<a name="line.599"></a> +<span class="sourceLineNo">600</span> * @throws IOException if a remote or network exception occurs.<a name="line.600"></a> +<span class="sourceLineNo">601</span> */<a name="line.601"></a> +<span class="sourceLineNo">602</span> default long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)<a name="line.602"></a> +<span class="sourceLineNo">603</span> throws IOException {<a name="line.603"></a> +<span class="sourceLineNo">604</span> Increment increment = new Increment(row).addColumn(family, qualifier, amount);<a name="line.604"></a> +<span class="sourceLineNo">605</span> Cell cell = increment(increment).getColumnLatestCell(family, qualifier);<a name="line.605"></a> +<span class="sourceLineNo">606</span> return Bytes.toLong(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength());<a name="line.606"></a> +<span class="sourceLineNo">607</span> }<a name="line.607"></a> +<span class="sourceLineNo">608</span><a name="line.608"></a> +<span class="sourceLineNo">609</span> /**<a name="line.609"></a> +<span class="sourceLineNo">610</span> * Atomically increments a column value. If the column value already exists<a name="line.610"></a> +<span class="sourceLineNo">611</span> * and is not a big-endian long, this could throw an exception. If the column<a name="line.611"></a> +<span class="sourceLineNo">612</span> * value does not yet exist it is initialized to <code>amount</code> and<a name="line.612"></a> +<span class="sourceLineNo">613</span> * written to the specified column.<a name="line.613"></a> +<span class="sourceLineNo">614</span> *<a name="line.614"></a> +<span class="sourceLineNo">615</span> * <p>Setting durability to {@link Durability#SKIP_WAL} means that in a fail<a name="line.615"></a> +<span class="sourceLineNo">616</span> * scenario you will lose any increments that have not been flushed.<a name="line.616"></a> +<span class="sourceLineNo">617</span> * @param row The row that contains the cell to increment.<a name="line.617"></a> +<span class="sourceLineNo">618</span> * @param family The column family of the cell to increment.<a name="line.618"></a> +<span class="sourceLineNo">619</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.619"></a> +<span class="sourceLineNo">620</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.620"></a> +<span class="sourceLineNo">621</span> * amount is negative).<a name="line.621"></a> +<span class="sourceLineNo">622</span> * @param durability The persistence guarantee for this increment.<a name="line.622"></a> +<span class="sourceLineNo">623</span> * @return The new value, post increment.<a name="line.623"></a> +<span class="sourceLineNo">624</span> * @throws IOException if a remote or network exception occurs.<a name="line.624"></a> +<span class="sourceLineNo">625</span> */<a name="line.625"></a> +<span class="sourceLineNo">626</span> default long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.626"></a> +<span class="sourceLineNo">627</span> long amount, Durability durability) throws IOException {<a name="line.627"></a> +<span class="sourceLineNo">628</span> Increment increment = new Increment(row)<a name="line.628"></a> +<span class="sourceLineNo">629</span> .addColumn(family, qualifier, amount)<a name="line.629"></a> +<span class="sourceLineNo">630</span> .setDurability(durability);<a name="line.630"></a> +<span class="sourceLineNo">631</span> Cell cell = increment(increment).getColumnLatestCell(family, qualifier);<a name="line.631"></a> +<span class="sourceLineNo">632</span> return Bytes.toLong(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength());<a name="line.632"></a> +<span class="sourceLineNo">633</span> }<a name="line.633"></a> +<span class="sourceLineNo">634</span><a name="line.634"></a> +<span class="sourceLineNo">635</span> /**<a name="line.635"></a> +<span class="sourceLineNo">636</span> * Releases any resources held or pending changes in internal buffers.<a name="line.636"></a> +<span class="sourceLineNo">637</span> *<a name="line.637"></a> +<span class="sourceLineNo">638</span> * @throws IOException if a remote or network exception occurs.<a name="line.638"></a> +<span class="sourceLineNo">639</span> */<a name="line.639"></a> +<span class="sourceLineNo">640</span> @Override<a name="line.640"></a> +<span class="sourceLineNo">641</span> default void close() throws IOException {<a name="line.641"></a> +<span class="sourceLineNo">642</span> throw new NotImplementedException("Add an implementation!");<a name="line.642"></a> +<span class="sourceLineNo">643</span> }<a name="line.643"></a> +<span class="sourceLineNo">644</span><a name="line.644"></a> +<span class="sourceLineNo">645</span> /**<a name="line.645"></a> +<span class="sourceLineNo">646</span> * Creates and returns a {@link com.google.protobuf.RpcChannel} instance connected to the<a name="line.646"></a> +<span class="sourceLineNo">647</span> * table region containing the specified row. The row given does not actually have<a name="line.647"></a> +<span class="sourceLineNo">648</span> * to exist. Whichever region would contain the row based on start and end keys will<a name="line.648"></a> +<span class="sourceLineNo">649</span> * be used. Note that the {@code row} parameter is also not passed to the<a name="line.649"></a> +<span class="sourceLineNo">650</span> * coprocessor handler registered for this protocol, unless the {@code row}<a name="line.650"></a> +<span class="sourceLineNo">651</span> * is separately passed as an argument in the service request. The parameter<a name="line.651"></a> +<span class="sourceLineNo">652</span> * here is only used to locate the region used to handle the call.<a name="line.652"></a> +<span class="sourceLineNo">653</span> *<a name="line.653"></a> +<span class="sourceLineNo">654</span> * <p><a name="line.654"></a> +<span class="sourceLineNo">655</span> * The obtained {@link com.google.protobuf.RpcChannel} instance can be used to access a published<a name="line.655"></a> +<span class="sourceLineNo">656</span> * coprocessor {@link com.google.protobuf.Service} using standard protobuf service invocations:<a name="line.656"></a> +<span class="sourceLineNo">657</span> * </p><a name="line.657"></a> +<span class="sourceLineNo">658</span> *<a name="line.658"></a> +<span class="sourceLineNo">659</span> * <div style="background-color: #cccccc; padding: 2px"><a name="line.659"></a> +<span class="sourceLineNo">660</span> * <blockquote><pre><a name="line.660"></a> +<span class="sourceLineNo">661</span> * CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey);<a name="line.661"></a> +<span class="sourceLineNo">662</span> * MyService.BlockingInterface service = MyService.newBlockingStub(channel);<a name="line.662"></a> +<span class="sourceLineNo">663</span> * MyCallRequest request = MyCallRequest.newBuilder()<a name="line.663"></a> +<span class="sourceLineNo">664</span> * ...<a name="line.664"></a> +<span class="sourceLineNo">665</span> * .build();<a name="line.665"></a> +<span class="sourceLineNo">666</span> * MyCallResponse response = service.myCall(null, request);<a name="line.666"></a> +<span class="sourceLineNo">667</span> * </pre></blockquote></div><a name="line.667"></a> +<span class="sourceLineNo">668</span> *<a name="line.668"></a> +<span class="sourceLineNo">669</span> * @param row The row key used to identify the remote region location<a name="line.669"></a> +<span class="sourceLineNo">670</span> * @return A CoprocessorRpcChannel instance<a name="line.670"></a> +<span class="sourceLineNo">671</span> */<a name="line.671"></a> +<span class="sourceLineNo">672</span> default CoprocessorRpcChannel coprocessorService(byte[] row) {<a name="line.672"></a> +<span class="sourceLineNo">673</span> throw new NotImplementedException("Add an implementation!");<a name="line.673"></a> +<span class="sourceLineNo">674</span> }<a name="line.674"></a> +<span class="sourceLineNo">675</span><a name="line.675"></a> +<span class="sourceLineNo">676</span> /**<a name="line.676"></a> +<span class="sourceLineNo">677</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.677"></a> +<span class="sourceLineNo">678</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.678"></a> +<span class="sourceLineNo">679</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.679"></a> +<span class="sourceLineNo">680</span> * with each {@link com.google.protobuf.Service} instance.<a name="line.680"></a> +<span class="sourceLineNo">681</span> *<a name="line.681"></a> +<span class="sourceLineNo">682</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.682"></a> +<span class="sourceLineNo">683</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.683"></a> +<span class="sourceLineNo">684</span> * selection will start with the first table region.<a name="line.684"></a> +<span class="sourceLineNo">685</span> * @param endKey select regions up to and including the region containing this row. If<a name="line.685"></a> +<span class="sourceLineNo">686</span> * {@code null}, selection will continue through the last table region.<a name="line.686"></a> +<span class="sourceLineNo">687</span> * @param callable this instance's<a name="line.687"></a> +<span class="sourceLineNo">688</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call}<a name="line.688"></a> +<span class="sourceLineNo">689</span> * method will be invoked once per table region, using the {@link com.google.protobuf.Service}<a name="line.689"></a> +<span class="sourceLineNo">690</span> * instance connected to that region.<a name="line.690"></a> +<span class="sourceLineNo">691</span> * @param <T> the {@link com.google.protobuf.Service} subclass to connect to<a name="line.691"></a> +<span class="sourceLineNo">692</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.692"></a> +<span class="sourceLineNo">693</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.693"></a> +<span class="sourceLineNo">694</span> * @return a map of result values keyed by region name<a name="line.694"></a> +<span class="sourceLineNo">695</span> */<a name="line.695"></a> +<span class="sourceLineNo">696</span> default <T extends Service, R> Map<byte[],R> coprocessorService(final Class<T> service,<a name="line.696"></a> +<span class="sourceLineNo">697</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable)<a name="line.697"></a> +<span class="sourceLineNo">698</span> throws ServiceException, Throwable {<a name="line.698"></a> +<span class="sourceLineNo">699</span> throw new NotImplementedException("Add an implementation!");<a name="line.699"></a> +<span class="sourceLineNo">700</span> }<a name="line.700"></a> +<span class="sourceLineNo">701</span><a name="line.701"></a> +<span class="sourceLineNo">702</span> /**<a name="line.702"></a> +<span class="sourceLineNo">703</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.703"></a> +<span class="sourceLineNo">704</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.704"></a> +<span class="sourceLineNo">705</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.705"></a> +<span class="sourceLineNo">706</span> * with each {@link Service} instance.<a name="line.706"></a> +<span class="sourceLineNo">707</span> *<a name="line.707"></a> +<span class="sourceLineNo">708</span> * <p> The given<a name="line.708"></a> +<span class="sourceLineNo">709</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],byte[],Object)}<a name="line.709"></a> +<span class="sourceLineNo">710</span> * method will be called with the return value from each region's<a name="line.710"></a> +<span class="sourceLineNo">711</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} invocation. </p><a name="line.711"></a> +<span class="sourceLineNo">712</span> *<a name="line.712"></a> +<span class="sourceLineNo">713</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.713"></a> +<span class="sourceLineNo">714</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.714"></a> +<span class="sourceLineNo">715</span> * selection will start with the first table region.<a name="line.715"></a> +<span class="sourceLineNo">716</span> * @param endKey select regions up to and including the region containing this row. If<a name="line.716"></a> +<span class="sourceLineNo">717</span> * {@code null}, selection will continue through the last table region.<a name="line.717"></a> +<span class="sourceLineNo">718</span> * @param callable this instance's<a name="line.718"></a> +<span class="sourceLineNo">719</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call}<a name="line.719"></a> +<span class="sourceLineNo">720</span> * method will be invoked once per table region, using the {@link Service} instance connected to<a name="line.720"></a> +<span class="sourceLineNo">721</span> * that region.<a name="line.721"></a> +<span class="sourceLineNo">722</span> * @param <T> the {@link Service} subclass to connect to<a name="line.722"></a> +<span class="sourceLineNo">723</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.723"></a> +<span class="sourceLineNo">724</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.724"></a> +<span class="sourceLineNo">725</span> */<a name="line.725"></a> +<span class="sourceLineNo">726</span> default <T extends Service, R> void coprocessorService(final Class<T> service,<a name="line.726"></a> +<span class="sourceLineNo">727</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable,<a name="line.727"></a> +<span class="sourceLineNo">728</span> final Batch.Callback<R> callback) throws ServiceException, Throwable {<a name="line.728"></a> +<span class="sourceLineNo">729</span> throw new NotImplementedException("Add an implementation!");<a name="line.729"></a> +<span class="sourceLineNo">730</span> }<a name="line.730"></a> +<span class="sourceLineNo">731</span><a name="line.731"></a> +<span class="sourceLineNo">732</span> /**<a name="line.732"></a> +<span class="sourceLineNo">733</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.733"></a> +<span class="sourceLineNo">734</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), all<a name="line.734"></a> +<span class="sourceLineNo">735</span> * the invocations to the same region server will be batched into one call. The coprocessor<a name="line.735"></a> +<span class="sourceLineNo">736</span> * service is invoked according to the service instance, method name and parameters.<a name="line.736"></a> +<span class="sourceLineNo">737</span> *<a name="line.737"></a> +<span class="sourceLineNo">738</span> * @param methodDescriptor<a name="line.738"></a> +<span class="sourceLineNo">739</span> * the descriptor for the protobuf service method to call.<a name="line.739"></a> +<span class="sourceLineNo">740</span> * @param request<a name="line.740"></a> +<span class="sourceLineNo">741</span> * the method call parameters<a name="line.741"></a> +<span class="sourceLineNo">742</span> * @param startKey<a name="line.742"></a> +<span class="sourceLineNo">743</span> * start region selection with region containing this row. If {@code null}, the<a name="line.743"></a> +<span class="sourceLineNo">744</span> * selection will start with the first table region.<a name="line.744"></a> +<span class="sourceLineNo">745</span> * @param endKey<a name="line.745"></a> +<span class="sourceLineNo">746</span> * select regions up to and including the region containing this row. If {@code null},<a name="line.746"></a> +<span class="sourceLineNo">747</span> * selection will continue through the last table region.<a name="line.747"></a> +<span class="sourceLineNo">748</span> * @param responsePrototype<a name="line.748"></a> +<span class="sourceLineNo">749</span> * the proto type of the response of the method in Service.<a name="line.749"></a> +<span class="sourceLineNo">750</span> * @param <R><a name="line.750"></a> +<span class="sourceLineNo">751</span> * the response type for the coprocessor Service method<a name="line.751"></a> +<span class="sourceLineNo">752</span> * @return a map of result values keyed by region name<a name="line.752"></a> +<span class="sourceLineNo">753</span> */<a name="line.753"></a> +<span class="sourceLineNo">754</span> default <R extends Message> Map<byte[], R> batchCoprocessorService(<a name="line.754"></a> +<span class="sourceLineNo">755</span> Descriptors.MethodDescriptor methodDescriptor, Message request,<a name="line.755"></a> +<span class="sourceLineNo">756</span> byte[] startKey, byte[] endKey, R responsePrototype) throws ServiceException, Throwable {<a name="line.756"></a> +<span class="sourceLineNo">757</span> throw new NotImplementedException("Add an implementation!");<a name="line.757"></a> +<span class="sourceLineNo">758</span> }<a name="line.758"></a> +<span class="sourceLineNo">759</span><a name="line.759"></a> +<span class="sourceLineNo">760</span> /**<a name="line.760"></a> +<span class="sourceLineNo">761</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.761"></a> +<span class="sourceLineNo">762</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), all<a name="line.762"></a> +<span class="sourceLineNo">763</span> * the invocations to the same region server will be batched into one call. The coprocessor<a name="line.763"></a> +<span class="sourceLineNo">764</span> * service is invoked according to the service instance, method name and parameters.<a name="line.764"></a> +<span class="sourceLineNo">765</span> *<a name="line.765"></a> +<span class="sourceLineNo">766</span> * <p><a name="line.766"></a> +<span class="sourceLineNo">767</span> * The given<a name="line.767"></a> +<span class="sourceLineNo">768</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],byte[],Object)}<a name="line.768"></a> +<span class="sourceLineNo">769</span> * method will be called with the return value from each region's invocation.<a name="line.769"></a> +<span class="sourceLineNo">770</span> * </p><a name="line.770"></a> +<span class="sourceLineNo">771</span> *<a name="line.771"></a> +<span class="sourceLineNo">772</span> * @param methodDescriptor the descriptor for the protobuf service method to call.<a name="line.772"></a> +<span class="sourceLineNo">773</span> * @param request the method call parameters<a name="line.773"></a> +<span class="sourceLineNo">774</span> * @param startKey start region selection with region containing this row.<a name="line.774"></a> +<span class="sourceLineNo">775</span> * If {@code null}, the selection will start with the first table region.<a name="line.775"></a> +<span class="sourceLineNo">776</span> * @param endKey select regions up to and including the region containing this row.<a name="line.776"></a> +<span class="sourceLineNo">777</span> * If {@code null}, selection will continue through the last table region.<a name="line.777"></a> +<span class="sourceLineNo">778</span> * @param responsePrototype the proto type of the response of the method in Service.<a name="line.778"></a> +<span class="sourceLineNo">779</span> * @param callback callback to invoke with the response for each region<a name="line.779"></a> +<span class="sourceLineNo">780</span> * @param <R><a name="line.780"></a> +<span class="sourceLineNo">781</span> * the response type for the coprocessor Service method<a name="line.781"></a> +<span class="sourceLineNo">782</span> */<a name="line.782"></a> +<span class="sourceLineNo">783</span> default <R extends Message> void batchCoprocessorService(<a name="line.783"></a> +<span class="sourceLineNo">784</span> Descriptors.MethodDescriptor methodDescriptor, Message request, byte[] startKey,<a name="line.784"></a> +<span class="sourceLineNo">785</span> byte[] endKey, R responsePrototype, Batch.Callback<R> callback)<a name="line.785"></a> +<span class="sourceLineNo">786</span> throws ServiceException, Throwable {<a name="line.786"></a> +<span class="sourceLineNo">787</span> throw new NotImplementedException("Add an implementation!");<a name="line.787"></a> +<span class="sourceLineNo">788</span> }<a name="line.788"></a> +<span class="sourceLineNo">789</span><a name="line.789"></a> +<span class="sourceLineNo">790</span> /**<a name="line.790"></a> +<span class="sourceLineNo">791</span> * Atomically checks if a row/family/qualifier value matches the expected value.<a name="line.791"></a> +<span class="sourceLineNo">792</span> * If it does, it performs the row mutations. If the passed value is null, the check<a name="line.792"></a> +<span class="sourceLineNo">793</span> * is for the lack of column (ie: non-existence)<a name="line.793"></a> +<span class="sourceLineNo">794</span> *<a name="line.794"></a> +<span class="sourceLineNo">795</span> * The expected value argument of this call is on the left and the current<a name="line.795"></a> +<span class="sourceLineNo">796</span> * value of the cell is on the right side of the comparison operator.<a name="line.796"></a> +<span class="sourceLineNo">797</span> *<a name="line.797"></a> +<span class="sourceLineNo">798</span> * Ie. eg. GREATER operator means expected value > existing <=> perform row mutations.<a name="line.798"></a> +<span class="sourceLineNo">799</span> *<a name="line.799"></a> +<span class="sourceLineNo">800</span> * @param row to check<a name="line.800"></a> +<span class="sourceLineNo">801</span> * @param family column family to check<a name="line.801"></a> +<span class="sourceLineNo">802</span> * @param qualifier column qualifier to check<a name="line.802"></a> +<span class="sourceLineNo">803</span> * @param compareOp the comparison operator<a name="line.803"></a> +<span class="sourceLineNo">804</span> * @param value the expected value<a name="line.804"></a> +<span class="sourceLineNo">805</span> * @param mutation mutations to perform if check succeeds<a name="line.805"></a> +<span class="sourceLineNo">806</span> * @throws IOException e<a name="line.806"></a> +<span class="sourceLineNo">807</span> * @return true if the new put was executed, false otherwise<a name="line.807"></a> +<span class="sourceLineNo">808</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.808"></a> +<span class="sourceLineNo">809</span> */<a name="line.809"></a> +<span class="sourceLineNo">810</span> @Deprecated<a name="line.810"></a> +<span class="sourceLineNo">811</span> default boolean checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.811"></a> +<span class="sourceLineNo">812</span> CompareFilter.CompareOp compareOp, byte[] value, RowMutations mutation) throws IOException {<a name="line.812"></a> +<span class="sourceLineNo">813</span> throw new NotImplementedException("Add an implementation!");<a name="line.813"></a> +<span class="sourceLineNo">814</span> }<a name="line.814"></a> +<span class="sourceLineNo">815</span><a name="line.815"></a> +<span class="sourceLineNo">816</span> /**<a name="line.816"></a> +<span class="sourceLineNo">817</span> * Atomically checks if a row/family/qualifier value matches the expected value.<a name="line.817"></a> +<span class="sourceLineNo">818</span> * If it does, it performs the row mutations. If the passed value is null, the check<a name="line.818"></a> +<span class="sourceLineNo">819</span> * is for the lack of column (ie: non-existence)<a name="line.819"></a> +<span class="sourceLineNo">820</span> *<a name="line.820"></a> +<span class="sourceLineNo">821</span> * The expected value argument of this call is on the left and the current<a name="line.821"></a> +<span class="sourceLineNo">822</span> * value of the cell is on the right side of the comparison operator.<a name="line.822"></a> +<span class="sourceLineNo">823</span> *<a name="line.823"></a> +<span class="sourceLineNo">824</span> * Ie. eg. GREATER operator means expected value > existing <=> perform row mutations.<a name="line.824"></a> +<span class="sourceLineNo">825</span> *<a name="line.825"></a> +<span class="sourceLineNo">826</span> * @param row to check<a name="line.826"></a> +<span class="sourceLineNo">827</span> * @param family column family to check<a name="line.827"></a> +<span class="sourceLineNo">828</span> * @param qualifier column qualifier to check<a name="line.828"></a> +<span class="sourceLineNo">829</span> * @param op the comparison operator<a name="line.829"></a> +<span class="sourceLineNo">830</span> * @param value the expected value<a name="line.830"></a> +<span class="sourceLineNo">831</span> * @param mutation mutations to perform if check succeeds<a name="line.831"></a> +<span class="sourceLineNo">832</span> * @throws IOException e<a name="line.832"></a> +<span class="sourceLineNo">833</span> * @return true if the new put was executed, false otherwise<a name="line.833"></a> +<span class="sourceLineNo">834</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.834"></a> +<span class="sourceLineNo">835</span> */<a name="line.835"></a> +<span class="sourceLineNo">836</span> @Deprecated<a name="line.836"></a> +<span class="sourceLineNo">837</span> default boolean checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op,<a name="line.837"></a> +<span class="sourceLineNo">838</span> byte[] value, RowMutations mutation) throws IOException {<a name="line.838"></a> +<span class="sourceLineNo">839</span> throw new NotImplementedException("Add an implementation!");<a name="line.839"></a> +<span class="sourceLineNo">840</span> }<a name="line.840"></a> +<span class="sourceLineNo">841</span><a name="line.841"></a> +<span class="sourceLineNo">842</span> /**<a name="line.842"></a> +<span class="sourceLineNo">843</span> * Get timeout of each rpc request in this Table instance. It will be overridden by a more<a name="line.843"></a> +<span class="sourceLineNo">844</span> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.<a name="line.844"></a> +<span class="sourceLineNo">845</span> * @see #getReadRpcTimeout(TimeUnit)<a name="line.845"></a> +<span class="sourceLineNo">846</span> * @see #getWriteRpcTimeout(TimeUnit)<a name="line.846"></a> +<span class="sourceLineNo">847</span> * @param unit the unit of time the timeout to be represented in<a name="line.847"></a> +<span class="sourceLineNo">848</span> * @return rpc timeout in the specified time unit<a name="line.848"></a> +<span class="sourceLineNo">849</span> */<a name="line.849"></a> +<span class="sourceLineNo">850</span> default long getRpcTimeout(TimeUnit unit) {<a name="line.850"></a> +<span class="sourceLineNo">851</span> throw new NotImplementedException("Add an implementation!");<a name="line.851"></a> +<span class="sourceLineNo">852</span> }<a name="line.852"></a> +<span class="sourceLineNo">853</span><a name="line.853"></a> +<span class="sourceLineNo">854</span> /**<a name="line.854"></a> +<span class="sourceLineNo">855</span> * Get timeout (millisecond) of each rpc request in this Table instance.<a name="line.855"></a> +<span class="sourceLineNo">856</span> *<a name="line.856"></a> +<span class="sourceLineNo">857</span> * @return Currently configured read timeout<a name="line.857"></a> +<span class="sourceLineNo">858</span> * @deprecated use {@link #getReadRpcTimeout(TimeUnit)} or<a name="line.858"></a> +<span class="sourceLineNo">859</span> * {@link #getWriteRpcTimeout(TimeUnit)} instead<a name="line.859"></a> +<span class="sourceLineNo">860</span> */<a name="line.860"></a> +<span class="sourceLineNo">861</span> @Deprecated<a name="line.861"></a> +<span class="sourceLineNo">862</span> default int getRpcTimeout() {<a name="line.862"></a> +<span class="sourceLineNo">863</span> return (int)getRpcTimeout(TimeUnit.MILLISECONDS);<a name="line.863"></a> +<span class="sourceLineNo">864</span> }<a name="line.864"></a> +<span class="sourceLineNo">865</span><a name="line.865"></a> +<span class="sourceLineNo">866</span> /**<a name="line.866"></a> +<span class="sourceLineNo">867</span> * Set timeout (millisecond) of each rpc request in operations of this Table instance, will<a name="line.867"></a> +<span class="sourceLineNo">868</span> * override the value of hbase.rpc.timeout in configuration.<a name="line.868"></a> +<span class="sourceLineNo">869</span> * If a rpc request waiting too long, it will stop waiting and send a new request to retry until<a name="line.869"></a> +<span class="sourceLineNo">870</span> * retries exhausted or operation timeout reached.<a name="line.870"></a> +<span class="sourceLineNo">871</span> * <p><a name="line.871"></a> +<span class="sourceLineNo">872</span> * NOTE: This will set both the read and write timeout settings to the provided value.<a name="line.872"></a> +<span class="sourceLineNo">873</span> *<a name="line.873"></a> +<span class="sourceLineNo">874</span> * @param rpcTimeout the timeout of each rpc request in millisecond.<a name="line.874"></a> +<span class="sourceLineNo">875</span> *<a name="line.875"></a> +<span class="sourceLineNo">876</span> * @deprecated Use setReadRpcTimeout or setWriteRpcTimeout instead<a name="line.876"></a> +<span class="sourceLineNo">877</span> */<a name="line.877"></a> +<span class="sourceLineNo">878</span> @Deprecated<a name="line.878"></a> +<span class="sourceLineNo">879</span> default void setRpcTimeout(int rpcTimeout) {<a name="line.879"></a> +<span class="sourceLineNo">880</span> setReadRpcTimeout(rpcTimeout);<a name="line.880"></a> +<span class="sourceLineNo">881</span> setWriteRpcTimeout(rpcTimeout);<a name="line.881"></a> +<span class="sourceLineNo">882</span> }<a name="line.882"></a> +<span class="sourceLineNo">883</span><a name="line.883"></a> +<span class="sourceLineNo">884</span> /**<a name="line.884"></a> +<span class="sourceLineNo">885</span> * Get timeout of each rpc read request in this Table instance.<a name="line.885"></a> +<span class="sourceLineNo">886</span> * @param unit the unit of time the timeout to be represented in<a name="line.886"></a> +<span class="sourceLineNo">887</span> * @return read rpc timeout in the specified time unit<a name="line.887"></a> +<span class="sourceLineNo">888</span> */<a name="line.888"></a> +<span class="sourceLineNo">889</span> default long getReadRpcTimeout(TimeUnit unit) {<a name="line.889"></a> +<span class="sourceLineNo">890</span> throw new NotImplementedException("Add an implementation!");<a name="line.890"></a> +<span class="sourceLineNo">891</span> }<a name="line.891"></a> +<span class="sourceLineNo">892</span><a name="line.892"></a> +<span class="sourceLineNo">893</span> /**<a name="line.893"></a> +<span class="sourceLineNo">894</span> * Get timeout (millisecond) of each rpc read request in this Table instance.<a name="line.894"></a> +<span class="sourceLineNo">895</span> * @deprecated since 2.0 and will be removed in 3.0 version<a name="line.895"></a> +<span class="sourceLineNo">896</span> * use {@link #getReadRpcTimeout(TimeUnit)} instead<a name="line.896"></a> +<span class="sourceLineNo">897</span> */<a name="line.897"></a> +<span class="sourceLineNo">898</span> @Deprecated<a name="line.898"></a> +<span class="sourceLineNo">899</span> default int getReadRpcTimeout() {<a name="line.899"></a> +<span class="sourceLineNo">900</span> return (int)getReadRpcTimeout(TimeUnit.MILLISECONDS);<a name="line.900"></a> +<span class="sourceLineNo">901</span> }<a name="line.901"></a> +<span class="sourceLineNo">902</span><a name="line.902"></a> +<span class="sourceLineNo">903</span> /**<a name="line.903"></a> +<span class="sourceLineNo">904</span> * Set timeout (millisecond) of each rpc read request in operations of this Table instance, will<a name="line.904"></a> +<span class="sourceLineNo">905</span> * override the value of hbase.rpc.read.timeout in configuration.<a name="line.905"></a> +<span class="sourceLineNo">906</span> * If a rpc read request waiting too long, it will stop waiting and send a new request to retry<a name="line.906"></a> +<span class="sourceLineNo">907</span> * until retries exhausted or operation timeout reached.<a name="line.907"></a> +<span class="sourceLineNo">908</span> *<a name="line.908"></a> +<span class="sourceLineNo">909</span> * @param readRpcTimeout the timeout for read rpc request in milliseconds<a name="line.909"></a> +<span class="sourceLineNo">910</span> * @deprecated since 2.0.0, use {@link TableBuilder#setReadRpcTimeout} instead<a name="line.910"></a> +<span class="sourceLineNo">911</span> */<a name="line.911"></a> +<span class="sourceLineNo">912</span> @Deprecated<a name="line.912"></a> +<span class="sourceLineNo">913</span> default void setReadRpcTimeout(int readRpcTimeout) {<a name="line.913"></a> +<span class="sourceLineNo">914</span> throw new NotImplementedException("Add an implementation!");<a name="line.914"></a> +<span class="sourceLineNo">915</span> }<a name="line.915"></a> +<span class="sourceLineNo">916</span><a name="line.916"></a> +<span class="sourceLineNo">917</span> /**<a name="line.917"></a> +<span class="sourceLineNo">918</span> * Get timeout of each rpc write request in this Table instance.<a name="line.918"></a> +<span class="sourceLineNo">919</span> * @param unit the unit of time the timeout to be represented in<a name="line.919"></a> +<span class="sourceLineNo">920</span> * @return write rpc timeout in the specified time unit<a name="line.920"></a> +<span class="sourceLineNo">921</span> */<a name="line.921"></a> +<span class="sourceLineNo">922</span> default long getWriteRpcTimeout(TimeUnit unit) {<a name="line.922"></a> +<span class="sourceLineNo">923</span> throw new NotImplementedException("Add an implementation!");<a name="line.923"></a> +<span class="sourceLineNo">924</span> }<a name="line.924"></a> +<span class="sourceLineNo">925</span><a name="line.925"></a> +<span class="sourceLineNo">926</span> /**<a name="line.926"></a> +<span class="sourceLineNo">927</span> * Get timeout (millisecond) of each rpc write request in this Table instance.<a name="line.927"></a> +<span class="sourceLineNo">928</span> * @deprecated since 2.0 and will be removed in 3.0 version<a name="line.928"></a> +<span class="sourceLineNo">929</span> * use {@link #getWriteRpcTimeout(TimeUnit)} instead<a name="line.929"></a> +<span class="sourceLineNo">930</span> */<a name="line.930"></a> +<span class="sourceLineNo">931</span> @Deprecated<a name="line.931"></a> +<span class="sourceLineNo">932</span> default int getWriteRpcTimeout() {<a name="line.932"></a> +<span class="sourceLineNo">933</span> return (int)getWriteRpcTimeout(TimeUnit.MILLISECONDS);<a name="line.933"></a> +<span class="sourceLineNo">934</span> }<a name="line.934"></a> +<span class="sourceLineNo">935</span><a name="line.935"></a> +<span class="sourceLineNo">936</span> /**<a name="line.936"></a> +<span class="sourceLineNo">937</span> * Set timeout (millisecond) of each rpc write request in operations of this Table instance, will<a name="line.937"></a> +<span class="sourceLineNo">938</span> * override the value of hbase.rpc.write.timeout in configuration.<a name="line.938"></a> +<span class="sourceLineNo">939</span> * If a rpc write request waiting too long, it will stop waiting and send a new request to retry<a name="line.939"></a> +<span class="sourceLineNo">940</span> * until retries exhausted or operation timeout reached.<a name="line.940"></a> +<span class="sourceLineNo">941</span> *<a name="line.941"></a> +<span class="sourceLineNo">942</span> * @param writeRpcTimeout the timeout for write rpc request in milliseconds<a name="line.942"></a> +<span class="sourceLineNo">943</span> * @deprecated since 2.0.0, use {@link TableBuilder#setWriteRpcTimeout} instead<a name="line.943"></a> +<span class="sourceLineNo">944</span> */<a name="line.944"></a> +<span class="sourceLineNo">945</span> @Deprecated<a name="line.945"></a> +<span class="sourceLineNo">946</span> default void setWriteRpcTimeout(int writeRpcTimeout) {<a name="line.946"></a> +<span class="sourceLineNo">947</span> throw new NotImplementedException("Add an implementation!");<a name="line.947"></a> +<span class="sourceLineNo">948</span> }<a name="line.948"></a> +<span class="sourceLineNo">949</span><a name="line.949"></a> +<span class="sourceLineNo">950</span> /**<a name="line.950"></a> +<span class="sourceLineNo">951</span> * Get timeout of each operation in Table instance.<a name="line.951"></a> +<span class="sourceLineNo">952</span> * @param unit the unit of time the timeout to be represented in<a name="line.952"></a> +<span class="sourceLineNo">953</span> * @return operation rpc timeout in the specified time unit<a name="line.953"></a> +<span class="sourceLineNo">954</span> */<a name="line.954"></a> +<span class="sourceLineNo">955</span> default long getOperationTimeout(TimeUnit unit) {<a name="line.955"></a> +<span class="sourceLineNo">956</span> throw new NotImplementedException("Add an implementation!");<a name="line.956"></a> +<span class="sourceLineNo">957</span> }<a name="line.957"></a> +<span class="sourceLineNo">958</span><a name="line.958"></a> +<span class="sourceLineNo">959</span> /**<a name="line.959"></a> +<span class="sourceLineNo">960</span> * Get timeout (millisecond) of each operation for in Table instance.<a name="line.960"></a> +<span class="sourceLineNo">961</span> * @deprecated since 2.0 and will be removed in 3.0 version<a name="line.961"></a> +<span class="sourceLineNo">962</span> * use {@link #getOperationTimeout(TimeUnit)} instead<a name="line.962"></a> +<span class="sourceLineNo">963</span> */<a name="line.963"></a> +<span class="sourceLineNo">964
<TRUNCATED>