Thrift module: Hbase

Module	Services	Data types	Constants
Hbase	Hbase atomicIncrement compact createTable deleteAll deleteAllRow deleteAllRowTs deleteAllTs deleteTable disableTable enableTable get getColumnDescriptors getRow getRowTs getRowWithColumns getRowWithColumnsTs getTableNames getTableRegions getVer getVerTs isTableEnabled majorCompact mutateRow mutateRowTs mutateRows mutateRowsTs scannerClose scannerGet scannerGetList scannerOpen scannerOpenTs scannerOpenWithPrefix scannerOpenWithStop scannerOpenWithStopTs	AlreadyExists BatchMutation Bytes ColumnDescriptor IOError IllegalArgument Mutation ScannerID TCell TRegionInfo TRowResult Text

Type declarations

Typedef: Text

Base type: string

Typedef: Bytes

Base type: string

Typedef: ScannerID

Base type: i32

Data structures

Struct: TCell

Field	Type	Description	Required	Default value
value	`Bytes`		yes
timestamp	`i64`		yes

TCell - Used to transport a cell value (byte[]) and the timestamp it was stored with together as a result for get and getRow methods. This promotes the timestamp of a cell to a first-class value, making it easy to take note of temporal data. Cell is used all the way from HStore up to HTable.

Struct: ColumnDescriptor

Field	Type	Required	Default value
name	`Text`	yes
maxVersions	`i32`	yes	3
compression	`string`	yes	"NONE"
inMemory	`bool`	yes	0
bloomFilterType	`string`	yes	"NONE"
bloomFilterVectorSize	`i32`	yes	0
bloomFilterNbHashes	`i32`	yes	0
blockCacheEnabled	`bool`	yes	0
timeToLive	`i32`	yes	-1

An HColumnDescriptor contains information about a column family such as the number of versions, compression settings, etc. It is used as input when creating a table or adding a column.

Struct: TRegionInfo

Field	Type	Required
startKey	`Text`	yes
endKey	`Text`	yes
id	`i64`	yes
name	`Text`	yes
version	`byte`	yes

A TRegionInfo contains information about an HTable region.

Struct: Mutation

Field	Type	Required	Default value
isDelete	`bool`	yes	0
column	`Text`	yes
value	`Text`	yes

A Mutation object is used to either update or delete a column-value.

Struct: BatchMutation

Field	Type	Description	Required	Default value
row	`Text`		yes
mutations	`list<Mutation>`		yes

A BatchMutation object is used to apply a number of Mutations to a single row.

Struct: TRowResult

Field	Type	Description	Required	Default value
row	`Text`		yes
columns	`map<Text, TCell>`		yes

Holds row name and then a map of columns to cells.

Exception: IOError

Field	Type	Description	Required	Default value
message	`string`		yes

An IOError exception signals that an error occurred communicating to the Hbase master or an Hbase region server. Also used to return more general Hbase error conditions.

Exception: IllegalArgument

Field	Type	Description	Required	Default value
message	`string`		yes

An IllegalArgument exception indicates an illegal or invalid argument was passed into a procedure.

Exception: AlreadyExists

Field	Type	Description	Required	Default value
message	`string`		yes

An AlreadyExists exceptions signals that a table with the specified name already exists

Services

Service: Hbase

Function: Hbase.enableTable

void enableTable(Bytes tableName)
    throws IOError

Brings a table on-line (enables it)

Parameters

Name	Description
tableName	name of the table

Function: Hbase.disableTable

void disableTable(Bytes tableName)
    throws IOError

Disables a table (takes it off-line) If it is being served, the master will tell the servers to stop serving it.

Parameters

Name	Description
tableName	name of the table

Function: Hbase.isTableEnabled

bool isTableEnabled(Bytes tableName)
    throws IOError

@return true if table is on-line

Parameters

Name	Description
tableName	name of the table to check

Function: Hbase.compact

void compact(Bytes tableNameOrRegionName)
    throws IOError

Parameters

Name	Description
tableNameOrRegionName

Function: Hbase.majorCompact

void majorCompact(Bytes tableNameOrRegionName)
    throws IOError

Parameters

Name	Description
tableNameOrRegionName

Function: Hbase.getTableNames

list<Text> getTableNames()
    throws IOError

List all the userspace tables.