public class HTableWrapper extends Object implements HTableInterface
| Modifier and Type | Field and Description |
|---|---|
private ClusterConnection |
connection |
private List<HTableInterface> |
openTables |
private HTableInterface |
table |
| Modifier | Constructor and Description |
|---|---|
private |
HTableWrapper(List<HTableInterface> openTables,
TableName tableName,
ClusterConnection connection,
ExecutorService pool) |
| 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> |
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> |
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 |
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> |
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> |
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. |
static HTableInterface |
createWrapper(List<HTableInterface> openTables,
TableName tableName,
CoprocessorHost.Environment env,
ExecutorService pool) |
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.
|
void |
flushCommits()
Executes all the buffered
Put operations. |
Result |
get(Get get)
Extracts certain cells from a given row.
|
Result[] |
get(List<Get> gets)
Extracts certain cells from the given rows, in batch.
|
org.apache.hadoop.conf.Configuration |
getConfiguration()
Returns the
Configuration object used by this instance. |
TableName |
getName()
Gets the fully qualified table name instance of this table.
|
Result |
getRowOrBefore(byte[] row,
byte[] family)
Deprecated.
|
ResultScanner |
getScanner(byte[] family)
Gets a scanner on the current table for the given family.
|
ResultScanner |
getScanner(byte[] family,
byte[] qualifier)
Gets a scanner on the current table for the given family and qualifier.
|
ResultScanner |
getScanner(Scan scan)
Returns a scanner on the current table as specified by the
Scan
object. |
HTableDescriptor |
getTableDescriptor()
Gets the
table descriptor for this table. |
byte[] |
getTableName()
Gets the name of this table.
|
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)
|
long |
incrementColumnValue(byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL) |
long |
incrementColumnValue(byte[] row,
byte[] family,
byte[] qualifier,
long amount,
Durability durability)
Atomically increments a column value.
|
void |
internalClose() |
boolean |
isAutoFlush()
Tells whether or not 'auto-flush' is turned on.
|
void |
mutateRow(RowMutations rm)
Performs multiple mutations atomically on a single row.
|
void |
put(List<Put> puts)
Puts some data in the table, in batch.
|
void |
put(Put put)
Puts some data in the table.
|
void |
setAutoFlush(boolean autoFlush)
|
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 |
setWriteBufferSize(long writeBufferSize)
Sets the size of the buffer in bytes.
|
private final HTableInterface table
private ClusterConnection connection
private final List<HTableInterface> openTables
private HTableWrapper(List<HTableInterface> openTables, TableName tableName, ClusterConnection connection, ExecutorService pool) throws IOException
IOExceptionpublic static HTableInterface createWrapper(List<HTableInterface> openTables, TableName tableName, CoprocessorHost.Environment env, ExecutorService pool) throws IOException
openTables - External list of tables used for tracking wrappers.IOExceptionpublic void internalClose()
throws IOException
IOExceptionpublic org.apache.hadoop.conf.Configuration getConfiguration()
TableConfiguration object used by this instance.
The reference returned is not a copy, so any change made to it will affect this instance.
getConfiguration in interface Tablepublic void close()
throws IOException
Tableclose in interface Closeableclose in interface AutoCloseableclose in interface TableIOException - if a remote or network exception occurs.@Deprecated public Result getRowOrBefore(byte[] row, byte[] family) throws IOException
HTableInterfacegetRowOrBefore in interface HTableInterfacerow - A row key.family - Column family to include in the Result.IOException - if a remote or network exception occurs.public Result get(Get get) throws IOException
Tableget in interface Tableget - The object that specifies what data to fetch and from which row.Result instance returned won't
contain any KeyValue, as indicated by Result.isEmpty().IOException - if a remote or network exception occurs.public boolean exists(Get get) throws IOException
TableThis 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.
exists in interface Tableget - the GetIOException - epublic boolean[] existsAll(List<Get> gets) throws IOException
TableThis 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.
existsAll in interface Tablegets - the GetsIOException - e@Deprecated public Boolean[] exists(List<Get> gets) throws IOException
exists in interface HTableInterfaceIOExceptionpublic void put(Put put) throws IOException
Tableput in interface Tableput - The data to put.IOException - if a remote or network exception occurs.public void put(List<Put> puts) throws IOException
TableThis 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.
put in interface Tableputs - 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.IOException - if a remote or network exception occurs.public void delete(Delete delete) throws IOException
Tabledelete in interface Tabledelete - The object that specifies what to delete.IOException - if a remote or network exception occurs.public void delete(List<Delete> deletes) throws IOException
Tabledelete in interface Tabledeletes - 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).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.public boolean checkAndPut(byte[] row,
byte[] family,
byte[] qualifier,
byte[] value,
Put put)
throws IOException
TablecheckAndPut in interface Tablerow - to checkfamily - column family to checkqualifier - column qualifier to checkvalue - the expected valueput - data to put if check succeedsIOException - epublic boolean checkAndPut(byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
byte[] value,
Put put)
throws IOException
TablecheckAndPut in interface Tablerow - to checkfamily - column family to checkqualifier - column qualifier to checkcompareOp - comparison operator to usevalue - the expected valueput - data to put if check succeedsIOException - epublic boolean checkAndDelete(byte[] row,
byte[] family,
byte[] qualifier,
byte[] value,
Delete delete)
throws IOException
TablecheckAndDelete in interface Tablerow - to checkfamily - column family to checkqualifier - column qualifier to checkvalue - the expected valuedelete - data to delete if check succeedsIOException - epublic boolean checkAndDelete(byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
byte[] value,
Delete delete)
throws IOException
TablecheckAndDelete in interface Tablerow - to checkfamily - column family to checkqualifier - column qualifier to checkcompareOp - comparison operator to usevalue - the expected valuedelete - data to delete if check succeedsIOException - epublic long incrementColumnValue(byte[] row,
byte[] family,
byte[] qualifier,
long amount)
throws IOException
TableTable.incrementColumnValue(byte[], byte[], byte[], long, Durability)
The Durability is defaulted to Durability.SYNC_WAL.
incrementColumnValue in interface Tablerow - 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).IOException - if a remote or network exception occurs.public long incrementColumnValue(byte[] row,
byte[] family,
byte[] qualifier,
long amount,
Durability durability)
throws IOException
Tableamount 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.
incrementColumnValue in interface Tablerow - 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.IOException - if a remote or network exception occurs.public Result append(Append append) throws IOException
TableThis 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.
append in interface Tableappend - object that specifies the columns and values to be appendedIOException - epublic Result increment(Increment increment) throws IOException
TableThis 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.
increment in interface Tableincrement - object that specifies the columns and amounts to be used
for the increment operationsIOException - epublic void flushCommits()
throws IOException
HTableInterfacePut 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.
flushCommits in interface HTableInterfaceIOException - if a remote or network exception occurs.public boolean isAutoFlush()
HTableInterfaceisAutoFlush in interface HTableInterfacetrue if 'auto-flush' is enabled (default), meaning
Put operations don't get buffered/delayed and are immediately
executed.public ResultScanner getScanner(Scan scan) throws IOException
TableScan
object.
Note that the passed Scan's start row and caching properties
maybe changed.getScanner in interface Tablescan - A configured Scan object.IOException - if a remote or network exception occurs.public ResultScanner getScanner(byte[] family) throws IOException
TablegetScanner in interface Tablefamily - The column family to scan.IOException - if a remote or network exception occurs.public ResultScanner getScanner(byte[] family, byte[] qualifier) throws IOException
TablegetScanner in interface Tablefamily - The column family to scan.qualifier - The column qualifier to scan.IOException - if a remote or network exception occurs.public HTableDescriptor getTableDescriptor() throws IOException
Tabletable descriptor for this table.getTableDescriptor in interface TableIOException - if a remote or network exception occurs.public byte[] getTableName()
HTableInterfacegetTableName in interface HTableInterfacepublic TableName getName()
Tablepublic void batch(List<? extends Row> actions, Object[] results) throws IOException, InterruptedException
TableTable.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.batch in interface Tableactions - list of Get, Put, Delete, Increment, Append objectsresults - 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 retriesIOExceptionInterruptedExceptionpublic Object[] batch(List<? extends Row> actions) throws IOException, InterruptedException
batch(List, Object[]) instead.Table.batch(List, Object[]), but returns an array of
results instead of using a results parameter reference.batch in interface Tableactions - list of Get, Put, Delete, Increment, Append objectsIOExceptionInterruptedExceptionpublic <R> void batchCallback(List<? extends Row> actions, Object[] results, Batch.Callback<R> callback) throws IOException, InterruptedException
TableTable.batch(List, Object[]), but with a callback.batchCallback in interface TableIOExceptionInterruptedExceptionpublic <R> Object[] batchCallback(List<? extends Row> actions, Batch.Callback<R> callback) throws IOException, InterruptedException
batchCallback(List, Object[], org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)
instead.Table.batch(List), but with a callback.batchCallback in interface TableIOExceptionInterruptedExceptionpublic Result[] get(List<Get> gets) throws IOException
Tableget in interface Tablegets - The objects that specify what data to fetch and from which rows.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.IOException - if a remote or network exception occurs.public CoprocessorRpcChannel coprocessorService(byte[] row)
TableRpcChannel 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);
coprocessorService in interface Tablerow - The row key used to identify the remote region locationpublic <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
TableService 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.coprocessorService in interface TableT - the Service subclass to connect toR - Return type for the callable parameter's Batch.Call.call(T) methodservice - the protocol buffer Service implementation to callstartKey - 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.com.google.protobuf.ServiceExceptionThrowablepublic <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
TableService 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.
coprocessorService in interface TableT - the Service subclass to connect toR - Return type for the callable parameter's Batch.Call.call(T) methodservice - the protocol buffer Service implementation to callstartKey - 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.com.google.protobuf.ServiceExceptionThrowablepublic void mutateRow(RowMutations rm) throws IOException
TablemutateRow in interface Tablerm - object that specifies the set of mutations to perform atomicallyIOExceptionpublic void setAutoFlush(boolean autoFlush)
HTableInterfacesetAutoFlush in interface HTableInterfaceautoFlush - Whether or not to enable 'auto-flush'.public void setAutoFlush(boolean autoFlush,
boolean clearBufferOnFail)
HTableInterface
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).
setAutoFlush in interface HTableInterfaceautoFlush - 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.BufferedMutator.flush()public void setAutoFlushTo(boolean autoFlush)
HTableInterfaceclearBufferOnFail.setAutoFlushTo in interface HTableInterfacepublic long getWriteBufferSize()
HTableInterface
The default value comes from the configuration parameter
hbase.client.write.buffer.
getWriteBufferSize in interface HTableInterfacegetWriteBufferSize in interface Tablepublic void setWriteBufferSize(long writeBufferSize)
throws IOException
HTableInterfaceIf the new size is less than the current amount of data in the write buffer, the buffer gets flushed.
setWriteBufferSize in interface HTableInterfacesetWriteBufferSize in interface TablewriteBufferSize - The new write buffer size, in bytes.IOException - if a remote or network exception occurs.public long incrementColumnValue(byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL)
throws IOException
incrementColumnValue in interface HTableInterfaceIOExceptionpublic <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
TableService 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.batchCoprocessorService in interface TableR - the response type for the coprocessor Service methodmethodDescriptor - the descriptor for the protobuf service method to call.request - the method call parametersstartKey - 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.com.google.protobuf.ServiceExceptionThrowablepublic <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
TableService 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.
batchCoprocessorService in interface TableR - the response type for the coprocessor Service methodmethodDescriptor - the descriptor for the protobuf service method to call.request - the method call parametersstartKey - 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 regioncom.google.protobuf.ServiceExceptionThrowablepublic boolean checkAndMutate(byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
byte[] value,
RowMutations rm)
throws IOException
TablecheckAndMutate in interface Tablerow - to checkfamily - column family to checkqualifier - column qualifier to checkcompareOp - the comparison operatorvalue - the expected valuerm - mutations to perform if check succeedsIOException - eCopyright © 2007–2019 The Apache Software Foundation. All rights reserved.