Table (Apache HBase 1.4.11 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

HTableInterface

All Known Implementing Classes:

HTable, HTableWrapper, RemoteHTable
```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface Table
extends Closeable
```
Used to communicate with a single HBase table. Obtain an instance from a Connection and call close() afterwards.
Table can be used to get, put, delete or scan data from a table.

Since:

0.99.0

See Also:
ConnectionFactory, Connection, Admin, RegionLocator

Method Summary

Methods
Modifier and Type	Method and Description
`Result`	`append(Append append)` Appends values to one or more columns within a single row.
`Object[]`	`batch(List<? extends Row> actions)` Deprecated. If any exception is thrown by one of the actions, there is no way to retrieve the partially executed results. Use `batch(List, Object[])` instead.
`void`	`batch(List<? extends Row> actions, Object[] results)` Method that does a batch call on Deletes, Gets, Puts, Increments, Appends, RowMutations The ordering of execution of the actions is not defined.
`<R> Object[]`	`batchCallback(List<? extends Row> actions, Batch.Callback<R> callback)` Deprecated. If any exception is thrown by one of the actions, there is no way to retrieve the partially executed results. Use `batchCallback(List, Object[], org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)` instead.
`<R> void`	`batchCallback(List<? extends Row> actions, Object[] results, Batch.Callback<R> callback)` Same as `batch(List, Object[])`, but with a callback.
`<R extends com.google.protobuf.Message> Map<byte[],R>`	`batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, com.google.protobuf.Message request, byte[] startKey, byte[] endKey, R responsePrototype)` Creates an instance of the given `Service` subclass for each table region spanning the range from the `startKey` row to `endKey` row (inclusive), all the invocations to the same region server will be batched into one call.
`<R extends com.google.protobuf.Message> void`	`batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, com.google.protobuf.Message request, byte[] startKey, byte[] endKey, R responsePrototype, Batch.Callback<R> callback)` Creates an instance of the given `Service` subclass for each table region spanning the range from the `startKey` row to `endKey` row (inclusive), all the invocations to the same region server will be batched into one call.
`boolean`	`checkAndDelete(byte[] row, byte[] family, byte[] qualifier, byte[] value, Delete delete)` Atomically checks if a row/family/qualifier value matches the expected value.
`boolean`	`checkAndDelete(byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value, Delete delete)` Atomically checks if a row/family/qualifier value matches the expected value.
`boolean`	`checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value, RowMutations mutation)` Atomically checks if a row/family/qualifier value matches the expected value.
`boolean`	`checkAndPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, Put put)` Atomically checks if a row/family/qualifier value matches the expected value.
`boolean`	`checkAndPut(byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value, Put put)` Atomically checks if a row/family/qualifier value matches the expected value.
`void`	`close()` Releases any resources held or pending changes in internal buffers.
`CoprocessorRpcChannel`	`coprocessorService(byte[] row)` Creates and returns a `RpcChannel` instance connected to the table region containing the specified row.
`<T extends com.google.protobuf.Service,R> Map<byte[],R>`	`coprocessorService(Class<T> service, byte[] startKey, byte[] endKey, Batch.Call<T,R> callable)` Creates an instance of the given `Service` subclass for each table region spanning the range from the `startKey` row to `endKey` row (inclusive), and invokes the passed `Batch.Call.call(T)` method with each `Service` instance.
`<T extends com.google.protobuf.Service,R> void`	`coprocessorService(Class<T> service, byte[] startKey, byte[] endKey, Batch.Call<T,R> callable, Batch.Callback<R> callback)` Creates an instance of the given `Service` subclass for each table region spanning the range from the `startKey` row to `endKey` row (inclusive), and invokes the passed `Batch.Call.call(T)` method with each `Service` instance.
`void`	`delete(Delete delete)` Deletes the specified cells/row.
`void`	`delete(List<Delete> deletes)` Deletes the specified cells/rows in bulk.
`boolean`	`exists(Get get)` Test for the existence of columns in the table, as specified by the Get.
`boolean[]`	`existsAll(List<Get> gets)` Test for the existence of columns in the table, as specified by the Gets.
`Result`	`get(Get get)` Extracts certain cells from a given row.
`Result[]`	`get(List<Get> gets)` Extracts certain cells from the given rows, in batch.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()` Returns the `Configuration` object used by this instance.
`TableName`	`getName()` Gets the fully qualified table name instance of this table.
`int`	`getOperationTimeout()` Get timeout (millisecond) of each operation for in Table instance.
`int`	`getReadRpcTimeout()` Get timeout (millisecond) of each rpc read request in this Table instance.
`int`	`getRpcTimeout()` Deprecated. Use getReadRpcTimeout or getWriteRpcTimeout instead
`ResultScanner`	`getScanner(byte[] family)` Gets a scanner on the current table for the given family.
`ResultScanner`	`getScanner(byte[] family, byte[] qualifier)` Gets a scanner on the current table for the given family and qualifier.
`ResultScanner`	`getScanner(Scan scan)` Returns a scanner on the current table as specified by the `Scan` object.
`HTableDescriptor`	`getTableDescriptor()` Gets the `table descriptor` for this table.
`long`	`getWriteBufferSize()` Deprecated. as of 1.0.1 (should not have been in 1.0.0). Replaced by `BufferedMutator.getWriteBufferSize()`
`int`	`getWriteRpcTimeout()` Get timeout (millisecond) of each rpc write request in this Table instance.
`Result`	`increment(Increment increment)` Increments one or more columns within a single row.
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)` See `incrementColumnValue(byte[], byte[], byte[], long, Durability)`
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, Durability durability)` Atomically increments a column value.
`void`	`mutateRow(RowMutations rm)` Performs multiple mutations atomically on a single row.
`void`	`put(List<Put> puts)` Puts some data in the table, in batch.
`void`	`put(Put put)` Puts some data in the table.
`void`	`setOperationTimeout(int operationTimeout)` Set timeout (millisecond) of each operation in this Table instance, will override the value of hbase.client.operation.timeout in configuration.
`void`	`setReadRpcTimeout(int readRpcTimeout)` Set timeout (millisecond) of each rpc read request in operations of this Table instance, will override the value of hbase.rpc.read.timeout in configuration.
`void`	`setRpcTimeout(int rpcTimeout)` Deprecated. Use setReadRpcTimeout or setWriteRpcTimeout instead
`void`	`setWriteBufferSize(long writeBufferSize)` Deprecated. as of 1.0.1 (should not have been in 1.0.0). Replaced by `BufferedMutator` and `BufferedMutatorParams.writeBufferSize(long)`
`void`	`setWriteRpcTimeout(int writeRpcTimeout)` Set timeout (millisecond) of each rpc write request in operations of this Table instance, will override the value of hbase.rpc.write.timeout in configuration.

- Method Detail
  - getName
```
TableName getName()
```
    Gets the fully qualified table name instance of this table.
  - getConfiguration
```
org.apache.hadoop.conf.Configuration getConfiguration()
```
    Returns the Configuration object used by this instance.
    The reference returned is not a copy, so any change made to it will affect this instance.
  - getTableDescriptor
```
HTableDescriptor getTableDescriptor()
                                    throws IOException
