HTable (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.client.HTable

All Implemented Interfaces:

Closeable, AutoCloseable, HTableInterface, RegionLocator, Table
```
@InterfaceAudience.Private
@InterfaceStability.Stable
public class HTable
extends Object
implements HTableInterface, RegionLocator
```
An implementation of Table. Used to communicate with a single HBase table. Lightweight. Get as needed and just close when done. Instances of this class SHOULD NOT be constructed directly. Obtain an instance via Connection. See ConnectionFactory class comment for an example of how.
This class is NOT thread safe for reads nor writes. In the case of writes (Put, Delete), the underlying write buffer can be corrupted if multiple threads contend over a single HTable instance. In the case of reads, some fields used by a Scan are shared among all threads.
HTable is no longer a client API. Use Table instead. It is marked InterfaceAudience.Private as of hbase-1.0.0 indicating that this is an HBase-internal class as defined in Hadoop Interface Classification. There are no guarantees for backwards source / binary compatibility and methods or the class can change or go away without deprecation.
Near all methods of this * class made it out to the new Table Interface or were * instantiations of methods defined in HTableInterface. A few did not. Namely, the getStartEndKeys(), getEndKeys(), and getStartKeys() methods. These three methods are available in RegionLocator as of 1.0.0 but were NOT marked as deprecated when we released 1.0.0. In spite of this oversight on our part, these methods will be removed in 2.0.0.

See Also:
Table, Admin, Connection, ConnectionFactory

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`autoFlush`
`private boolean`	`cleanupConnectionOnClose`
`private boolean`	`cleanupPoolOnClose`
`private boolean`	`closed`
`private org.apache.hadoop.conf.Configuration`	`configuration`
`private ConnectionConfiguration`	`connConfiguration`
`protected ClusterConnection`	`connection`
`private Consistency`	`defaultConsistency`
`private HRegionLocator`	`locator`
`private static org.apache.commons.logging.Log`	`LOG`
`protected AsyncProcess`	`multiAp` The Async process for batch
`protected BufferedMutatorImpl`	`mutator`
`private int`	`operationTimeout`
`private ExecutorService`	`pool`
`private RpcRetryingCallerFactory`	`rpcCallerFactory`
`private RpcControllerFactory`	`rpcControllerFactory`
`private int`	`rpcTimeout`
`protected int`	`scannerCaching`
`protected long`	`scannerMaxResultSize`
`private TableName`	`tableName`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`HTable(byte[] tableName, Connection connection, ExecutorService pool)` Deprecated. Do not use, internal ctor.
`protected`	`HTable(ClusterConnection conn, BufferedMutatorParams params)` For internal testing.
	`HTable(org.apache.hadoop.conf.Configuration conf, byte[] tableName)` Deprecated. Constructing HTable objects manually has been deprecated. Please use `Connection` to instantiate a `Table` instead.
	`HTable(org.apache.hadoop.conf.Configuration conf, byte[] tableName, ExecutorService pool)` Deprecated. Constructing HTable objects manually has been deprecated. Please use `Connection` to instantiate a `Table` instead.
	`HTable(org.apache.hadoop.conf.Configuration conf, String tableName)` Deprecated. Constructing HTable objects manually has been deprecated. Please use `Connection` to instantiate a `Table` instead.
	`HTable(org.apache.hadoop.conf.Configuration conf, TableName tableName)` Deprecated. Constructing HTable objects manually has been deprecated. Please use `Connection` to instantiate a `Table` instead.
	`HTable(org.apache.hadoop.conf.Configuration conf, TableName tableName, ExecutorService pool)` Deprecated. Constructing HTable objects manually has been deprecated. Please use `Connection` to instantiate a `Table` instead.
	`HTable(TableName tableName, ClusterConnection connection, ConnectionConfiguration tableConfig, RpcRetryingCallerFactory rpcCallerFactory, RpcControllerFactory rpcControllerFactory, ExecutorService pool)` Creates an object to access a HBase table.
	`HTable(TableName tableName, Connection connection)` Deprecated. Do not use.
	`HTable(TableName tableName, Connection connection, ExecutorService pool)` Deprecated. Do not use, internal ctor.

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 and Appends.
`<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 `Table.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 rm)` 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`	`clearRegionCache()` Explicitly clears the region cache to fetch the latest value from META.
`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[]`	`exists(List<Get> gets)` Deprecated.
`boolean[]`	`existsAll(List<Get> gets)` Test for the existence of columns in the table, as specified by the Gets.
`private void`	`finishSetup()` setup this HTable's parameter based on the passed configuration
`void`	`flushCommits()` Executes all the buffered `Put` operations.
`Result`	`get(Get get)` Extracts certain cells from a given row.
`private Result`	`get(Get get, boolean checkExistenceOnly)`
`Result[]`	`get(List<Get> gets)` Extracts certain cells from the given rows, in batch.
`List<HRegionLocation>`	`getAllRegionLocations()` Deprecated. Use `RegionLocator.getAllRegionLocations()` instead;
`(package private) BufferedMutator`	`getBufferedMutator()`
`org.apache.hadoop.conf.Configuration`	`getConfiguration()` Returns the `Configuration` object used by this instance.
`HConnection`	`getConnection()` Deprecated. This method will be changed from public to package protected.
`static ThreadPoolExecutor`	`getDefaultExecutor(org.apache.hadoop.conf.Configuration conf)`
`byte[][]`	`getEndKeys()` Deprecated. Since 1.1.0. Use `RegionLocator.getEndKeys()` instead;
`private Pair<List<byte[]>,List<HRegionLocation>>`	`getKeysAndRegionsInRange(byte[] startKey, byte[] endKey, boolean includeEndKey)` Deprecated. This is no longer a public API
`private Pair<List<byte[]>,List<HRegionLocation>>`	`getKeysAndRegionsInRange(byte[] startKey, byte[] endKey, boolean includeEndKey, boolean reload)` Deprecated. This is no longer a public API
`static int`	`getMaxKeyValueSize(org.apache.hadoop.conf.Configuration conf)`
`TableName`	`getName()` Gets the fully qualified table name instance of this table.
`int`	`getOperationTimeout()`
`(package private) ExecutorService`	`getPool()` The pool is used for mutli requests for this HTable
`static boolean`	`getRegionCachePrefetch(byte[] tableName)` Deprecated. always return false since 0.99
`static boolean`	`getRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf, byte[] tableName)` Deprecated. always return false since 0.99
`static boolean`	`getRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf, TableName tableName)` Deprecated. always return false since 0.99
`static boolean`	`getRegionCachePrefetch(TableName tableName)` Deprecated. always return false since 0.99
`HRegionLocation`	`getRegionLocation(byte[] row)` Deprecated. Use `RegionLocator.getRegionLocation(byte[])` instead.
`HRegionLocation`	`getRegionLocation(byte[] row, boolean reload)` Deprecated. Use `RegionLocator.getRegionLocation(byte[], boolean)` instead.
`HRegionLocation`	`getRegionLocation(String row)` Deprecated. Use `RegionLocator.getRegionLocation(byte[])`
`NavigableMap<HRegionInfo,ServerName>`	`getRegionLocations()` Deprecated. This is no longer a public API. Use `getAllRegionLocations()` instead.
`RegionLocator`	`getRegionLocator()`
`List<HRegionLocation>`	`getRegionsInRange(byte[] startKey, byte[] endKey)` Deprecated. This is no longer a public API
`List<HRegionLocation>`	`getRegionsInRange(byte[] startKey, byte[] endKey, boolean reload)` Deprecated. This is no longer a public API
`Result`	`getRowOrBefore(byte[] row, byte[] family)` Deprecated. Use reversed scan instead.
`int`	`getRpcTimeout()`
`ResultScanner`	`getScanner(byte[] family)` The underlying `HTable` must not be closed.
`ResultScanner`	`getScanner(byte[] family, byte[] qualifier)` The underlying `HTable` must not be closed.
`ResultScanner`	`getScanner(Scan scan)` The underlying `HTable` must not be closed.
`int`	`getScannerCaching()` Deprecated. Use `Scan.setCaching(int)` and `Scan.getCaching()`
`Pair<byte[][],byte[][]>`	`getStartEndKeys()` Deprecated. Since 1.1.0. Use `RegionLocator.getStartEndKeys()` instead;
`byte[][]`	`getStartKeys()` Deprecated. Since 1.1.0. Use `RegionLocator.getStartEndKeys()` instead
`private List<byte[]>`	`getStartKeysInRange(byte[] start, byte[] end)`
`HTableDescriptor`	`getTableDescriptor()` Gets the `table descriptor` for this table.
`byte[]`	`getTableName()` Gets the name of this table.
`List<Row>`	`getWriteBuffer()` Deprecated. since 0.96. This is an internal buffer that should not be read nor write.
`long`	`getWriteBufferSize()` Returns the maximum size in bytes of the write buffer for this HTable.
`Result`	`increment(Increment increment)` Increments one or more columns within a single row.
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)` See `Table.incrementColumnValue(byte[], byte[], byte[], long, Durability)`
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, boolean writeToWAL)` Deprecated. As of release 0.96 (HBASE-9508). This will be removed in HBase 2.0.0. Use `incrementColumnValue(byte[], byte[], byte[], long, Durability)`.
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, Durability durability)` Atomically increments a column value.
`boolean`	`isAutoFlush()` Tells whether or not 'auto-flush' is turned on.
`static boolean`	`isTableEnabled(byte[] tableName)` Deprecated. use `HBaseAdmin.isTableEnabled(byte[])`
`static boolean`	`isTableEnabled(org.apache.hadoop.conf.Configuration conf, byte[] tableName)` Deprecated. use `HBaseAdmin.isTableEnabled(byte[])`
`static boolean`	`isTableEnabled(org.apache.hadoop.conf.Configuration conf, String tableName)` Deprecated. use `HBaseAdmin.isTableEnabled(byte[])`
`static boolean`	`isTableEnabled(org.apache.hadoop.conf.Configuration conf, TableName tableName)` Deprecated. use `HBaseAdmin.isTableEnabled(org.apache.hadoop.hbase.TableName tableName)`
`static boolean`	`isTableEnabled(String tableName)` Deprecated. use `HBaseAdmin.isTableEnabled(byte[])`
`static boolean`	`isTableEnabled(TableName tableName)` Deprecated. use `HBaseAdmin.isTableEnabled(byte[])`
`void`	`mutateRow(RowMutations rm)` Performs multiple mutations atomically on a single row.
`void`	`processBatch(List<? extends Row> list, Object[] results)` Parameterized batch processing, allowing varying return types for different `Row` implementations.
`<R> void`	`processBatchCallback(List<? extends Row> list, Object[] results, Batch.Callback<R> callback)` Process a mixed batch of Get, Put and Delete actions.
`void`	`put(List<Put> puts)` Puts some data in the table, in batch.
`void`	`put(Put put)` Puts some data in the table.
`void`	`setAutoFlush(boolean autoFlush)` Deprecated.
`void`	`setAutoFlush(boolean autoFlush, boolean clearBufferOnFail)` Turns 'auto-flush' on or off.
`void`	`setAutoFlushTo(boolean autoFlush)` Set the autoFlush behavior, without changing the value of `clearBufferOnFail`.
`void`	`setOperationTimeout(int operationTimeout)`
`static void`	`setRegionCachePrefetch(byte[] tableName, boolean enable)` Deprecated. does nothing since 0.99
`static void`	`setRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf, byte[] tableName, boolean enable)` Deprecated. does nothing since 0.99
`static void`	`setRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf, TableName tableName, boolean enable)` Deprecated. does nothing since 0.99
`static void`	`setRegionCachePrefetch(TableName tableName, boolean enable)` Deprecated. does nothing since 0.99
`void`	`setRpcTimeout(int rpcTimeout)`
`void`	`setScannerCaching(int scannerCaching)` Deprecated. Use `Scan.setCaching(int)`
`void`	`setWriteBufferSize(long writeBufferSize)` Sets the size of the buffer in bytes.
`String`	`toString()`
`void`	`validatePut(Put put)`
`static void`	`validatePut(Put put, int maxKeyValueSize)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - connection
```
protected ClusterConnection connection
```
  - tableName
