co.cask.cdap.data2.dataset2.lib.table.hbase

Class HBaseTable

java.lang.Object

co.cask.cdap.data2.dataset2.lib.table.AbstractTable

co.cask.cdap.data2.dataset2.lib.table.BufferingTable

co.cask.cdap.data2.dataset2.lib.table.hbase.HBaseTable

All Implemented Interfaces:

co.cask.cdap.api.data.batch.BatchReadable<byte[],co.cask.cdap.api.dataset.table.Row>, co.cask.cdap.api.data.batch.BatchWritable<byte[],co.cask.cdap.api.dataset.table.Put>, co.cask.cdap.api.data.batch.RecordScannable<co.cask.cdap.api.data.format.StructuredRecord>, co.cask.cdap.api.data.batch.RecordWritable<co.cask.cdap.api.data.format.StructuredRecord>, co.cask.cdap.api.dataset.Dataset, co.cask.cdap.api.dataset.metrics.MeteredDataset, co.cask.cdap.api.dataset.table.Table, co.cask.tephra.TransactionAware, Closeable, AutoCloseable

public class HBaseTable
extends BufferingTable

Dataset client for HBase tables.

Nested Class Summary

Nested classes/interfaces inherited from class co.cask.cdap.data2.dataset2.lib.table.AbstractTable

AbstractTable.TableScanner

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELTA_WRITE

Fields inherited from class co.cask.cdap.data2.dataset2.lib.table.BufferingTable

DELETE_MARKER

Fields inherited from class co.cask.cdap.data2.dataset2.lib.table.AbstractTable

EMPTY_ROW_MAP

Fields inherited from interface co.cask.cdap.api.dataset.table.Table

PROPERTY_COLUMN_FAMILY, PROPERTY_CONFLICT_LEVEL, PROPERTY_READLESS_INCREMENT, PROPERTY_SCHEMA, PROPERTY_SCHEMA_ROW_FIELD, PROPERTY_TTL

Constructor Summary

Constructors

Constructor and Description
HBaseTable(co.cask.cdap.api.dataset.DatasetContext datasetContext, co.cask.cdap.api.dataset.DatasetSpecification spec, CConfiguration cConf, Configuration hConf, HBaseTableUtil tableUtil)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
byte[]	getNameAsTxChangePrefix() Generates a byte array to be used as the transaction change prefix.
protected NavigableMap<byte[],byte[]>	getPersisted(byte[] row, byte[][] columns) Fetches column->value pairs for set of columns from persistent store.
protected NavigableMap<byte[],byte[]>	getPersisted(byte[] row, byte[] startColumn, byte[] stopColumn, int limit) Fetches column->value pairs for range of columns from persistent store.
List<Map<byte[],byte[]>>	getPersisted(List<co.cask.cdap.api.dataset.table.Get> gets) Fetches a list of rows from persistent store.
protected void	persist(NavigableMap<byte[],NavigableMap<byte[],Update>> buff) Persists in-memory buffer.
protected co.cask.cdap.api.dataset.table.Scanner	scanPersisted(co.cask.cdap.api.dataset.table.Scan scan) Scans range of rows from persistent store for a given Scan.
void	startTx(co.cask.tephra.Transaction tx)
String	toString()
protected void	undo(NavigableMap<byte[],NavigableMap<byte[],Update>> persisted) Undos previously persisted changes.

Methods inherited from class co.cask.cdap.data2.dataset2.lib.table.BufferingTable

commitTx, compareAndSwap, delete, delete, get, get, get, get, getRange, getSplits, getTableName, getTransactionAwareName, getTxChanges, head, increment, incrementAndGet, postTxCommit, put, rollbackTx, scan, scan, setMetricsCollector, unwrapDeleteIfNeeded, unwrapDeletes, unwrapDeletesForRows, updateTx, wrapDeleteIfNeeded

Methods inherited from class co.cask.cdap.data2.dataset2.lib.table.AbstractTable

createSplitReader, createSplitRecordScanner, delete, delete, get, get, getRecordType, getSplits, increment, increment, incrementAndGet, incrementAndGet, put, put, write, write

Methods inherited from class java.lang.Object

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

Field Detail

DELTA_WRITE

public static final String DELTA_WRITE

See Also:

Constant Field Values

Constructor Detail

HBaseTable

