Package com.google.cloud.bigtable.hbase1_x

Class BigtableAdmin

java.lang.Object

org.apache.hadoop.hbase.client.AbstractBigtableAdmin

com.google.cloud.bigtable.hbase1_x.BigtableAdmin

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.hbase.Abortable, Admin

public class BigtableAdmin
extends AbstractBigtableAdmin

This is an hbase 1.x implementation of AbstractBigtableAdmin. Most methods in this class unsupported

Nested Class Summary

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

Admin.MasterSwitchType

Field Summary

Fields inherited from class org.apache.hadoop.hbase.client.AbstractBigtableAdmin

bigtableTableAdminClient, connection, LOG

Constructor Summary

Constructors

Constructor	Description
BigtableAdmin(AbstractBigtableConnection connection)

Method Summary

Modifier and Type	Method	Description
boolean	abortProcedure(long procId, boolean mayInterruptIfRunning)
java.util.concurrent.Future<java.lang.Boolean>	abortProcedureAsync(long procId, boolean mayInterruptIfRunning)
boolean	balancer(boolean arg0)
java.util.List<org.apache.hadoop.hbase.ServerName>	clearDeadServers(java.util.List<org.apache.hadoop.hbase.ServerName> list)
void	cloneSnapshot(java.lang.String s, org.apache.hadoop.hbase.TableName tableName, boolean b)
void	disableTableAsync(org.apache.hadoop.hbase.TableName tableName)
void	enableTableAsync(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState	getCompactionState(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState	getCompactionStateForRegion(byte[] bytes)
long	getLastMajorCompactionTimestamp(org.apache.hadoop.hbase.TableName tableName)
long	getLastMajorCompactionTimestampForRegion(byte[] regionName)
org.apache.hadoop.hbase.quotas.QuotaRetriever	getQuotaRetriever(org.apache.hadoop.hbase.quotas.QuotaFilter filter)
java.util.List<org.apache.hadoop.hbase.client.security.SecurityCapability>	getSecurityCapabilities()
boolean	isBalancerEnabled()
boolean	isCleanerChoreEnabled()
boolean	isMasterInMaintenanceMode()
boolean	isNormalizerEnabled()
boolean	isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
boolean	isSplitOrMergeEnabled(Admin.MasterSwitchType arg0)
java.util.List<org.apache.hadoop.hbase.ServerName>	listDeadServers()
org.apache.hadoop.hbase.ProcedureInfo[]	listProcedures()
java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listSnapshots()
java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listSnapshots(java.lang.String regex)
java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listSnapshots(java.util.regex.Pattern pattern)
java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listTableSnapshots(java.lang.String tableNameRegex, java.lang.String snapshotNameRegex)
java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listTableSnapshots(java.util.regex.Pattern tableNamePattern, java.util.regex.Pattern snapshotNamePattern)
boolean	normalize()
void	restoreSnapshot(java.lang.String s, boolean b, boolean b1)
boolean	runCleanerChore()
boolean	setCleanerChoreRunning(boolean b)
boolean	setNormalizerRunning(boolean on)
void	setQuota(org.apache.hadoop.hbase.quotas.QuotaSettings quota)
boolean[]	setSplitOrMergeEnabled(boolean arg0, boolean arg1, Admin.MasterSwitchType... arg2)
void	snapshot(java.lang.String snapshotName, org.apache.hadoop.hbase.TableName tableName, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)	The snapshot will be created with the ttl configured by BigtableOptionsFactory.BIGTABLE_SNAPSHOT_DEFAULT_TTL_SECS_KEY key in the configuration.
void	snapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SnapshotResponse	takeSnapshotAsync(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)

Methods inherited from class org.apache.hadoop.hbase.client.AbstractBigtableAdmin

abort, addColumn, addColumn, assign, balancer, cloneSnapshot, cloneSnapshot, cloneSnapshot, close, closeRegion, closeRegion, closeRegion, closeRegionWithEncodedRegionName, compact, compact, compactRegion, compactRegion, compactRegionServer, convertToTableExistsException, coprocessorService, coprocessorService, createNamespace, createSplitKeys, createTable, createTable, createTable, createTable, createTableAsync, createTableAsync, deleteColumn, deleteColumn, deleteColumn, deleteNamespace, deleteRowRangeByPrefix, deleteSnapshot, deleteSnapshot, deleteSnapshots, deleteSnapshots, deleteTable, deleteTables, deleteTables, deleteTableSnapshots, deleteTableSnapshots, disableTable, disableTable, disableTables, disableTables, enableCatalogJanitor, enableTable, enableTable, enableTables, enableTables, execProcedure, execProcedureWithRet, flush, flushRegion, getAlterStatus, getAlterStatus, getAlterStatus, getClusterName, getClusterStatus, getConfiguration, getConnection, getMasterCoprocessors, getMasterInfoPort, getNamespaceDescriptor, getOnlineRegions, getOperationTimeout, getSnapshotClusterName, getTableDescriptor, getTableDescriptors, getTableDescriptorsByTableName, getTableNames, getTableRegions, isAborted, isCatalogJanitorEnabled, isProcedureFinished, isTableAvailable, isTableAvailable, isTableDisabled, isTableDisabled, isTableEnabled, isTableEnabled, listNamespaceDescriptors, listTableDescriptorsByNamespace, listTableNames, listTableNames, listTableNames, listTableNames, listTableNames, listTableNamesByNamespace, listTables, listTables, listTables, listTables, listTables, majorCompact, majorCompact, majorCompactRegion, majorCompactRegion, mergeRegions, modifyColumn, modifyColumn, modifyColumn, modifyNamespace, modifyTable, move, offline, restoreSnapshot, restoreSnapshot, restoreSnapshot, restoreSnapshot, rollWALWriter, runCatalogScan, setBalancerRunning, shutdown, snapshot, snapshot, snapshot, snapshotTable, split, split, splitRegion, splitRegion, stopMaster, stopRegionServer, tableExists, tableExists, toBigtableName, toString, truncateTable, unassign, updateConfiguration, updateConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

BigtableAdmin

public BigtableAdmin(AbstractBigtableConnection connection)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

takeSnapshotAsync

public org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SnapshotResponse takeSnapshotAsync(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                                                                                           throws java.io.IOException,
                                                                                                  org.apache.hadoop.hbase.snapshot.SnapshotCreationException

Throws:

java.io.IOException

org.apache.hadoop.hbase.snapshot.SnapshotCreationException

disableTableAsync

public void disableTableAsync(org.apache.hadoop.hbase.TableName tableName)
                       throws java.io.IOException

Throws:

java.io.IOException

enableTableAsync

public void enableTableAsync(org.apache.hadoop.hbase.TableName tableName)
                      throws java.io.IOException

Throws:

java.io.IOException

getCompactionState

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionState(org.apache.hadoop.hbase.TableName tableName)
                                                                                                                throws java.io.IOException

Throws:

java.io.IOException

getCompactionStateForRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionStateForRegion(byte[] bytes)
                                                                                                                         throws java.io.IOException

Throws:

java.io.IOException

snapshot

public void snapshot(java.lang.String snapshotName,
                     org.apache.hadoop.hbase.TableName tableName,
                     org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)
              throws java.io.IOException,
                     org.apache.hadoop.hbase.snapshot.SnapshotCreationException,
                     java.lang.IllegalArgumentException

The snapshot will be created with the ttl configured by BigtableOptionsFactory.BIGTABLE_SNAPSHOT_DEFAULT_TTL_SECS_KEY key in the configuration. If not configured, the ttl will be set to serverside default.

Throws:

java.io.IOException

org.apache.hadoop.hbase.snapshot.SnapshotCreationException

java.lang.IllegalArgumentException

snapshot

public void snapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
              throws java.io.IOException,
                     org.apache.hadoop.hbase.snapshot.SnapshotCreationException,
                     java.lang.IllegalArgumentException

Throws:

java.io.IOException

org.apache.hadoop.hbase.snapshot.SnapshotCreationException

java.lang.IllegalArgumentException

isSnapshotFinished

public boolean isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                           throws java.io.IOException,
                                  org.apache.hadoop.hbase.snapshot.HBaseSnapshotException,
                                  org.apache.hadoop.hbase.snapshot.UnknownSnapshotException

Throws:

java.io.IOException

org.apache.hadoop.hbase.snapshot.HBaseSnapshotException

org.apache.hadoop.hbase.snapshot.UnknownSnapshotException

restoreSnapshot

public void restoreSnapshot(java.lang.String s,
                            boolean b,
                            boolean b1)
                     throws java.io.IOException,
                            org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Throws:

java.io.IOException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

cloneSnapshot

public void cloneSnapshot(java.lang.String s,
                          org.apache.hadoop.hbase.TableName tableName,
                          boolean b)
                   throws java.io.IOException,
                          org.apache.hadoop.hbase.TableExistsException,
                          org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

Throws:

java.io.IOException

org.apache.hadoop.hbase.TableExistsException

org.apache.hadoop.hbase.snapshot.RestoreSnapshotException

listSnapshots

public java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots()
                                                                                                         throws java.io.IOException

Throws:

java.io.IOException

listSnapshots

public java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots(java.lang.String regex)
                                                                                                         throws java.io.IOException

Throws:

java.io.IOException

listSnapshots

public java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots(java.util.regex.Pattern pattern)
                                                                                                         throws java.io.IOException

Throws:

java.io.IOException

listTableSnapshots

public java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listTableSnapshots(java.lang.String tableNameRegex,
                                                                                                                     java.lang.String snapshotNameRegex)
                                                                                                              throws java.io.IOException

Throws:

java.io.IOException

listTableSnapshots

public java.util.List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listTableSnapshots(java.util.regex.Pattern tableNamePattern,
                                                                                                                     java.util.regex.Pattern snapshotNamePattern)
                                                                                                              throws java.io.IOException

Throws:

java.io.IOException

isBalancerEnabled

public boolean isBalancerEnabled()
                          throws java.io.IOException

Throws:

java.io.IOException

getLastMajorCompactionTimestamp

public long getLastMajorCompactionTimestamp(org.apache.hadoop.hbase.TableName tableName)
                                     throws java.io.IOException

Throws:

java.io.IOException

getLastMajorCompactionTimestampForRegion

public long getLastMajorCompactionTimestampForRegion(byte[] regionName)
                                              throws java.io.IOException

Throws:

java.io.IOException

setQuota

public void setQuota(org.apache.hadoop.hbase.quotas.QuotaSettings quota)
              throws java.io.IOException

Throws:

java.io.IOException

getQuotaRetriever

public org.apache.hadoop.hbase.quotas.QuotaRetriever getQuotaRetriever(org.apache.hadoop.hbase.quotas.QuotaFilter filter)
                                                                throws java.io.IOException

Throws:

java.io.IOException

normalize

public boolean normalize()
                  throws java.io.IOException

Throws:

java.io.IOException

isNormalizerEnabled

public boolean isNormalizerEnabled()
                            throws java.io.IOException

Throws:

java.io.IOException

setNormalizerRunning

public boolean setNormalizerRunning(boolean on)
                             throws java.io.IOException

Throws:

java.io.IOException

setCleanerChoreRunning

public boolean setCleanerChoreRunning(boolean b)
                               throws java.io.IOException

Throws:

java.io.IOException

runCleanerChore

public boolean runCleanerChore()
                        throws java.io.IOException

Throws:

java.io.IOException

isCleanerChoreEnabled

public boolean isCleanerChoreEnabled()
                              throws java.io.IOException

Throws:

java.io.IOException

isMasterInMaintenanceMode

public boolean isMasterInMaintenanceMode()
                                  throws java.io.IOException

Throws:

java.io.IOException

abortProcedure

public boolean abortProcedure(long procId,
                              boolean mayInterruptIfRunning)
                       throws java.io.IOException

Throws:

java.io.IOException

listProcedures

public org.apache.hadoop.hbase.ProcedureInfo[] listProcedures()
                                                       throws java.io.IOException

Throws:

java.io.IOException

abortProcedureAsync

public java.util.concurrent.Future<java.lang.Boolean> abortProcedureAsync(long procId,
                                                                          boolean mayInterruptIfRunning)
                                                                   throws java.io.IOException

Throws:

java.io.IOException

getSecurityCapabilities

public java.util.List<org.apache.hadoop.hbase.client.security.SecurityCapability> getSecurityCapabilities()
                                                                                                   throws java.io.IOException

Throws:

java.io.IOException

balancer

public boolean balancer(boolean arg0)
                 throws java.io.IOException

Throws:

java.io.IOException

isSplitOrMergeEnabled

public boolean isSplitOrMergeEnabled(Admin.MasterSwitchType arg0)
                              throws java.io.IOException

Throws:

java.io.IOException

listDeadServers

public java.util.List<org.apache.hadoop.hbase.ServerName> listDeadServers()
                                                                   throws java.io.IOException

Throws:

java.io.IOException

clearDeadServers

public java.util.List<org.apache.hadoop.hbase.ServerName> clearDeadServers(java.util.List<org.apache.hadoop.hbase.ServerName> list)
                                                                    throws java.io.IOException

Throws:

java.io.IOException

setSplitOrMergeEnabled

public boolean[] setSplitOrMergeEnabled(boolean arg0,
                                        boolean arg1,
                                        Admin.MasterSwitchType... arg2)
                                 throws java.io.IOException

Throws:

java.io.IOException