```
    Gets the table descriptor for this table.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - exists
```
boolean exists(Get get)
               throws IOException
```
    Test for the existence of columns in the table, as specified by the Get.
    This will return true if the Get matches one or more keys, false if not.
    This is a server-side call so it prevents any data from being transfered to the client.
    
    Parameters:
    get - the Get
    
    Returns:
    true if the specified Get matches one or more keys, false if not
    
    Throws:
    
    IOException - e
  - existsAll
```
boolean[] existsAll(List<Get> gets)
                    throws IOException
```
    Test for the existence of columns in the table, as specified by the Gets.
    This will return an array of booleans. Each value will be true if the related Get matches one or more keys, false if not.
    This is a server-side call so it prevents any data from being transferred to the client.
    
    Parameters:
    gets - the Gets
    
    Returns:
    Array of boolean. True if the specified Get matches one or more keys, false if not.
    
    Throws:
    
    IOException - e
  - batch
```
void batch(List<? extends Row> actions,
         Object[] results)
           throws IOException,
                  InterruptedException
```
    Method that does a batch call on Deletes, Gets, Puts, Increments, Appends, RowMutations The ordering of execution of the actions is not defined. Meaning if you do a Put and a Get in the same batch(java.util.List<? extends org.apache.hadoop.hbase.client.Row>, java.lang.Object[]) call, you will not necessarily be guaranteed that the Get returns what the Put had put.
    
    Parameters:
    actions - list of Get, Put, Delete, Increment, Append, RowMutations
    results - Empty Object[], same size as actions. Provides access to partial results, in case an exception is thrown. A null in the result array means that the call for that action failed, even after retries
    
    Throws:
    
    IOException
    
    InterruptedException
    Since:
    
    0.90.0
  - batch
```
@Deprecated
Object[] batch(List<? extends Row> actions)
               throws IOException,
                      InterruptedException