```
private final TableName tableName
```
  - configuration
```
private volatile org.apache.hadoop.conf.Configuration configuration
```
  - connConfiguration
```
private ConnectionConfiguration connConfiguration
```
  - mutator
```
protected BufferedMutatorImpl mutator
```
  - autoFlush
```
private boolean autoFlush
```
  - closed
```
private boolean closed
```
  - scannerCaching
```
protected int scannerCaching
```
  - scannerMaxResultSize
```
protected long scannerMaxResultSize
```
  - pool
```
private ExecutorService pool
```
  - operationTimeout
```
private int operationTimeout
```
  - rpcTimeout
```
private int rpcTimeout
```
  - cleanupPoolOnClose
```
private final boolean cleanupPoolOnClose
```
  - cleanupConnectionOnClose
```
private final boolean cleanupConnectionOnClose
```
  - defaultConsistency
```
private Consistency defaultConsistency
```
  - locator
```
private HRegionLocator locator
```
  - multiAp
```
protected AsyncProcess multiAp
```
    The Async process for batch
  - rpcCallerFactory
```
private RpcRetryingCallerFactory rpcCallerFactory
```
  - rpcControllerFactory
```
private RpcControllerFactory rpcControllerFactory
```
- Constructor Detail
  - HTable
```
@Deprecated
public HTable(org.apache.hadoop.conf.Configuration conf,
                 String tableName)
       throws IOException
```
    Deprecated. Constructing HTable objects manually has been deprecated. Please use Connection to instantiate a Table instead.
    
    Creates an object to access a HBase table.
    
    Parameters:
    conf - Configuration object to use.
    tableName - Name of the table.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - HTable
