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.
+
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.
+
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
+
Create a table with the specified column families. The name
+field for each ColumnDescriptor must be set and must end in a
+colon (:). All other fields are optional and will get default
+values if not explicitly specified.
+
+@throws IllegalArgument if an input parameter is invalid
+
+@throws AlreadyExists if the table name already exists
+
Get a single TCell for the specified table, row, and column at the
+latest timestamp. Returns an empty list if no such value exists.
+
+@return value for specified row/column
+
Parameters
+
Name
Description
+
tableName
name of table
+
row
row key
+
column
column name
+
+
Function: Hbase.getVer
+
list<TCell> getVer(Text tableName,
+ Text row,
+ Text column,
+ i32 numVersions)
+ throws IOError
+
Get the specified number of versions for the specified table,
+row, and column.
+
+@return list of cells for specified row/column
+
Parameters
+
Name
Description
+
tableName
name of table
+
row
row key
+
column
column name
+
numVersions
number of versions to retrieve
+
+
Function: Hbase.getVerTs
+
list<TCell> getVerTs(Text tableName,
+ Text row,
+ Text column,
+ i64 timestamp,
+ i32 numVersions)
+ throws IOError
+
Get the specified number of versions for the specified table,
+row, and column. Only versions less than or equal to the specified
+timestamp will be returned.
+
+@return list of cells for specified row/column
+
Get all the data for the specified table and row at the latest
+timestamp. Returns an empty list if the row does not exist.
+
+@return TRowResult containing the row and map of columns to TCells
+
Get the specified columns for the specified table and row at the latest
+timestamp. Returns an empty list if the row does not exist.
+
+@return TRowResult containing the row and map of columns to TCells
+
Get all the data for the specified table and row at the specified
+timestamp. Returns an empty list if the row does not exist.
+
+@return TRowResult containing the row and map of columns to TCells
+
Get the specified columns for the specified table and row at the specified
+timestamp. Returns an empty list if the row does not exist.
+
+@return TRowResult containing the row and map of columns to TCells
+
Apply a series of mutations (updates/deletes) to a row in a
+single transaction. If an exception is thrown, then the
+transaction is aborted. Default current timestamp is used, and
+all entries will have an identical timestamp.
+
Apply a series of mutations (updates/deletes) to a row in a
+single transaction. If an exception is thrown, then the
+transaction is aborted. The specified timestamp is used, and
+all entries will have an identical timestamp.
+
Apply a series of batches (each a series of mutations on a single row)
+in a single transaction. If an exception is thrown, then the
+transaction is aborted. Default current timestamp is used, and
+all entries will have an identical timestamp.
+
Apply a series of batches (each a series of mutations on a single row)
+in a single transaction. If an exception is thrown, then the
+transaction is aborted. The specified timestamp is used, and
+all entries will have an identical timestamp.
+
Get a scanner on the current table starting at the specified row and
+ending at the last row in the table. Return the specified columns.
+
+@return scanner id to be used with other scanner procedures
+
Parameters
+
Name
Description
+
tableName
name of table
+
startRow
Starting row in table to scan.
+Send "" (empty string) to start at the first row.
+
columns
columns to scan. If column name is a column family, all
+columns of the specified column family are returned. It's also possible
+to pass a regex in the column qualifier.
+
Get a scanner on the current table starting and stopping at the
+specified rows. ending at the last row in the table. Return the
+specified columns.
+
+@return scanner id to be used with other scanner procedures
+
Parameters
+
Name
Description
+
tableName
name of table
+
startRow
Starting row in table to scan.
+Send "" (empty string) to start at the first row.
+
stopRow
row to stop scanning on. This row is *not* included in the
+scanner's results
+
columns
columns to scan. If column name is a column family, all
+columns of the specified column family are returned. It's also possible
+to pass a regex in the column qualifier.
+
Open a scanner for a given prefix. That is all rows will have the specified
+prefix. No other rows will be returned.
+
+@return scanner id to use with other scanner calls
+
Parameters
+
Name
Description
+
tableName
name of table
+
startAndPrefix
the prefix (and thus start row) of the keys you want
+
Get a scanner on the current table starting at the specified row and
+ending at the last row in the table. Return the specified columns.
+Only values with the specified timestamp are returned.
+
+@return scanner id to be used with other scanner procedures
+
Parameters
+
Name
Description
+
tableName
name of table
+
startRow
Starting row in table to scan.
+Send "" (empty string) to start at the first row.
+
columns
columns to scan. If column name is a column family, all
+columns of the specified column family are returned. It's also possible
+to pass a regex in the column qualifier.
+
timestamp
timestamp
+
+
Function: Hbase.scannerOpenWithStopTs
+
ScannerID scannerOpenWithStopTs(Text tableName,
+ Text startRow,
+ Text stopRow,
+ list<Text> columns,
+ i64 timestamp)
+ throws IOError
+
Get a scanner on the current table starting and stopping at the
+specified rows. ending at the last row in the table. Return the
+specified columns. Only values with the specified timestamp are
+returned.
+
+@return scanner id to be used with other scanner procedures
+
Parameters
+
Name
Description
+
tableName
name of table
+
startRow
Starting row in table to scan.
+Send "" (empty string) to start at the first row.
+
stopRow
row to stop scanning on. This row is *not* included in the
+scanner's results
+
columns
columns to scan. If column name is a column family, all
+columns of the specified column family are returned. It's also possible
+to pass a regex in the column qualifier.
+
Returns the scanner's current row value and advances to the next
+row in the table. When there are no more rows in the table, or a key
+greater-than-or-equal-to the scanner's specified stopRow is reached,
+an empty list is returned.
+
+@return a TRowResult containing the current row and a map of the columns to TCells.
+
+@throws IllegalArgument if ScannerID is invalid
+
+@throws NotFound when the scanner reaches the end
+
Returns, starting at the scanner's current row value nbRows worth of
+rows and advances to the next row in the table. When there are no more
+rows in the table, or a key greater-than-or-equal-to the scanner's
+specified stopRow is reached, an empty list is returned.
+
+@return a TRowResult containing the current row and a map of the columns to TCells.
+
+@throws IllegalArgument if ScannerID is invalid
+
+@throws NotFound when the scanner reaches the end
+
+
Index: src/java/org/apache/hadoop/hbase/thrift/doc-files/style.css
===================================================================
--- src/java/org/apache/hadoop/hbase/thrift/doc-files/style.css (revision 0)
+++ src/java/org/apache/hadoop/hbase/thrift/doc-files/style.css (revision 0)
@@ -0,0 +1,10 @@
+/* Auto-generated CSS for generated Thrift docs */
+body { font-family: Tahoma, sans-serif; }
+pre { background-color: #dddddd; padding: 6px; }
+h3,h4 { padding-top: 0px; margin-top: 0px; }
+div.definition { border: 1px solid gray; margin: 10px; padding: 10px; }
+div.extends { margin: -0.5em 0 1em 5em }
+table { border: 1px solid grey; border-collapse: collapse; }
+td { border: 1px solid grey; padding: 1px 6px; vertical-align: top; }
+th { border: 1px solid black; background-color: #bbbbbb;
+ text-align: left; padding: 1px 6px; }
Index: src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift
===================================================================
--- src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift (revision 901964)
+++ src/java/org/apache/hadoop/hbase/thrift/Hbase.thrift (working copy)
@@ -182,6 +182,7 @@
/**
* List all the userspace tables.
+ *
* @return returns a list of names
*/
list getTableNames()
@@ -189,6 +190,7 @@
/**
* List all the column families assoicated with a table.
+ *
* @return list of column family descriptors
*/
map getColumnDescriptors (
@@ -198,6 +200,7 @@
/**
* List the regions associated with a table.
+ *
* @return list of region descriptors
*/
list getTableRegions(
@@ -212,6 +215,7 @@
* values if not explicitly specified.
*
* @throws IllegalArgument if an input parameter is invalid
+ *
* @throws AlreadyExists if the table name already exists
*/
void createTable(
@@ -645,7 +649,9 @@
* an empty list is returned.
*
* @return a TRowResult containing the current row and a map of the columns to TCells.
+ *
* @throws IllegalArgument if ScannerID is invalid
+ *
* @throws NotFound when the scanner reaches the end
*/
list scannerGet(
@@ -660,7 +666,9 @@
* specified stopRow is reached, an empty list is returned.
*
* @return a TRowResult containing the current row and a map of the columns to TCells.
+ *
* @throws IllegalArgument if ScannerID is invalid
+ *
* @throws NotFound when the scanner reaches the end
*/
list scannerGetList(
Index: src/java/org/apache/hadoop/hbase/thrift/package.html
===================================================================
--- src/java/org/apache/hadoop/hbase/thrift/package.html (revision 901964)
+++ src/java/org/apache/hadoop/hbase/thrift/package.html (working copy)
@@ -35,7 +35,7 @@
The Hbase API is defined in the
-file Hbase.thrift. A server-side implementation of the API is in
+file Hbase.thrift. A server-side implementation of the API is in
org.apache.hadoop.hbase.thrift.ThriftServer. The generated interfaces,
types, and RPC utility files are checked into SVN under the
org.apache.hadoop.hbase.thrift.generated directory.