```
    Deprecated. If any exception is thrown by one of the actions, there is no way to retrieve the partially executed results. Use batch(List, Object[]) instead.
    
    Same as batch(List, Object[]), but returns an array of results instead of using a results parameter reference.
    
    Parameters:
    actions - list of Get, Put, Delete, Increment, Append, RowMutations
    
    Returns:
    the results from the actions. A null in the return array means that the call for that action failed, even after retries
    
    Throws:
    
    IOException
    
    InterruptedException
    Since:
    
    0.90.0
  - batchCallback
```
<R> void batchCallback(List<? extends Row> actions,
                     Object[] results,
                     Batch.Callback<R> callback)
                   throws IOException,
                          InterruptedException
```
    Same as batch(List, Object[]), but with a callback.
    
    Throws:
    
    IOException
    
    InterruptedException
    Since:
    
    0.96.0
  - batchCallback
```
@Deprecated
<R> Object[] batchCallback(List<? extends Row> actions,
                                    Batch.Callback<R> callback)
                       throws IOException,
                              InterruptedException
```
    Deprecated. If any exception is thrown by one of the actions, there is no way to retrieve the partially executed results. Use batchCallback(List, Object[], org.apache.hadoop.hbase.client.coprocessor.Batch.Callback) instead.
    
    Same as batch(List), but with a callback.
    
    Throws:
    
    IOException
    
    InterruptedException
    Since:
    
    0.96.0
  - get
```
Result get(Get get)
           throws IOException
```
    Extracts certain cells from a given row.
    
    Parameters:
    get - The object that specifies what data to fetch and from which row.
    
    Returns:
    The data coming from the specified row, if it exists. If the row specified doesn't exist, the Result instance returned won't contain any KeyValue, as indicated by Result.isEmpty().
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.20.0
  - get
```
Result[] get(List<Get> gets)
             throws IOException
```
    Extracts certain cells from the given rows, in batch.
    
    Parameters:
    gets - The objects that specify what data to fetch and from which rows.
    
    Returns:
    The data coming from the specified rows, if it exists. If the row specified doesn't exist, the Result instance returned won't contain any KeyValue, as indicated by Result.isEmpty(). If there are any failures even after retries, there will be a null in the results array for those Gets, AND an exception will be thrown.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.90.0
  - getScanner
```
ResultScanner getScanner(Scan scan)
                         throws IOException
```
    Returns a scanner on the current table as specified by the Scan object. Note that the passed Scan's start row and caching properties maybe changed.
    
    Parameters:
    scan - A configured Scan object.
    
    Returns:
    A scanner.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.20.0
  - getScanner
```
ResultScanner getScanner(byte[] family)
                         throws IOException
```
    Gets a scanner on the current table for the given family.
    
    Parameters:
    family - The column family to scan.
    
    Returns:
    A scanner.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.20.0
  - getScanner
```
ResultScanner getScanner(byte[] family,
                       byte[] qualifier)
                         throws IOException
```
    Gets a scanner on the current table for the given family and qualifier.
    
    Parameters:
    family - The column family to scan.
    qualifier - The column qualifier to scan.
    
    Returns:
    A scanner.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.20.0
  - put
```
void put(Put put)
         throws IOException