```
@Deprecated
public HTable(org.apache.hadoop.conf.Configuration conf,
                 byte[] tableName)
       throws IOException
```
    Deprecated. Constructing HTable objects manually has been deprecated. Please use Connection to instantiate a Table instead.
    
    Creates an object to access a HBase table.
    
    Parameters:
    conf - Configuration object to use.
    tableName - Name of the table.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - HTable
```
@Deprecated
public HTable(org.apache.hadoop.conf.Configuration conf,
                 TableName tableName)
       throws IOException
```
    Deprecated. Constructing HTable objects manually has been deprecated. Please use Connection to instantiate a Table instead.
    
    Creates an object to access a HBase table.
    
    Parameters:
    conf - Configuration object to use.
    tableName - table name pojo
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - HTable
```
@Deprecated
public HTable(TableName tableName,
                 Connection connection)
       throws IOException
```
    Deprecated. Do not use.
    
    Creates an object to access a HBase table.
    
    Parameters:
    tableName - Name of the table.
    connection - HConnection to be used.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - HTable
```
@Deprecated
public HTable(org.apache.hadoop.conf.Configuration conf,
                 byte[] tableName,
                 ExecutorService pool)
       throws IOException
```
    Deprecated. Constructing HTable objects manually has been deprecated. Please use Connection to instantiate a Table instead.
    
    Creates an object to access a HBase table.
    
    Parameters:
    conf - Configuration object to use.
    tableName - Name of the table.
    pool - ExecutorService to be used.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - HTable
```
@Deprecated
public HTable(org.apache.hadoop.conf.Configuration conf,
                 TableName tableName,
                 ExecutorService pool)
       throws IOException
```
    Deprecated. Constructing HTable objects manually has been deprecated. Please use Connection to instantiate a Table instead.
    
    Creates an object to access a HBase table.
    
    Parameters:
    conf - Configuration object to use.
    tableName - Name of the table.
    pool - ExecutorService to be used.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - HTable
```
@Deprecated
public HTable(byte[] tableName,
                 Connection connection,
                 ExecutorService pool)
       throws IOException
```
    Deprecated. Do not use, internal ctor.
    
    Creates an object to access a HBase table.
    
    Parameters:
    tableName - Name of the table.
    connection - HConnection to be used.
    pool - ExecutorService to be used.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - HTable
```
@Deprecated
public HTable(TableName tableName,
                 Connection connection,
                 ExecutorService pool)
       throws IOException
```
    Deprecated. Do not use, internal ctor.
    
    Throws:
    
    IOException
  - HTable
```
@InterfaceAudience.Private
public HTable(TableName tableName,
                                ClusterConnection connection,
                                ConnectionConfiguration tableConfig,
                                RpcRetryingCallerFactory rpcCallerFactory,
                                RpcControllerFactory rpcControllerFactory,
                                ExecutorService pool)
       throws IOException
```
    Creates an object to access a HBase table. Used by HBase internally. DO NOT USE. See ConnectionFactory class comment for how to get a Table instance (use Table instead of HTable).
    
    Parameters:
    tableName - Name of the table.
    connection - HConnection to be used.
    pool - ExecutorService to be used.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - HTable
