org.apache.hadoop.hbase.client

Class AbstractBigtableAdmin

java.lang.Object

org.apache.hadoop.hbase.client.AbstractBigtableAdmin

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.hbase.Abortable, org.apache.hadoop.hbase.client.Admin

@InternalApi(value="For internal usage only")
public abstract class AbstractBigtableAdmin
extends Object
implements org.apache.hadoop.hbase.client.Admin

Abstract AbstractBigtableAdmin class.

For internal use only - public for technical reasons.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractBigtableAdmin.UnsupportedOperationsHandler Handler for unsupported operations for generating Admin class at runtime.

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.client.Admin

org.apache.hadoop.hbase.client.Admin.MasterSwitchType

Field Summary

Fields

Modifier and Type	Field and Description
protected AdminClientWrapper	adminClientWrapper
protected CommonConnection	connection
protected Logger	LOG

Constructor Summary

Constructors

Constructor and Description
AbstractBigtableAdmin(CommonConnection connection) Constructor for AbstractBigtableAdmin.

Method Summary

Modifier and Type	Method and Description
void	abort(String why, Throwable e)
void	addColumn(String tableName, org.apache.hadoop.hbase.HColumnDescriptor column) Deprecated.
void	addColumn(org.apache.hadoop.hbase.TableName tableName, org.apache.hadoop.hbase.HColumnDescriptor column)
void	assign(byte[] regionName)
boolean	balancer()
void	cloneSnapshot(byte[] snapshotId, byte[] tableName) This is needed for the hbase shell.
void	cloneSnapshot(byte[] snapshotName, org.apache.hadoop.hbase.TableName tableName)
void	cloneSnapshot(String snapshotId, org.apache.hadoop.hbase.TableName tableName)
void	close()
void	closeRegion(byte[] regionname, String serverName)
void	closeRegion(org.apache.hadoop.hbase.ServerName sn, org.apache.hadoop.hbase.HRegionInfo hri)
void	closeRegion(String regionname, String serverName)
boolean	closeRegionWithEncodedRegionName(String encodedRegionName, String serverName)
void	compact(org.apache.hadoop.hbase.TableName tableName)
void	compact(org.apache.hadoop.hbase.TableName tableName, byte[] bytes)
void	compactRegion(byte[] bytes)
void	compactRegion(byte[] bytes, byte[] bytes2)
void	compactRegionServer(org.apache.hadoop.hbase.ServerName serverName, boolean b)
static IOException	convertToTableExistsException(org.apache.hadoop.hbase.TableName tableName, Throwable throwable)
org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel	coprocessorService()
org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel	coprocessorService(org.apache.hadoop.hbase.ServerName serverName)
void	createNamespace(org.apache.hadoop.hbase.NamespaceDescriptor descriptor)
static byte[][]	createSplitKeys(byte[] startKey, byte[] endKey, int numRegions)
void	createTable(org.apache.hadoop.hbase.HTableDescriptor desc)
void	createTable(org.apache.hadoop.hbase.HTableDescriptor desc, byte[][] splitKeys)
void	createTable(org.apache.hadoop.hbase.HTableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)
protected void	createTable(org.apache.hadoop.hbase.TableName tableName, com.google.cloud.bigtable.admin.v2.models.CreateTableRequest request) Creates a Table.
void	createTableAsync(org.apache.hadoop.hbase.HTableDescriptor desc, byte[][] splitKeys)
protected com.google.common.util.concurrent.ListenableFuture<com.google.cloud.bigtable.admin.v2.models.Table>	createTableAsync(org.apache.hadoop.hbase.TableName tableName, com.google.cloud.bigtable.admin.v2.models.CreateTableRequest request)
void	deleteColumn(String tableName, byte[] columnName) Deprecated.
void	deleteColumn(String tableName, String columnName) Deprecated.
void	deleteColumn(org.apache.hadoop.hbase.TableName tableName, byte[] columnName)
void	deleteNamespace(String name)
void	deleteRowRangeByPrefix(org.apache.hadoop.hbase.TableName tableName, byte[] prefix) deleteRowRangeByPrefix.
void	deleteSnapshot(byte[] snapshotId)
void	deleteSnapshot(String snapshotId)
void	deleteSnapshots(Pattern pattern)
void	deleteSnapshots(String regex)
void	deleteTable(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.HTableDescriptor[]	deleteTables(Pattern pattern)
org.apache.hadoop.hbase.HTableDescriptor[]	deleteTables(String regex)
void	deleteTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)
void	deleteTableSnapshots(String tableNameRegex, String snapshotNameRegex)
void	disableTable(String tableName) Deprecated.
void	disableTable(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.HTableDescriptor[]	disableTables(Pattern pattern)
org.apache.hadoop.hbase.HTableDescriptor[]	disableTables(String regex)
boolean	enableCatalogJanitor(boolean enable)
void	enableTable(String tableName) Deprecated.
void	enableTable(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.HTableDescriptor[]	enableTables(Pattern pattern)
org.apache.hadoop.hbase.HTableDescriptor[]	enableTables(String regex)
void	execProcedure(String signature, String instance, Map<String,String> props)
byte[]	execProcedureWithRet(String signature, String instance, Map<String,String> props)
void	flush(org.apache.hadoop.hbase.TableName tableName)
void	flushRegion(byte[] bytes)
org.apache.hadoop.hbase.util.Pair<Integer,Integer>	getAlterStatus(byte[] tableName)
org.apache.hadoop.hbase.util.Pair<Integer,Integer>	getAlterStatus(String tableName) getAlterStatus.
org.apache.hadoop.hbase.util.Pair<Integer,Integer>	getAlterStatus(org.apache.hadoop.hbase.TableName tableName) HBase column operations are not synchronous, since they're not as fast as Bigtable.
protected String	getBackupClusterId()
org.apache.hadoop.conf.Configuration	getConfiguration()
org.apache.hadoop.hbase.client.Connection	getConnection()
String[]	getMasterCoprocessors()
int	getMasterInfoPort()
org.apache.hadoop.hbase.NamespaceDescriptor	getNamespaceDescriptor(String name)
List<org.apache.hadoop.hbase.HRegionInfo>	getOnlineRegions(org.apache.hadoop.hbase.ServerName sn)
int	getOperationTimeout()
org.apache.hadoop.hbase.HTableDescriptor	getTableDescriptor(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.HTableDescriptor[]	getTableDescriptors(List<String> names)
org.apache.hadoop.hbase.HTableDescriptor[]	getTableDescriptorsByTableName(List<org.apache.hadoop.hbase.TableName> tableNames)
String[]	getTableNames(String regex) Deprecated.
List<org.apache.hadoop.hbase.HRegionInfo>	getTableRegions(org.apache.hadoop.hbase.TableName tableName)
boolean	isAborted()
boolean	isCatalogJanitorEnabled()
boolean	isProcedureFinished(String signature, String instance, Map<String,String> props)
boolean	isTableAvailable(org.apache.hadoop.hbase.TableName tableName)
boolean	isTableAvailable(org.apache.hadoop.hbase.TableName tableName, byte[][] splitKeys)
boolean	isTableDisabled(String tableName) Deprecated.
boolean	isTableDisabled(org.apache.hadoop.hbase.TableName tableName)
boolean	isTableEnabled(String tableName) Deprecated.
boolean	isTableEnabled(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.NamespaceDescriptor[]	listNamespaceDescriptors()
org.apache.hadoop.hbase.HTableDescriptor[]	listTableDescriptorsByNamespace(String name)
org.apache.hadoop.hbase.TableName[]	listTableNames() Lists all table names for the cluster provided in the configuration.
org.apache.hadoop.hbase.TableName[]	listTableNames(Pattern pattern)
org.apache.hadoop.hbase.TableName[]	listTableNames(Pattern pattern, boolean includeSysTables)
org.apache.hadoop.hbase.TableName[]	listTableNames(String patternStr) Deprecated.
org.apache.hadoop.hbase.TableName[]	listTableNames(String regex, boolean includeSysTables)
org.apache.hadoop.hbase.TableName[]	listTableNamesByNamespace(String name)
org.apache.hadoop.hbase.HTableDescriptor[]	listTables()
org.apache.hadoop.hbase.HTableDescriptor[]	listTables(Pattern pattern)
org.apache.hadoop.hbase.HTableDescriptor[]	listTables(Pattern pattern, boolean includeSysTables)
org.apache.hadoop.hbase.HTableDescriptor[]	listTables(String regex)
org.apache.hadoop.hbase.HTableDescriptor[]	listTables(String regex, boolean includeSysTables)
void	majorCompact(org.apache.hadoop.hbase.TableName tableName)
void	majorCompact(org.apache.hadoop.hbase.TableName tableName, byte[] bytes)
void	majorCompactRegion(byte[] bytes)
void	majorCompactRegion(byte[] bytes, byte[] bytes2)
void	mergeRegions(byte[] encodedNameOfRegionA, byte[] encodedNameOfRegionB, boolean forcible)
void	modifyColumn(org.apache.hadoop.hbase.TableName tableName, org.apache.hadoop.hbase.HColumnDescriptor column)
void	modifyColumns(String tableName, org.apache.hadoop.hbase.HColumnDescriptor descriptor) Modify an existing column family on a table.
protected Void	modifyColumns(org.apache.hadoop.hbase.TableName tableName, String columnName, String modificationType, ModifyTableBuilder builder) modifyColumns.
void	modifyNamespace(org.apache.hadoop.hbase.NamespaceDescriptor descriptor)
void	modifyTable(org.apache.hadoop.hbase.TableName tableName, org.apache.hadoop.hbase.HTableDescriptor newDescriptor)
void	move(byte[] encodedRegionName, byte[] destServerName)
void	offline(byte[] regionName)
void	restoreSnapshot(byte[] snapshotName)
void	restoreSnapshot(byte[] snapshotName, boolean takeFailSafeSnapshot)
void	restoreSnapshot(String snapshotName)
void	restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot)
void	rollWALWriter(org.apache.hadoop.hbase.ServerName serverName)
int	runCatalogScan()
boolean	setBalancerRunning(boolean on, boolean synchronous)
void	shutdown()
void	snapshot(byte[] snapshotId, byte[] tableName) This is needed for the hbase shell.
void	snapshot(byte[] snapshotId, org.apache.hadoop.hbase.TableName tableName)
void	snapshot(String snapshotId, org.apache.hadoop.hbase.TableName tableName) Creates a snapshot from an existing table.
protected com.google.cloud.bigtable.admin.v2.models.Backup	snapshotTable(String snapshotId, org.apache.hadoop.hbase.TableName tableName)
void	split(org.apache.hadoop.hbase.TableName tableName)
void	split(org.apache.hadoop.hbase.TableName tableName, byte[] bytes)
void	splitRegion(byte[] bytes)
void	splitRegion(byte[] bytes, byte[] bytes2)
void	stopMaster()
void	stopRegionServer(String hostnamePort)
boolean	tableExists(String tableName) Deprecated.
boolean	tableExists(org.apache.hadoop.hbase.TableName tableName)
String	toString()
void	truncateTable(org.apache.hadoop.hbase.TableName tableName, boolean preserveSplits)
void	unassign(byte[] regionName, boolean force)
void	updateConfiguration()
void	updateConfiguration(org.apache.hadoop.hbase.ServerName serverName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.client.Admin

abortProcedure, abortProcedureAsync, balancer, clearDeadServers, clearSlowLogResponses, cloneSnapshot, compactionSwitch, disableTableAsync, enableTableAsync, getClusterStatus, getCompactionState, getCompactionStateForRegion, getLastMajorCompactionTimestamp, getLastMajorCompactionTimestampForRegion, getLogEntries, getMaster, getQuotaRetriever, getSecurityCapabilities, isBalancerEnabled, isCleanerChoreEnabled, isMasterInMaintenanceMode, isNormalizerEnabled, isSnapshotCleanupEnabled, isSnapshotFinished, isSplitOrMergeEnabled, listDeadServers, listNamespaces, listProcedures, listSnapshots, listSnapshots, listSnapshots, listTableSnapshots, listTableSnapshots, normalize, restoreSnapshot, runCleanerChore, setCleanerChoreRunning, setNormalizerRunning, setQuota, setSplitOrMergeEnabled, snapshot, snapshot, snapshot, snapshotCleanupSwitch, takeSnapshotAsync

Field Detail

LOG

protected final Logger LOG

connection

protected final CommonConnection connection

adminClientWrapper

protected final AdminClientWrapper adminClientWrapper

Constructor Detail

AbstractBigtableAdmin

public AbstractBigtableAdmin(CommonConnection connection)
                      throws IOException

Constructor for AbstractBigtableAdmin.

Parameters:

connection - a CommonConnection object.

Throws:

IOException - if any.

Method Detail

getConnection

public org.apache.hadoop.hbase.client.Connection getConnection()

Specified by:

getConnection in interface org.apache.hadoop.hbase.client.Admin

tableExists

public boolean tableExists(org.apache.hadoop.hbase.TableName tableName)
                    throws IOException

Specified by:

tableExists in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

tableExists

@Deprecated
public boolean tableExists(String tableName)
                                throws IOException

Deprecated.

tableExists.

Parameters:

tableName - a String object.

Returns:

a boolean.

Throws:

IOException - if any.

listTables

public org.apache.hadoop.hbase.HTableDescriptor[] listTables()
                                                      throws IOException

Specified by:

listTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTables

public org.apache.hadoop.hbase.HTableDescriptor[] listTables(Pattern pattern)
                                                      throws IOException

Specified by:

listTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTables

public org.apache.hadoop.hbase.HTableDescriptor[] listTables(Pattern pattern,
                                                             boolean includeSysTables)
                                                      throws IOException

Specified by:

listTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTableNames

@Deprecated
public org.apache.hadoop.hbase.TableName[] listTableNames(String patternStr)
                                                               throws IOException

Deprecated.

Specified by:

listTableNames in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTableNames

public org.apache.hadoop.hbase.TableName[] listTableNames(Pattern pattern)
                                                   throws IOException

Specified by:

listTableNames in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTableNames

public org.apache.hadoop.hbase.TableName[] listTableNames(Pattern pattern,
                                                          boolean includeSysTables)
                                                   throws IOException

Specified by:

listTableNames in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTableNames

public org.apache.hadoop.hbase.TableName[] listTableNames(String regex,
                                                          boolean includeSysTables)
                                                   throws IOException

Specified by:

listTableNames in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTables

public org.apache.hadoop.hbase.HTableDescriptor[] listTables(String regex)
                                                      throws IOException

Specified by:

listTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTables

public org.apache.hadoop.hbase.HTableDescriptor[] listTables(String regex,
                                                             boolean includeSysTables)
                                                      throws IOException

Specified by:

listTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTableNames

public org.apache.hadoop.hbase.TableName[] listTableNames()
                                                   throws IOException

Lists all table names for the cluster provided in the configuration.

Specified by:

listTableNames in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getTableDescriptor

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

Specified by:

getTableDescriptor in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getTableNames

@Deprecated
public String[] getTableNames(String regex)
                                   throws IOException

Deprecated.

getTableNames.

Parameters:

regex - a String object.

Returns:

an array of String objects.

Throws:

IOException - if any.

createTable

public void createTable(org.apache.hadoop.hbase.HTableDescriptor desc)
                 throws IOException

Specified by:

createTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

createTable

public void createTable(org.apache.hadoop.hbase.HTableDescriptor desc,
                        byte[] startKey,
                        byte[] endKey,
                        int numRegions)
                 throws IOException

Specified by:

createTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

createSplitKeys

public static byte[][] createSplitKeys(byte[] startKey,
                                       byte[] endKey,
                                       int numRegions)

createTable

public void createTable(org.apache.hadoop.hbase.HTableDescriptor desc,
                        byte[][] splitKeys)
                 throws IOException

Specified by:

createTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

createTable

protected void createTable(org.apache.hadoop.hbase.TableName tableName,
                           com.google.cloud.bigtable.admin.v2.models.CreateTableRequest request)
                    throws IOException

Creates a Table.

Parameters:

tableName - a TableName object.

request - a CreateTableRequest object to send.

Throws:

IOException - if any.

createTableAsync

public void createTableAsync(org.apache.hadoop.hbase.HTableDescriptor desc,
                             byte[][] splitKeys)
                      throws IOException

Specified by:

createTableAsync in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

createTableAsync

protected com.google.common.util.concurrent.ListenableFuture<com.google.cloud.bigtable.admin.v2.models.Table> createTableAsync(org.apache.hadoop.hbase.TableName tableName,
                                                                                                                               com.google.cloud.bigtable.admin.v2.models.CreateTableRequest request)
                                                                                                                        throws IOException

Parameters:

tableName - a TableName object for exception identification.

request - a CreateTableRequest object to send.

Returns:

a ListenableFuture object.

Throws:

IOException - if any.

convertToTableExistsException

public static IOException convertToTableExistsException(org.apache.hadoop.hbase.TableName tableName,
                                                        Throwable throwable)

deleteTable

public void deleteTable(org.apache.hadoop.hbase.TableName tableName)
                 throws IOException

Specified by:

deleteTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteTables

public org.apache.hadoop.hbase.HTableDescriptor[] deleteTables(String regex)
                                                        throws IOException

Specified by:

deleteTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteTables

public org.apache.hadoop.hbase.HTableDescriptor[] deleteTables(Pattern pattern)
                                                        throws IOException

Specified by:

deleteTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

enableTable

public void enableTable(org.apache.hadoop.hbase.TableName tableName)
                 throws IOException

Specified by:

enableTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

enableTable

@Deprecated
public void enableTable(String tableName)
                             throws IOException

Deprecated.

enableTable.

Parameters:

tableName - a String object.

Throws:

IOException - if any.

enableTables

public org.apache.hadoop.hbase.HTableDescriptor[] enableTables(String regex)
                                                        throws IOException

Specified by:

enableTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

enableTables

public org.apache.hadoop.hbase.HTableDescriptor[] enableTables(Pattern pattern)
                                                        throws IOException

Specified by:

enableTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

disableTable

public void disableTable(org.apache.hadoop.hbase.TableName tableName)
                  throws IOException

Specified by:

disableTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

disableTable

@Deprecated
public void disableTable(String tableName)
                              throws IOException

Deprecated.

disableTable.

Parameters:

tableName - a String object.

Throws:

IOException - if any.

disableTables

public org.apache.hadoop.hbase.HTableDescriptor[] disableTables(String regex)
                                                         throws IOException

Specified by:

disableTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

disableTables

public org.apache.hadoop.hbase.HTableDescriptor[] disableTables(Pattern pattern)
                                                         throws IOException

Specified by:

disableTables in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

isTableEnabled

public boolean isTableEnabled(org.apache.hadoop.hbase.TableName tableName)
                       throws IOException

Specified by:

isTableEnabled in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

isTableEnabled

@Deprecated
public boolean isTableEnabled(String tableName)
                                   throws IOException

Deprecated.

isTableEnabled.

Parameters:

tableName - a String object.

Returns:

a boolean.

Throws:

IOException - if any.

isTableDisabled

public boolean isTableDisabled(org.apache.hadoop.hbase.TableName tableName)
                        throws IOException

Specified by:

isTableDisabled in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

isTableDisabled

@Deprecated
public boolean isTableDisabled(String tableName)
                                    throws IOException

Deprecated.

isTableDisabled.

Parameters:

tableName - a String object.

Returns:

a boolean.

Throws:

IOException - if any.

isTableAvailable

public boolean isTableAvailable(org.apache.hadoop.hbase.TableName tableName)
                         throws IOException

Specified by:

isTableAvailable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

addColumn

public void addColumn(org.apache.hadoop.hbase.TableName tableName,
                      org.apache.hadoop.hbase.HColumnDescriptor column)
               throws IOException

Specified by:

addColumn in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

modifyColumn

public void modifyColumn(org.apache.hadoop.hbase.TableName tableName,
                         org.apache.hadoop.hbase.HColumnDescriptor column)
                  throws IOException

Specified by:

modifyColumn in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteColumn

public void deleteColumn(org.apache.hadoop.hbase.TableName tableName,
                         byte[] columnName)
                  throws IOException

Specified by:

deleteColumn in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

modifyTable

public void modifyTable(org.apache.hadoop.hbase.TableName tableName,
                        org.apache.hadoop.hbase.HTableDescriptor newDescriptor)
                 throws IOException

Specified by:

modifyTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

modifyColumns

protected Void modifyColumns(org.apache.hadoop.hbase.TableName tableName,
                             String columnName,
                             String modificationType,
                             ModifyTableBuilder builder)
                      throws IOException

modifyColumns.

Parameters:

tableName - a TableName object for error messages.

columnName - a String object for error messages

modificationType - a String object for error messages

builder - a ModifyTableBuilder object to send.

Throws:

IOException - if any.

addColumn

@Deprecated
public void addColumn(String tableName,
                                  org.apache.hadoop.hbase.HColumnDescriptor column)
                           throws IOException

Deprecated.

Throws:

IOException

modifyColumns

public void modifyColumns(String tableName,
                          org.apache.hadoop.hbase.HColumnDescriptor descriptor)
                   throws IOException

Modify an existing column family on a table. NOTE: this is needed for backwards compatibility for the hbase shell.

Parameters:

tableName - a TableName object.

descriptor - a HColumnDescriptor object.

Throws:

IOException - if any.

deleteColumn

@Deprecated
public void deleteColumn(String tableName,
                                     byte[] columnName)
                              throws IOException

Deprecated.

deleteColumn.

Parameters:

tableName - a String object.

columnName - an array of byte.

Throws:

IOException - if any.

deleteColumn

@Deprecated
public void deleteColumn(String tableName,
                                     String columnName)
                              throws IOException

Deprecated.

deleteColumn.

Parameters:

tableName - a String object.

columnName - a String object.

Throws:

IOException - if any.

getConfiguration

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

Specified by:

getConfiguration in interface org.apache.hadoop.hbase.client.Admin

getTableRegions

public List<org.apache.hadoop.hbase.HRegionInfo> getTableRegions(org.apache.hadoop.hbase.TableName tableName)
                                                          throws IOException

Specified by:

getTableRegions in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getTableDescriptorsByTableName

public org.apache.hadoop.hbase.HTableDescriptor[] getTableDescriptorsByTableName(List<org.apache.hadoop.hbase.TableName> tableNames)
                                                                          throws IOException

Specified by:

getTableDescriptorsByTableName in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getTableDescriptors

public org.apache.hadoop.hbase.HTableDescriptor[] getTableDescriptors(List<String> names)
                                                               throws IOException

Specified by:

getTableDescriptors in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getOperationTimeout

public int getOperationTimeout()

Specified by:

getOperationTimeout in interface org.apache.hadoop.hbase.client.Admin

abort

public void abort(String why,
                  Throwable e)

Specified by:

abort in interface org.apache.hadoop.hbase.Abortable

Specified by:

abort in interface org.apache.hadoop.hbase.client.Admin

isAborted

public boolean isAborted()

Specified by:

isAborted in interface org.apache.hadoop.hbase.Abortable

Specified by:

isAborted in interface org.apache.hadoop.hbase.client.Admin

truncateTable

public void truncateTable(org.apache.hadoop.hbase.TableName tableName,
                          boolean preserveSplits)
                   throws IOException

Specified by:

truncateTable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteRowRangeByPrefix

public void deleteRowRangeByPrefix(org.apache.hadoop.hbase.TableName tableName,
                                   byte[] prefix)
                            throws IOException

deleteRowRangeByPrefix.

Parameters:

tableName - a TableName object.

prefix - an array of byte.

Throws:

IOException - if any.

isTableAvailable

public boolean isTableAvailable(org.apache.hadoop.hbase.TableName tableName,
                                byte[][] splitKeys)
                         throws IOException

Specified by:

isTableAvailable in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getAlterStatus

public org.apache.hadoop.hbase.util.Pair<Integer,Integer> getAlterStatus(org.apache.hadoop.hbase.TableName tableName)
                                                                  throws IOException

HBase column operations are not synchronous, since they're not as fast as Bigtable. Bigtable does not have async operations, so always return (0, 0). This is needed for some shell operations.

Specified by:

getAlterStatus in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getAlterStatus

public org.apache.hadoop.hbase.util.Pair<Integer,Integer> getAlterStatus(byte[] tableName)
                                                                  throws IOException

Specified by:

getAlterStatus in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getAlterStatus

public org.apache.hadoop.hbase.util.Pair<Integer,Integer> getAlterStatus(String tableName)
                                                                  throws IOException

getAlterStatus.

Parameters:

tableName - a String object.

Returns:

a Pair object.

Throws:

IOException - if any.

snapshot

public void snapshot(byte[] snapshotId,
                     byte[] tableName)
              throws IOException,
                     IllegalArgumentException

This is needed for the hbase shell.

Parameters:

snapshotId - a byte array object.

tableName - a byte array object.

Throws:

IOException - if any.

IllegalArgumentException

snapshot

public void snapshot(String snapshotId,
                     org.apache.hadoop.hbase.TableName tableName)
              throws IOException,
                     org.apache.hadoop.hbase.snapshot.SnapshotCreationException,
                     IllegalArgumentException

Creates a snapshot from an existing table. NOTE: Cloud Bigtable has a cleanup policy

Specified by:

snapshot in interface org.apache.hadoop.hbase.client.Admin

Parameters:

snapshotId - a String object.

tableName - a TableName object.

Throws:

IOException - if any.

org.apache.hadoop.hbase.snapshot.SnapshotCreationException

IllegalArgumentException

snapshot

public void snapshot(byte[] snapshotId,
                     org.apache.hadoop.hbase.TableName tableName)
              throws IOException,
                     IllegalArgumentException

Specified by:

snapshot in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

IllegalArgumentException

cloneSnapshot

public void cloneSnapshot(byte[] snapshotId,
                          byte[] tableName)
                   throws IOException

This is needed for the hbase shell.

Throws:

IOException

cloneSnapshot

public void cloneSnapshot(byte[] snapshotName,
                          org.apache.hadoop.hbase.TableName tableName)
                   throws IOException,
                          org.apache.hadoop.hbase.TableExistsException,
                          org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Specified by:

cloneSnapshot in interface org.apache.hadoop.hbase.client.Admin

Parameters:

snapshotName - a String object.

tableName - a TableName object.

Throws:

IOException - if any.

org.apache.hadoop.hbase.TableExistsException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

cloneSnapshot

public void cloneSnapshot(String snapshotId,
                          org.apache.hadoop.hbase.TableName tableName)
                   throws IOException,
                          org.apache.hadoop.hbase.TableExistsException,
                          org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Specified by:

cloneSnapshot in interface org.apache.hadoop.hbase.client.Admin

Parameters:

snapshotId - a String object.

tableName - a TableName object.

Throws:

IOException - if any.

org.apache.hadoop.hbase.TableExistsException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

deleteSnapshot

public void deleteSnapshot(byte[] snapshotId)
                    throws IOException

Specified by:

deleteSnapshot in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteSnapshot

public void deleteSnapshot(String snapshotId)
                    throws IOException

Specified by:

deleteSnapshot in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

snapshotTable

protected com.google.cloud.bigtable.admin.v2.models.Backup snapshotTable(String snapshotId,
                                                                         org.apache.hadoop.hbase.TableName tableName)
                                                                  throws IOException

Throws:

IOException

deleteSnapshots

public void deleteSnapshots(String regex)
                     throws IOException

Specified by:

deleteSnapshots in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteSnapshots

public void deleteSnapshots(Pattern pattern)
                     throws IOException

Specified by:

deleteSnapshots in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteTableSnapshots

public void deleteTableSnapshots(String tableNameRegex,
                                 String snapshotNameRegex)
                          throws IOException

Specified by:

deleteTableSnapshots in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteTableSnapshots

public void deleteTableSnapshots(Pattern tableNamePattern,
                                 Pattern snapshotNamePattern)
                          throws IOException

Specified by:

deleteTableSnapshots in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

restoreSnapshot

public void restoreSnapshot(byte[] snapshotName)
                     throws IOException,
                            org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Specified by:

restoreSnapshot in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

restoreSnapshot

public void restoreSnapshot(String snapshotName)
                     throws IOException,
                            org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Specified by:

restoreSnapshot in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

restoreSnapshot

public void restoreSnapshot(byte[] snapshotName,
                            boolean takeFailSafeSnapshot)
                     throws IOException,
                            org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Specified by:

restoreSnapshot in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

restoreSnapshot

public void restoreSnapshot(String snapshotName,
                            boolean takeFailSafeSnapshot)
                     throws IOException,
                            org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Specified by:

restoreSnapshot in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

getBackupClusterId

protected String getBackupClusterId()

closeRegion

public void closeRegion(String regionname,
                        String serverName)
                 throws IOException

Specified by:

closeRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

closeRegion

public void closeRegion(byte[] regionname,
                        String serverName)
                 throws IOException

Specified by:

closeRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

closeRegionWithEncodedRegionName

public boolean closeRegionWithEncodedRegionName(String encodedRegionName,
                                                String serverName)
                                         throws IOException

Specified by:

closeRegionWithEncodedRegionName in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

closeRegion

public void closeRegion(org.apache.hadoop.hbase.ServerName sn,
                        org.apache.hadoop.hbase.HRegionInfo hri)
                 throws IOException

Specified by:

closeRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getOnlineRegions

public List<org.apache.hadoop.hbase.HRegionInfo> getOnlineRegions(org.apache.hadoop.hbase.ServerName sn)
                                                           throws IOException

Specified by:

getOnlineRegions in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

flush

public void flush(org.apache.hadoop.hbase.TableName tableName)
           throws IOException

Specified by:

flush in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

flushRegion

public void flushRegion(byte[] bytes)
                 throws IOException

Specified by:

flushRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

compact

public void compact(org.apache.hadoop.hbase.TableName tableName)
             throws IOException

Specified by:

compact in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

compactRegion

public void compactRegion(byte[] bytes)
                   throws IOException

Specified by:

compactRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

compact

public void compact(org.apache.hadoop.hbase.TableName tableName,
                    byte[] bytes)
             throws IOException

Specified by:

compact in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

compactRegion

public void compactRegion(byte[] bytes,
                          byte[] bytes2)
                   throws IOException

Specified by:

compactRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

majorCompact

public void majorCompact(org.apache.hadoop.hbase.TableName tableName)
                  throws IOException

Specified by:

majorCompact in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

majorCompactRegion

public void majorCompactRegion(byte[] bytes)
                        throws IOException

Specified by:

majorCompactRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

majorCompact

public void majorCompact(org.apache.hadoop.hbase.TableName tableName,
                         byte[] bytes)
                  throws IOException

Specified by:

majorCompact in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

majorCompactRegion

public void majorCompactRegion(byte[] bytes,
                               byte[] bytes2)
                        throws IOException

Specified by:

majorCompactRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

compactRegionServer

public void compactRegionServer(org.apache.hadoop.hbase.ServerName serverName,
                                boolean b)
                         throws IOException

Specified by:

compactRegionServer in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

move

public void move(byte[] encodedRegionName,
                 byte[] destServerName)
          throws org.apache.hadoop.hbase.HBaseIOException,
                 org.apache.hadoop.hbase.MasterNotRunningException,
                 org.apache.hadoop.hbase.ZooKeeperConnectionException

Specified by:

move in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.HBaseIOException

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

assign

public void assign(byte[] regionName)
            throws org.apache.hadoop.hbase.MasterNotRunningException,
                   org.apache.hadoop.hbase.ZooKeeperConnectionException,
                   IOException

Specified by:

assign in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

IOException

unassign

public void unassign(byte[] regionName,
                     boolean force)
              throws org.apache.hadoop.hbase.MasterNotRunningException,
                     org.apache.hadoop.hbase.ZooKeeperConnectionException,
                     IOException

Specified by:

unassign in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

IOException

offline

public void offline(byte[] regionName)
             throws IOException

Specified by:

offline in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

setBalancerRunning

public boolean setBalancerRunning(boolean on,
                                  boolean synchronous)
                           throws org.apache.hadoop.hbase.MasterNotRunningException,
                                  org.apache.hadoop.hbase.ZooKeeperConnectionException

Specified by:

setBalancerRunning in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

balancer

public boolean balancer()
                 throws org.apache.hadoop.hbase.MasterNotRunningException,
                        org.apache.hadoop.hbase.ZooKeeperConnectionException

Specified by:

balancer in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

org.apache.hadoop.hbase.ZooKeeperConnectionException

enableCatalogJanitor

public boolean enableCatalogJanitor(boolean enable)
                             throws org.apache.hadoop.hbase.MasterNotRunningException

Specified by:

enableCatalogJanitor in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

runCatalogScan

public int runCatalogScan()
                   throws org.apache.hadoop.hbase.MasterNotRunningException

Specified by:

runCatalogScan in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

isCatalogJanitorEnabled

public boolean isCatalogJanitorEnabled()
                                throws org.apache.hadoop.hbase.MasterNotRunningException

Specified by:

isCatalogJanitorEnabled in interface org.apache.hadoop.hbase.client.Admin

Throws:

org.apache.hadoop.hbase.MasterNotRunningException

mergeRegions

public void mergeRegions(byte[] encodedNameOfRegionA,
                         byte[] encodedNameOfRegionB,
                         boolean forcible)
                  throws IOException

Specified by:

mergeRegions in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

split

public void split(org.apache.hadoop.hbase.TableName tableName)
           throws IOException

Specified by:

split in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

splitRegion

public void splitRegion(byte[] bytes)
                 throws IOException

Specified by:

splitRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

split

public void split(org.apache.hadoop.hbase.TableName tableName,
                  byte[] bytes)
           throws IOException

Specified by:

split in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

splitRegion

public void splitRegion(byte[] bytes,
                        byte[] bytes2)
                 throws IOException

Specified by:

splitRegion in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

shutdown

public void shutdown()
              throws IOException

Specified by:

shutdown in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

stopMaster

public void stopMaster()
                throws IOException

Specified by:

stopMaster in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

stopRegionServer

public void stopRegionServer(String hostnamePort)
                      throws IOException

Specified by:

stopRegionServer in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

createNamespace

public void createNamespace(org.apache.hadoop.hbase.NamespaceDescriptor descriptor)
                     throws IOException

Specified by:

createNamespace in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

modifyNamespace

public void modifyNamespace(org.apache.hadoop.hbase.NamespaceDescriptor descriptor)
                     throws IOException

Specified by:

modifyNamespace in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

deleteNamespace

public void deleteNamespace(String name)
                     throws IOException

Specified by:

deleteNamespace in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getNamespaceDescriptor

public org.apache.hadoop.hbase.NamespaceDescriptor getNamespaceDescriptor(String name)
                                                                   throws IOException

Specified by:

getNamespaceDescriptor in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listNamespaceDescriptors

public org.apache.hadoop.hbase.NamespaceDescriptor[] listNamespaceDescriptors()
                                                                       throws IOException

Specified by:

listNamespaceDescriptors in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTableDescriptorsByNamespace

public org.apache.hadoop.hbase.HTableDescriptor[] listTableDescriptorsByNamespace(String name)
                                                                           throws IOException

Specified by:

listTableDescriptorsByNamespace in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

listTableNamesByNamespace

public org.apache.hadoop.hbase.TableName[] listTableNamesByNamespace(String name)
                                                              throws IOException

Specified by:

listTableNamesByNamespace in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getMasterCoprocessors

public String[] getMasterCoprocessors()

Specified by:

getMasterCoprocessors in interface org.apache.hadoop.hbase.client.Admin

execProcedure

public void execProcedure(String signature,
                          String instance,
                          Map<String,String> props)
                   throws IOException

Specified by:

execProcedure in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

execProcedureWithRet

public byte[] execProcedureWithRet(String signature,
                                   String instance,
                                   Map<String,String> props)
                            throws IOException

Specified by:

execProcedureWithRet in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

isProcedureFinished

public boolean isProcedureFinished(String signature,
                                   String instance,
                                   Map<String,String> props)
                            throws IOException

Specified by:

isProcedureFinished in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

coprocessorService

public org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel coprocessorService()

Specified by:

coprocessorService in interface org.apache.hadoop.hbase.client.Admin

coprocessorService

public org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel coprocessorService(org.apache.hadoop.hbase.ServerName serverName)

Specified by:

coprocessorService in interface org.apache.hadoop.hbase.client.Admin

updateConfiguration

public void updateConfiguration(org.apache.hadoop.hbase.ServerName serverName)
                         throws IOException

Specified by:

updateConfiguration in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

updateConfiguration

public void updateConfiguration()
                         throws IOException

Specified by:

updateConfiguration in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

getMasterInfoPort

public int getMasterInfoPort()
                      throws IOException

Specified by:

getMasterInfoPort in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

rollWALWriter

public void rollWALWriter(org.apache.hadoop.hbase.ServerName serverName)
                   throws IOException,
                          org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException

Specified by:

rollWALWriter in interface org.apache.hadoop.hbase.client.Admin

Throws:

IOException

org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException