HTableWrapper (HBase - Server 1.0.1 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable, HTableInterface, Table
```
public class HTableWrapper
extends Object
implements HTableInterface
```
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

Methods
Modifier and Type	Method and Description
`Result`	`append(Append append)`
`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)`
`<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)`
`<R extends Message> Map<byte[],R>`	`batchCoprocessorService(Descriptors.MethodDescriptor methodDescriptor, Message request, byte[] startKey, byte[] endKey, R responsePrototype)`
`<R extends Message> void`	`batchCoprocessorService(Descriptors.MethodDescriptor methodDescriptor, 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`	`checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, 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)`
`void`	`close()`
`CoprocessorRpcChannel`	`coprocessorService(byte[] row)`
`<T extends Service,R> Map<byte[],R>`	`coprocessorService(Class<T> service, byte[] startKey, byte[] endKey, Batch.Call<T,R> callable)`
`<T extends Service,R> void`	`coprocessorService(Class<T> service, byte[] startKey, byte[] endKey, Batch.Call<T,R> callable, Batch.Callback<R> callback)`
`static HTableInterface`	`createWrapper(List<HTableInterface> 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.
`boolean[]`	`existsAll(List<Get> gets)`
`void`	`flushCommits()`
`Result`	`get(Get get)`
`Result[]`	`get(List<Get> gets)`
`org.apache.hadoop.conf.Configuration`	`getConfiguration()`
`TableName`	`getName()`
`Result`	`getRowOrBefore(byte[] row, byte[] family)` Deprecated.
`ResultScanner`	`getScanner(byte[] family)`
`ResultScanner`	`getScanner(byte[] family, byte[] qualifier)`
`ResultScanner`	`getScanner(Scan scan)`
`HTableDescriptor`	`getTableDescriptor()`
`byte[]`	`getTableName()`
`long`	`getWriteBufferSize()`
`Result`	`increment(Increment increment)`
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)`
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, boolean writeToWAL)`
`long`	`incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, Durability durability)`
`void`	`internalClose()`
`boolean`	`isAutoFlush()`
`void`	`mutateRow(RowMutations rm)`
`void`	`put(List<Put> puts)`
`void`	`put(Put put)`
`void`	`setAutoFlush(boolean autoFlush)`
`void`	`setAutoFlush(boolean autoFlush, boolean clearBufferOnFail)`
`void`	`setAutoFlushTo(boolean autoFlush)`
`void`	`setWriteBufferSize(long writeBufferSize)`

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

Method Detail

createWrapper

public static HTableInterface createWrapper(List<HTableInterface> 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

getRowOrBefore

@Deprecated
public Result getRowOrBefore(byte[] row,
                               byte[] family)
                      throws IOException

Deprecated.

Specified by:: getRowOrBefore in interface HTableInterface
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.

Specified by:: exists in interface HTableInterface
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

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

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

flushCommits
```
public void flushCommits()
                  throws IOException
```
Specified by:

flushCommits in interface HTableInterface

Throws:

IOException

isAutoFlush
```
public boolean isAutoFlush()
```
Specified by:

isAutoFlush in interface HTableInterface

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

getTableName
```
public byte[] getTableName()
```
Specified by:

getTableName in interface HTableInterface

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

batch
```
public Object[] batch(List<? extends Row> actions)
               throws IOException,
                      InterruptedException
```
Deprecated. If any exception is thrown by one of the actions, there is no way to retrieve the partially executed results. Use batch(List, Object[]) instead.

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

batchCallback
```
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.

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 Service,R> Map<byte[],R> coprocessorService(Class<T> service,
                                                     byte[] startKey,
                                                     byte[] endKey,
                                                     Batch.Call<T,R> callable)
                                 throws ServiceException,
                                        Throwable

Specified by:: coprocessorService in interface Table
Throws:: ServiceException; Throwable

coprocessorService

public <T extends Service,R> void coprocessorService(Class<T> service,
                                            byte[] startKey,
                                            byte[] endKey,
                                            Batch.Call<T,R> callable,
                                            Batch.Callback<R> callback)
                        throws ServiceException,
                               Throwable

Specified by:: coprocessorService in interface Table
Throws:: ServiceException; Throwable

mutateRow

public void mutateRow(RowMutations rm)
               throws IOException

Specified by:: mutateRow in interface Table
Throws:: IOException

setAutoFlush
```
public void setAutoFlush(boolean autoFlush)
```
Specified by:

setAutoFlush in interface HTableInterface

setAutoFlush

public void setAutoFlush(boolean autoFlush,
                boolean clearBufferOnFail)

Specified by:: setAutoFlush in interface HTableInterface

setAutoFlushTo
```
public void setAutoFlushTo(boolean autoFlush)
```
Specified by:

setAutoFlushTo in interface HTableInterface

getWriteBufferSize
```
public long getWriteBufferSize()
```
Specified by:

getWriteBufferSize in interface HTableInterface

Specified by:

getWriteBufferSize in interface Table

setWriteBufferSize
```
public void setWriteBufferSize(long writeBufferSize)
                        throws IOException
```
Specified by:

setWriteBufferSize in interface HTableInterface

Specified by:

setWriteBufferSize in interface Table

Throws:

IOException

incrementColumnValue

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

Specified by:: incrementColumnValue in interface HTableInterface
Throws:: IOException

batchCoprocessorService

public <R extends Message> Map<byte[],R> batchCoprocessorService(Descriptors.MethodDescriptor methodDescriptor,
                                                        Message request,
                                                        byte[] startKey,
                                                        byte[] endKey,
                                                        R responsePrototype)
                                                      throws ServiceException,
                                                             Throwable

Specified by:: batchCoprocessorService in interface Table
Throws:: ServiceException; Throwable

batchCoprocessorService

public <R extends Message> void batchCoprocessorService(Descriptors.MethodDescriptor methodDescriptor,
                                               Message request,
                                               byte[] startKey,
                                               byte[] endKey,
                                               R responsePrototype,
                                               Batch.Callback<R> callback)
                             throws ServiceException,
                                    Throwable

Specified by:: batchCoprocessorService in interface Table
Throws:: 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

Class HTableWrapper

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createWrapper

internalClose

getConfiguration

close

getRowOrBefore

get

exists

existsAll

exists

put

put

delete

delete

checkAndPut

checkAndPut

checkAndDelete

checkAndDelete

incrementColumnValue

incrementColumnValue

append

increment

flushCommits

isAutoFlush

getScanner

getScanner

getScanner

getTableDescriptor

getTableName

getName

batch

batch

batchCallback

batchCallback

get

coprocessorService

coprocessorService

coprocessorService

mutateRow

setAutoFlush

setAutoFlush

setAutoFlushTo

getWriteBufferSize

setWriteBufferSize

incrementColumnValue

batchCoprocessorService

batchCoprocessorService

checkAndMutate