org.apache.omid.transaction

Class TTable

java.lang.Object

org.apache.omid.transaction.TTable

All Implemented Interfaces:

Closeable, AutoCloseable

public class TTable
extends Object
implements Closeable

Provides transactional methods for accessing and modifying a given snapshot of data identified by an opaque Transaction object. It mimics the behavior in Table

Constructor Summary

Constructors

Constructor and Description
TTable(org.apache.hadoop.hbase.client.Connection connection, byte[] tableName)
TTable(org.apache.hadoop.hbase.client.Connection connection, byte[] tableName, boolean conflictFree)
TTable(org.apache.hadoop.hbase.client.Connection connection, byte[] tableName, org.apache.omid.committable.CommitTable.Client commitTableClient)
TTable(org.apache.hadoop.hbase.client.Connection connection, byte[] tableName, org.apache.omid.committable.CommitTable.Client commitTableClient, boolean conflictFree)
TTable(org.apache.hadoop.hbase.client.Connection connection, String tableName)
TTable(org.apache.hadoop.hbase.client.Connection connection, String tableName, boolean conflictFree)
TTable(org.apache.hadoop.hbase.client.Connection connection, String tableName, org.apache.omid.committable.CommitTable.Client commitTableClient)
TTable(org.apache.hadoop.hbase.client.Connection connection, String tableName, org.apache.omid.committable.CommitTable.Client commitTableClient, boolean conflictFree)
TTable(org.apache.hadoop.hbase.client.Table hTable)
TTable(org.apache.hadoop.hbase.client.Table hTable, boolean conflictFree)
TTable(org.apache.hadoop.hbase.client.Table hTable, boolean serverSideFilter, boolean conflictFree)
TTable(org.apache.hadoop.hbase.client.Table hTable, org.apache.omid.committable.CommitTable.Client commitTableClient)
TTable(org.apache.hadoop.hbase.client.Table hTable, org.apache.omid.committable.CommitTable.Client commitTableClient, boolean conflictFree)
TTable(org.apache.hadoop.hbase.client.Table hTable, SnapshotFilter snapshotFilter)
TTable(org.apache.hadoop.hbase.client.Table hTable, SnapshotFilter snapshotFilter, boolean conflictFree)

Method Summary

Modifier and Type	Method and Description
void	batch(Transaction transaction, List<? extends org.apache.hadoop.hbase.client.Row> rows)
void	batch(Transaction transaction, List<? extends org.apache.hadoop.hbase.client.Row> rows, boolean addShadowCells) Transactional version of Table#batch(List rows)
void	close() Releases any resources held or pending changes in internal buffers.
void	delete(Transaction tx, org.apache.hadoop.hbase.client.Delete delete) Transactional version of Table.delete(Delete delete)
void	delete(Transaction transaction, List<org.apache.hadoop.hbase.client.Delete> deletes) Transactional version of Table.delete(List deletes)
boolean	exists(Transaction transaction, org.apache.hadoop.hbase.client.Get get) Transactional version of Table.exists(Get get)
void	flushCommits()
org.apache.hadoop.hbase.client.Result	get(Transaction tx, org.apache.hadoop.hbase.client.Get get) Transactional version of Table.get(Get get)
org.apache.hadoop.hbase.client.Result[]	get(Transaction transaction, List<org.apache.hadoop.hbase.client.Get> gets) Transactional version of Table.get(List gets)
org.apache.hadoop.conf.Configuration	getConfiguration() Delegates to Table.getConfiguration()
org.apache.hadoop.hbase.client.TableDescriptor	getDescriptor() Delegates to Table.getDescriptor()
org.apache.hadoop.hbase.client.Table	getHBaseTable() Return the raw HBase table This is needed to resolve API incompatibilities between HBase 2 and 3 in Phoenix.
org.apache.hadoop.hbase.client.Table	getHTable() Provides access to the underliying Table in order to configure it or to perform unsafe (non-transactional) operations.
org.apache.hadoop.hbase.client.ResultScanner	getScanner(Transaction transaction, byte[] family) Transactional version of Table.getScanner(byte[] family)
org.apache.hadoop.hbase.client.ResultScanner	getScanner(Transaction transaction, byte[] family, byte[] qualifier) Transactional version of Table.getScanner(byte[] family, byte[] qualifier)
org.apache.hadoop.hbase.client.ResultScanner	getScanner(Transaction tx, org.apache.hadoop.hbase.client.Scan scan) Transactional version of Table.getScanner(Scan scan)
org.apache.hadoop.hbase.HTableDescriptor	getTableDescriptor() Delegates to Table.getTableDescriptor() This deprecated method is implemented for backwards compatibility reasons.
byte[]	getTableName()
boolean	isAutoFlush()
static org.apache.hadoop.hbase.client.Put	markPutAsCommitted(org.apache.hadoop.hbase.client.Put put, long timestamp, long commitTimestamp)
void	put(Transaction transaction, List<org.apache.hadoop.hbase.client.Put> puts)
void	put(Transaction transaction, List<org.apache.hadoop.hbase.client.Put> puts, boolean addShadowCells) Transactional version of Table.put(List puts)
void	put(Transaction tx, org.apache.hadoop.hbase.client.Put put) Transactional version of Table.put(Put put)
void	put(Transaction tx, org.apache.hadoop.hbase.client.Put put, boolean addShadowCell)
void	setAutoFlush(boolean autoFlush)

Methods inherited from class java.lang.Object

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

Constructor Detail

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              byte[] tableName)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              byte[] tableName,
              org.apache.omid.committable.CommitTable.Client commitTableClient)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              String tableName)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              String tableName,
              org.apache.omid.committable.CommitTable.Client commitTableClient)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Table hTable)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              byte[] tableName,
              boolean conflictFree)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              byte[] tableName,
              org.apache.omid.committable.CommitTable.Client commitTableClient,
              boolean conflictFree)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              String tableName,
              boolean conflictFree)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Connection connection,
              String tableName,
              org.apache.omid.committable.CommitTable.Client commitTableClient,
              boolean conflictFree)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Table hTable,
              boolean conflictFree)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Table hTable,
              SnapshotFilter snapshotFilter)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Table hTable,
              org.apache.omid.committable.CommitTable.Client commitTableClient)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Table hTable,
              boolean serverSideFilter,
              boolean conflictFree)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Table hTable,
              SnapshotFilter snapshotFilter,
              boolean conflictFree)
       throws IOException

Throws:

IOException

TTable

public TTable(org.apache.hadoop.hbase.client.Table hTable,
              org.apache.omid.committable.CommitTable.Client commitTableClient,
              boolean conflictFree)
       throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Releases any resources held or pending changes in internal buffers.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if a remote or network exception occurs.

get

public org.apache.hadoop.hbase.client.Result get(Transaction tx,
                                                 org.apache.hadoop.hbase.client.Get get)
                                          throws IOException

Transactional version of Table.get(Get get)

Parameters:

get - an instance of Get

tx - an instance of transaction to be used

Returns:

Result an instance of Result

Throws:

IOException - if a remote or network exception occurs.

delete

public void delete(Transaction tx,
                   org.apache.hadoop.hbase.client.Delete delete)
            throws IOException

Transactional version of Table.delete(Delete delete)

Parameters:

delete - an instance of Delete

tx - an instance of transaction to be used

Throws:

IOException - if a remote or network exception occurs.

put

public void put(Transaction tx,
                org.apache.hadoop.hbase.client.Put put)
         throws IOException

Transactional version of Table.put(Put put)

Parameters:

put - an instance of Put

tx - an instance of transaction to be used

Throws:

IOException - if a remote or network exception occurs.

markPutAsCommitted

public static org.apache.hadoop.hbase.client.Put markPutAsCommitted(org.apache.hadoop.hbase.client.Put put,
                                                                    long timestamp,
                                                                    long commitTimestamp)

Parameters:

put - an instance of Put

timestamp - timestamp to be used as cells version

commitTimestamp - timestamp to be used as commit timestamp

put

public void put(Transaction tx,
                org.apache.hadoop.hbase.client.Put put,
                boolean addShadowCell)
         throws IOException

Parameters:

put - an instance of Put

tx - an instance of transaction to be used

addShadowCell - denotes whether to add the shadow cell

Throws:

IOException - if a remote or network exception occurs.

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(Transaction tx,
                                                               org.apache.hadoop.hbase.client.Scan scan)
                                                        throws IOException

Transactional version of Table.getScanner(Scan scan)

Parameters:

scan - an instance of Scan

tx - an instance of transaction to be used

Returns:

ResultScanner an instance of ResultScanner