```
protected HTable(ClusterConnection conn,
      BufferedMutatorParams params)
          throws IOException
```
    For internal testing. Uses Connection provided in params.
    
    Throws:
    
    IOException
- Method Detail
  - getDefaultExecutor
```
@InterfaceAudience.Private
public static ThreadPoolExecutor getDefaultExecutor(org.apache.hadoop.conf.Configuration conf)
```
  - getMaxKeyValueSize
```
public static int getMaxKeyValueSize(org.apache.hadoop.conf.Configuration conf)
```
    Returns:
    maxKeyValueSize from configuration.
  - finishSetup
```
private void finishSetup()
                  throws IOException
```
    setup this HTable's parameter based on the passed configuration
    
    Throws:
    
    IOException
  - getConfiguration
```
public 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.
    
    Specified by:
    
    getConfiguration in interface Table
  - isTableEnabled
```
@Deprecated
public static boolean isTableEnabled(String tableName)
                              throws IOException
```
    Deprecated. use HBaseAdmin.isTableEnabled(byte[])
    
    Tells whether or not a table is enabled or not. This method creates a new HBase configuration, so it might make your unit tests fail due to incorrect ZK client port.
    
    Parameters:
    tableName - Name of table to check.
    
    Returns:
    true if table is online.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableEnabled
```
@Deprecated
public static boolean isTableEnabled(byte[] tableName)
                              throws IOException
```
    Deprecated. use HBaseAdmin.isTableEnabled(byte[])
    
    Tells whether or not a table is enabled or not. This method creates a new HBase configuration, so it might make your unit tests fail due to incorrect ZK client port.
    
    Parameters:
    tableName - Name of table to check.
    
    Returns:
    true if table is online.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableEnabled
```
@Deprecated
public static boolean isTableEnabled(TableName tableName)
                              throws IOException
```
    Deprecated. use HBaseAdmin.isTableEnabled(byte[])
    
    Tells whether or not a table is enabled or not. This method creates a new HBase configuration, so it might make your unit tests fail due to incorrect ZK client port.
    
    Parameters:
    tableName - Name of table to check.
    
    Returns:
    true if table is online.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableEnabled
```
@Deprecated
public static boolean isTableEnabled(org.apache.hadoop.conf.Configuration conf,
                                String tableName)
                              throws IOException
```
    Deprecated. use HBaseAdmin.isTableEnabled(byte[])
    
    Tells whether or not a table is enabled or not.
    
    Parameters:
    conf - The Configuration object to use.
    tableName - Name of table to check.
    
    Returns:
    true if table is online.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableEnabled
```
@Deprecated
public static boolean isTableEnabled(org.apache.hadoop.conf.Configuration conf,
                                byte[] tableName)
                              throws IOException
```
    Deprecated. use HBaseAdmin.isTableEnabled(byte[])
    
    Tells whether or not a table is enabled or not.
    
    Parameters:
    conf - The Configuration object to use.
    tableName - Name of table to check.
    
    Returns:
    true if table is online.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableEnabled
```
@Deprecated
public static boolean isTableEnabled(org.apache.hadoop.conf.Configuration conf,
                                TableName tableName)
                              throws IOException
```
    Deprecated. use HBaseAdmin.isTableEnabled(org.apache.hadoop.hbase.TableName tableName)
    
    Tells whether or not a table is enabled or not.
    
    Parameters:
    conf - The Configuration object to use.
    tableName - Name of table to check.
    
    Returns:
    true if table is online.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionLocation
```
@Deprecated
public HRegionLocation getRegionLocation(String row)
                                  throws IOException
```
    Deprecated. Use RegionLocator.getRegionLocation(byte[])
    
    Find region location hosting passed row using cached info
    
    Parameters:
    row - Row to find.
    
    Returns:
    The location of the given row.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionLocation
```
@Deprecated
public HRegionLocation getRegionLocation(byte[] row)
                                  throws IOException
```
    Deprecated. Use RegionLocator.getRegionLocation(byte[]) instead.
    
    Description copied from interface: RegionLocator
    
    Finds the region on which the given row is being served. Does not reload the cache.
    
    Specified by:
    
    getRegionLocation in interface RegionLocator
    
    Parameters:
    row - Row to find.
    
    Returns:
    Location of the row.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionLocation
```
@Deprecated
public HRegionLocation getRegionLocation(byte[] row,
                                           boolean reload)
                                  throws IOException
```
    Deprecated. Use RegionLocator.getRegionLocation(byte[], boolean) instead.
    
    Description copied from interface: RegionLocator
    
    Finds the region on which the given row is being served.
    
    Specified by:
    
    getRegionLocation in interface RegionLocator
    
    Parameters:
    row - Row to find.
    reload - true to reload information or false to use cached information
    
    Returns:
    Location of the row.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getTableName
```
public byte[] getTableName()
```
    Gets the name of this table.
    
    Specified by:
    
    getTableName in interface HTableInterface
    
    Returns:
    the table name.
  - getName
```
public TableName getName()
```
    Description copied from interface: Table
    
    Gets the fully qualified table name instance of this table.
    
    Specified by:
    
    getName in interface RegionLocator
    
    Specified by:
    
    getName in interface Table
  - getConnection
```
@Deprecated
public HConnection getConnection()
```
    Deprecated. This method will be changed from public to package protected.
    
    INTERNAL Used by unit tests and tools to do low-level manipulations.
    
    Returns:
    An HConnection instance.
  - getScannerCaching
```
@Deprecated
public int getScannerCaching()
```
    Deprecated. Use Scan.setCaching(int) and Scan.getCaching()
    
    Gets the number of rows that a scanner will fetch at once.
    The default value comes from hbase.client.scanner.caching.
  - getWriteBuffer
```
@Deprecated
public List<Row> getWriteBuffer()
```
    Deprecated. since 0.96. This is an internal buffer that should not be read nor write.
    
    Kept in 0.96 for backward compatibility
  - setScannerCaching
```
@Deprecated
public void setScannerCaching(int scannerCaching)
```
    Deprecated. Use Scan.setCaching(int)
    
    Sets the number of rows that a scanner will fetch at once.
    This will override the value specified by hbase.client.scanner.caching. Increasing this value will reduce the amount of work needed each time next() is called on a scanner, at the expense of memory use (since more rows will need to be maintained in memory by the scanners).
    
    Parameters:
    scannerCaching - the number of rows a scanner will fetch at once.
  - getTableDescriptor
```
public HTableDescriptor getTableDescriptor()
                                    throws IOException
