Region (Apache HBase 2.2.3 API)

All Superinterfaces:

ConfigurationObserver

All Known Implementing Classes:

HRegion
```
@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Evolving
public interface Region
extends ConfigurationObserver
```
Region is a subset of HRegion with operations required for the Coprocessors. The operations include ability to do mutations, requesting compaction, getting different counters/sizes, locking rows and getting access to Stores.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Region.Operation` Operation enum is used in `startRegionOperation()` and elsewhere to provide context for various checks.
`static interface`	`Region.RowLock` Row lock held by a given thread.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Result`	`append(Append append)` Perform one or more append operations on a row.
`OperationStatus[]`	`batchMutate(Mutation[] mutations)` Perform a batch of mutations.
`default boolean`	`checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Mutation mutation)` Atomically checks if a row/family/qualifier value matches the expected value and if it does, it performs the mutation.
`boolean`	`checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, TimeRange timeRange, Mutation mutation)` Atomically checks if a row/family/qualifier value matches the expected value and if it does, it performs the mutation.
`default boolean`	`checkAndRowMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, RowMutations mutations)` Atomically checks if a row/family/qualifier value matches the expected values and if it does, it performs the row mutations.
`boolean`	`checkAndRowMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, TimeRange timeRange, RowMutations mutations)` Atomically checks if a row/family/qualifier value matches the expected values and if it does, it performs the row mutations.
`void`	`closeRegionOperation()` Closes the region operation lock.
`void`	`closeRegionOperation(Region.Operation op)` Closes the region operation lock.
`void`	`delete(Delete delete)` Deletes the specified cells/row.
`Result`	`get(Get get)` Do a get based on the get parameter.
`List<Cell>`	`get(Get get, boolean withCoprocessor)` Do a get based on the get parameter.
`long`	`getBlockedRequestsCount()`
`CellComparator`	`getCellComparator()` The comparator to be used with the region
`long`	`getCheckAndMutateChecksFailed()`
`long`	`getCheckAndMutateChecksPassed()`
`CompactionState`	`getCompactionState()`
`long`	`getDataInMemoryWithoutWAL()`
`long`	`getEarliestFlushTimeForAllStores()`
`long`	`getFilteredReadRequestsCount()`
`long`	`getMaxFlushedSeqId()`
`Map<byte[],Long>`	`getMaxStoreSeqId()`
`long`	`getMemStoreDataSize()`
`long`	`getMemStoreHeapSize()`
`long`	`getMemStoreOffHeapSize()`
`long`	`getNumMutationsWithoutWAL()`
`long`	`getOldestHfileTs(boolean majorCompactionOnly)` This can be used to determine the last time all files of this region were major compacted.
`long`	`getReadRequestsCount()`
`RegionInfo`	`getRegionInfo()`
`Region.RowLock`	`getRowLock(byte[] row, boolean readLock)` Get a row lock for the specified row.
`RegionScanner`	`getScanner(Scan scan)` Return an iterator that scans over the HRegion, returning the indicated columns and rows specified by the `Scan`.
`RegionScanner`	`getScanner(Scan scan, List<KeyValueScanner> additionalScanners)` Return an iterator that scans over the HRegion, returning the indicated columns and rows specified by the `Scan`.
`Store`	`getStore(byte[] family)` Return the Store for the given family
`List<String>`	`getStoreFileList(byte[][] columns)`
`List<? extends Store>`	`getStores()` Return the list of Stores managed by this region
`TableDescriptor`	`getTableDescriptor()`
`long`	`getWriteRequestsCount()`
`Result`	`increment(Increment increment)` Perform one or more increment operations on a row.
`boolean`	`isAvailable()`
`boolean`	`isClosed()`
`boolean`	`isClosing()`
`boolean`	`isMergeable()`
`boolean`	`isReadOnly()`
`boolean`	`isSplittable()`
`void`	`mutateRow(RowMutations mutations)` Performs multiple mutations atomically on a single row.
`void`	`mutateRowsWithLocks(Collection<Mutation> mutations, Collection<byte[]> rowsToLock, long nonceGroup, long nonce)` Perform atomic mutations within the region.
`void`	`processRowsWithLocks(RowProcessor<?,?> processor)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use Coprocessors instead.
`void`	`processRowsWithLocks(RowProcessor<?,?> processor, long nonceGroup, long nonce)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use Coprocessors instead.
`void`	`processRowsWithLocks(RowProcessor<?,?> processor, long timeout, long nonceGroup, long nonce)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use Coprocessors instead.
`void`	`put(Put put)` Puts some data in the table.
`boolean`	`refreshStoreFiles()` Check the region's underlying store files, open the files that have not been opened yet, and remove the store file readers for store files no longer available.
`void`	`requestCompaction(byte[] family, String why, int priority, boolean major, CompactionLifeCycleTracker tracker)` Request compaction for the given family
`void`	`requestCompaction(String why, int priority, boolean major, CompactionLifeCycleTracker tracker)` Request compaction on this region.
`void`	`requestFlush(FlushLifeCycleTracker tracker)` Request flush on this region.
`void`	`startRegionOperation()` This method needs to be called before any public call that reads or modifies data.
`void`	`startRegionOperation(Region.Operation op)` This method needs to be called before any public call that reads or modifies data.
`boolean`	`waitForFlushes(long timeout)` Wait for all current flushes of the region to complete

Methods inherited from interface org.apache.hadoop.hbase.conf.ConfigurationObserver
onConfigurationChange

- Method Detail
  - getRegionInfo
```
RegionInfo getRegionInfo()
```
    Returns:
    
    region information for this region
  - getTableDescriptor
```
TableDescriptor getTableDescriptor()
```
    Returns:
    
    table descriptor for this region
  - isAvailable
```
boolean isAvailable()
```
    Returns:
    
    true if region is available (not closed and not closing)
  - isClosed
```
boolean isClosed()
```
    Returns:
    
    true if region is closed
  - isClosing
```
boolean isClosing()
```
    Returns:
    
    True if closing process has started
  - isReadOnly
```
boolean isReadOnly()
```
    Returns:
    
    True if region is read only
  - isSplittable
```
boolean isSplittable()
```
    Returns:
    
    true if region is splittable
  - isMergeable
```
boolean isMergeable()
```
    Returns:
    
    true if region is mergeable
  - getStores
```
List<? extends Store> getStores()
```
    Return the list of Stores managed by this region
    Use with caution. Exposed for use of fixup utilities.
    
    Returns:
    
    a list of the Stores managed by this region
  - getStore
```
Store getStore(byte[] family)
```
    Return the Store for the given family
    Use with caution. Exposed for use of fixup utilities.
    
    Returns:
    
    the Store for the given family
  - getStoreFileList
```
List<String> getStoreFileList(byte[][] columns)
```
    Returns:
    
    list of store file names for the given families
  - refreshStoreFiles
```
boolean refreshStoreFiles()
                   throws IOException
