org.apache.hadoop.hbase.thrift2.generated

Class THBaseService.Client

java.lang.Object

org.apache.thrift.TServiceClient

org.apache.hadoop.hbase.thrift2.generated.THBaseService.Client

All Implemented Interfaces:

THBaseService.Iface

Enclosing class:

THBaseService

public static class THBaseService.Client
extends org.apache.thrift.TServiceClient
implements THBaseService.Iface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	THBaseService.Client.Factory

Constructor Summary

Constructors

Constructor and Description
Client(org.apache.thrift.protocol.TProtocol prot)
Client(org.apache.thrift.protocol.TProtocol iprot, org.apache.thrift.protocol.TProtocol oprot)

Method Summary

Modifier and Type	Method and Description
TResult	append(ByteBuffer table, TAppend tappend)
boolean	checkAndDelete(ByteBuffer table, ByteBuffer row, ByteBuffer family, ByteBuffer qualifier, ByteBuffer value, TDelete tdelete) Atomically checks if a row/family/qualifier value matches the expected value.
boolean	checkAndPut(ByteBuffer table, ByteBuffer row, ByteBuffer family, ByteBuffer qualifier, ByteBuffer value, TPut tput) Atomically checks if a row/family/qualifier value matches the expected value.
void	closeScanner(int scannerId) Closes the scanner.
List<TDelete>	deleteMultiple(ByteBuffer table, List<TDelete> tdeletes) Bulk commit a List of TDeletes to the table.
void	deleteSingle(ByteBuffer table, TDelete tdelete) Deletes as specified by the TDelete.
boolean	exists(ByteBuffer table, TGet tget) Test for the existence of columns in the table, as specified in the TGet.
TResult	get(ByteBuffer table, TGet tget) Method for getting data from a row.
List<TResult>	getMultiple(ByteBuffer table, List<TGet> tgets) Method for getting multiple rows.
List<TResult>	getScannerResults(ByteBuffer table, TScan tscan, int numRows) Get results for the provided TScan object.
List<TResult>	getScannerRows(int scannerId, int numRows) Grabs multiple rows from a Scanner.
TResult	increment(ByteBuffer table, TIncrement tincrement)
void	mutateRow(ByteBuffer table, TRowMutations trowMutations) mutateRow performs multiple mutations atomically on a single row.
int	openScanner(ByteBuffer table, TScan tscan) Get a Scanner for the provided TScan object.
void	put(ByteBuffer table, TPut tput) Commit a TPut to a table.
void	putMultiple(ByteBuffer table, List<TPut> tputs) Commit a List of Puts to the table.
TResult	recv_append()
boolean	recv_checkAndDelete()
boolean	recv_checkAndPut()
void	recv_closeScanner()
List<TDelete>	recv_deleteMultiple()
void	recv_deleteSingle()
boolean	recv_exists()
TResult	recv_get()
List<TResult>	recv_getMultiple()
List<TResult>	recv_getScannerResults()
List<TResult>	recv_getScannerRows()
TResult	recv_increment()
void	recv_mutateRow()
int	recv_openScanner()
void	recv_put()
void	recv_putMultiple()
void	send_append(ByteBuffer table, TAppend tappend)
void	send_checkAndDelete(ByteBuffer table, ByteBuffer row, ByteBuffer family, ByteBuffer qualifier, ByteBuffer value, TDelete tdelete)
void	send_checkAndPut(ByteBuffer table, ByteBuffer row, ByteBuffer family, ByteBuffer qualifier, ByteBuffer value, TPut tput)
void	send_closeScanner(int scannerId)
void	send_deleteMultiple(ByteBuffer table, List<TDelete> tdeletes)
void	send_deleteSingle(ByteBuffer table, TDelete tdelete)
void	send_exists(ByteBuffer table, TGet tget)
void	send_get(ByteBuffer table, TGet tget)
void	send_getMultiple(ByteBuffer table, List<TGet> tgets)
void	send_getScannerResults(ByteBuffer table, TScan tscan, int numRows)
void	send_getScannerRows(int scannerId, int numRows)
void	send_increment(ByteBuffer table, TIncrement tincrement)
void	send_mutateRow(ByteBuffer table, TRowMutations trowMutations)
void	send_openScanner(ByteBuffer table, TScan tscan)
void	send_put(ByteBuffer table, TPut tput)
void	send_putMultiple(ByteBuffer table, List<TPut> tputs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Client

public Client(org.apache.thrift.protocol.TProtocol prot)

Client

public Client(org.apache.thrift.protocol.TProtocol iprot,
              org.apache.thrift.protocol.TProtocol oprot)

Method Detail

exists

public boolean exists(ByteBuffer table,
                      TGet tget)
               throws TIOError,
                      org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Test for the existence of columns in the table, as specified in the TGet.

Specified by:

exists in interface THBaseService.Iface

Parameters:

table - the table to check on

tget - the TGet to check for

Returns:

true if the specified TGet matches one or more keys, false if not

Throws:

TIOError

org.apache.thrift.TException

send_exists

public void send_exists(ByteBuffer table,
                        TGet tget)
                 throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_exists

public boolean recv_exists()
                    throws TIOError,
                           org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

get

public TResult get(ByteBuffer table,
                   TGet tget)
            throws TIOError,
                   org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Method for getting data from a row. If the row cannot be found an empty Result is returned. This can be checked by the empty field of the TResult

Specified by:

get in interface THBaseService.Iface

Parameters:

table - the table to get from

tget - the TGet to fetch

Returns:

the result

Throws:

TIOError

org.apache.thrift.TException

send_get

public void send_get(ByteBuffer table,
                     TGet tget)
              throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_get

public TResult recv_get()
                 throws TIOError,
                        org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

getMultiple

public List<TResult> getMultiple(ByteBuffer table,
                                 List<TGet> tgets)
                          throws TIOError,
                                 org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Method for getting multiple rows. If a row cannot be found there will be a null value in the result list for that TGet at the same position. So the Results are in the same order as the TGets.

Specified by:

getMultiple in interface THBaseService.Iface

Parameters:

table - the table to get from

tgets - a list of TGets to fetch, the Result list will have the Results at corresponding positions or null if there was an error

Throws:

TIOError

org.apache.thrift.TException

send_getMultiple

public void send_getMultiple(ByteBuffer table,
                             List<TGet> tgets)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_getMultiple

public List<TResult> recv_getMultiple()
                               throws TIOError,
                                      org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

put

public void put(ByteBuffer table,
                TPut tput)
         throws TIOError,
                org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Commit a TPut to a table.

Specified by:

put in interface THBaseService.Iface

Parameters:

table - the table to put data in

tput - the TPut to put

Throws:

TIOError

org.apache.thrift.TException

send_put

public void send_put(ByteBuffer table,
                     TPut tput)
              throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_put

public void recv_put()
              throws TIOError,
                     org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

checkAndPut

public boolean checkAndPut(ByteBuffer table,
                           ByteBuffer row,
                           ByteBuffer family,
                           ByteBuffer qualifier,
                           ByteBuffer value,
                           TPut tput)
                    throws TIOError,
                           org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the TPut.

Specified by:

checkAndPut in interface THBaseService.Iface

Parameters:

table - to check in and put to

row - row to check

family - column family to check

qualifier - column qualifier to check

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

tput - the TPut to put if the check succeeds

Returns:

true if the new put was executed, false otherwise

Throws:

TIOError

org.apache.thrift.TException

send_checkAndPut

public void send_checkAndPut(ByteBuffer table,
                             ByteBuffer row,
                             ByteBuffer family,
                             ByteBuffer qualifier,
                             ByteBuffer value,
                             TPut tput)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_checkAndPut

public boolean recv_checkAndPut()
                         throws TIOError,
                                org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

putMultiple

public void putMultiple(ByteBuffer table,
                        List<TPut> tputs)
                 throws TIOError,
                        org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Commit a List of Puts to the table.

Specified by:

putMultiple in interface THBaseService.Iface

Parameters:

table - the table to put data in

tputs - a list of TPuts to commit

Throws:

TIOError

org.apache.thrift.TException

send_putMultiple

public void send_putMultiple(ByteBuffer table,
                             List<TPut> tputs)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_putMultiple

public void recv_putMultiple()
                      throws TIOError,
                             org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

deleteSingle

public void deleteSingle(ByteBuffer table,
                         TDelete tdelete)
                  throws TIOError,
                         org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Deletes as specified by the TDelete. Note: "delete" is a reserved keyword and cannot be used in Thrift thus the inconsistent naming scheme from the other functions.

Specified by:

deleteSingle in interface THBaseService.Iface

Parameters:

table - the table to delete from

tdelete - the TDelete to delete

Throws:

TIOError

org.apache.thrift.TException

send_deleteSingle

public void send_deleteSingle(ByteBuffer table,
                              TDelete tdelete)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_deleteSingle

public void recv_deleteSingle()
                       throws TIOError,
                              org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

deleteMultiple

public List<TDelete> deleteMultiple(ByteBuffer table,
                                    List<TDelete> tdeletes)
                             throws TIOError,
                                    org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Bulk commit a List of TDeletes to the table. Throws a TIOError if any of the deletes fail. Always returns an empty list for backwards compatibility.

Specified by:

deleteMultiple in interface THBaseService.Iface

Parameters:

table - the table to delete from

tdeletes - list of TDeletes to delete

Throws:

TIOError

org.apache.thrift.TException

send_deleteMultiple

public void send_deleteMultiple(ByteBuffer table,
                                List<TDelete> tdeletes)
                         throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_deleteMultiple

public List<TDelete> recv_deleteMultiple()
                                  throws TIOError,
                                         org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

checkAndDelete

public boolean checkAndDelete(ByteBuffer table,
                              ByteBuffer row,
                              ByteBuffer family,
                              ByteBuffer qualifier,
                              ByteBuffer value,
                              TDelete tdelete)
                       throws TIOError,
                              org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the delete.

Specified by:

checkAndDelete in interface THBaseService.Iface

Parameters:

table - to check in and delete from

row - row to check

family - column family to check

qualifier - column qualifier to check

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

tdelete - the TDelete to execute if the check succeeds

Returns:

true if the new delete was executed, false otherwise

Throws:

TIOError

org.apache.thrift.TException

send_checkAndDelete

public void send_checkAndDelete(ByteBuffer table,
                                ByteBuffer row,
                                ByteBuffer family,
                                ByteBuffer qualifier,
                                ByteBuffer value,
                                TDelete tdelete)
                         throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_checkAndDelete

public boolean recv_checkAndDelete()
                            throws TIOError,
                                   org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

increment

public TResult increment(ByteBuffer table,
                         TIncrement tincrement)
                  throws TIOError,
                         org.apache.thrift.TException

Specified by:

increment in interface THBaseService.Iface

Throws:

TIOError

org.apache.thrift.TException

send_increment

public void send_increment(ByteBuffer table,
                           TIncrement tincrement)
                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_increment

public TResult recv_increment()
                       throws TIOError,
                              org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

append

public TResult append(ByteBuffer table,
                      TAppend tappend)
               throws TIOError,
                      org.apache.thrift.TException

Specified by:

append in interface THBaseService.Iface

Throws:

TIOError

org.apache.thrift.TException

send_append

public void send_append(ByteBuffer table,
                        TAppend tappend)
                 throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_append

public TResult recv_append()
                    throws TIOError,
                           org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

openScanner

public int openScanner(ByteBuffer table,
                       TScan tscan)
                throws TIOError,
                       org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Get a Scanner for the provided TScan object.

Specified by:

openScanner in interface THBaseService.Iface

Parameters:

table - the table to get the Scanner for

tscan - the scan object to get a Scanner for

Returns:

Scanner Id to be used with other scanner procedures

Throws:

TIOError

org.apache.thrift.TException

send_openScanner

public void send_openScanner(ByteBuffer table,
                             TScan tscan)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_openScanner

public int recv_openScanner()
                     throws TIOError,
                            org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

getScannerRows

public List<TResult> getScannerRows(int scannerId,
                                    int numRows)
                             throws TIOError,
                                    TIllegalArgument,
                                    org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Grabs multiple rows from a Scanner.

Specified by:

getScannerRows in interface THBaseService.Iface

Parameters:

scannerId - the Id of the Scanner to return rows from. This is an Id returned from the openScanner function.

numRows - number of rows to return

Returns:

Between zero and numRows TResults

Throws:

TIOError

TIllegalArgument

org.apache.thrift.TException

send_getScannerRows

public void send_getScannerRows(int scannerId,
                                int numRows)
                         throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_getScannerRows

public List<TResult> recv_getScannerRows()
                                  throws TIOError,
                                         TIllegalArgument,
                                         org.apache.thrift.TException

Throws:

TIOError

TIllegalArgument

org.apache.thrift.TException

closeScanner

public void closeScanner(int scannerId)
                  throws TIOError,
                         TIllegalArgument,
                         org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Closes the scanner. Should be called to free server side resources timely. Typically close once the scanner is not needed anymore, i.e. after looping over it to get all the required rows.

Specified by:

closeScanner in interface THBaseService.Iface

Parameters:

scannerId - the Id of the Scanner to close *

Throws:

TIOError

TIllegalArgument

org.apache.thrift.TException

send_closeScanner

public void send_closeScanner(int scannerId)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_closeScanner

public void recv_closeScanner()
                       throws TIOError,
                              TIllegalArgument,
                              org.apache.thrift.TException

Throws:

TIOError

TIllegalArgument

org.apache.thrift.TException

mutateRow

public void mutateRow(ByteBuffer table,
                      TRowMutations trowMutations)
               throws TIOError,
                      org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

mutateRow performs multiple mutations atomically on a single row.

Specified by:

mutateRow in interface THBaseService.Iface

Parameters:

table - table to apply the mutations

trowMutations - mutations to apply

Throws:

TIOError

org.apache.thrift.TException

send_mutateRow

public void send_mutateRow(ByteBuffer table,
                           TRowMutations trowMutations)
                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_mutateRow

public void recv_mutateRow()
                    throws TIOError,
                           org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException

getScannerResults

public List<TResult> getScannerResults(ByteBuffer table,
                                       TScan tscan,
                                       int numRows)
                                throws TIOError,
                                       org.apache.thrift.TException

Description copied from interface: THBaseService.Iface

Get results for the provided TScan object. This helper function opens a scanner, get the results and close the scanner.

Specified by:

getScannerResults in interface THBaseService.Iface

Parameters:

table - the table to get the Scanner for

tscan - the scan object to get a Scanner for

numRows - number of rows to return

Returns:

between zero and numRows TResults

Throws:

TIOError

org.apache.thrift.TException

send_getScannerResults

public void send_getScannerResults(ByteBuffer table,
                                   TScan tscan,
                                   int numRows)
                            throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_getScannerResults

public List<TResult> recv_getScannerResults()
                                     throws TIOError,
                                            org.apache.thrift.TException

Throws:

TIOError

org.apache.thrift.TException