```
    Gets the table descriptor for this table.
    
    Specified by:
    
    getTableDescriptor in interface Table
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - getStartKeys
```
@Deprecated
public byte[][] getStartKeys()
                      throws IOException
```
    Deprecated. Since 1.1.0. Use RegionLocator.getStartEndKeys() instead
    
    To be removed in 2.0.0.
    
    Specified by:
    
    getStartKeys in interface RegionLocator
    
    Returns:
    Array of region starting row keys
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getEndKeys
```
@Deprecated
public byte[][] getEndKeys()
                    throws IOException
```
    Deprecated. Since 1.1.0. Use RegionLocator.getEndKeys() instead;
    
    To be removed in 2.0.0.
    
    Specified by:
    
    getEndKeys in interface RegionLocator
    
    Returns:
    Array of region ending row keys
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getStartEndKeys
```
@Deprecated
public Pair<byte[][],byte[][]> getStartEndKeys()
                                        throws IOException
```
    Deprecated. Since 1.1.0. Use RegionLocator.getStartEndKeys() instead;
    
    To be removed in 2.0.0.
    
    Specified by:
    
    getStartEndKeys in interface RegionLocator
    
    Returns:
    Pair of arrays of region starting and ending row keys
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionLocations
```
@Deprecated
public NavigableMap<HRegionInfo,ServerName> getRegionLocations()
                                                        throws IOException
```
    Deprecated. This is no longer a public API. Use getAllRegionLocations() instead.
    
    Gets all the regions and their address for this table.
    This is mainly useful for the MapReduce integration.
    
    Returns:
    A map of HRegionInfo with it's server address
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getAllRegionLocations
```
@Deprecated
public List<HRegionLocation> getAllRegionLocations()
                                            throws IOException
```
    Deprecated. Use RegionLocator.getAllRegionLocations() instead;
    
    Gets all the regions and their address for this table.
    This is mainly useful for the MapReduce integration.
    
    Specified by:
    
    getAllRegionLocations in interface RegionLocator
    
    Returns:
    A map of HRegionInfo with it's server address
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionsInRange
```
@Deprecated
public List<HRegionLocation> getRegionsInRange(byte[] startKey,
                                                 byte[] endKey)
                                        throws IOException
```
    Deprecated. This is no longer a public API
    
    Get the corresponding regions for an arbitrary range of keys.
    
    Parameters:
    startKey - Starting row in range, inclusive
    endKey - Ending row in range, exclusive
    
    Returns:
    A list of HRegionLocations corresponding to the regions that contain the specified range
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionsInRange
```
@Deprecated
public List<HRegionLocation> getRegionsInRange(byte[] startKey,
                                                 byte[] endKey,
                                                 boolean reload)
                                        throws IOException
```
    Deprecated. This is no longer a public API
    
    Get the corresponding regions for an arbitrary range of keys.
    
    Parameters:
    startKey - Starting row in range, inclusive
    endKey - Ending row in range, exclusive
    reload - true to reload information or false to use cached information
    
    Returns:
    A list of HRegionLocations corresponding to the regions that contain the specified range
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getKeysAndRegionsInRange
```
@Deprecated
private Pair<List<byte[]>,List<HRegionLocation>> getKeysAndRegionsInRange(byte[] startKey,
                                                                           byte[] endKey,
                                                                           boolean includeEndKey)
                                                                   throws IOException
```
    Deprecated. This is no longer a public API
    
    Get the corresponding start keys and regions for an arbitrary range of keys.
    
    Parameters:
    startKey - Starting row in range, inclusive
    endKey - Ending row in range
    includeEndKey - true if endRow is inclusive, false if exclusive
    
    Returns:
    A pair of list of start keys and list of HRegionLocations that contain the specified range
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getKeysAndRegionsInRange
```
@Deprecated
private Pair<List<byte[]>,List<HRegionLocation>> getKeysAndRegionsInRange(byte[] startKey,
                                                                           byte[] endKey,
                                                                           boolean includeEndKey,
                                                                           boolean reload)
                                                                   throws IOException
```
    Deprecated. This is no longer a public API
    
    Get the corresponding start keys and regions for an arbitrary range of keys.
    
    Parameters:
    startKey - Starting row in range, inclusive
    endKey - Ending row in range
    includeEndKey - true if endRow is inclusive, false if exclusive
    reload - true to reload information or false to use cached information
    
    Returns:
    A pair of list of start keys and list of HRegionLocations that contain the specified range
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRowOrBefore
```
@Deprecated
public Result getRowOrBefore(byte[] row,
                               byte[] family)
                      throws IOException
```
    Deprecated. Use reversed scan instead.
    
    Return the row that matches row exactly, or the one that immediately precedes it.
    
    Specified by:
    
    getRowOrBefore in interface HTableInterface
    
    Parameters:
    row - A row key.
    family - Column family to include in the Result.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - getScanner
```
public ResultScanner getScanner(Scan scan)
                         throws IOException