```
    Check the region's underlying store files, open the files that have not been opened yet, and remove the store file readers for store files no longer available.
    
    Throws:
    
    IOException
  - getMaxFlushedSeqId
```
long getMaxFlushedSeqId()
```
    Returns:
    
    the max sequence id of flushed data on this region; no edit in memory will have a sequence id that is less that what is returned here.
  - getOldestHfileTs
```
long getOldestHfileTs(boolean majorCompactionOnly)
               throws IOException
```
    This can be used to determine the last time all files of this region were major compacted.
    
    Parameters:
    
    majorCompactionOnly - Only consider HFile that are the result of major compaction
    
    Returns:
    
    the timestamp of the oldest HFile for all stores of this region
    
    Throws:
    
    IOException
  - getMaxStoreSeqId
```
Map<byte[],Long> getMaxStoreSeqId()
```
    Returns:
    
    map of column family names to max sequence id that was read from storage when this region was opened
  - getEarliestFlushTimeForAllStores
```
long getEarliestFlushTimeForAllStores()
```
    Returns:
    
    The earliest time a store in the region was flushed. All other stores in the region would have been flushed either at, or after this time.
  - getReadRequestsCount
```
long getReadRequestsCount()
```
    Returns:
    
    read requests count for this region
  - getFilteredReadRequestsCount
```
long getFilteredReadRequestsCount()
```
    Returns:
    
    filtered read requests count for this region
  - getWriteRequestsCount
```
long getWriteRequestsCount()
```
    Returns:
    
    write request count for this region
  - getMemStoreDataSize
```
long getMemStoreDataSize()
```
    Returns:
    
    memstore size for this region, in bytes. It just accounts data size of cells added to the memstores of this Region. Means size in bytes for key, value and tags within Cells. It wont consider any java heap overhead for the cell objects or any other.
  - getMemStoreHeapSize
```
long getMemStoreHeapSize()
```
    Returns:
    
    memstore heap size for this region, in bytes. It accounts data size of cells added to the memstores of this Region, as well as java heap overhead for the cell objects or any other.
  - getMemStoreOffHeapSize
```
long getMemStoreOffHeapSize()
```
    Returns:
    
    memstore off-heap size for this region, in bytes. It accounts data size of cells added to the memstores of this Region, as well as overhead for the cell objects or any other that is allocated off-heap.
  - getNumMutationsWithoutWAL
```
long getNumMutationsWithoutWAL()
```
    Returns:
    
    the number of mutations processed bypassing the WAL
  - getDataInMemoryWithoutWAL
```
long getDataInMemoryWithoutWAL()
```
    Returns:
    
    the size of data processed bypassing the WAL, in bytes
  - getBlockedRequestsCount
```
long getBlockedRequestsCount()
```
    Returns:
    
    the number of blocked requests
  - getCheckAndMutateChecksPassed
```
long getCheckAndMutateChecksPassed()
```
    Returns:
    
    the number of checkAndMutate guards that passed
  - getCheckAndMutateChecksFailed
```
long getCheckAndMutateChecksFailed()
```
    Returns:
    
    the number of failed checkAndMutate guards
  - startRegionOperation
```
void startRegionOperation()
                   throws IOException
```
    This method needs to be called before any public call that reads or modifies data. Acquires a read lock and checks if the region is closing or closed.
    closeRegionOperation() MUST then always be called after the operation has completed, whether it succeeded or failed.
    
    Throws:
    
    IOException
  - startRegionOperation
```
void startRegionOperation(Region.Operation op)
                   throws IOException
```
    This method needs to be called before any public call that reads or modifies data. Acquires a read lock and checks if the region is closing or closed.
    closeRegionOperation() MUST then always be called after the operation has completed, whether it succeeded or failed.
    
    Parameters:
    
    op - The operation is about to be taken on the region
    
    Throws:
    
    IOException
  - closeRegionOperation
```
void closeRegionOperation()
                   throws IOException
```
    Closes the region operation lock.
    
    Throws:
    
    IOException
  - closeRegionOperation
```
void closeRegionOperation(Region.Operation op)
                   throws IOException
```
    Closes the region operation lock. This needs to be called in the finally block corresponding to the try block of startRegionOperation(Operation)
    
    Throws:
    
    IOException
  - getRowLock
```
Region.RowLock getRowLock(byte[] row,
                          boolean readLock)
                   throws IOException
```
    Get a row lock for the specified row. All locks are reentrant. Before calling this function make sure that a region operation has already been started (the calling thread has already acquired the region-close-guard lock).
    The obtained locks should be released after use by Region.RowLock.release()
    NOTE: the boolean passed here has changed. It used to be a boolean that stated whether or not to wait on the lock. Now it is whether it an exclusive lock is requested.
    
    Parameters:
    
    row - The row actions will be performed against
    
    readLock - is the lock reader or writer. True indicates that a non-exclusive lock is requested
    
    Throws:
    
    IOException
    
    See Also:
    
    startRegionOperation(), startRegionOperation(Operation)
  - append
```
Result append(Append append)
       throws IOException
```
    Perform one or more append operations on a row.
    
    Parameters:
    
    append -
    
    Returns:
    
    result of the operation
    
    Throws:
    
    IOException
  - batchMutate
```
OperationStatus[] batchMutate(Mutation[] mutations)
                       throws IOException
```
    Perform a batch of mutations.
    Note this supports only Put and Delete mutations and will ignore other types passed.
    
    Parameters:
    
    mutations - the list of mutations
    
    Returns:
    
    an array of OperationStatus which internally contains the OperationStatusCode and the exceptionMessage if any.
    
    Throws:
    
    IOException
  - checkAndMutate
```
default boolean checkAndMutate(byte[] row,
                               byte[] family,
                               byte[] qualifier,
                               CompareOperator op,
                               ByteArrayComparable comparator,
                               Mutation mutation)
                        throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected value and if it does, it performs the mutation. If the passed value is null, the lack of column value (ie: non-existence) is used. See checkAndRowMutate to do many checkAndPuts at a time on a single row.
    
    Parameters:
    
    row - to check
    
    family - column family to check
    
    qualifier - column qualifier to check
    
    op - the comparison operator
    
    comparator - the expected value
    
    mutation - data to put if check succeeds
    
    Returns:
    
    true if mutation was applied, false otherwise
    
    Throws:
    
    IOException
  - checkAndMutate