```
    Puts some data in the table.
    
    Parameters:
    put - The data to put.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.20.0
  - put
```
void put(List<Put> puts)
         throws IOException
```
    Puts some data in the table, in batch.
    This can be used for group commit, or for submitting user defined batches. The writeBuffer will be periodically inspected while the List is processed, so depending on the List size the writeBuffer may flush not at all, or more than once.
    
    Parameters:
    puts - The list of mutations to apply. The batch put is done by aggregating the iteration of the Puts over the write buffer at the client-side for a single RPC call.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.20.0
  - checkAndPut
```
boolean checkAndPut(byte[] row,
                  byte[] family,
                  byte[] qualifier,
                  byte[] value,
                  Put put)
                    throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the put. If the passed value is null, the check is for the lack of column (ie: non-existance)
    
    Parameters:
    row - to check
    family - column family to check
    qualifier - column qualifier to check
    value - the expected value
    put - data to put if check succeeds
    
    Returns:
    true if the new put was executed, false otherwise
    
    Throws:
    
    IOException - e
  - checkAndPut
```
boolean checkAndPut(byte[] row,
                  byte[] family,
                  byte[] qualifier,
                  CompareFilter.CompareOp compareOp,
                  byte[] value,
                  Put put)
                    throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the put. If the passed value is null, the check is for the lack of column (ie: non-existance)
    
    Parameters:
    row - to check
    family - column family to check
    qualifier - column qualifier to check
    compareOp - comparison operator to use
    value - the expected value
    put - data to put if check succeeds
    
    Returns:
    true if the new put was executed, false otherwise
    
    Throws:
    
    IOException - e
  - delete
```
void delete(Delete delete)
            throws IOException
```
    Deletes the specified cells/row.
    
    Parameters:
    delete - The object that specifies what to delete.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
    Since:
    
    0.20.0
  - delete
```
void delete(List<Delete> deletes)
            throws IOException
```
    Deletes the specified cells/rows in bulk.
    
    Parameters:
    deletes - List of things to delete. List gets modified by this method (in particular it gets re-ordered, so the order in which the elements are inserted in the list gives no guarantee as to the order in which the Deletes are executed).
    
    Throws:
    
    IOException - if a remote or network exception occurs. In that case the deletes argument will contain the Delete instances that have not be successfully applied.
    Since:
    
    0.20.1
  - checkAndDelete
```
boolean checkAndDelete(byte[] row,
                     byte[] family,
                     byte[] qualifier,
                     byte[] value,
                     Delete delete)
                       throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the delete. If the passed value is null, the check is for the lack of column (ie: non-existance)
    
    Parameters:
    row - to check
    family - column family to check
    qualifier - column qualifier to check
    value - the expected value
    delete - data to delete if check succeeds
    
    Returns:
    true if the new delete was executed, false otherwise
    
    Throws:
    
    IOException - e
  - checkAndDelete
```
boolean checkAndDelete(byte[] row,
                     byte[] family,
                     byte[] qualifier,
                     CompareFilter.CompareOp compareOp,
                     byte[] value,
                     Delete delete)
                       throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the delete. If the passed value is null, the check is for the lack of column (ie: non-existance)
    
    Parameters:
    row - to check
    family - column family to check
    qualifier - column qualifier to check
    compareOp - comparison operator to use
    value - the expected value
    delete - data to delete if check succeeds
    
    Returns:
    true if the new delete was executed, false otherwise
    
    Throws:
    
    IOException - e
  - mutateRow
```
void mutateRow(RowMutations rm)
               throws IOException
```
    Performs multiple mutations atomically on a single row. Currently Put and Delete are supported.
    
    Parameters:
    rm - object that specifies the set of mutations to perform atomically
    
    Throws:
    
    IOException
  - append
```
Result append(Append append)
              throws IOException
```
    Appends values to one or more columns within a single row.
    This operation guaranteed atomicity to readers. Appends are done under a single row lock, so write operations to a row are synchronized, and readers are guaranteed to see this operation fully completed.
    
    Parameters:
    append - object that specifies the columns and values to be appended
    
    Returns:
    values of columns after the append operation (maybe null)
    
    Throws:
    
    IOException - e
  - increment
```
Result increment(Increment increment)
                 throws IOException
