org.apache.hadoop.hbase.client

Class HTableWrapper

java.lang.Object

org.apache.hadoop.hbase.client.HTableWrapper

All Implemented Interfaces:

Closeable, AutoCloseable, Table

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Stable
public final class HTableWrapper
extends Object
implements Table

A wrapper for HTable. Can be used to restrict privilege. Currently it just helps to track tables opened by a Coprocessor and facilitate close of them if it is aborted. We also disallow row locking. There is nothing now that will stop a coprocessor from using HTable objects directly instead of this API, but in the future we intend to analyze coprocessor implementations as they are loaded and reject those which attempt to use objects and methods outside the Environment sandbox.

Method Summary

Modifier and Type	Method and Description
Result	append(Append append)
void	batch(List<? extends Row> actions, Object[] results)
<R> void	batchCallback(List<? extends Row> actions, Object[] results, Batch.Callback<R> 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)
<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)
boolean	checkAndDelete(byte[] row, byte[] family, byte[] qualifier, byte[] value, Delete delete)
boolean	checkAndDelete(byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value, Delete delete)
boolean	checkAndDelete(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, byte[] value, Delete delete)
boolean	checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value, RowMutations rm)
boolean	checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, byte[] value, RowMutations rm)
boolean	checkAndPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, Put put)
boolean	checkAndPut(byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value, Put put)
boolean	checkAndPut(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, byte[] value, Put put)
void	close()
CoprocessorRpcChannel	coprocessorService(byte[] row)
<T extends com.google.protobuf.Service,R> Map<byte[],R>	coprocessorService(Class<T> service, byte[] startKey, byte[] endKey, Batch.Call<T,R> callable)
<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)
static Table	createWrapper(List<Table> openTables, TableName tableName, CoprocessorHost.Environment env, ExecutorService pool)
void	delete(Delete delete)
void	delete(List<Delete> deletes)
boolean	exists(Get get)
Boolean[]	exists(List<Get> gets) Deprecated. Use existsAll(java.util.List) instead. since 2.0. remove in 3.0
boolean[]	existsAll(List<Get> gets)
Result	get(Get get)
Result[]	get(List<Get> gets)
org.apache.hadoop.conf.Configuration	getConfiguration()
TableDescriptor	getDescriptor()
TableName	getName()
int	getOperationTimeout()
int	getReadRpcTimeout()
int	getRpcTimeout() Deprecated.
ResultScanner	getScanner(byte[] family)
ResultScanner	getScanner(byte[] family, byte[] qualifier)
ResultScanner	getScanner(Scan scan)
HTableDescriptor	getTableDescriptor()
int	getWriteRpcTimeout()
Result	increment(Increment increment)
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, Durability durability)
void	internalClose()
void	mutateRow(RowMutations rm)
void	put(List<Put> puts)
void	put(Put put)
void	setOperationTimeout(int operationTimeout)
void	setReadRpcTimeout(int readRpcTimeout)
void	setRpcTimeout(int rpcTimeout) Deprecated.
void	setWriteRpcTimeout(int writeRpcTimeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createWrapper

public static Table createWrapper(List<Table> openTables,
                                  TableName tableName,
                                  CoprocessorHost.Environment env,
                                  ExecutorService pool)
                           throws IOException

Parameters:

openTables - External list of tables used for tracking wrappers.

Throws:

IOException

internalClose

public void internalClose()
                   throws IOException

Throws:

IOException

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

Specified by:

getConfiguration in interface Table

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Table

Throws:

IOException

get

public Result get(Get get)
           throws IOException

Specified by:

get in interface Table

Throws:

IOException

exists

public boolean exists(Get get)
               throws IOException

Specified by:

exists in interface Table

Throws:

IOException

existsAll

public boolean[] existsAll(List<Get> gets)
                    throws IOException

Specified by:

existsAll in interface Table

Throws:

IOException

exists

@Deprecated
public Boolean[] exists(List<Get> gets)
                             throws IOException

Deprecated. Use existsAll(java.util.List) instead. since 2.0. remove in 3.0

Throws:

IOException

put

public void put(Put put)
         throws IOException

Specified by:

put in interface Table

Throws:

IOException

put

public void put(List<Put> puts)
         throws IOException

Specified by:

put in interface Table

Throws:

IOException

delete

public void delete(Delete delete)
            throws IOException

Specified by:

delete in interface Table

Throws:

IOException

delete

public void delete(List<Delete> deletes)
            throws IOException

Specified by:

delete in interface Table

Throws:

IOException

checkAndPut

public boolean checkAndPut(byte[] row,
                           byte[] family,
                           byte[] qualifier,
                           byte[] value,
                           Put put)
                    throws IOException

Specified by:

checkAndPut in interface Table

Throws:

IOException

checkAndPut

public boolean checkAndPut(byte[] row,
                           byte[] family,
                           byte[] qualifier,
                           CompareFilter.CompareOp compareOp,
                           byte[] value,
                           Put put)
                    throws IOException

Specified by:

checkAndPut in interface Table

Throws:

IOException

checkAndPut

public boolean checkAndPut(byte[] row,
                           byte[] family,
                           byte[] qualifier,
                           CompareOperator op,
                           byte[] value,
                           Put put)
                    throws IOException

Specified by:

checkAndPut in interface Table

Throws:

IOException

checkAndDelete

public boolean checkAndDelete(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              byte[] value,
                              Delete delete)
                       throws IOException

Specified by:

checkAndDelete in interface Table

Throws:

IOException

checkAndDelete

public boolean checkAndDelete(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              CompareFilter.CompareOp compareOp,
                              byte[] value,
                              Delete delete)
                       throws IOException

Specified by:

checkAndDelete in interface Table

Throws:

IOException

checkAndDelete

public boolean checkAndDelete(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              CompareOperator op,
                              byte[] value,
                              Delete delete)
                       throws IOException

Specified by:

checkAndDelete in interface Table

Throws:

IOException

incrementColumnValue

public long incrementColumnValue(byte[] row,
                                 byte[] family,
                                 byte[] qualifier,
                                 long amount)
                          throws IOException

Specified by:

incrementColumnValue in interface Table

Throws:

IOException

incrementColumnValue

public long incrementColumnValue(byte[] row,
                                 byte[] family,
                                 byte[] qualifier,
                                 long amount,
                                 Durability durability)
                          throws IOException

Specified by:

incrementColumnValue in interface Table

Throws:

IOException

append

public Result append(Append append)
              throws IOException

Specified by:

append in interface Table

Throws:

IOException

increment

public Result increment(Increment increment)
                 throws IOException

Specified by:

increment in interface Table

Throws:

IOException

getScanner

public ResultScanner getScanner(Scan scan)
                         throws IOException

Specified by:

getScanner in interface Table

Throws:

IOException

getScanner

public ResultScanner getScanner(byte[] family)
                         throws IOException

Specified by:

getScanner in interface Table

Throws:

IOException

getScanner

public ResultScanner getScanner(byte[] family,
                                byte[] qualifier)
                         throws IOException

Specified by:

getScanner in interface Table

Throws:

IOException

getTableDescriptor

public HTableDescriptor getTableDescriptor()
                                    throws IOException

Specified by:

getTableDescriptor in interface Table

Throws:

IOException

getDescriptor

public TableDescriptor getDescriptor()
                              throws IOException

Specified by:

getDescriptor in interface Table

Throws:

IOException

getName

public TableName getName()

Specified by:

getName in interface Table

batch

public void batch(List<? extends Row> actions,
                  Object[] results)
           throws IOException,
                  InterruptedException

Specified by:

batch in interface Table

Throws:

IOException

InterruptedException

batchCallback

public <R> void batchCallback(List<? extends Row> actions,
                              Object[] results,
                              Batch.Callback<R> callback)
                       throws IOException,
                              InterruptedException

Specified by:

batchCallback in interface Table

Throws:

IOException

InterruptedException

get

public Result[] get(List<Get> gets)
             throws IOException

Specified by:

get in interface Table

Throws:

IOException

coprocessorService

public CoprocessorRpcChannel coprocessorService(byte[] row)

Specified by:

coprocessorService in interface Table

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

Specified by:

coprocessorService in interface Table

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

Specified by:

coprocessorService in interface Table

Throws:

com.google.protobuf.ServiceException

Throwable

mutateRow

public void mutateRow(RowMutations rm)
               throws IOException

Specified by:

mutateRow in interface Table

Throws:

IOException

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

Specified by:

batchCoprocessorService in interface Table

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

Specified by:

batchCoprocessorService in interface Table

Throws:

com.google.protobuf.ServiceException

Throwable

checkAndMutate

public boolean checkAndMutate(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              CompareFilter.CompareOp compareOp,
                              byte[] value,
                              RowMutations rm)
                       throws IOException

Specified by:

checkAndMutate in interface Table

Throws:

IOException

checkAndMutate

public boolean checkAndMutate(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              CompareOperator op,
                              byte[] value,
                              RowMutations rm)
                       throws IOException

Specified by:

checkAndMutate in interface Table

Throws:

IOException

setOperationTimeout

public void setOperationTimeout(int operationTimeout)

Specified by:

setOperationTimeout in interface Table

getOperationTimeout

public int getOperationTimeout()

Specified by:

getOperationTimeout in interface Table

setRpcTimeout

@Deprecated
public void setRpcTimeout(int rpcTimeout)

Deprecated.

Specified by:

setRpcTimeout in interface Table

setWriteRpcTimeout

public void setWriteRpcTimeout(int writeRpcTimeout)

Specified by:

setWriteRpcTimeout in interface Table

setReadRpcTimeout

public void setReadRpcTimeout(int readRpcTimeout)

Specified by:

setReadRpcTimeout in interface Table

getRpcTimeout

@Deprecated
public int getRpcTimeout()

Deprecated.

Specified by:

getRpcTimeout in interface Table

getWriteRpcTimeout

public int getWriteRpcTimeout()

Specified by:

getWriteRpcTimeout in interface Table

getReadRpcTimeout

public int getReadRpcTimeout()

Specified by:

getReadRpcTimeout in interface Table