co.cask.cdap.data2.util.hbase

Class HBaseTableUtil

java.lang.Object

co.cask.cdap.data2.util.hbase.HBaseTableUtil

public abstract class HBaseTableUtil
extends Object

Common utilities for dealing with HBase.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HBaseTableUtil.BloomType Represents the bloom filter types supported for HBase tables.
static class	HBaseTableUtil.CompressionType Represents the compression types supported for HBase tables.
static class	HBaseTableUtil.CoprocessorInfo Carries information about coprocessor information.
static class	HBaseTableUtil.TableStats Carries information about table stats

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFG_HBASE_TABLE_COMPRESSION
static int	DEFAULT_WRITE_BUFFER_SIZE
static long	MAX_CREATE_TABLE_WAIT
protected String	tablePrefix

Constructor Summary

Constructors

Constructor and Description
HBaseTableUtil()

Method Summary

Methods

Modifier and Type	Method and Description
DeleteBuilder	buildDelete(byte[] row) Creates a DeleteBuilder for the given row.
DeleteBuilder	buildDelete(org.apache.hadoop.hbase.client.Delete delete) Creates a DeleteBuilder by copying from another Delete instance.
GetBuilder	buildGet(byte[] row) Creates a GetBuilder for the given row.
GetBuilder	buildGet(org.apache.hadoop.hbase.client.Get get) Creates a GetBuilder by copying from another Get instance.
abstract HTableDescriptorBuilder	buildHTableDescriptor(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor) Creates a new HTableDescriptorBuilder which may contain an HBase namespace depending on the HBase version
abstract HTableDescriptorBuilder	buildHTableDescriptor(TableId tableId) Creates a new HTableDescriptorBuilder which may contain an HBase namespace depending on the HBase version
PutBuilder	buildPut(byte[] row) Creates a PutBuilder for the given row.
PutBuilder	buildPut(org.apache.hadoop.hbase.client.Put put) Creates a PutBuilder by copying from another Put instance.
ScanBuilder	buildScan() Creates a ScanBuilder.
ScanBuilder	buildScan(org.apache.hadoop.hbase.client.Scan scan) Creates a ScanBuilder by copying from another Scan instance.
static Location	createCoProcessorJar(String filePrefix, Location jarDir, Iterable<? extends Class<? extends org.apache.hadoop.hbase.Coprocessor>> classes)
abstract org.apache.hadoop.hbase.client.HTable	createHTable(Configuration conf, TableId tableId) Creates a new HTable which may contain an HBase namespace depending on the HBase version
abstract void	createNamespaceIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin, Id.Namespace namespace) Creates an HBase namespace, if it does not already exist This method uses Id.Namespace here to cover for a future case when CDAP namespaces may push down namespace properties to HBase
void	createTableIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId, org.apache.hadoop.hbase.HTableDescriptor tableDescriptor) Create a hbase table if it does not exist.
void	createTableIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId, org.apache.hadoop.hbase.HTableDescriptor tableDescriptor, byte[][] splitKeys) Creates a hbase table if it does not exists.
void	createTableIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId, org.apache.hadoop.hbase.HTableDescriptor tableDescriptor, byte[][] splitKeys, long timeout, TimeUnit timeoutUnit) Create a hbase table if it does not exist.
void	deleteAllInNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin, Id.Namespace namespaceId) Deletes all tables in the specified namespace
void	deleteAllInNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin, Id.Namespace namespaceId, com.google.common.base.Predicate<TableId> predicate) Deletes all tables in the specified namespace that satisfy the given Predicate.
abstract void	deleteNamespaceIfExists(org.apache.hadoop.hbase.client.HBaseAdmin admin, Id.Namespace namespace) Creates an HBase namespace, if it exists
abstract void	deleteTable(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Delete an HBase table
abstract void	disableTable(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Disable an HBase table
void	dropTable(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Disables and deletes a table.
abstract void	enableTable(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Enable an HBase table
abstract HBaseTableUtil.BloomType	getBloomFilter(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)
abstract HBaseTableUtil.CompressionType	getCompression(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)
static Map<String,HBaseTableUtil.CoprocessorInfo>	getCoprocessorInfo(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor) Returns information for all coprocessor configured for the table.
abstract Class<? extends org.apache.hadoop.hbase.Coprocessor>	getDequeueScanObserverClassForVersion()
abstract org.apache.hadoop.hbase.HTableDescriptor	getHTableDescriptor(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Constructs a HTableDescriptor which may contain an HBase namespace for an existing table
abstract Class<? extends org.apache.hadoop.hbase.Coprocessor>	getIncrementHandlerClassForVersion()
abstract Class<? extends org.apache.hadoop.hbase.Coprocessor>	getQueueRegionObserverClassForVersion()
static byte[][]	getSplitKeys(int splits, int buckets, AbstractRowKeyDistributor keyDistributor)
abstract List<org.apache.hadoop.hbase.HRegionInfo>	getTableRegions(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Returns a list of HRegionInfo for the specified TableId
abstract Map<TableId,HBaseTableUtil.TableStats>	getTableStats(org.apache.hadoop.hbase.client.HBaseAdmin admin) Collects HBase table stats //TODO: Explore the possiblitity of returning a Map<TableId, TableStats>
abstract Class<? extends org.apache.hadoop.hbase.Coprocessor>	getTransactionDataJanitorClassForVersion()
abstract boolean	hasNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin, Id.Namespace namespace) Checks if an HBase namespace already exists
protected boolean	isCDAPTable(org.apache.hadoop.hbase.HTableDescriptor hTableDescriptor)
abstract List<TableId>	listTables(org.apache.hadoop.hbase.client.HBaseAdmin admin) Lists all tables
abstract List<TableId>	listTablesInNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin, Id.Namespace namespaceId) Lists all tables in the specified namespace
abstract void	modifyTable(org.apache.hadoop.hbase.client.HBaseAdmin admin, org.apache.hadoop.hbase.HTableDescriptor tableDescriptor) Modify an HBase table
abstract void	setBloomFilter(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor, HBaseTableUtil.BloomType type)
void	setCConf(CConfiguration cConf)
abstract void	setCompression(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor, HBaseTableUtil.CompressionType type)
abstract boolean	tableExists(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Check if an HBase table exists
void	truncateTable(org.apache.hadoop.hbase.client.HBaseAdmin admin, TableId tableId) Truncates a table

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CREATE_TABLE_WAIT

public static final long MAX_CREATE_TABLE_WAIT

See Also:

Constant Field Values

DEFAULT_WRITE_BUFFER_SIZE

public static final int DEFAULT_WRITE_BUFFER_SIZE

See Also:

Constant Field Values

CFG_HBASE_TABLE_COMPRESSION

public static final String CFG_HBASE_TABLE_COMPRESSION

See Also:

Constant Field Values

tablePrefix

protected String tablePrefix

Constructor Detail

HBaseTableUtil

public HBaseTableUtil()

Method Detail

setCConf

public void setCConf(CConfiguration cConf)

isCDAPTable

protected boolean isCDAPTable(org.apache.hadoop.hbase.HTableDescriptor hTableDescriptor)

createTableIfNotExists

public void createTableIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                          TableId tableId,
                          org.apache.hadoop.hbase.HTableDescriptor tableDescriptor)
                            throws IOException

Create a hbase table if it does not exist. Deals with race conditions when two clients concurrently attempt to create the table.

Parameters:

admin - the hbase admin

tableId - the TableId for the table to create

tableDescriptor - hbase table descriptor for the new table

Throws:

IOException

createTableIfNotExists

public void createTableIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                          TableId tableId,
                          org.apache.hadoop.hbase.HTableDescriptor tableDescriptor,
                          @Nullable
                          byte[][] splitKeys)
                            throws IOException

Creates a hbase table if it does not exists. Same as calling createTableIfNotExists(HBaseAdmin, TableId, HTableDescriptor, byte[][], long, TimeUnit) with timeout = MAX_CREATE_TABLE_WAIT milliseconds.

Throws:

IOException

createTableIfNotExists

public void createTableIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                          TableId tableId,
                          org.apache.hadoop.hbase.HTableDescriptor tableDescriptor,
                          @Nullable
                          byte[][] splitKeys,
                          long timeout,
                          TimeUnit timeoutUnit)
                            throws IOException

Create a hbase table if it does not exist. Deals with race conditions when two clients concurrently attempt to create the table.

Parameters:

admin - the hbase admin

tableId - TableId representing the table

tableDescriptor - hbase table descriptor for the new table

timeout - Maximum time to wait for table creation.

timeoutUnit - The TimeUnit for timeout.

Throws:

IOException

getSplitKeys

public static byte[][] getSplitKeys(int splits,
                    int buckets,
                    AbstractRowKeyDistributor keyDistributor)

createCoProcessorJar

public static Location createCoProcessorJar(String filePrefix,
                            Location jarDir,
                            Iterable<? extends Class<? extends org.apache.hadoop.hbase.Coprocessor>> classes)
                                     throws IOException

Throws:

IOException

getCoprocessorInfo

public static Map<String,HBaseTableUtil.CoprocessorInfo> getCoprocessorInfo(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor)

Returns information for all coprocessor configured for the table.

Returns:

a Map from coprocessor class name to CoprocessorInfo

createHTable

public abstract org.apache.hadoop.hbase.client.HTable createHTable(Configuration conf,
                                                 TableId tableId)
                                                            throws IOException

Creates a new HTable which may contain an HBase namespace depending on the HBase version

Parameters:

conf - the hadoop configuration

tableId - the TableId to create an HTable for

Returns:

an HTable for the tableName in the namespace

Throws:

IOException

buildHTableDescriptor

public abstract HTableDescriptorBuilder buildHTableDescriptor(TableId tableId)

Creates a new HTableDescriptorBuilder which may contain an HBase namespace depending on the HBase version

Parameters:

tableId - the TableId to create an HTableDescriptor for

Returns:

an HTableDescriptorBuilder for the table

buildHTableDescriptor

public abstract HTableDescriptorBuilder buildHTableDescriptor(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor)

Creates a new HTableDescriptorBuilder which may contain an HBase namespace depending on the HBase version

Parameters:

tableDescriptor - the HTableDescriptor whose values should be copied

Returns:

an HTableDescriptorBuilder for the table

getHTableDescriptor

public abstract org.apache.hadoop.hbase.HTableDescriptor getHTableDescriptor(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                                                           TableId tableId)
                                                                      throws IOException

Constructs a HTableDescriptor which may contain an HBase namespace for an existing table

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - the TableId to construct an HTableDescriptor for

Returns:

an HTableDescriptor for the table

Throws:

IOException

hasNamespace

public abstract boolean hasNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                   Id.Namespace namespace)
                              throws IOException

Checks if an HBase namespace already exists

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

namespace - the Id.Namespace to check for existence

Throws:

IOException - if an I/O error occurs during the operation

createNamespaceIfNotExists

public abstract void createNamespaceIfNotExists(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                              Id.Namespace namespace)
                                         throws IOException

Creates an HBase namespace, if it does not already exist This method uses Id.Namespace here to cover for a future case when CDAP namespaces may push down namespace properties to HBase

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

namespace - the Id.Namespace to create

Throws:

IOException - if an I/O error occurs during the operation

deleteNamespaceIfExists

public abstract void deleteNamespaceIfExists(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                           Id.Namespace namespace)
                                      throws IOException

Creates an HBase namespace, if it exists

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

namespace - the Id.Namespace to delete

Throws:

IOException - if an I/O error occurs during the operation

disableTable

public abstract void disableTable(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                TableId tableId)
                           throws IOException

Disable an HBase table

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - TableId for the specified table

Throws:

IOException

enableTable

public abstract void enableTable(org.apache.hadoop.hbase.client.HBaseAdmin admin,
               TableId tableId)
                          throws IOException

Enable an HBase table

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - TableId for the specified table

Throws:

IOException

tableExists

public abstract boolean tableExists(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                  TableId tableId)
                             throws IOException

Check if an HBase table exists

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - TableId for the specified table

Throws:

IOException

deleteTable

public abstract void deleteTable(org.apache.hadoop.hbase.client.HBaseAdmin admin,
               TableId tableId)
                          throws IOException

Delete an HBase table

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - TableId for the specified table

Throws:

IOException

modifyTable

public abstract void modifyTable(org.apache.hadoop.hbase.client.HBaseAdmin admin,
               org.apache.hadoop.hbase.HTableDescriptor tableDescriptor)
                          throws IOException

Modify an HBase table

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableDescriptor - the modified HTableDescriptor

Throws:

IOException

getTableRegions

public abstract List<org.apache.hadoop.hbase.HRegionInfo> getTableRegions(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                                                        TableId tableId)
                                                                   throws IOException

Returns a list of HRegionInfo for the specified TableId

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - TableId for the specified table

Returns:

a list of HRegionInfo for the specified TableId

Throws:

IOException

deleteAllInNamespace

public void deleteAllInNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                        Id.Namespace namespaceId,
                        com.google.common.base.Predicate<TableId> predicate)
                          throws IOException

