|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HTableInterface
Used to communicate with a single HBase table.
Method Summary | ||
---|---|---|
Object[] |
batch(List<Row> actions)
Same as batch(List, Object[]) , but returns an array of
results instead of using a results parameter reference. |
|
void |
batch(List<Row> actions,
Object[] results)
Method that does a batch call on Deletes, Gets and Puts. |
|
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 |
checkAndPut(byte[] row,
byte[] family,
byte[] qualifier,
byte[] value,
Put put)
Atomically checks if a row/family/qualifier value matches the expected value. |
|
void |
close()
Releases any resources help or pending changes in internal buffers. |
|
|
coprocessorExec(Class<T> protocol,
byte[] startKey,
byte[] endKey,
Batch.Call<T,R> callable)
Invoke the passed Batch.Call against
the CoprocessorProtocol instances running in the selected regions. |
|
|
coprocessorExec(Class<T> protocol,
byte[] startKey,
byte[] endKey,
Batch.Call<T,R> callable,
Batch.Callback<R> callback)
Invoke the passed Batch.Call against
the CoprocessorProtocol instances running in the selected regions. |
|
|
coprocessorProxy(Class<T> protocol,
byte[] row)
Creates and returns a proxy to the CoprocessorProtocol instance running in the region containing the specified row. |
|
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 in the Get. |
|
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. |
|
Result |
getRowOrBefore(byte[] row,
byte[] family)
Deprecated. As of version 0.92 this method is deprecated without replacement. getRowOrBefore is used internally to find entries in .META. and makes various assumptions about the table (which are true for .META. but not in general) to be efficient. |
|
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. |
|
Result |
increment(Increment increment)
Increments one or more columns within a single row. |
|
long |
incrementColumnValue(byte[] row,
byte[] family,
byte[] qualifier,
long amount)
Atomically increments a column value. |
|
long |
incrementColumnValue(byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL)
Atomically increments a column value. |
|
boolean |
isAutoFlush()
Tells whether or not 'auto-flush' is turned on. |
|
RowLock |
lockRow(byte[] row)
Obtains a lock on a 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 |
unlockRow(RowLock rl)
Releases a row lock. |
Method Detail |
---|
byte[] getTableName()
org.apache.hadoop.conf.Configuration getConfiguration()
Configuration
object used by this instance.
The reference returned is not a copy, so any change made to it will affect this instance.
HTableDescriptor getTableDescriptor() throws IOException
table descriptor
for this table.
IOException
- if a remote or network exception occurs.boolean exists(Get get) throws IOException
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.
get
- the Get
IOException
- evoid batch(List<Row> actions, Object[] results) throws IOException, InterruptedException
batch(java.util.List, java.lang.Object[])
call, you will not necessarily be
guaranteed that the Get returns what the Put had put.
actions
- list of Get, Put, Delete 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 retries
IOException
InterruptedException
Object[] batch(List<Row> actions) throws IOException, InterruptedException
batch(List, Object[])
, but returns an array of
results instead of using a results parameter reference.
actions
- list of Get, Put, Delete objects
IOException
InterruptedException
Result get(Get get) throws IOException
get
- 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.Result[] get(List<Get> gets) throws IOException
gets
- 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.Result getRowOrBefore(byte[] row, byte[] family) throws IOException
row
- A row key.family
- Column family to include in the Result
.
IOException
- if a remote or network exception occurs.ResultScanner getScanner(Scan scan) throws IOException
Scan
object.
scan
- A configured Scan
object.
IOException
- if a remote or network exception occurs.ResultScanner getScanner(byte[] family) throws IOException
family
- The column family to scan.
IOException
- if a remote or network exception occurs.ResultScanner getScanner(byte[] family, byte[] qualifier) throws IOException
family
- The column family to scan.qualifier
- The column qualifier to scan.
IOException
- if a remote or network exception occurs.void put(Put put) throws IOException
If isAutoFlush
is false, the update is buffered
until the internal buffer is full.
put
- The data to put.
IOException
- if a remote or network exception occurs.void put(List<Put> puts) throws IOException
If isAutoFlush
is false, the update is buffered
until the internal buffer is full.
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.
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.
IOException
- if a remote or network exception occurs.boolean checkAndPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, Put put) throws IOException
row
- to checkfamily
- column family to checkqualifier
- column qualifier to checkvalue
- the expected valueput
- data to put if check succeeds
IOException
- evoid delete(Delete delete) throws IOException
delete
- The object that specifies what to delete.
IOException
- if a remote or network exception occurs.void delete(List<Delete> deletes) throws IOException
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
Delete
s 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.boolean checkAndDelete(byte[] row, byte[] family, byte[] qualifier, byte[] value, Delete delete) throws IOException
row
- to checkfamily
- column family to checkqualifier
- column qualifier to checkvalue
- the expected valuedelete
- data to delete if check succeeds
IOException
- eResult increment(Increment increment) throws IOException
This operation does not appear atomic to readers. Increments are done under a single row lock, so write operations to a row are synchronized, but readers do not take row locks so get and scan operations can see this operation partially completed.
increment
- object that specifies the columns and amounts to be used
for the increment operations
IOException
- elong incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount) throws IOException
Equivalent to incrementColumnValue
(row, family, qualifier, amount,
true)}
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).
IOException
- if a remote or network exception occurs.long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, boolean writeToWAL) throws IOException
amount
and
written to the specified column.
Setting writeToWAL to false means that in a fail scenario, you will lose any increments that have not been flushed.
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).writeToWAL
- if true
, the operation will be applied to the
Write Ahead Log (WAL). This makes the operation slower but safer, as if
the call returns successfully, it is guaranteed that the increment will
be safely persisted. When set to false
, the call may return
successfully before the increment is safely persisted, so it's possible
that the increment be lost in the event of a failure happening before the
operation gets persisted.
IOException
- if a remote or network exception occurs.boolean isAutoFlush()
true
if 'auto-flush' is enabled (default), meaning
Put
operations don't get buffered/delayed and are immediately
executed.void flushCommits() throws IOException
Put
operations.
This method gets called once automatically for every Put
or batch
of Put
s (when put(List
is used) when
isAutoFlush()
is true
.
IOException
- if a remote or network exception occurs.void close() throws IOException
IOException
- if a remote or network exception occurs.RowLock lockRow(byte[] row) throws IOException
row
- The row to lock.
RowLock
containing the row and lock id.
IOException
- if a remote or network exception occurs.RowLock
,
unlockRow(org.apache.hadoop.hbase.client.RowLock)
void unlockRow(RowLock rl) throws IOException
rl
- The row lock to release.
IOException
- if a remote or network exception occurs.RowLock
,
unlockRow(org.apache.hadoop.hbase.client.RowLock)
<T extends CoprocessorProtocol> T coprocessorProxy(Class<T> protocol, byte[] row)
row
parameter is also not passed to the
coprocessor handler registered for this protocol, unless the row
is separately passed as an argument in a proxy method call. The parameter
here is just used to locate the region used to handle the call.
protocol
- The class or interface defining the remote protocolrow
- The row key used to identify the remote region location
<T extends CoprocessorProtocol,R> Map<byte[],R> coprocessorExec(Class<T> protocol, byte[] startKey, byte[] endKey, Batch.Call<T,R> callable) throws IOException, Throwable
Batch.Call
against
the CoprocessorProtocol
instances running in the selected regions.
All regions beginning with the region containing the startKey
row, through to the region containing the endKey
row (inclusive)
will be used. If startKey
or endKey
is
null
, the first and last regions in the table, respectively,
will be used in the range selection.
T
- CoprocessorProtocol subclass for the remote invocationR
- Return type for the
Batch.Call.call(Object)
methodprotocol
- the CoprocessorProtocol implementation to callstartKey
- start region selection with region containing this rowendKey
- select regions up to and including the region containing
this rowcallable
- wraps the CoprocessorProtocol implementation method calls
made per-region
Map
of region names to
Batch.Call.call(Object)
return values
IOException
Throwable
<T extends CoprocessorProtocol,R> void coprocessorExec(Class<T> protocol, byte[] startKey, byte[] endKey, Batch.Call<T,R> callable, Batch.Callback<R> callback) throws IOException, Throwable
Batch.Call
against
the CoprocessorProtocol
instances running in the selected regions.
All regions beginning with the region containing the startKey
row, through to the region containing the endKey
row
(inclusive)
will be used. If startKey
or endKey
is
null
, the first and last regions in the table, respectively,
will be used in the range selection.
For each result, the given
Batch.Callback.update(byte[], byte[], Object)
method will be called.
T
- CoprocessorProtocol subclass for the remote invocationR
- Return type for the
Batch.Call.call(Object)
methodprotocol
- the CoprocessorProtocol implementation to callstartKey
- start region selection with region containing this rowendKey
- select regions up to and including the region containing
this rowcallable
- wraps the CoprocessorProtocol implementation method calls
made per-regioncallback
- an instance upon which
Batch.Callback.update(byte[], byte[], Object)
with the
Batch.Call.call(Object)
return value for each region
IOException
Throwable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |