org.apache.hadoop.hbase
Interface HRegionInterface

All Superinterfaces:

VersionedProtocol

All Known Implementing Classes:

HRegionServer

public interface HRegionInterface
extends VersionedProtocol

Clients interact with HRegionServers using a handle to the HRegionInterface.

Field Summary

static long

versionID initial version

Method Summary

void	batchUpdate(Text regionName, long timestamp, BatchUpdate b) Applies a batch of updates via one RPC
void	close(long scannerId) Close a scanner
void	deleteAll(Text regionName, Text row, Text column, long timestamp) Delete all cells that match the passed row and column and whose timestamp is equal-to or older than the passed timestamp.
byte[]	get(Text regionName, Text row, Text column) Retrieve a single value from the specified region for the specified row and column keys
byte[][]	get(Text regionName, Text row, Text column, int numVersions) Get the specified number of versions of the specified row and column
byte[][]	get(Text regionName, Text row, Text column, long timestamp, int numVersions) Get the specified number of versions of the specified row and column with the specified timestamp.
HRegionInfo	getRegionInfo(Text regionName) Get metainfo about an HRegion
MapWritable	getRow(Text regionName, Text row) Get all the data for the specified row
MapWritable	next(long scannerId) Get the next set of values
long	openScanner(Text regionName, Text[] columns, Text startRow, long timestamp, RowFilterInterface filter) Opens a remote scanner with a RowFilter.

Methods inherited from interface org.apache.hadoop.ipc.VersionedProtocol

getProtocolVersion

Field Detail

versionID

static final long versionID

initial version

See Also:

Constant Field Values

Method Detail

getRegionInfo

HRegionInfo getRegionInfo(Text regionName)
                          throws NotServingRegionException

Get metainfo about an HRegion

Parameters:

regionName - name of the region

Returns:

HRegionInfo object for region

Throws:

NotServingRegionException

get

byte[] get(Text regionName,
           Text row,
           Text column)
           throws IOException

Retrieve a single value from the specified region for the specified row and column keys

Parameters:

regionName - name of region

row - row key

column - column key

Returns:

alue for that region/row/column

Throws:

IOException

get

byte[][] get(Text regionName,
             Text row,
             Text column,
             int numVersions)
             throws IOException

Get the specified number of versions of the specified row and column

Parameters:

regionName - region name

row - row key

column - column key

numVersions - number of versions to return

Returns:

array of values

Throws:

IOException

get

byte[][] get(Text regionName,
             Text row,
             Text column,
             long timestamp,
             int numVersions)
             throws IOException

Get the specified number of versions of the specified row and column with the specified timestamp.

Parameters:

regionName - region name

row - row key

column - column key

timestamp - timestamp

numVersions - number of versions to return

Returns:

array of values

Throws:

IOException

getRow

MapWritable getRow(Text regionName,
                   Text row)
                   throws IOException

Get all the data for the specified row

Parameters:

regionName - region name

row - row key

Returns:

map of values

Throws:

IOException

batchUpdate

void batchUpdate(Text regionName,
                 long timestamp,
                 BatchUpdate b)
                 throws IOException

Applies a batch of updates via one RPC

Parameters:

regionName - name of the region to update

timestamp - the time to be associated with the changes

b - BatchUpdate

Throws:

IOException

deleteAll

void deleteAll(Text regionName,
               Text row,
               Text column,
               long timestamp)
               throws IOException

Delete all cells that match the passed row and column and whose timestamp is equal-to or older than the passed timestamp.

Parameters:

regionName - region name

row - row key

column - column key

timestamp - Delete all entries that have this timestamp or older

Throws:

IOException

openScanner

long openScanner(Text regionName,
                 Text[] columns,
                 Text startRow,
                 long timestamp,
                 RowFilterInterface filter)
                 throws IOException

Opens a remote scanner with a RowFilter.

Parameters:

regionName - name of region to scan

columns - columns to scan. If column name is a column family, all columns of the specified column family are returned. Its also possible to pass a regex for column family name. A column name is judged to be regex if it contains at least one of the following characters: \+|^&*$[]]}{)(.

startRow - starting row to scan

timestamp - only return values whose timestamp is <= this value

filter - RowFilter for filtering results at the row-level.

Returns:

scannerId scanner identifier used in other calls

Throws:

IOException

next

MapWritable next(long scannerId)
                 throws IOException

Get the next set of values

Parameters:

scannerId - clientId passed to openScanner

Returns:

map of values

Throws:

IOException

close

void close(long scannerId)
           throws IOException

Close a scanner

Parameters:

scannerId - the scanner id returned by openScanner

Throws:

IOException