Deletes all tables in the specified namespace that satisfy the given Predicate.

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

namespaceId - namespace for which the tables are being deleted

predicate - The Predicate to decide whether to drop a table or not

Throws:

IOException

deleteAllInNamespace

public void deleteAllInNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                        Id.Namespace namespaceId)
                          throws IOException

Deletes all tables in the specified namespace

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

namespaceId - namespace for which the tables are being deleted

Throws:

IOException

listTablesInNamespace

public abstract List<TableId> listTablesInNamespace(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                                  Id.Namespace namespaceId)
                                             throws IOException

Lists all tables in the specified namespace

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

namespaceId - namespace for which the tables are being requested

Throws:

IOException

listTables

public abstract List<TableId> listTables(org.apache.hadoop.hbase.client.HBaseAdmin admin)
                                  throws IOException

Lists all tables

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

Throws:

IOException

dropTable

public void dropTable(org.apache.hadoop.hbase.client.HBaseAdmin admin,
             TableId tableId)
               throws IOException

Disables and deletes a table.

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - TableId for the specified table

Throws:

IOException

truncateTable

public void truncateTable(org.apache.hadoop.hbase.client.HBaseAdmin admin,
                 TableId tableId)
                   throws IOException

Truncates a table

Parameters:

admin - the HBaseAdmin to use to communicate with HBase