```
    Increments one or more columns within a single row.
    This operation ensures atomicity to readers. Increments are done under a single row lock, so write operations to a row are synchronized, and readers are guaranteed to see this operation fully completed.
    
    Parameters:
    increment - object that specifies the columns and amounts to be used for the increment operations
    
    Returns:
    values of columns after the increment
    
    Throws:
    
    IOException - e
  - incrementColumnValue
```
long incrementColumnValue(byte[] row,
                        byte[] family,
                        byte[] qualifier,
                        long amount)
                          throws IOException
```
    See incrementColumnValue(byte[], byte[], byte[], long, Durability)
    The Durability is defaulted to Durability.SYNC_WAL.
    
    Parameters:
    row - The row that contains the cell to increment.
    family - The column family of the cell to increment.
    qualifier - The column qualifier of the cell to increment.
    amount - The amount to increment the cell with (or decrement, if the amount is negative).
    
    Returns:
    The new value, post increment.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - incrementColumnValue
```
long incrementColumnValue(byte[] row,
                        byte[] family,
                        byte[] qualifier,
                        long amount,
                        Durability durability)
                          throws IOException
```
    Atomically increments a column value. If the column value already exists and is not a big-endian long, this could throw an exception. If the column value does not yet exist it is initialized to amount and written to the specified column.
    Setting durability to Durability.SKIP_WAL means that in a fail scenario you will lose any increments that have not been flushed.
    
    Parameters:
    row - The row that contains the cell to increment.
    family - The column family of the cell to increment.
    qualifier - The column qualifier of the cell to increment.
    amount - The amount to increment the cell with (or decrement, if the amount is negative).
    durability - The persistence guarantee for this increment.
    
    Returns:
    The new value, post increment.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - close
```
void close()
           throws IOException
```
    Releases any resources held or pending changes in internal buffers.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - coprocessorService
```
CoprocessorRpcChannel coprocessorService(byte[] row)
```
    Creates and returns a RpcChannel instance connected to the table region containing the specified row. The row given does not actually have to exist. Whichever region would contain the row based on start and end keys will be used. Note that the row parameter is also not passed to the coprocessor handler registered for this protocol, unless the row is separately passed as an argument in the service request. The parameter here is only used to locate the region used to handle the call.
    The obtained RpcChannel instance can be used to access a published coprocessor Service using standard protobuf service invocations:
    CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey); MyService.BlockingInterface service = MyService.newBlockingStub(channel); MyCallRequest request = MyCallRequest.newBuilder() ... .build(); MyCallResponse response = service.myCall(null, request);
    Parameters:
    row - The row key used to identify the remote region location
    
    Returns:
    A CoprocessorRpcChannel instance
  - coprocessorService
```
<T extends com.google.protobuf.Service,R> Map<byte[],R> coprocessorService(Class<T> service,
                                                                         byte[] startKey,
                                                                         byte[] endKey,
                                                                         Batch.Call<T,R> callable)
                                 throws com.google.protobuf.ServiceException,
                                        Throwable
```
    Creates an instance of the given Service subclass for each table region spanning the range from the startKey row to endKey row (inclusive), and invokes the passed Batch.Call.call(T) method with each Service instance.
    
    Type Parameters:
    T - the Service subclass to connect to
    R - Return type for the callable parameter's Batch.Call.call(T) method
    Parameters:
    service - the protocol buffer Service implementation to call
    startKey - start region selection with region containing this row. If null, the selection will start with the first table region.
    endKey - select regions up to and including the region containing this row. If null, selection will continue through the last table region.
    callable - this instance's .Call#call method will be invoked once per table region, using the Service instance connected to that region.
    
    Returns:
    a map of result values keyed by region name
    
    Throws:
    
    com.google.protobuf.ServiceException
    
    Throwable
  - coprocessorService
```
<T extends com.google.protobuf.Service,R> void coprocessorService(Class<T> service,
                                                                byte[] startKey,
                                                                byte[] endKey,
                                                                Batch.Call<T,R> callable,
                                                                Batch.Callback<R> callback)
                        throws com.google.protobuf.ServiceException,
                               Throwable