```
    The underlying HTable must not be closed. Table.getScanner(Scan) has other usage details.
    
    Specified by:
    
    getScanner in interface Table
    
    Parameters:
    scan - A configured Scan object.
    
    Returns:
    A scanner.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - getScanner
```
public ResultScanner getScanner(byte[] family)
                         throws IOException
```
    The underlying HTable must not be closed. Table.getScanner(byte[]) has other usage details.
    
    Specified by:
    
    getScanner in interface Table
    
    Parameters:
    family - The column family to scan.
    
    Returns:
    A scanner.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - getScanner
```
public ResultScanner getScanner(byte[] family,
                       byte[] qualifier)
                         throws IOException
```
    The underlying HTable must not be closed. Table.getScanner(byte[], byte[]) has other usage details.
    
    Specified by:
    
    getScanner in interface Table
    
    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.
  - get
```
public Result get(Get get)
           throws IOException
```
    Extracts certain cells from a given row.
    
    Specified by:
    
    get in interface Table
    
    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.
  - get
```
private Result get(Get get,
         boolean checkExistenceOnly)
            throws IOException
```
    Throws:
    
    IOException
  - get
```
public Result[] get(List<Get> gets)
             throws IOException
```
    Extracts certain cells from the given rows, in batch.
    
    Specified by:
    
    get in interface Table
    
    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.
  - batch
```
public void batch(List<? extends Row> actions,
         Object[] results)
           throws InterruptedException,
                  IOException
```
    Method that does a batch call on Deletes, Gets, Puts, Increments and Appends. The ordering of execution of the actions is not defined. Meaning if you do a Put and a Get in the same Table.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.
    
    Specified by:
    
    batch in interface Table
    
    Parameters:
    actions - list of Get, Put, Delete, Increment, Append objects
    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
  - batch
```
@Deprecated
public Object[] batch(List<? extends Row> actions)
               throws InterruptedException,
                      IOException
```
    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 Table.batch(List, Object[]), but returns an array of results instead of using a results parameter reference.
    
    Specified by:
    
    batch in interface Table
    
    Parameters:
    actions - list of Get, Put, Delete, Increment, Append objects
    
    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
  - batchCallback
```
public <R> void batchCallback(List<? extends Row> actions,
                     Object[] results,
                     Batch.Callback<R> callback)
                   throws IOException,
                          InterruptedException
```
    Same as Table.batch(List, Object[]), but with a callback.
    
    Specified by:
    
    batchCallback in interface Table
    
    Throws:
    
    IOException
    
    InterruptedException
  - batchCallback
```
@Deprecated
public <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 Table.batch(List), but with a callback.
    
    Specified by:
    
    batchCallback in interface Table
    
    Throws:
    
    IOException
    
    InterruptedException
  - delete
```
public void delete(Delete delete)
            throws IOException
```
    Deletes the specified cells/row.
    
    Specified by:
    
    delete in interface Table
    
    Parameters:
    delete - The object that specifies what to delete.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - delete
```
public void delete(List<Delete> deletes)
            throws IOException
```
    Deletes the specified cells/rows in bulk.
    
    Specified by:
    
    delete in interface Table
    
    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.
  - put
```
public void put(Put put)
         throws IOException
```
    Puts some data in the table.
    
    Specified by:
    
    put in interface Table
    
    Parameters:
    put - The data to put.
    
    Throws:
    
    IOException
  - put
```
public 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.
    
    Specified by:
    
    put in interface Table
    
    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
  - mutateRow
```
public void mutateRow(RowMutations rm)
               throws IOException
```
    Performs multiple mutations atomically on a single row. Currently Put and Delete are supported.
    
    Specified by:
    
    mutateRow in interface Table
    
    Parameters:
    rm - object that specifies the set of mutations to perform atomically
    
    Throws:
    
    IOException
  - append
```
public 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.
    
    Specified by:
    
    append in interface Table
    
    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
```
public 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.
    
    Specified by:
    
    increment in interface Table
    
    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
```
public long incrementColumnValue(byte[] row,
                        byte[] family,
                        byte[] qualifier,
                        long amount)
                          throws IOException
```
    See Table.incrementColumnValue(byte[], byte[], byte[], long, Durability)
    The Durability is defaulted to Durability.SYNC_WAL.
    
    Specified by:
    
    incrementColumnValue in interface Table
    
    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
```
@Deprecated
public long incrementColumnValue(byte[] row,
                                   byte[] family,
                                   byte[] qualifier,
                                   long amount,
                                   boolean writeToWAL)
                          throws IOException
```
    Deprecated. As of release 0.96 (HBASE-9508). This will be removed in HBase 2.0.0. Use incrementColumnValue(byte[], byte[], byte[], long, Durability).
    
    Specified by:
    
    incrementColumnValue in interface HTableInterface
    
    Throws:
    
    IOException
  - incrementColumnValue
```
public 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.
    
    Specified by:
    
    incrementColumnValue in interface Table
    
    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.
  - checkAndPut
```
public 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)
    
    Specified by:
    
    checkAndPut in interface Table
    
    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
```
public 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)
    
    Specified by:
    
    checkAndPut in interface Table
    
    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
  - checkAndDelete
```
public 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)
    
    Specified by:
    
    checkAndDelete in interface Table
    
    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
```
public 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)
    
    Specified by:
    
    checkAndDelete in interface Table
    
    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
  - checkAndMutate
```
public boolean checkAndMutate(byte[] row,
                     byte[] family,
                     byte[] qualifier,
                     CompareFilter.CompareOp compareOp,
                     byte[] value,
                     RowMutations rm)
                       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)
    
    Specified by:
    
    checkAndMutate in interface Table
    
    Parameters:
    row - to check
    family - column family to check
    qualifier - column qualifier to check
    compareOp - the comparison operator
    value - the expected value
    rm - mutations to perform if check succeeds
    
    Returns:
    true if the new put was executed, false otherwise
    
    Throws:
    
    IOException - e
  - exists
```
public 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.
    
    Specified by:
    
    exists in interface Table
    
    Parameters:
    get - the Get
    
    Returns:
    true if the specified Get matches one or more keys, false if not
    
    Throws:
    
    IOException - e
  - existsAll