tableId - TableId for the specified table

Throws:

IOException

buildScan

public ScanBuilder buildScan()

Creates a ScanBuilder.

buildScan

public ScanBuilder buildScan(org.apache.hadoop.hbase.client.Scan scan)
                      throws IOException

Creates a ScanBuilder by copying from another Scan instance.

Throws:

IOException

buildPut

public PutBuilder buildPut(byte[] row)

Creates a PutBuilder for the given row.

buildPut

public PutBuilder buildPut(org.apache.hadoop.hbase.client.Put put)

Creates a PutBuilder by copying from another Put instance.

buildGet

public GetBuilder buildGet(byte[] row)

Creates a GetBuilder for the given row.

buildGet

public GetBuilder buildGet(org.apache.hadoop.hbase.client.Get get)

Creates a GetBuilder by copying from another Get instance.

buildDelete

public DeleteBuilder buildDelete(byte[] row)

Creates a DeleteBuilder for the given row.

buildDelete

public DeleteBuilder buildDelete(org.apache.hadoop.hbase.client.Delete delete)

Creates a DeleteBuilder by copying from another Delete instance.

setCompression

public abstract void setCompression(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor,
                  HBaseTableUtil.CompressionType type)

setBloomFilter

public abstract void setBloomFilter(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor,
                  HBaseTableUtil.BloomType type)