```
    Creates an instance of the given Service subclass for each table region spanning the range from the startKey row to endKey row (inclusive), and invokes the passed Batch.Call.call(T) method with each Service instance.
    The given Batch.Callback.update(byte[], byte[], Object) method will be called with the return value from each region's Batch.Call.call(T) invocation.
    
    Type Parameters:
    T - the Service subclass to connect to
    R - Return type for the callable parameter's Batch.Call.call(T) method
    Parameters:
    service - the protocol buffer Service implementation to call
    startKey - start region selection with region containing this row. If null, the selection will start with the first table region.
    endKey - select regions up to and including the region containing this row. If null, selection will continue through the last table region.
    callable - this instance's .Call#call method will be invoked once per table region, using the Service instance connected to that region.
    callback -
    
    Throws:
    
    com.google.protobuf.ServiceException
    
    Throwable
  - getWriteBufferSize
```
@Deprecated
long getWriteBufferSize()
```
    Deprecated. as of 1.0.1 (should not have been in 1.0.0). Replaced by BufferedMutator.getWriteBufferSize()
    
    Returns the maximum size in bytes of the write buffer for this HTable.
    The default value comes from the configuration parameter hbase.client.write.buffer.
    
    Returns:
    The size of the write buffer in bytes.
  - setWriteBufferSize
```
@Deprecated
void setWriteBufferSize(long writeBufferSize)
                        throws IOException
```
    Deprecated. as of 1.0.1 (should not have been in 1.0.0). Replaced by BufferedMutator and BufferedMutatorParams.writeBufferSize(long)
    
    Sets the size of the buffer in bytes.
    If the new size is less than the current amount of data in the write buffer, the buffer gets flushed.
    
    Parameters:
    writeBufferSize - The new write buffer size, in bytes.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - batchCoprocessorService
```
<R extends com.google.protobuf.Message> Map<byte[],R> batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor,
                                                                            com.google.protobuf.Message request,
                                                                            byte[] startKey,
                                                                            byte[] endKey,
                                                                            R responsePrototype)
                                                                          throws com.google.protobuf.ServiceException,
                                                                                 Throwable
```
    Creates an instance of the given Service subclass for each table region spanning the range from the startKey row to endKey row (inclusive), all the invocations to the same region server will be batched into one call. The coprocessor service is invoked according to the service instance, method name and parameters.
    
    Type Parameters:
    R - the response type for the coprocessor Service method
    Parameters:
    methodDescriptor - the descriptor for the protobuf service method to call.
    request - the method call parameters
    startKey - start region selection with region containing this row. If null, the selection will start with the first table region.
    endKey - select regions up to and including the region containing this row. If null, selection will continue through the last table region.
    responsePrototype - the proto type of the response of the method in Service.
    
    Returns:
    a map of result values keyed by region name
    
    Throws:
    
    com.google.protobuf.ServiceException
    
    Throwable
  - batchCoprocessorService
```
<R extends com.google.protobuf.Message> void batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor,
                                                                   com.google.protobuf.Message request,
                                                                   byte[] startKey,
                                                                   byte[] endKey,
                                                                   R responsePrototype,
                                                                   Batch.Callback<R> callback)
                             throws com.google.protobuf.ServiceException,
                                    Throwable
```
    Creates an instance of the given Service subclass for each table region spanning the range from the startKey row to endKey row (inclusive), all the invocations to the same region server will be batched into one call. The coprocessor service is invoked according to the service instance, method name and parameters.
    The given Batch.Callback.update(byte[],byte[],Object) method will be called with the return value from each region's invocation.
    
    Type Parameters:
    R - the response type for the coprocessor Service method
    Parameters:
    methodDescriptor - the descriptor for the protobuf service method to call.
    request - the method call parameters
    startKey - start region selection with region containing this row. If null, the selection will start with the first table region.
    endKey - select regions up to and including the region containing this row. If null, selection will continue through the last table region.
    responsePrototype - the proto type of the response of the method in Service.
    callback - callback to invoke with the response for each region
    
    Throws:
    
    com.google.protobuf.ServiceException
    
    Throwable
  - checkAndMutate
```
boolean checkAndMutate(byte[] row,
                     byte[] family,
                     byte[] qualifier,
                     CompareFilter.CompareOp compareOp,
                     byte[] value,
                     RowMutations mutation)
                       throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected value. If it does, it performs the row mutations. If the passed value is null, the check is for the lack of column (ie: non-existence)
    
    Parameters:
    row - to check
    family - column family to check
    qualifier - column qualifier to check
    compareOp - the comparison operator
    value - the expected value
    mutation - mutations to perform if check succeeds
    
    Returns:
    true if the new put was executed, false otherwise
    
    Throws:
    
    IOException - e
  - setOperationTimeout