```
public 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.
    
    Specified by:
    
    existsAll in interface Table
    
    Parameters:
    gets - the Gets
    
    Returns:
    Array of boolean. True if the specified Get matches one or more keys, false if not.
    
    Throws:
    
    IOException - e
  - exists
```
@Deprecated
public Boolean[] exists(List<Get> gets)
                 throws IOException
```
    Deprecated.
    
    Specified by:
    
    exists in interface HTableInterface
    
    Throws:
    
    IOException
  - flushCommits
```
public void flushCommits()
                  throws IOException
```
    Executes all the buffered Put operations.
    This method gets called once automatically for every Put or batch of Puts (when put(List<Put>) is used) when HTableInterface.isAutoFlush() is true.
    
    Specified by:
    
    flushCommits in interface HTableInterface
    
    Throws:
    
    IOException
  - processBatchCallback
```
public <R> void processBatchCallback(List<? extends Row> list,
                            Object[] results,
                            Batch.Callback<R> callback)
                          throws IOException,
                                 InterruptedException
```
    Process a mixed batch of Get, Put and Delete actions. All actions for a RegionServer are forwarded in one RPC call. Queries are executed in parallel.
    
    Parameters:
    list - The collection of actions.
    results - An empty array, same size as list. If an exception is thrown, you can test here for partial results, and to determine which actions processed successfully.
    
    Throws:
    
    IOException - if there are problems talking to META. Per-item exceptions are stored in the results array.
    
    InterruptedException
  - processBatch
```
public void processBatch(List<? extends Row> list,
                Object[] results)
                  throws IOException,
                         InterruptedException
```
    Parameterized batch processing, allowing varying return types for different Row implementations.
    
    Throws:
    
    IOException
    
    InterruptedException
  - close
```
public void close()
           throws IOException
```
    Description copied from interface: Table
    
    Releases any resources held or pending changes in internal buffers.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Table
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - validatePut
```
public void validatePut(Put put)
                 throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - validatePut
```
public static void validatePut(Put put,
               int maxKeyValueSize)
                        throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - isAutoFlush
```
public boolean isAutoFlush()
```
    Tells whether or not 'auto-flush' is turned on.
    
    Specified by:
    
    isAutoFlush in interface HTableInterface
    
    Returns:
    true if 'auto-flush' is enabled (default), meaning Put operations don't get buffered/delayed and are immediately executed.
  - setAutoFlush
```
@Deprecated
public void setAutoFlush(boolean autoFlush)
```
    Deprecated.
    
    See HTableInterface.setAutoFlush(boolean, boolean)
    
    Specified by:
    
    setAutoFlush in interface HTableInterface
    
    Parameters:
    autoFlush - Whether or not to enable 'auto-flush'.
  - setAutoFlushTo
```
public void setAutoFlushTo(boolean autoFlush)
```
    Set the autoFlush behavior, without changing the value of clearBufferOnFail.
    
    Specified by:
    
    setAutoFlushTo in interface HTableInterface
  - setAutoFlush
```
public void setAutoFlush(boolean autoFlush,
                boolean clearBufferOnFail)
```
    Turns 'auto-flush' on or off.
    When enabled (default), Put operations don't get buffered/delayed and are immediately executed. Failed operations are not retried. This is slower but safer.
    Turning off #autoFlush means that multiple Puts will be accepted before any RPC is actually sent to do the write operations. If the application dies before pending writes get flushed to HBase, data will be lost.
    When you turn #autoFlush off, you should also consider the #clearBufferOnFail option. By default, asynchronous Put requests will be retried on failure until successful. However, this can pollute the writeBuffer and slow down batching performance. Additionally, you may want to issue a number of Put requests and call HTableInterface.flushCommits() as a barrier. In both use cases, consider setting clearBufferOnFail to true to erase the buffer after HTableInterface.flushCommits() has been called, regardless of success.
    In other words, if you call #setAutoFlush(false); HBase will retry N time for each flushCommit, including the last one when closing the table. This is NOT recommended, most of the time you want to call #setAutoFlush(false, true).
    
    Specified by:
    
    setAutoFlush in interface HTableInterface
    
    Parameters:
    autoFlush - Whether or not to enable 'auto-flush'.
    clearBufferOnFail - Whether to keep Put failures in the writeBuffer. If autoFlush is true, then the value of this parameter is ignored and clearBufferOnFail is set to true. Setting clearBufferOnFail to false is deprecated since 0.96.
    See Also:
    BufferedMutator.flush()
  - getWriteBufferSize
```
public long 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.
    
    Specified by:
    
    getWriteBufferSize in interface HTableInterface
    
    Specified by:
    
    getWriteBufferSize in interface Table
    
    Returns:
    The size of the write buffer in bytes.
  - setWriteBufferSize
```
public void setWriteBufferSize(long writeBufferSize)
                        throws IOException
```
    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.
    
    Specified by:
    
    setWriteBufferSize in interface HTableInterface
    
    Specified by:
    
    setWriteBufferSize in interface Table
    
    Parameters:
    writeBufferSize - The new write buffer size, in bytes.
    
    Throws:
    
    IOException - if a remote or network exception occurs.
  - getPool
```
ExecutorService getPool()
```
    The pool is used for mutli requests for this HTable
    
    Returns:
    the pool used for mutli
  - setRegionCachePrefetch
