|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface HRegionInterface
Clients interact with HRegionServers using a handle to the HRegionInterface.
NOTE: if you change the interface, you must change the RPC version number in HBaseRPCProtocolVersion
| Field Summary | |
|---|---|
static long |
VERSION
This Interfaces' version. |
| Method Summary | ||
|---|---|---|
boolean |
bulkLoadHFiles(List<Pair<byte[],String>> familyPaths,
byte[] regionName)
Atomically bulk load multiple HFiles (say from different column families) into an open region. |
|
boolean |
checkAndDelete(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
byte[] value,
Delete delete)
Atomically checks if a row/family/qualifier value match the expectedValue. |
|
boolean |
checkAndDelete(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Delete delete)
Atomically checks if a row/family/qualifier value match the expectedValue. |
|
boolean |
checkAndPut(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
byte[] value,
Put put)
Atomically checks if a row/family/qualifier value match the expectedValue. |
|
boolean |
checkAndPut(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Put put)
Atomically checks if a row/family/qualifier value match the expectedValue. |
|
void |
close(long scannerId)
Close a scanner |
|
boolean |
closeRegion(byte[] encodedRegionName,
boolean zk)
Closes the region in the RS with the specified encoded regionName and will use or not use ZK during the close according to the specified flag. |
|
boolean |
closeRegion(HRegionInfo region)
Closes the specified region. |
|
boolean |
closeRegion(HRegionInfo region,
boolean zk)
Closes the specified region and will use or not use ZK during the close according to the specified flag. |
|
void |
compactRegion(HRegionInfo regionInfo,
boolean major)
Compacts the specified region. |
|
void |
delete(byte[] regionName,
Delete delete)
Deletes all the KeyValues that match those found in the Delete object, if their ts <= to the Delete. |
|
int |
delete(byte[] regionName,
List<Delete> deletes)
Put an array of deletes into the specified region |
|
ExecResult |
execCoprocessor(byte[] regionName,
Exec call)
Executes a single CoprocessorProtocol
method using the registered protocol handlers. |
|
boolean |
exists(byte[] regionName,
Get get)
Perform exists operation. |
|
void |
flushRegion(HRegionInfo regionInfo)
Flushes the MemStore of the specified region. |
|
Result |
get(byte[] regionName,
Get get)
Perform Get operation. |
|
List<BlockCacheColumnFamilySummary> |
getBlockCacheColumnFamilySummaries()
Performs a BlockCache summary and returns a List of BlockCacheColumnFamilySummary objects. |
|
Result |
getClosestRowBefore(byte[] regionName,
byte[] row,
byte[] family)
Return all the data for the row that matches row exactly, or the one that immediately preceeds it. |
|
HServerInfo |
getHServerInfo()
Deprecated. |
|
List<HRegionInfo> |
getOnlineRegions()
|
|
HRegionInfo |
getRegionInfo(byte[] regionName)
Get metainfo about an HRegion |
|
Result |
increment(byte[] regionName,
Increment increment)
Increments one or more columns values in a row. |
|
long |
incrementColumnValue(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL)
Atomically increments a column value. |
|
long |
lockRow(byte[] regionName,
byte[] row)
Opens a remote row lock. |
|
|
multi(MultiAction<R> multi)
Method used for doing multiple actions(Deletes, Gets and Puts) in one call |
|
Result |
next(long scannerId)
Get the next set of values |
|
Result[] |
next(long scannerId,
int numberOfRows)
Get the next set of values |
|
RegionOpeningState |
openRegion(HRegionInfo region)
Opens the specified region. |
|
RegionOpeningState |
openRegion(HRegionInfo region,
int versionOfOfflineNode)
Opens the specified region. |
|
void |
openRegions(List<HRegionInfo> regions)
Opens the specified regions. |
|
long |
openScanner(byte[] regionName,
Scan scan)
Opens a remote scanner with a RowFilter. |
|
int |
put(byte[] regionName,
List<Put> puts)
Put an array of puts into the specified region |
|
void |
put(byte[] regionName,
Put put)
Put data into the specified region |
|
void |
replicateLogEntries(HLog.Entry[] entries)
Replicates the given entries. |
|
byte[][] |
rollHLogWriter()
Roll the log writer. |
|
void |
splitRegion(HRegionInfo regionInfo)
Splits the specified region. |
|
void |
splitRegion(HRegionInfo regionInfo,
byte[] splitPoint)
Splits the specified region. |
|
void |
unlockRow(byte[] regionName,
long lockId)
Releases a remote row lock. |
|
| Methods inherited from interface org.apache.hadoop.hbase.ipc.VersionedProtocol |
|---|
getProtocolSignature, getProtocolVersion |
| Methods inherited from interface org.apache.hadoop.hbase.Stoppable |
|---|
isStopped, stop |
| Methods inherited from interface org.apache.hadoop.hbase.Abortable |
|---|
abort, isAborted |
| Field Detail |
|---|
static final long VERSION
| Method Detail |
|---|
HRegionInfo getRegionInfo(byte[] regionName)
throws NotServingRegionException,
ConnectException,
IOException
regionName - name of the region
NotServingRegionException
ConnectException
IOException - This can manifest as an Hadoop ipc RemoteException
Result getClosestRowBefore(byte[] regionName,
byte[] row,
byte[] family)
throws IOException
regionName - region namerow - row keyfamily - Column family to look for row in.
IOException - e
Result get(byte[] regionName,
Get get)
throws IOException
regionName - name of region to get fromget - Get operation
IOException - e
boolean exists(byte[] regionName,
Get get)
throws IOException
regionName - name of region to get fromget - Get operation describing cell to test
IOException - e
void put(byte[] regionName,
Put put)
throws IOException
regionName - region nameput - the data to be put
IOException - e
int put(byte[] regionName,
List<Put> puts)
throws IOException
regionName - region nameputs - List of puts to execute
IOException - e
void delete(byte[] regionName,
Delete delete)
throws IOException
regionName - region namedelete - delete object
IOException - e
int delete(byte[] regionName,
List<Delete> deletes)
throws IOException
regionName - region namedeletes - delete List to execute
IOException - e
boolean checkAndPut(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
byte[] value,
Put put)
throws IOException
regionName - region namerow - row to checkfamily - column familyqualifier - column qualifiervalue - the expected valueput - data to put if check succeeds
IOException - e
boolean checkAndDelete(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
byte[] value,
Delete delete)
throws IOException
regionName - region namerow - row to checkfamily - column familyqualifier - column qualifiervalue - the expected valuedelete - data to delete if check succeeds
IOException - e
long incrementColumnValue(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL)
throws IOException
regionName - region namerow - row to checkfamily - column familyqualifier - column qualifieramount - long amount to incrementwriteToWAL - whether to write the increment to the WAL
IOException - e
Result increment(byte[] regionName,
Increment increment)
throws IOException
This operation does not appear atomic to readers. Increments are done under a row lock but readers do not take row locks.
regionName - region nameincrement - increment operation
IOException
long openScanner(byte[] regionName,
Scan scan)
throws IOException
regionName - name of region to scanscan - configured scan object
IOException - e
Result next(long scannerId)
throws IOException
scannerId - clientId passed to openScanner
IOException - e
Result[] next(long scannerId,
int numberOfRows)
throws IOException
scannerId - clientId passed to openScannernumberOfRows - the number of rows to fetch
IOException - e
void close(long scannerId)
throws IOException
scannerId - the scanner id returned by openScanner
IOException - e
long lockRow(byte[] regionName,
byte[] row)
throws IOException
regionName - name of regionrow - row to lock
IOException - e
void unlockRow(byte[] regionName,
long lockId)
throws IOException
regionName - region namelockId - the lock id returned by lockRow
IOException - e
List<HRegionInfo> getOnlineRegions()
throws IOException
IOException - e
HServerInfo getHServerInfo()
throws IOException
HServerInfo; it has RegionServer POV on the
hostname which may not agree w/ how the Master sees this server.
IOException - e
<R> MultiResponse multi(MultiAction<R> multi)
throws IOException
multi -
IOException
boolean bulkLoadHFiles(List<Pair<byte[],String>> familyPaths,
byte[] regionName)
throws IOException
familyPaths - List of (family, hfile path) pairsregionName - name of region to load hfiles into
IOException - if fails unrecoverably
RegionOpeningState openRegion(HRegionInfo region)
throws IOException
region - region to open
IOException
RegionOpeningState openRegion(HRegionInfo region,
int versionOfOfflineNode)
throws IOException
region - region to openversionOfOfflineNode - the version of znode to compare when RS transitions the znode from
OFFLINE state.
IOException
void openRegions(List<HRegionInfo> regions)
throws IOException
regions - regions to open
IOException
boolean closeRegion(HRegionInfo region)
throws IOException
region - region to close
IOException
boolean closeRegion(HRegionInfo region,
boolean zk)
throws IOException
region - region to closezk - true if transitions should be done in ZK, false if not
IOException
boolean closeRegion(byte[] encodedRegionName,
boolean zk)
throws IOException
encodedRegionName - in byteszk - true if to use zookeeper, false if need not.
IOException
void flushRegion(HRegionInfo regionInfo)
throws NotServingRegionException,
IOException
This method is synchronous.
regionInfo - region to flush
NotServingRegionException
IOException
void splitRegion(HRegionInfo regionInfo)
throws NotServingRegionException,
IOException
This method currently flushes the region and then forces a compaction which will then trigger a split. The flush is done synchronously but the compaction is asynchronous.
regionInfo - region to split
NotServingRegionException
IOException
void splitRegion(HRegionInfo regionInfo,
byte[] splitPoint)
throws NotServingRegionException,
IOException
This method currently flushes the region and then forces a compaction which will then trigger a split. The flush is done synchronously but the compaction is asynchronous.
regionInfo - region to splitsplitPoint - the explicit row to split on
NotServingRegionException
IOException
void compactRegion(HRegionInfo regionInfo,
boolean major)
throws NotServingRegionException,
IOException
This method is asynchronous.
regionInfo - region to compactmajor - true to force major compaction
NotServingRegionException
IOException
void replicateLogEntries(HLog.Entry[] entries)
throws IOException
entries - entries to replicate
IOException
ExecResult execCoprocessor(byte[] regionName,
Exec call)
throws IOException
CoprocessorProtocol
method using the registered protocol handlers.
CoprocessorProtocol implementations must be registered via the
HRegion.registerProtocol(Class, org.apache.hadoop.hbase.ipc.CoprocessorProtocol)
method before they are available.
regionName - name of the region against which the invocation is executedcall - an Exec instance identifying the protocol, method name,
and parameters for the method invocation
ExecResult instance containing the region name of the
invocation and the return value
IOException - if no registered protocol handler is found or an error
occurs during the invocationHRegion.registerProtocol(Class, org.apache.hadoop.hbase.ipc.CoprocessorProtocol)
boolean checkAndPut(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Put put)
throws IOException
regionName - row - family - qualifier - compareOp - comparator - put -
IOException
boolean checkAndDelete(byte[] regionName,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Delete delete)
throws IOException
regionName - row - family - qualifier - compareOp - comparator - delete -
IOException
List<BlockCacheColumnFamilySummary> getBlockCacheColumnFamilySummaries()
throws IOException
IOException - exception
byte[][] rollHLogWriter()
throws IOException,
FailedLogCloseException
HRegionInfo.getEncodedName()
IOException
FailedLogCloseException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||