```
boolean checkAndMutate(byte[] row,
                       byte[] family,
                       byte[] qualifier,
                       CompareOperator op,
                       ByteArrayComparable comparator,
                       TimeRange timeRange,
                       Mutation mutation)
                throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected value and if it does, it performs the mutation. If the passed value is null, the lack of column value (ie: non-existence) is used. See checkAndRowMutate to do many checkAndPuts at a time on a single row.
    
    Parameters:
    
    row - to check
    
    family - column family to check
    
    qualifier - column qualifier to check
    
    op - the comparison operator
    
    comparator - the expected value
    
    mutation - data to put if check succeeds
    
    timeRange - time range to check
    
    Returns:
    
    true if mutation was applied, false otherwise
    
    Throws:
    
    IOException
  - checkAndRowMutate
```
default boolean checkAndRowMutate(byte[] row,
                                  byte[] family,
                                  byte[] qualifier,
                                  CompareOperator op,
                                  ByteArrayComparable comparator,
                                  RowMutations mutations)
                           throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected values and if it does, it performs the row mutations. If the passed value is null, the lack of column value (ie: non-existence) is used. Use to do many mutations on a single row. Use checkAndMutate to do one checkAndMutate at a time.
    
    Parameters:
    
    row - to check
    
    family - column family to check
    
    qualifier - column qualifier to check
    
    op - the comparison operator
    
    comparator - the expected value
    
    mutations - data to put if check succeeds
    
    Returns:
    
    true if mutations were applied, false otherwise
    
    Throws:
    
    IOException
  - checkAndRowMutate
```
boolean checkAndRowMutate(byte[] row,
                          byte[] family,
                          byte[] qualifier,
                          CompareOperator op,
                          ByteArrayComparable comparator,
                          TimeRange timeRange,
                          RowMutations mutations)
                   throws IOException
```
    Atomically checks if a row/family/qualifier value matches the expected values and if it does, it performs the row mutations. If the passed value is null, the lack of column value (ie: non-existence) is used. Use to do many mutations on a single row. Use checkAndMutate to do one checkAndMutate at a time.
    
    Parameters:
    
    row - to check
    
    family - column family to check
    
    qualifier - column qualifier to check
    
    op - the comparison operator
    
    comparator - the expected value
    
    mutations - data to put if check succeeds
    
    timeRange - time range to check
    
    Returns:
    
    true if mutations were applied, false otherwise
    
    Throws:
    
    IOException
  - delete
```
void delete(Delete delete)
     throws IOException
```
    Deletes the specified cells/row.
    
    Parameters:
    
    delete -
    
    Throws:
    
    IOException
  - get
```
Result get(Get get)
    throws IOException
```
    Do a get based on the get parameter.
    
    Parameters:
    
    get - query parameters
    
    Returns:
    
    result of the operation
    
    Throws:
    
    IOException
  - get
```
List<Cell> get(Get get,
               boolean withCoprocessor)
        throws IOException
```
    Do a get based on the get parameter.
    
    Parameters:
    
    get - query parameters
    
    withCoprocessor - invoke coprocessor or not. We don't want to always invoke cp.
    
    Returns:
    
    list of cells resulting from the operation
    
    Throws:
    
    IOException
  - getScanner
```
RegionScanner getScanner(Scan scan)
                  throws IOException
```
    Return an iterator that scans over the HRegion, returning the indicated columns and rows specified by the Scan.
    This Iterator must be closed by the caller.
    
    Parameters:
    
    scan - configured Scan
    
    Returns:
    
    RegionScanner
    
    Throws:
    
    IOException - read exceptions
  - getScanner
```
RegionScanner getScanner(Scan scan,
                         List<KeyValueScanner> additionalScanners)
                  throws IOException
```
    Return an iterator that scans over the HRegion, returning the indicated columns and rows specified by the Scan. The scanner will also include the additional scanners passed along with the scanners for the specified Scan instance. Should be careful with the usage to pass additional scanners only within this Region
    This Iterator must be closed by the caller.
    
    Parameters:
    
    scan - configured Scan
    
    additionalScanners - Any additional scanners to be used
    
    Returns:
    
    RegionScanner
    
    Throws:
    
    IOException - read exceptions
  - getCellComparator
```
CellComparator getCellComparator()
```
    The comparator to be used with the region
  - increment
```
Result increment(Increment increment)
          throws IOException
```
    Perform one or more increment operations on a row.
    
    Parameters:
    
    increment -
    
    Returns:
    
    result of the operation
    
    Throws:
    
    IOException
  - mutateRow
```
void mutateRow(RowMutations mutations)
        throws IOException
```
    Performs multiple mutations atomically on a single row. Currently Put and Delete are supported.
    
    Parameters:
    
    mutations - object that specifies the set of mutations to perform atomically
    
    Throws:
    
    IOException
  - mutateRowsWithLocks