```
@Deprecated
public static void setRegionCachePrefetch(byte[] tableName,
                                     boolean enable)
                                   throws IOException
```
    Deprecated. does nothing since 0.99
    
    Enable or disable region cache prefetch for the table. It will be applied for the given table's all HTable instances who share the same connection. By default, the cache prefetch is enabled.
    
    Parameters:
    tableName - name of table to configure.
    enable - Set to true to enable region cache prefetch. Or set to false to disable it.
    
    Throws:
    
    IOException
  - setRegionCachePrefetch
```
@Deprecated
public static void setRegionCachePrefetch(TableName tableName,
                                     boolean enable)
                                   throws IOException
```
    Deprecated. does nothing since 0.99
    
    Throws:
    
    IOException
  - setRegionCachePrefetch
```
@Deprecated
public static void setRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf,
                                     byte[] tableName,
                                     boolean enable)
                                   throws IOException
```
    Deprecated. does nothing since 0.99
    
    Enable or disable region cache prefetch for the table. It will be applied for the given table's all HTable instances who share the same connection. By default, the cache prefetch is enabled.
    
    Parameters:
    conf - The Configuration object to use.
    tableName - name of table to configure.
    enable - Set to true to enable region cache prefetch. Or set to false to disable it.
    
    Throws:
    
    IOException
  - setRegionCachePrefetch
```
@Deprecated
public static void setRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf,
                                     TableName tableName,
                                     boolean enable)
                                   throws IOException
```
    Deprecated. does nothing since 0.99
    
    Throws:
    
    IOException
  - getRegionCachePrefetch
```
@Deprecated
public static boolean getRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf,
                                        byte[] tableName)
                                      throws IOException
```
    Deprecated. always return false since 0.99
    
    Check whether region cache prefetch is enabled or not for the table.
    
    Parameters:
    conf - The Configuration object to use.
    tableName - name of table to check
    
    Returns:
    true if table's region cache prefecth is enabled. Otherwise it is disabled.
    
    Throws:
    
    IOException
  - getRegionCachePrefetch
```
@Deprecated
public static boolean getRegionCachePrefetch(org.apache.hadoop.conf.Configuration conf,
                                        TableName tableName)
                                      throws IOException
```
    Deprecated. always return false since 0.99
    
    Throws:
    
    IOException
  - getRegionCachePrefetch
```
@Deprecated
public static boolean getRegionCachePrefetch(byte[] tableName)
                                      throws IOException
```
    Deprecated. always return false since 0.99
    
    Check whether region cache prefetch is enabled or not for the table.
    
    Parameters:
    tableName - name of table to check
    
    Returns:
    true if table's region cache prefecth is enabled. Otherwise it is disabled.
    
    Throws:
    
    IOException
  - getRegionCachePrefetch
```
@Deprecated
public static boolean getRegionCachePrefetch(TableName tableName)
                                      throws IOException
```
    Deprecated. always return false since 0.99
    
    Throws:
    
    IOException
  - clearRegionCache
```
public void clearRegionCache()
```
    Explicitly clears the region cache to fetch the latest value from META. This is a power user function: avoid unless you know the ramifications.
  - coprocessorService
```
public 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);
    Specified by:
    
    coprocessorService in interface Table
    
    Parameters:
    row - The row key used to identify the remote region location
    
    Returns:
    A CoprocessorRpcChannel instance
  - coprocessorService
```
public <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.
    
    Specified by:
    
    coprocessorService in interface Table
    
    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
```
public <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.
    
    Specified by:
    
    coprocessorService in interface Table
    
    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.
    
    Throws:
    
    com.google.protobuf.ServiceException
    
    Throwable
  - getStartKeysInRange
```
private List<byte[]> getStartKeysInRange(byte[] start,
                               byte[] end)
                                  throws IOException
```
    Throws:
    
    IOException
  - setOperationTimeout
```
public void setOperationTimeout(int operationTimeout)
```
  - getOperationTimeout
```
public int getOperationTimeout()
```
  - setRpcTimeout
```
public void setRpcTimeout(int rpcTimeout)
```
  - getRpcTimeout
```
public int getRpcTimeout()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - batchCoprocessorService
```
public <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.
    
    Specified by:
    
    batchCoprocessorService in interface Table
    
    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
```
public <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.
    
    Specified by:
    
    batchCoprocessorService in interface Table
    
    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
  - getRegionLocator
```
public RegionLocator getRegionLocator()
```
  - getBufferedMutator
```
BufferedMutator getBufferedMutator()
                             throws IOException
```
    Throws:
    
    IOException

Class HTable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

connection

tableName

configuration

connConfiguration

mutator

autoFlush

closed

scannerCaching

scannerMaxResultSize

pool

operationTimeout

rpcTimeout

cleanupPoolOnClose

cleanupConnectionOnClose

defaultConsistency

locator

multiAp

rpcCallerFactory

rpcControllerFactory

Constructor Detail

HTable

HTable

HTable

HTable

HTable

HTable

HTable

HTable

HTable

HTable

Method Detail

getDefaultExecutor

getMaxKeyValueSize

finishSetup

getConfiguration

isTableEnabled

isTableEnabled

isTableEnabled

isTableEnabled

isTableEnabled

isTableEnabled

getRegionLocation

getRegionLocation

getRegionLocation

getTableName

getName

getConnection

getScannerCaching

getWriteBuffer

setScannerCaching

getTableDescriptor

getStartKeys

getEndKeys

getStartEndKeys

getRegionLocations

getAllRegionLocations

getRegionsInRange

getRegionsInRange

getKeysAndRegionsInRange

getKeysAndRegionsInRange

getRowOrBefore

getScanner

getScanner

getScanner

get

get

get

batch

batch

batchCallback

batchCallback

delete

delete