public HBaseTable(co.cask.cdap.api.dataset.DatasetContext datasetContext,
          co.cask.cdap.api.dataset.DatasetSpecification spec,
          CConfiguration cConf,
          Configuration hConf,
          HBaseTableUtil tableUtil)
           throws IOException

Throws:

IOException

Method Detail

toString

public String toString()

Overrides:

toString in class Object

startTx

public void startTx(co.cask.tephra.Transaction tx)

Specified by:

startTx in interface co.cask.tephra.TransactionAware

Overrides:

startTx in class BufferingTable

getPersisted

public List<Map<byte[],byte[]>> getPersisted(List<co.cask.cdap.api.dataset.table.Get> gets)

Description copied from class: BufferingTable

Fetches a list of rows from persistent store. Subclasses should override this if they can batch multiple gets into a single request, as the default implementation simply loops through the gets and calls BufferingTable.getPersisted(byte[], byte[][]) on each get. NOTE: persisted store can also be in-memory, it is called "persisted" to distinguish from in-memory buffer.

Overrides:

getPersisted in class BufferingTable

Parameters:

gets - list of gets to perform

Returns:

list of rows, one for each get

getNameAsTxChangePrefix

public byte[] getNameAsTxChangePrefix()

Description copied from class: BufferingTable

Generates a byte array to be used as the transaction change prefix. Allows implementations to override it so the change prefix more closely represents the underlying storage.

Overrides:

getNameAsTxChangePrefix in class BufferingTable

Returns:

transaction change prefix

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class BufferingTable

Throws:

IOException

persist

protected void persist(NavigableMap<byte[],NavigableMap<byte[],Update>> buff)
                throws Exception

Description copied from class: BufferingTable

Persists in-memory buffer. After this method returns we assume that data can be visible to other table clients (of course other clients may choose still not to see it based on transaction isolation logic).

Specified by:

persist in class BufferingTable

Parameters:

buff - in-memory buffer to persist. Map is described as row->(column->value). Map can contain null values which means that the corresponded column was deleted

Throws:

Exception

undo

protected void undo(NavigableMap<byte[],NavigableMap<byte[],Update>> persisted)
             throws Exception

Description copied from class: BufferingTable

Undos previously persisted changes. After this method returns we assume that data can be visible to other table clients (of course other clients may choose still not to see it based on transaction isolation logic).

Specified by:

undo in class BufferingTable

Parameters:

persisted - previously persisted changes. Map is described as row->(column->value). Map can contain null values which means that the corresponded column was deleted

Throws:

Exception

getPersisted

protected NavigableMap<byte[],byte[]> getPersisted(byte[] row,
                                       byte[] startColumn,
                                       byte[] stopColumn,
                                       int limit)
                                            throws Exception

Description copied from class: BufferingTable

Fetches column->value pairs for range of columns from persistent store. NOTE: persisted store can also be in-memory, it is called "persisted" to distinguish from in-memory buffer. NOTE: Using this method is generally always not efficient since it always hits the persisted store even if all needed data is in-memory buffer. Since columns set is not strictly defined the implementation always looks up for more columns in persistent store.

Specified by:

getPersisted in class BufferingTable

Parameters:

row - row key defines the row to fetch columns from

startColumn - first column in a range, inclusive

stopColumn - last column in a range, exclusive

limit - max number of columns to fetch

Returns:

map of column->value pairs, never null.

Throws:

Exception

getPersisted

protected NavigableMap<byte[],byte[]> getPersisted(byte[] row,
                                       @Nullable
                                       byte[][] columns)
                                            throws Exception

Description copied from class: BufferingTable

Fetches column->value pairs for set of columns from persistent store. NOTE: persisted store can also be in-memory, it is called "persisted" to distinguish from in-memory buffer.

Specified by:

getPersisted in class BufferingTable

Parameters:

row - row key defines the row to fetch columns from

columns - set of columns to fetch. null means fetch everything; empty array which means fetch nothing.

Returns:

map of column->value pairs, never null.

Throws:

Exception

scanPersisted

protected co.cask.cdap.api.dataset.table.Scanner scanPersisted(co.cask.cdap.api.dataset.table.Scan scan)
                                                        throws Exception

Description copied from class: BufferingTable

Scans range of rows from persistent store for a given Scan. NOTE: persisted store can also be in-memory, it is called "persisted" to distinguish from in-memory buffer.

Specified by:

scanPersisted in class BufferingTable

Parameters:

scan - scan configuration

Returns:

instance of Scanner, never null

Throws:

Exception