```
void mutateRowsWithLocks(Collection<Mutation> mutations,
                         Collection<byte[]> rowsToLock,
                         long nonceGroup,
                         long nonce)
                  throws IOException
```
    Perform atomic mutations within the region.
    
    Parameters:
    
    mutations - The list of mutations to perform. mutations can contain operations for multiple rows. Caller has to ensure that all rows are contained in this region.
    
    rowsToLock - Rows to lock
    
    nonceGroup - Optional nonce group of the operation (client Id)
    
    nonce - Optional nonce of the operation (unique random id to ensure "more idempotence") If multiple rows are locked care should be taken that rowsToLock is sorted in order to avoid deadlocks.
    
    Throws:
    
    IOException
  - processRowsWithLocks
```
@Deprecated
void processRowsWithLocks(RowProcessor<?,?> processor)
                               throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use Coprocessors instead.
    
    Performs atomic multiple reads and writes on a given row.
    
    Parameters:
    
    processor - The object defines the reads and writes to a row.
    
    Throws:
    
    IOException
  - processRowsWithLocks
```
@Deprecated
void processRowsWithLocks(RowProcessor<?,?> processor,
                                      long nonceGroup,
                                      long nonce)
                               throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use Coprocessors instead.
    
    Performs atomic multiple reads and writes on a given row.
    
    Parameters:
    
    processor - The object defines the reads and writes to a row.
    
    nonceGroup - Optional nonce group of the operation (client Id)
    
    nonce - Optional nonce of the operation (unique random id to ensure "more idempotence")
    
    Throws:
    
    IOException
  - processRowsWithLocks
```
@Deprecated
void processRowsWithLocks(RowProcessor<?,?> processor,
                                      long timeout,
                                      long nonceGroup,
                                      long nonce)
                               throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use Coprocessors instead.
    
    Performs atomic multiple reads and writes on a given row.
    
    Parameters:
    
    processor - The object defines the reads and writes to a row.
    
    timeout - The timeout of the processor.process() execution Use a negative number to switch off the time bound
    
    nonceGroup - Optional nonce group of the operation (client Id)
    
    nonce - Optional nonce of the operation (unique random id to ensure "more idempotence")
    
    Throws:
    
    IOException
  - put
```
void put(Put put)
  throws IOException
```
    Puts some data in the table.
    
    Parameters:
    
    put -
    
    Throws:
    
    IOException
  - getCompactionState
```
CompactionState getCompactionState()
```
    Returns:
    
    if a given region is in compaction now.
  - requestCompaction
```
void requestCompaction(String why,
                       int priority,
                       boolean major,
                       CompactionLifeCycleTracker tracker)
                throws IOException
```
    Request compaction on this region.
    
    Throws:
    
    IOException
  - requestCompaction
```
void requestCompaction(byte[] family,
                       String why,
                       int priority,
                       boolean major,
                       CompactionLifeCycleTracker tracker)
                throws IOException
```
    Request compaction for the given family
    
    Throws:
    
    IOException
  - requestFlush
```
void requestFlush(FlushLifeCycleTracker tracker)
           throws IOException
```
    Request flush on this region.
    
    Throws:
    
    IOException
  - waitForFlushes
```
boolean waitForFlushes(long timeout)
```
    Wait for all current flushes of the region to complete
    
    Parameters:
    
    timeout - The maximum time to wait in milliseconds.
    
    Returns:
    
    False when timeout elapsed but flushes are not over. True when flushes are over within max wait time period.

Interface Region

Nested Class Summary

Method Summary

Methods inherited from interface org.apache.hadoop.hbase.conf.ConfigurationObserver

Method Detail

getRegionInfo

getTableDescriptor

isAvailable

isClosed

isClosing

isReadOnly

isSplittable

isMergeable

getStores

getStore

getStoreFileList

refreshStoreFiles

getMaxFlushedSeqId

getOldestHfileTs

getMaxStoreSeqId

getEarliestFlushTimeForAllStores

getReadRequestsCount

getFilteredReadRequestsCount

getWriteRequestsCount

getMemStoreDataSize

getMemStoreHeapSize

getMemStoreOffHeapSize

getNumMutationsWithoutWAL

getDataInMemoryWithoutWAL

getBlockedRequestsCount

getCheckAndMutateChecksPassed

getCheckAndMutateChecksFailed

startRegionOperation

startRegionOperation

closeRegionOperation

closeRegionOperation

getRowLock

append

batchMutate

checkAndMutate

checkAndMutate

checkAndRowMutate

checkAndRowMutate

delete

get

get

getScanner

getScanner

getCellComparator

increment

mutateRow

mutateRowsWithLocks

processRowsWithLocks

processRowsWithLocks

processRowsWithLocks

put

getCompactionState

requestCompaction

requestCompaction

requestFlush

waitForFlushes