org.apache.hadoop.hbase.thrift.generated

Interface Hbase.Iface

All Known Implementing Classes:

Hbase.Client, ThriftServerRunner.HBaseHandler

Enclosing class:

Hbase

public static interface Hbase.Iface

Method Summary

Methods

Modifier and Type	Method and Description
List<TCell>	append(TAppend append) Appends values to one or more columns within a single row.
long	atomicIncrement(ByteBuffer tableName, ByteBuffer row, ByteBuffer column, long value) Atomically increment the column value specified.
boolean	checkAndPut(ByteBuffer tableName, ByteBuffer row, ByteBuffer column, ByteBuffer value, Mutation mput, Map<ByteBuffer,ByteBuffer> attributes) Atomically checks if a row/family/qualifier value matches the expected value.
void	compact(ByteBuffer tableNameOrRegionName)
void	createTable(ByteBuffer tableName, List<ColumnDescriptor> columnFamilies) Create a table with the specified column families.
void	deleteAll(ByteBuffer tableName, ByteBuffer row, ByteBuffer column, Map<ByteBuffer,ByteBuffer> attributes) Delete all cells that match the passed row and column.
void	deleteAllRow(ByteBuffer tableName, ByteBuffer row, Map<ByteBuffer,ByteBuffer> attributes) Completely delete the row's cells.
void	deleteAllRowTs(ByteBuffer tableName, ByteBuffer row, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Completely delete the row's cells marked with a timestamp equal-to or older than the passed timestamp.
void	deleteAllTs(ByteBuffer tableName, ByteBuffer row, ByteBuffer column, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Delete all cells that match the passed row and column and whose timestamp is equal-to or older than the passed timestamp.
void	deleteTable(ByteBuffer tableName) Deletes a table
void	disableTable(ByteBuffer tableName) Disables a table (takes it off-line) If it is being served, the master will tell the servers to stop serving it.
void	enableTable(ByteBuffer tableName) Brings a table on-line (enables it)
List<TCell>	get(ByteBuffer tableName, ByteBuffer row, ByteBuffer column, Map<ByteBuffer,ByteBuffer> attributes) Get a single TCell for the specified table, row, and column at the latest timestamp.
Map<ByteBuffer,ColumnDescriptor>	getColumnDescriptors(ByteBuffer tableName) List all the column families assoicated with a table.
TRegionInfo	getRegionInfo(ByteBuffer row) Get the regininfo for the specified row.
List<TRowResult>	getRow(ByteBuffer tableName, ByteBuffer row, Map<ByteBuffer,ByteBuffer> attributes) Get all the data for the specified table and row at the latest timestamp.
List<TCell>	getRowOrBefore(ByteBuffer tableName, ByteBuffer row, ByteBuffer family) Get the row just before the specified one.
List<TRowResult>	getRows(ByteBuffer tableName, List<ByteBuffer> rows, Map<ByteBuffer,ByteBuffer> attributes) Get all the data for the specified table and rows at the latest timestamp.
List<TRowResult>	getRowsTs(ByteBuffer tableName, List<ByteBuffer> rows, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Get all the data for the specified table and rows at the specified timestamp.
List<TRowResult>	getRowsWithColumns(ByteBuffer tableName, List<ByteBuffer> rows, List<ByteBuffer> columns, Map<ByteBuffer,ByteBuffer> attributes) Get the specified columns for the specified table and rows at the latest timestamp.
List<TRowResult>	getRowsWithColumnsTs(ByteBuffer tableName, List<ByteBuffer> rows, List<ByteBuffer> columns, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Get the specified columns for the specified table and rows at the specified timestamp.
List<TRowResult>	getRowTs(ByteBuffer tableName, ByteBuffer row, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Get all the data for the specified table and row at the specified timestamp.
List<TRowResult>	getRowWithColumns(ByteBuffer tableName, ByteBuffer row, List<ByteBuffer> columns, Map<ByteBuffer,ByteBuffer> attributes) Get the specified columns for the specified table and row at the latest timestamp.
List<TRowResult>	getRowWithColumnsTs(ByteBuffer tableName, ByteBuffer row, List<ByteBuffer> columns, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Get the specified columns for the specified table and row at the specified timestamp.
List<ByteBuffer>	getTableNames() List all the userspace tables.
List<TRegionInfo>	getTableRegions(ByteBuffer tableName) List the regions associated with a table.
List<TCell>	getVer(ByteBuffer tableName, ByteBuffer row, ByteBuffer column, int numVersions, Map<ByteBuffer,ByteBuffer> attributes) Get the specified number of versions for the specified table, row, and column.
List<TCell>	getVerTs(ByteBuffer tableName, ByteBuffer row, ByteBuffer column, long timestamp, int numVersions, Map<ByteBuffer,ByteBuffer> attributes) Get the specified number of versions for the specified table, row, and column.
void	increment(TIncrement increment) Increment a cell by the ammount.
void	incrementRows(List<TIncrement> increments)
boolean	isTableEnabled(ByteBuffer tableName)
void	majorCompact(ByteBuffer tableNameOrRegionName)
void	mutateRow(ByteBuffer tableName, ByteBuffer row, List<Mutation> mutations, Map<ByteBuffer,ByteBuffer> attributes) Apply a series of mutations (updates/deletes) to a row in a single transaction.
void	mutateRows(ByteBuffer tableName, List<BatchMutation> rowBatches, Map<ByteBuffer,ByteBuffer> attributes) Apply a series of batches (each a series of mutations on a single row) in a single transaction.
void	mutateRowsTs(ByteBuffer tableName, List<BatchMutation> rowBatches, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Apply a series of batches (each a series of mutations on a single row) in a single transaction.
void	mutateRowTs(ByteBuffer tableName, ByteBuffer row, List<Mutation> mutations, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Apply a series of mutations (updates/deletes) to a row in a single transaction.
void	scannerClose(int id) Closes the server-state associated with an open scanner.
List<TRowResult>	scannerGet(int id) Returns the scanner's current row value and advances to the next row in the table.
List<TRowResult>	scannerGetList(int id, int nbRows) Returns, starting at the scanner's current row value nbRows worth of rows and advances to the next row in the table.
int	scannerOpen(ByteBuffer tableName, ByteBuffer startRow, List<ByteBuffer> columns, Map<ByteBuffer,ByteBuffer> attributes) Get a scanner on the current table starting at the specified row and ending at the last row in the table.
int	scannerOpenTs(ByteBuffer tableName, ByteBuffer startRow, List<ByteBuffer> columns, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Get a scanner on the current table starting at the specified row and ending at the last row in the table.
int	scannerOpenWithPrefix(ByteBuffer tableName, ByteBuffer startAndPrefix, List<ByteBuffer> columns, Map<ByteBuffer,ByteBuffer> attributes) Open a scanner for a given prefix.
int	scannerOpenWithScan(ByteBuffer tableName, TScan scan, Map<ByteBuffer,ByteBuffer> attributes) Get a scanner on the current table, using the Scan instance for the scan parameters.
int	scannerOpenWithStop(ByteBuffer tableName, ByteBuffer startRow, ByteBuffer stopRow, List<ByteBuffer> columns, Map<ByteBuffer,ByteBuffer> attributes) Get a scanner on the current table starting and stopping at the specified rows.
int	scannerOpenWithStopTs(ByteBuffer tableName, ByteBuffer startRow, ByteBuffer stopRow, List<ByteBuffer> columns, long timestamp, Map<ByteBuffer,ByteBuffer> attributes) Get a scanner on the current table starting and stopping at the specified rows.

Method Detail

enableTable

void enableTable(ByteBuffer tableName)
                 throws IOError,
                        org.apache.thrift.TException

Brings a table on-line (enables it)

Parameters:

tableName - name of the table

Throws:

IOError

org.apache.thrift.TException

disableTable

void disableTable(ByteBuffer tableName)
                  throws IOError,
                         org.apache.thrift.TException

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

Parameters:

tableName - name of the table

Throws:

IOError

org.apache.thrift.TException

isTableEnabled

boolean isTableEnabled(ByteBuffer tableName)
                       throws IOError,
                              org.apache.thrift.TException

Parameters:

tableName - name of the table to check

Returns:

true if table is on-line

Throws:

IOError

org.apache.thrift.TException

compact

void compact(ByteBuffer tableNameOrRegionName)
             throws IOError,
                    org.apache.thrift.TException

Throws:

IOError

org.apache.thrift.TException

majorCompact

void majorCompact(ByteBuffer tableNameOrRegionName)
                  throws IOError,
                         org.apache.thrift.TException

Throws:

IOError

org.apache.thrift.TException

getTableNames

List<ByteBuffer> getTableNames()
                               throws IOError,
                                      org.apache.thrift.TException

List all the userspace tables.

Returns:

returns a list of names

Throws:

IOError

org.apache.thrift.TException

getColumnDescriptors

Map<ByteBuffer,ColumnDescriptor> getColumnDescriptors(ByteBuffer tableName)
                                                      throws IOError,
                                                             org.apache.thrift.TException

List all the column families assoicated with a table.

Parameters:

tableName - table name

Returns:

list of column family descriptors

Throws:

IOError

org.apache.thrift.TException

getTableRegions

List<TRegionInfo> getTableRegions(ByteBuffer tableName)
                                  throws IOError,
                                         org.apache.thrift.TException

List the regions associated with a table.

Parameters:

tableName - table name

Returns:

list of region descriptors

Throws:

IOError

org.apache.thrift.TException

createTable

void createTable(ByteBuffer tableName,
               List<ColumnDescriptor> columnFamilies)
                 throws IOError,
                        IllegalArgument,
                        AlreadyExists,
                        org.apache.thrift.TException

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.

Parameters:

tableName - name of table to create

columnFamilies - list of column family descriptors

Throws:

IllegalArgument - if an input parameter is invalid

AlreadyExists - if the table name already exists

IOError

org.apache.thrift.TException

deleteTable

void deleteTable(ByteBuffer tableName)
                 throws IOError,
                        org.apache.thrift.TException

Deletes a table

Parameters:

tableName - name of table to delete

Throws:

IOError - if table doesn't exist on server or there was some other problem

org.apache.thrift.TException

get

List<TCell> get(ByteBuffer tableName,
              ByteBuffer row,
              ByteBuffer column,
              Map<ByteBuffer,ByteBuffer> attributes)
                throws IOError,
                       org.apache.thrift.TException

Get a single TCell for the specified table, row, and column at the latest timestamp. Returns an empty list if no such value exists.

Parameters:

tableName - name of table

row - row key

column - column name

attributes - Get attributes

Returns:

value for specified row/column

Throws:

IOError

org.apache.thrift.TException

getVer

List<TCell> getVer(ByteBuffer tableName,
                 ByteBuffer row,
                 ByteBuffer column,
                 int numVersions,
                 Map<ByteBuffer,ByteBuffer> attributes)
                   throws IOError,
                          org.apache.thrift.TException

Get the specified number of versions for the specified table, row, and column.

Parameters:

tableName - name of table

row - row key

column - column name

numVersions - number of versions to retrieve

attributes - Get attributes

Returns:

list of cells for specified row/column

Throws:

IOError

org.apache.thrift.TException

getVerTs

List<TCell> getVerTs(ByteBuffer tableName,
                   ByteBuffer row,
                   ByteBuffer column,
                   long timestamp,
                   int numVersions,
                   Map<ByteBuffer,ByteBuffer> attributes)
                     throws IOError,
                            org.apache.thrift.TException

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.

Parameters:

tableName - name of table

row - row key

column - column name

timestamp - timestamp

numVersions - number of versions to retrieve

attributes - Get attributes

Returns:

list of cells for specified row/column

Throws:

IOError

org.apache.thrift.TException

getRow

List<TRowResult> getRow(ByteBuffer tableName,
                      ByteBuffer row,
                      Map<ByteBuffer,ByteBuffer> attributes)
                        throws IOError,
                               org.apache.thrift.TException

Get all the data for the specified table and row at the latest timestamp. Returns an empty list if the row does not exist.

Parameters:

tableName - name of table

row - row key

attributes - Get attributes

Returns:

TRowResult containing the row and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

getRowWithColumns

List<TRowResult> getRowWithColumns(ByteBuffer tableName,
                                 ByteBuffer row,
                                 List<ByteBuffer> columns,
                                 Map<ByteBuffer,ByteBuffer> attributes)
                                   throws IOError,
                                          org.apache.thrift.TException

Get the specified columns for the specified table and row at the latest timestamp. Returns an empty list if the row does not exist.

Parameters:

tableName - name of table

row - row key

columns - List of columns to return, null for all columns

attributes - Get attributes

Returns:

TRowResult containing the row and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

getRowTs

List<TRowResult> getRowTs(ByteBuffer tableName,
                        ByteBuffer row,
                        long timestamp,
                        Map<ByteBuffer,ByteBuffer> attributes)
                          throws IOError,
                                 org.apache.thrift.TException

Get all the data for the specified table and row at the specified timestamp. Returns an empty list if the row does not exist.

Parameters:

tableName - name of the table

row - row key

timestamp - timestamp

attributes - Get attributes

Returns:

TRowResult containing the row and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

getRowWithColumnsTs

List<TRowResult> getRowWithColumnsTs(ByteBuffer tableName,
                                   ByteBuffer row,
                                   List<ByteBuffer> columns,
                                   long timestamp,
                                   Map<ByteBuffer,ByteBuffer> attributes)
                                     throws IOError,
                                            org.apache.thrift.TException

Get the specified columns for the specified table and row at the specified timestamp. Returns an empty list if the row does not exist.

Parameters:

tableName - name of table

row - row key

columns - List of columns to return, null for all columns

timestamp -

attributes - Get attributes

Returns:

TRowResult containing the row and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

getRows

List<TRowResult> getRows(ByteBuffer tableName,
                       List<ByteBuffer> rows,
                       Map<ByteBuffer,ByteBuffer> attributes)
                         throws IOError,
                                org.apache.thrift.TException

Get all the data for the specified table and rows at the latest timestamp. Returns an empty list if no rows exist.

Parameters:

tableName - name of table

rows - row keys

attributes - Get attributes

Returns:

TRowResult containing the rows and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

getRowsWithColumns

List<TRowResult> getRowsWithColumns(ByteBuffer tableName,
                                  List<ByteBuffer> rows,
                                  List<ByteBuffer> columns,
                                  Map<ByteBuffer,ByteBuffer> attributes)
                                    throws IOError,
                                           org.apache.thrift.TException

Get the specified columns for the specified table and rows at the latest timestamp. Returns an empty list if no rows exist.

Parameters:

tableName - name of table

rows - row keys

columns - List of columns to return, null for all columns

attributes - Get attributes

Returns:

TRowResult containing the rows and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

getRowsTs

List<TRowResult> getRowsTs(ByteBuffer tableName,
                         List<ByteBuffer> rows,
                         long timestamp,
                         Map<ByteBuffer,ByteBuffer> attributes)
                           throws IOError,
                                  org.apache.thrift.TException

Get all the data for the specified table and rows at the specified timestamp. Returns an empty list if no rows exist.

Parameters:

tableName - name of the table

rows - row keys

timestamp - timestamp

attributes - Get attributes

Returns:

TRowResult containing the rows and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

getRowsWithColumnsTs

List<TRowResult> getRowsWithColumnsTs(ByteBuffer tableName,
                                    List<ByteBuffer> rows,
                                    List<ByteBuffer> columns,
                                    long timestamp,
                                    Map<ByteBuffer,ByteBuffer> attributes)
                                      throws IOError,
                                             org.apache.thrift.TException

Get the specified columns for the specified table and rows at the specified timestamp. Returns an empty list if no rows exist.

Parameters:

tableName - name of table

rows - row keys

columns - List of columns to return, null for all columns

timestamp -

attributes - Get attributes

Returns:

TRowResult containing the rows and map of columns to TCells

Throws:

IOError

org.apache.thrift.TException

mutateRow

void mutateRow(ByteBuffer tableName,
             ByteBuffer row,
             List<Mutation> mutations,
             Map<ByteBuffer,ByteBuffer> attributes)
               throws IOError,
                      IllegalArgument,
                      org.apache.thrift.TException

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.

Parameters:

tableName - name of table

row - row key

mutations - list of mutation commands

attributes - Mutation attributes

Throws:

IOError

IllegalArgument

org.apache.thrift.TException

mutateRowTs

void mutateRowTs(ByteBuffer tableName,
               ByteBuffer row,
               List<Mutation> mutations,
               long timestamp,
               Map<ByteBuffer,ByteBuffer> attributes)
                 throws IOError,
                        IllegalArgument,
                        org.apache.thrift.TException

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.

Parameters:

tableName - name of table

row - row key

mutations - list of mutation commands

timestamp - timestamp

attributes - Mutation attributes

Throws:

IOError

IllegalArgument

org.apache.thrift.TException

mutateRows

void mutateRows(ByteBuffer tableName,
              List<BatchMutation> rowBatches,
              Map<ByteBuffer,ByteBuffer> attributes)
                throws IOError,
                       IllegalArgument,
                       org.apache.thrift.TException

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.

Parameters:

tableName - name of table

rowBatches - list of row batches

attributes - Mutation attributes

Throws:

IOError

IllegalArgument

org.apache.thrift.TException

mutateRowsTs

void mutateRowsTs(ByteBuffer tableName,
                List<BatchMutation> rowBatches,
                long timestamp,
                Map<ByteBuffer,ByteBuffer> attributes)
                  throws IOError,
                         IllegalArgument,
                         org.apache.thrift.TException

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.

Parameters:

tableName - name of table

rowBatches - list of row batches

timestamp - timestamp

attributes - Mutation attributes

Throws:

IOError

IllegalArgument

org.apache.thrift.TException

atomicIncrement

long atomicIncrement(ByteBuffer tableName,
                   ByteBuffer row,
                   ByteBuffer column,
                   long value)
                     throws IOError,
                            IllegalArgument,
                            org.apache.thrift.TException

Atomically increment the column value specified. Returns the next value post increment.

Parameters:

tableName - name of table

row - row to increment

column - name of column

value - amount to increment by

Throws:

IOError

IllegalArgument

org.apache.thrift.TException

deleteAll

void deleteAll(ByteBuffer tableName,
             ByteBuffer row,
             ByteBuffer column,
             Map<ByteBuffer,ByteBuffer> attributes)
               throws IOError,
                      org.apache.thrift.TException

Delete all cells that match the passed row and column.

Parameters:

tableName - name of table

row - Row to update

column - name of column whose value is to be deleted

attributes - Delete attributes

Throws:

IOError

org.apache.thrift.TException

deleteAllTs

void deleteAllTs(ByteBuffer tableName,
               ByteBuffer row,
               ByteBuffer column,
               long timestamp,
               Map<ByteBuffer,ByteBuffer> attributes)
                 throws IOError,
                        org.apache.thrift.TException

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

Parameters:

tableName - name of table

row - Row to update

column - name of column whose value is to be deleted

timestamp - timestamp

attributes - Delete attributes

Throws:

IOError

org.apache.thrift.TException

deleteAllRow

void deleteAllRow(ByteBuffer tableName,
                ByteBuffer row,
                Map<ByteBuffer,ByteBuffer> attributes)
                  throws IOError,
                         org.apache.thrift.TException

Completely delete the row's cells.

Parameters:

tableName - name of table

row - key of the row to be completely deleted.

attributes - Delete attributes

Throws:

IOError

org.apache.thrift.TException

increment

void increment(TIncrement increment)
               throws IOError,
                      org.apache.thrift.TException

Increment a cell by the ammount. Increments can be applied async if hbase.regionserver.thrift.coalesceIncrement is set to true. False is the default. Turn to true if you need the extra performance and can accept some data loss if a thrift server dies with increments still in the queue.

Parameters:

increment - The single increment to apply

Throws:

IOError

org.apache.thrift.TException

incrementRows

void incrementRows(List<TIncrement> increments)
                   throws IOError,
                          org.apache.thrift.TException

Throws:

IOError

org.apache.thrift.TException

deleteAllRowTs

void deleteAllRowTs(ByteBuffer tableName,
                  ByteBuffer row,
                  long timestamp,
                  Map<ByteBuffer,ByteBuffer> attributes)
                    throws IOError,
                           org.apache.thrift.TException

Completely delete the row's cells marked with a timestamp equal-to or older than the passed timestamp.

Parameters:

tableName - name of table

row - key of the row to be completely deleted.

timestamp - timestamp

attributes - Delete attributes

Throws:

IOError

org.apache.thrift.TException

scannerOpenWithScan

int scannerOpenWithScan(ByteBuffer tableName,
                      TScan scan,
                      Map<ByteBuffer,ByteBuffer> attributes)
                        throws IOError,
                               org.apache.thrift.TException

Get a scanner on the current table, using the Scan instance for the scan parameters.

Parameters:

tableName - name of table

scan - Scan instance

attributes - Scan attributes

Throws:

IOError

org.apache.thrift.TException

scannerOpen

int scannerOpen(ByteBuffer tableName,
              ByteBuffer startRow,
              List<ByteBuffer> columns,
              Map<ByteBuffer,ByteBuffer> attributes)
                throws IOError,
                       org.apache.thrift.TException

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.

Parameters:

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.

attributes - Scan attributes

Returns:

scanner id to be used with other scanner procedures

Throws:

IOError

org.apache.thrift.TException

scannerOpenWithStop

int scannerOpenWithStop(ByteBuffer tableName,
                      ByteBuffer startRow,
                      ByteBuffer stopRow,
                      List<ByteBuffer> columns,
                      Map<ByteBuffer,ByteBuffer> attributes)
                        throws IOError,
                               org.apache.thrift.TException

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.

Parameters:

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.

attributes - Scan attributes

Returns:

scanner id to be used with other scanner procedures

Throws:

IOError

org.apache.thrift.TException

scannerOpenWithPrefix

int scannerOpenWithPrefix(ByteBuffer tableName,
                        ByteBuffer startAndPrefix,
                        List<ByteBuffer> columns,
                        Map<ByteBuffer,ByteBuffer> attributes)
                          throws IOError,
                                 org.apache.thrift.TException

Open a scanner for a given prefix. That is all rows will have the specified prefix. No other rows will be returned.

Parameters:

tableName - name of table

startAndPrefix - the prefix (and thus start row) of the keys you want

columns - the columns you want returned

attributes - Scan attributes

Returns:

scanner id to use with other scanner calls

Throws:

IOError

org.apache.thrift.TException

scannerOpenTs

int scannerOpenTs(ByteBuffer tableName,
                ByteBuffer startRow,
                List<ByteBuffer> columns,
                long timestamp,
                Map<ByteBuffer,ByteBuffer> attributes)
                  throws IOError,
                         org.apache.thrift.TException

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.

Parameters:

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

attributes - Scan attributes

Returns:

scanner id to be used with other scanner procedures

Throws:

IOError

org.apache.thrift.TException

scannerOpenWithStopTs

int scannerOpenWithStopTs(ByteBuffer tableName,
                        ByteBuffer startRow,
                        ByteBuffer stopRow,
                        List<ByteBuffer> columns,
                        long timestamp,
                        Map<ByteBuffer,ByteBuffer> attributes)
                          throws IOError,
                                 org.apache.thrift.TException

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.

Parameters:

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.

timestamp - timestamp

attributes - Scan attributes

Returns:

scanner id to be used with other scanner procedures

Throws:

IOError

org.apache.thrift.TException

scannerGet

List<TRowResult> scannerGet(int id)
                            throws IOError,
                                   IllegalArgument,
                                   org.apache.thrift.TException

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.

Parameters:

id - id of a scanner returned by scannerOpen

Returns:

a TRowResult containing the current row and a map of the columns to TCells.

Throws:

IllegalArgument - if ScannerID is invalid

NotFound - when the scanner reaches the end

IOError

org.apache.thrift.TException

scannerGetList

List<TRowResult> scannerGetList(int id,
                              int nbRows)
                                throws IOError,
                                       IllegalArgument,
                                       org.apache.thrift.TException

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.

Parameters:

id - id of a scanner returned by scannerOpen

nbRows - number of results to return

Returns:

a TRowResult containing the current row and a map of the columns to TCells.

Throws:

IllegalArgument - if ScannerID is invalid

NotFound - when the scanner reaches the end

IOError

org.apache.thrift.TException

scannerClose

void scannerClose(int id)
                  throws IOError,
                         IllegalArgument,
                         org.apache.thrift.TException

Closes the server-state associated with an open scanner.

Parameters:

id - id of a scanner returned by scannerOpen

Throws:

IllegalArgument - if ScannerID is invalid

IOError

org.apache.thrift.TException

getRowOrBefore

List<TCell> getRowOrBefore(ByteBuffer tableName,
                         ByteBuffer row,
                         ByteBuffer family)
                           throws IOError,
                                  org.apache.thrift.TException

Get the row just before the specified one.

Parameters:

tableName - name of table

row - row key

family - column name

Returns:

value for specified row/column

Throws:

IOError

org.apache.thrift.TException

getRegionInfo

TRegionInfo getRegionInfo(ByteBuffer row)
                          throws IOError,
                                 org.apache.thrift.TException

Get the regininfo for the specified row. It scans the metatable to find region's start and end keys.

Parameters:

row - row key

Returns:

value for specified row/column

Throws:

IOError

org.apache.thrift.TException

append

List<TCell> append(TAppend append)
                   throws IOError,
                          org.apache.thrift.TException

Appends values to one or more columns within a single row.

Parameters:

append - The single append operation to apply

Returns:

values of columns after the append operation.

Throws:

IOError

org.apache.thrift.TException

checkAndPut

boolean checkAndPut(ByteBuffer tableName,
                  ByteBuffer row,
                  ByteBuffer column,
                  ByteBuffer value,
                  Mutation mput,
                  Map<ByteBuffer,ByteBuffer> attributes)
                    throws IOError,
                           IllegalArgument,
                           org.apache.thrift.TException

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the corresponding mutation operation for put.

Parameters:

tableName - name of table

row - row key

column - column name

value - the expected value for the column parameter, if not provided the check is for the non-existence of the column in question

mput - mutation for the put

attributes - Mutation attributes

Returns:

true if the new put was executed, false otherwise

Throws:

IOError

IllegalArgument

org.apache.thrift.TException