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

Class AbstractHBaseDataSetAdmin

java.lang.Object

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

All Implemented Interfaces:

co.cask.cdap.api.dataset.DatasetAdmin, Closeable, AutoCloseable

Direct Known Subclasses:

HBaseTableAdmin

public abstract class AbstractHBaseDataSetAdmin
extends Object
implements co.cask.cdap.api.dataset.DatasetAdmin

Base class for writing HBase EntityAdmin.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractHBaseDataSetAdmin.CoprocessorJar Holder for coprocessor information.

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	hConf
static String	SYSTEM_PROPERTY_FORCE_HBASE_UPGRADE This will only be set by the upgrade tool to force upgrade of all HBase coprocessors after an HBase upgrade.
protected TableId	tableId
protected HBaseTableUtil	tableUtil

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHBaseDataSetAdmin(TableId tableId, Configuration hConf, HBaseTableUtil tableUtil)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCoprocessor(HTableDescriptorBuilder tableDescriptor, Class<? extends org.apache.hadoop.hbase.Coprocessor> coprocessor, Location jarFile, Integer priority)
void	close()
protected abstract AbstractHBaseDataSetAdmin.CoprocessorJar	createCoprocessorJar()
void	drop()
boolean	exists()
protected org.apache.hadoop.hbase.client.HBaseAdmin	getAdmin()
static ProjectInfo.Version	getVersion(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor)
static void	setVersion(HTableDescriptorBuilder tableDescriptor)
void	truncate()
void	upgrade()
void	upgradeTable(boolean force) Performs upgrade on a given HBase table.
protected abstract boolean	upgradeTable(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor) Modifies the table descriptor for upgrade.

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.cask.cdap.api.dataset.DatasetAdmin

create

Field Detail

SYSTEM_PROPERTY_FORCE_HBASE_UPGRADE

public static final String SYSTEM_PROPERTY_FORCE_HBASE_UPGRADE

This will only be set by the upgrade tool to force upgrade of all HBase coprocessors after an HBase upgrade.

See Also:

Constant Field Values

tableId

protected final TableId tableId

hConf

protected final Configuration hConf

tableUtil

protected final HBaseTableUtil tableUtil

Constructor Detail

AbstractHBaseDataSetAdmin

protected AbstractHBaseDataSetAdmin(TableId tableId,
                         Configuration hConf,
                         HBaseTableUtil tableUtil)

Method Detail

upgrade

public void upgrade()
             throws IOException

Specified by:

upgrade in interface co.cask.cdap.api.dataset.DatasetAdmin

Throws:

IOException

exists

public boolean exists()
               throws IOException

Specified by:

exists in interface co.cask.cdap.api.dataset.DatasetAdmin

Throws:

IOException

truncate

public void truncate()
              throws IOException

Specified by:

truncate in interface co.cask.cdap.api.dataset.DatasetAdmin

Throws:

IOException

drop

public void drop()
          throws IOException

Specified by:

drop in interface co.cask.cdap.api.dataset.DatasetAdmin

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

upgradeTable

public void upgradeTable(boolean force)
                  throws IOException

Performs upgrade on a given HBase table. It will be upgraded if either its spec has changed since the HBase table was created or upgraded, or if the CDAP version recorded in the HTable descriptor

Parameters:

force - forces upgrade regardless of whether the table needs upgrade.

Throws:

IOException - If upgrade failed.

setVersion

public static void setVersion(HTableDescriptorBuilder tableDescriptor)

getVersion

public static ProjectInfo.Version getVersion(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor)

addCoprocessor

protected void addCoprocessor(HTableDescriptorBuilder tableDescriptor,
                  Class<? extends org.apache.hadoop.hbase.Coprocessor> coprocessor,
                  Location jarFile,
                  Integer priority)
                       throws IOException

Throws:

IOException

createCoprocessorJar

protected abstract AbstractHBaseDataSetAdmin.CoprocessorJar createCoprocessorJar()
                                                                          throws IOException

Throws:

IOException

upgradeTable

protected abstract boolean upgradeTable(org.apache.hadoop.hbase.HTableDescriptor tableDescriptor)

Modifies the table descriptor for upgrade.

Returns:

true if the table descriptor is modified.

getAdmin

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

Throws:

IOException