co.cask.cdap.data2.transaction.queue.hbase

Class HBaseQueueAdmin

java.lang.Object

co.cask.cdap.data2.transaction.queue.AbstractQueueAdmin

co.cask.cdap.data2.transaction.queue.hbase.HBaseQueueAdmin

All Implemented Interfaces:

QueueAdmin

public class HBaseQueueAdmin
extends AbstractQueueAdmin

admin for queues in hbase.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_PREFIX_BYTES HBase table property for the number of bytes as the prefix of the queue entry row key.
protected HBaseTableUtil	tableUtil

Fields inherited from class co.cask.cdap.data2.transaction.queue.AbstractQueueAdmin

unqualifiedTableNamePrefix

Constructor Summary

Constructors

Modifier	Constructor and Description
	HBaseQueueAdmin(Configuration hConf, CConfiguration cConf, LocationFactory locationFactory, HBaseTableUtil tableUtil, DatasetFramework datasetFramework, co.cask.tephra.TransactionExecutorFactory txExecutorFactory)
protected	HBaseQueueAdmin(Configuration hConf, CConfiguration cConf, LocationFactory locationFactory, HBaseTableUtil tableUtil, DatasetFramework datasetFramework, co.cask.tephra.TransactionExecutorFactory txExecutorFactory, QueueConstants.QueueType type)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAllForFlow(Id.Flow flowId) Clears all queues for a flow, for example if the flow is upgraded and old.
void	create(QueueName queueName) Creates queue if doesn't exist.
void	create(QueueName queueName, Properties properties) Creates queue if doesn't exist.
boolean	doTruncateTable(QueueName queueName) This determines whether truncating a queue is supported (by truncating the queue's table).
void	dropAllForFlow(Id.Flow flowId) Deletes all queues for a flow, for example if the flow is deleted.
void	dropAllInNamespace(Id.Namespace namespaceId) Deletes all queues in a namespace
boolean	exists(QueueName queueName)
static TableId	getConfigTableId(QueueName queueName)
static TableId	getConfigTableId(String namespace)
HBaseConsumerStateStore	getConsumerStateStore(QueueName queueName)
protected List<? extends Class<? extends org.apache.hadoop.hbase.Coprocessor>>	getCoprocessors()
TableId	getDataTableId(Id.Flow flowId)
TableId	getDataTableId(Id.Flow flowId, QueueConstants.QueueType queueType)
TableId	getDataTableId(QueueName queueName) This determines the actual TableId from the table name prefix and the name of the queue.
TableId	getDataTableId(QueueName queueName, QueueConstants.QueueType queueType)
protected org.apache.hadoop.hbase.client.HBaseAdmin	getHBaseAdmin()
QueueConfigurer	getQueueConfigurer(QueueName queueName) Returns a QueueConfigurer for configuring the queue.
void	truncate(QueueName queueName) Wipes out queue data.
void	upgrade() Performs upgrade action for all queues.

Methods inherited from class co.cask.cdap.data2.transaction.queue.AbstractQueueAdmin

getApplicationName, getFlowName

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PREFIX_BYTES

public static final String PROPERTY_PREFIX_BYTES

HBase table property for the number of bytes as the prefix of the queue entry row key.

See Also:

Constant Field Values

tableUtil

protected final HBaseTableUtil tableUtil

Constructor Detail

HBaseQueueAdmin

@Inject
public HBaseQueueAdmin(Configuration hConf,
                      CConfiguration cConf,
                      LocationFactory locationFactory,
                      HBaseTableUtil tableUtil,
                      DatasetFramework datasetFramework,
                      co.cask.tephra.TransactionExecutorFactory txExecutorFactory)

HBaseQueueAdmin

protected HBaseQueueAdmin(Configuration hConf,
               CConfiguration cConf,
               LocationFactory locationFactory,
               HBaseTableUtil tableUtil,
               DatasetFramework datasetFramework,
               co.cask.tephra.TransactionExecutorFactory txExecutorFactory,
               QueueConstants.QueueType type)

Method Detail

getConfigTableId

public static TableId getConfigTableId(QueueName queueName)

getConfigTableId

public static TableId getConfigTableId(String namespace)

getHBaseAdmin

protected final org.apache.hadoop.hbase.client.HBaseAdmin getHBaseAdmin()
                                                                 throws IOException

Throws:

IOException

doTruncateTable

public boolean doTruncateTable(QueueName queueName)

This determines whether truncating a queue is supported (by truncating the queue's table).

exists

public boolean exists(QueueName queueName)
               throws Exception

Parameters:

queueName - Name of the queue

Returns:

true if queue with given name exists, otherwise false

Throws:

Exception - if check fails

create

public void create(QueueName queueName)
            throws IOException

Description copied from interface: QueueAdmin

Creates queue if doesn't exist. If queue exists does nothing.

Parameters:

queueName - Name of the queue

Throws:

IOException

create

public void create(QueueName queueName,
          Properties properties)
            throws IOException

Description copied from interface: QueueAdmin

Creates queue if doesn't exist. If queue exists does nothing.

Parameters:

queueName - Name of the queue

properties - additional properties

Throws:

IOException

truncate

public void truncate(QueueName queueName)
              throws Exception

Description copied from interface: QueueAdmin

Wipes out queue data.

Parameters:

queueName - Name of the queue

Throws:

Exception - if cleanup fails

clearAllForFlow

public void clearAllForFlow(Id.Flow flowId)
                     throws Exception

Description copied from interface: QueueAdmin

Clears all queues for a flow, for example if the flow is upgraded and old. todo: make this independent of the concept of a flow

Throws:

Exception

getQueueConfigurer

public QueueConfigurer getQueueConfigurer(QueueName queueName)
                                   throws Exception

Description copied from interface: QueueAdmin

Returns a QueueConfigurer for configuring the queue.

Throws:

Exception

dropAllForFlow

public void dropAllForFlow(Id.Flow flowId)
                    throws Exception

Description copied from interface: QueueAdmin

Deletes all queues for a flow, for example if the flow is deleted. todo: make this independent of the concept of a flow

Throws:

Exception

upgrade

public void upgrade()
             throws Exception

Description copied from interface: QueueAdmin

Performs upgrade action for all queues.

Throws:

Exception

getConsumerStateStore

public HBaseConsumerStateStore getConsumerStateStore(QueueName queueName)
                                              throws Exception

Throws:

Exception

getCoprocessors

protected List<? extends Class<? extends org.apache.hadoop.hbase.Coprocessor>> getCoprocessors()

Returns:

coprocessors to set for the HTable

dropAllInNamespace

public void dropAllInNamespace(Id.Namespace namespaceId)
                        throws Exception

Description copied from interface: QueueAdmin

Deletes all queues in a namespace

Parameters:

namespaceId - the namespace to delete flows in

Throws:

Exception

getDataTableId

public TableId getDataTableId(Id.Flow flowId)

Overrides:

getDataTableId in class AbstractQueueAdmin

getDataTableId

public TableId getDataTableId(QueueName queueName)

Description copied from class: AbstractQueueAdmin

This determines the actual TableId from the table name prefix and the name of the queue.

Overrides:

getDataTableId in class AbstractQueueAdmin

Parameters:

queueName - The name of the queue.

Returns:

the full name of the table that holds this queue.

getDataTableId

public TableId getDataTableId(QueueName queueName,
                     QueueConstants.QueueType queueType)

getDataTableId

public TableId getDataTableId(Id.Flow flowId,
                     QueueConstants.QueueType queueType)