getCompression

public abstract HBaseTableUtil.CompressionType getCompression(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

getBloomFilter

public abstract HBaseTableUtil.BloomType getBloomFilter(org.apache.hadoop.hbase.HColumnDescriptor columnDescriptor)

getTransactionDataJanitorClassForVersion

public abstract Class<? extends org.apache.hadoop.hbase.Coprocessor> getTransactionDataJanitorClassForVersion()

getQueueRegionObserverClassForVersion

public abstract Class<? extends org.apache.hadoop.hbase.Coprocessor> getQueueRegionObserverClassForVersion()

getDequeueScanObserverClassForVersion

public abstract Class<? extends org.apache.hadoop.hbase.Coprocessor> getDequeueScanObserverClassForVersion()

getIncrementHandlerClassForVersion

public abstract Class<? extends org.apache.hadoop.hbase.Coprocessor> getIncrementHandlerClassForVersion()

getTableStats

public abstract Map<TableId,HBaseTableUtil.TableStats> getTableStats(org.apache.hadoop.hbase.client.HBaseAdmin admin)
                                                              throws IOException

Collects HBase table stats //TODO: Explore the possiblitity of returning a Map<TableId, TableStats>

Parameters:

admin - instance of HBaseAdmin to communicate with HBase

Returns:

map of table name -> table stats

Throws:

IOException