Throws:

IOException - if a remote or network exception occurs.

getHBaseTable

public org.apache.hadoop.hbase.client.Table getHBaseTable()

Return the raw HBase table This is needed to resolve API incompatibilities between HBase 2 and 3 in Phoenix.

Returns:

the backing table

getTableName

public byte[] getTableName()

Returns:

array of byte

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

Delegates to Table.getConfiguration()

Returns:

standard configuration object

getTableDescriptor

public org.apache.hadoop.hbase.HTableDescriptor getTableDescriptor()
                                                            throws IOException

Delegates to Table.getTableDescriptor() This deprecated method is implemented for backwards compatibility reasons. use getDescriptor()

Returns:

HTableDescriptor an instance of HTableDescriptor

Throws:

IOException - if a remote or network exception occurs.

getDescriptor

public org.apache.hadoop.hbase.client.TableDescriptor getDescriptor()
                                                             throws IOException

Delegates to Table.getDescriptor()

Returns:

TableDescriptor an instance of TableDescriptor

Throws:

IOException - if a remote or network exception occurs.

exists

public boolean exists(Transaction transaction,
                      org.apache.hadoop.hbase.client.Get get)
               throws IOException

Transactional version of Table.exists(Get get)

Parameters:

transaction - an instance of transaction to be used

get - an instance of Get

Returns:

true if cell exists

Throws:

IOException - if a remote or network exception occurs.

get

public org.apache.hadoop.hbase.client.Result[] get(Transaction transaction,
                                                   List<org.apache.hadoop.hbase.client.Get> gets)
                                            throws IOException

Transactional version of Table.get(List gets)

Parameters:

transaction - an instance of transaction to be used

gets - list of Get instances

Returns:

array of Results

Throws:

IOException - if a remote or network exception occurs

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(Transaction transaction,
                                                               byte[] family)
                                                        throws IOException

Transactional version of Table.getScanner(byte[] family)

Parameters:

transaction - an instance of transaction to be used

family - column family

Returns:

an instance of ResultScanner

Throws:

IOException - if a remote or network exception occurs

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(Transaction transaction,
                                                               byte[] family,
                                                               byte[] qualifier)
                                                        throws IOException

Transactional version of Table.getScanner(byte[] family, byte[] qualifier)

Parameters:

transaction - an instance of transaction to be used

family - column family

qualifier - column name

Returns:

an instance of ResultScanner

Throws:

IOException - if a remote or network exception occurs

put

public void put(Transaction transaction,
                List<org.apache.hadoop.hbase.client.Put> puts,
                boolean addShadowCells)
         throws IOException

Transactional version of Table.put(List puts)

Parameters:

transaction - an instance of transaction to be used

puts - List of puts

addShadowCells - denotes whether to add the shadow cell

Throws:

IOException - if a remote or network exception occurs

put

public void put(Transaction transaction,
                List<org.apache.hadoop.hbase.client.Put> puts)
         throws IOException

Throws:

IOException

batch

public void batch(Transaction transaction,
                  List<? extends org.apache.hadoop.hbase.client.Row> rows,
                  boolean addShadowCells)
           throws IOException

Transactional version of Table#batch(List rows)

Parameters:

transaction - an instance of transaction to be used

rows - List of rows that must be instances of Put or Delete

addShadowCells - denotes whether to add the shadow cell

Throws:

IOException - if a remote or network exception occurs

batch

public void batch(Transaction transaction,
                  List<? extends org.apache.hadoop.hbase.client.Row> rows)
           throws IOException

Throws:

IOException

delete

public void delete(Transaction transaction,
                   List<org.apache.hadoop.hbase.client.Delete> deletes)
            throws IOException

Transactional version of Table.delete(List deletes)

Parameters:

transaction - an instance of transaction to be used

deletes - List of deletes

Throws:

IOException - if a remote or network exception occurs

getHTable

public org.apache.hadoop.hbase.client.Table getHTable()

Provides access to the underliying Table in order to configure it or to perform unsafe (non-transactional) operations. The latter would break the transactional guarantees of the whole system.

Returns:

The underlying Table object

setAutoFlush

public void setAutoFlush(boolean autoFlush)
                  throws IOException

Throws:

IOException

isAutoFlush

public boolean isAutoFlush()

flushCommits

public void flushCommits()
                  throws IOException

Throws:

IOException