```
void setOperationTimeout(int operationTimeout)
```
    Set timeout (millisecond) of each operation in this Table instance, will override the value of hbase.client.operation.timeout in configuration. Operation timeout is a top-level restriction that makes sure a blocking method will not be blocked more than this. In each operation, if rpc request fails because of timeout or other reason, it will retry until success or throw a RetriesExhaustedException. But if the total time being blocking reach the operation timeout before retries exhausted, it will break early and throw SocketTimeoutException.
    
    Parameters:
    operationTimeout - the total timeout of each operation in millisecond.
  - getOperationTimeout
```
int getOperationTimeout()
```
    Get timeout (millisecond) of each operation for in Table instance.
  - getRpcTimeout
```
@Deprecated
int getRpcTimeout()
```
    Deprecated. Use getReadRpcTimeout or getWriteRpcTimeout instead
    
    Get timeout (millisecond) of each rpc request in this Table instance.
  - setRpcTimeout
```
@Deprecated
void setRpcTimeout(int rpcTimeout)
```
    Deprecated. Use setReadRpcTimeout or setWriteRpcTimeout instead
    
    Set timeout (millisecond) of each rpc request in operations of this Table instance, will override the value of hbase.rpc.timeout in configuration. If a rpc request waiting too long, it will stop waiting and send a new request to retry until retries exhausted or operation timeout reached.
    NOTE: This will set both the read and write timeout settings to the provided value.
    
    Parameters:
    rpcTimeout - the timeout of each rpc request in millisecond.
  - getReadRpcTimeout
```
int getReadRpcTimeout()
```
    Get timeout (millisecond) of each rpc read request in this Table instance.
  - setReadRpcTimeout
```
void setReadRpcTimeout(int readRpcTimeout)
```
    Set timeout (millisecond) of each rpc read request in operations of this Table instance, will override the value of hbase.rpc.read.timeout in configuration. If a rpc read request waiting too long, it will stop waiting and send a new request to retry until retries exhausted or operation timeout reached.
    
    Parameters:
    readRpcTimeout -
  - getWriteRpcTimeout
```
int getWriteRpcTimeout()
```
    Get timeout (millisecond) of each rpc write request in this Table instance.
  - setWriteRpcTimeout
```
void setWriteRpcTimeout(int writeRpcTimeout)
```
    Set timeout (millisecond) of each rpc write request in operations of this Table instance, will override the value of hbase.rpc.write.timeout in configuration. If a rpc write request waiting too long, it will stop waiting and send a new request to retry until retries exhausted or operation timeout reached.
    
    Parameters:
    writeRpcTimeout -

Interface Table

Method Summary

Method Detail

getName

getConfiguration

getTableDescriptor

exists

existsAll

batch

batch

batchCallback

batchCallback

get

get

getScanner

getScanner

getScanner

put

put

checkAndPut

checkAndPut

delete

delete

checkAndDelete

checkAndDelete

mutateRow

append

increment

incrementColumnValue

incrementColumnValue

close

coprocessorService

coprocessorService

coprocessorService

getWriteBufferSize

setWriteBufferSize

batchCoprocessorService

batchCoprocessorService

checkAndMutate

setOperationTimeout

getOperationTimeout

getRpcTimeout

setRpcTimeout

getReadRpcTimeout

setReadRpcTimeout

getWriteRpcTimeout

setWriteRpcTimeout