Admin (Apache HBase 2.1.0-cdh6.3.2 API)

All Superinterfaces:

Abortable, AutoCloseable, Closeable

All Known Implementing Classes:

HBaseAdmin
```
@InterfaceAudience.Public
public interface Admin
extends Abortable, Closeable
```
The administrative API for HBase. Obtain an instance from Connection.getAdmin() and call close() when done.
Admin can be used to create, drop, list, enable and disable and otherwise modify tables, as well as perform other administrative operations.

Since:

0.99.0

See Also:

ConnectionFactory, Connection, Table

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abort(String why, Throwable e)` Abort the server or client.
`boolean`	`abortProcedure(long procId, boolean mayInterruptIfRunning)` Deprecated. Since 2.1.1 -- to be removed.
`Future<Boolean>`	`abortProcedureAsync(long procId, boolean mayInterruptIfRunning)` Deprecated. Since 2.1.1 -- to be removed.
`default void`	`addColumn(TableName tableName, ColumnFamilyDescriptor columnFamily)` Deprecated. As of release 2.0.0. This will be removed in HBase 3.0.0. Use `addColumnFamily(TableName, ColumnFamilyDescriptor)`.
`void`	`addColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily)` Add a column family to an existing table.
`Future<Void>`	`addColumnFamilyAsync(TableName tableName, ColumnFamilyDescriptor columnFamily)` Add a column family to an existing table.
`default void`	`addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig)` Add a new replication peer for replicating data to slave cluster.
`void`	`addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig, boolean enabled)` Add a new replication peer for replicating data to slave cluster.
`default Future<Void>`	`addReplicationPeerAsync(String peerId, ReplicationPeerConfig peerConfig)` Add a new replication peer but does not block and wait for it.
`Future<Void>`	`addReplicationPeerAsync(String peerId, ReplicationPeerConfig peerConfig, boolean enabled)` Add a new replication peer but does not block and wait for it.
`void`	`appendReplicationPeerTableCFs(String id, Map<TableName,List<String>> tableCfs)` Append the replicable table column family config from the specified peer.
`void`	`assign(byte[] regionName)` Assign a Region.
`boolean`	`balance()` Invoke the balancer.
`boolean`	`balance(boolean force)` Invoke the balancer.
`default boolean`	`balancer()` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `balance()` instead.
`default boolean`	`balancer(boolean force)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `balance(boolean)` instead.
`boolean`	`balancerSwitch(boolean onOrOff, boolean synchronous)` Turn the load balancer on or off.
`boolean`	`catalogJanitorSwitch(boolean onOrOff)` Enable/Disable the catalog janitor/
`boolean`	`cleanerChoreSwitch(boolean onOrOff)` Enable/Disable the cleaner chore.
`CacheEvictionStats`	`clearBlockCache(TableName tableName)` Clear all the blocks corresponding to this table from BlockCache.
`void`	`clearCompactionQueues(ServerName serverName, Set<String> queues)` Clear compacting queues on a regionserver.
`List<ServerName>`	`clearDeadServers(List<ServerName> servers)` Clear dead region servers from master.
`void`	`cloneSnapshot(byte[] snapshotName, TableName tableName)` Create a new table by cloning the snapshot content.
`void`	`cloneSnapshot(String snapshotName, TableName tableName)` Create a new table by cloning the snapshot content.
`void`	`cloneSnapshot(String snapshotName, TableName tableName, boolean restoreAcl)` Create a new table by cloning the snapshot content.
`Future<Void>`	`cloneSnapshotAsync(String snapshotName, TableName tableName)` Create a new table by cloning the snapshot content, but does not block and wait for it to be completely cloned.
`void`	`cloneTableSchema(TableName tableName, TableName newTableName, boolean preserveSplits)` Create a new table by cloning the existent table schema.
`void`	`close()`
`void`	`closeRegion(byte[] regionname, String serverName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `unassign(byte[], boolean)`.
`void`	`closeRegion(ServerName sn, HRegionInfo hri)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18231). Use `unassign(byte[], boolean)`.
`void`	`closeRegion(String regionname, String serverName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `unassign(byte[], boolean)`.
`boolean`	`closeRegionWithEncodedRegionName(String encodedRegionName, String serverName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `unassign(byte[], boolean)`.
`void`	`compact(TableName tableName)` Compact a table.
`void`	`compact(TableName tableName, byte[] columnFamily)` Compact a column family within a table.
`void`	`compact(TableName tableName, byte[] columnFamily, CompactType compactType)` Compact a column family within a table.
`void`	`compact(TableName tableName, CompactType compactType)` Compact a table.
`void`	`compactRegion(byte[] regionName)` Compact an individual region.
`void`	`compactRegion(byte[] regionName, byte[] columnFamily)` Compact a column family within a region.
`void`	`compactRegionServer(ServerName serverName)` Compact all regions on the region server.
`default void`	`compactRegionServer(ServerName sn, boolean major)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `compactRegionServer(ServerName)` or `majorCompactRegionServer(ServerName)`.
`CoprocessorRpcChannel`	`coprocessorService()` Creates and returns a `RpcChannel` instance connected to the active master.
`CoprocessorRpcChannel`	`coprocessorService(ServerName serverName)` Creates and returns a `RpcChannel` instance connected to the passed region server.
`void`	`createNamespace(NamespaceDescriptor descriptor)` Create a new namespace.
`Future<Void>`	`createNamespaceAsync(NamespaceDescriptor descriptor)` Create a new namespace.
`void`	`createTable(TableDescriptor desc)` Creates a new table.
`void`	`createTable(TableDescriptor desc, byte[][] splitKeys)` Creates a new table with an initial set of empty regions defined by the specified split keys.
`void`	`createTable(TableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)` Creates a new table with the specified number of regions.
`Future<Void>`	`createTableAsync(TableDescriptor desc, byte[][] splitKeys)` Creates a new table but does not block and wait for it to come online.
`void`	`decommissionRegionServers(List<ServerName> servers, boolean offload)` Mark region server(s) as decommissioned to prevent additional regions from getting assigned to them.
`void`	`deleteColumn(TableName tableName, byte[] columnFamily)` Deprecated. As of release 2.0.0. This will be removed in HBase 3.0.0. Use `deleteColumnFamily(TableName, byte[])`}.
`void`	`deleteColumnFamily(TableName tableName, byte[] columnFamily)` Delete a column family from a table.
`Future<Void>`	`deleteColumnFamilyAsync(TableName tableName, byte[] columnFamily)` Delete a column family from a table.
`void`	`deleteNamespace(String name)` Delete an existing namespace.
`Future<Void>`	`deleteNamespaceAsync(String name)` Delete an existing namespace.
`void`	`deleteSnapshot(byte[] snapshotName)` Delete an existing snapshot.
`void`	`deleteSnapshot(String snapshotName)` Delete an existing snapshot.
`void`	`deleteSnapshots(Pattern pattern)` Delete existing snapshots whose names match the pattern passed.
`void`	`deleteSnapshots(String regex)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `deleteSnapshots(Pattern)` instead.
`void`	`deleteTable(TableName tableName)` Deletes a table.
`Future<Void>`	`deleteTableAsync(TableName tableName)` Deletes the table but does not block and wait for it to be completely removed.
`HTableDescriptor[]`	`deleteTables(Pattern pattern)` Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using `listTableDescriptors(java.util.regex.Pattern)` and `deleteTable(TableName)`
`HTableDescriptor[]`	`deleteTables(String regex)` Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using `listTableDescriptors(Pattern)` and `deleteTable(TableName)`
`void`	`deleteTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)` Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
`void`	`deleteTableSnapshots(String tableNameRegex, String snapshotNameRegex)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `deleteTableSnapshots(Pattern, Pattern)` instead.
`void`	`disableReplicationPeer(String peerId)` Stop the replication stream to the specified peer.
`Future<Void>`	`disableReplicationPeerAsync(String peerId)` Disable a replication peer but does not block and wait for it.
`void`	`disableTable(TableName tableName)` Disable table and wait on completion.
`Future<Void>`	`disableTableAsync(TableName tableName)` Disable the table but does not block and wait for it to be completely disabled.
`void`	`disableTableReplication(TableName tableName)` Disable a table's replication switch.
`HTableDescriptor[]`	`disableTables(Pattern pattern)` Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using `listTableDescriptors(java.util.regex.Pattern)` and `disableTable(org.apache.hadoop.hbase.TableName)`
`HTableDescriptor[]`	`disableTables(String regex)` Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using `listTableDescriptors(Pattern)` and `disableTable(org.apache.hadoop.hbase.TableName)`
`default boolean`	`enableCatalogJanitor(boolean enable)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `catalogJanitorSwitch(boolean)`} instead.
`void`	`enableReplicationPeer(String peerId)` Restart the replication stream to the specified peer.
`Future<Void>`	`enableReplicationPeerAsync(String peerId)` Enable a replication peer but does not block and wait for it.
`void`	`enableTable(TableName tableName)` Enable a table.
`Future<Void>`	`enableTableAsync(TableName tableName)` Enable the table but does not block and wait for it to be completely enabled.
`void`	`enableTableReplication(TableName tableName)` Enable a table's replication switch.
`HTableDescriptor[]`	`enableTables(Pattern pattern)` Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using `listTableDescriptors(java.util.regex.Pattern)` and `enableTable(org.apache.hadoop.hbase.TableName)`
`HTableDescriptor[]`	`enableTables(String regex)` Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using `listTableDescriptors(Pattern)` and `enableTable(org.apache.hadoop.hbase.TableName)`
`void`	`execProcedure(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`default byte[]`	`execProcedureWithRet(String signature, String instance, Map<String,String> props)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `execProcedureWithReturn(String, String, Map)` } instead.
`byte[]`	`execProcedureWithReturn(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`void`	`flush(TableName tableName)` Flush a table.
`void`	`flushRegion(byte[] regionName)` Flush an individual region.
`void`	`flushRegionServer(ServerName serverName)` Flush all regions on the region server.
`Pair<Integer,Integer>`	`getAlterStatus(byte[] tableName)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. No longer needed now you get a Future on an operation.
`Pair<Integer,Integer>`	`getAlterStatus(TableName tableName)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. No longer needed now you get a Future on an operation.
`default Collection<ServerName>`	`getBackupMasters()`
`default ClusterMetrics`	`getClusterMetrics()` Get whole cluster metrics, containing status about:
`ClusterMetrics`	`getClusterMetrics(EnumSet<ClusterMetrics.Option> options)` Get cluster status with a set of `ClusterMetrics.Option` to get desired status.
`default ClusterStatus`	`getClusterStatus()` Deprecated. since 2.0 version and will be removed in 3.0 version. use `getClusterMetrics()`
`CompactionState`	`getCompactionState(TableName tableName)` Get the current compaction state of a table.
`CompactionState`	`getCompactionState(TableName tableName, CompactType compactType)` Get the current compaction state of a table.
`CompactionState`	`getCompactionStateForRegion(byte[] regionName)` Get the current compaction state of region.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()`
`Connection`	`getConnection()`
`TableDescriptor`	`getDescriptor(TableName tableName)` Get a table descriptor.
`long`	`getLastMajorCompactionTimestamp(TableName tableName)` Get the timestamp of the last major compaction for the passed table The timestamp of the oldest HFile resulting from a major compaction of that table, or 0 if no such HFile could be found.
`long`	`getLastMajorCompactionTimestampForRegion(byte[] regionName)` Get the timestamp of the last major compaction for the passed region.
`String`	`getLocks()` Get locks.
`default ServerName`	`getMaster()`
`default List<String>`	`getMasterCoprocessorNames()` Helper that delegates to getClusterMetrics().getMasterCoprocessorNames().
`default String[]`	`getMasterCoprocessors()` Deprecated. since 2.0 version and will be removed in 3.0 version. use `getMasterCoprocessorNames()`
`default int`	`getMasterInfoPort()` Get the info port of the current master if one is available.
`NamespaceDescriptor`	`getNamespaceDescriptor(String name)` Get a namespace descriptor by name.
`List<HRegionInfo>`	`getOnlineRegions(ServerName sn)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17980). Use `getRegions(ServerName sn)`.
`int`	`getOperationTimeout()`
`String`	`getProcedures()` Get procedures.
`List<QuotaSettings>`	`getQuota(QuotaFilter filter)` List the quotas based on the filter.
`QuotaRetriever`	`getQuotaRetriever(QuotaFilter filter)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `getQuota(QuotaFilter)`.
`default List<RegionMetrics>`	`getRegionMetrics(ServerName serverName)` Get `RegionMetrics` of all regions hosted on a regionserver.
`List<RegionMetrics>`	`getRegionMetrics(ServerName serverName, TableName tableName)` Get `RegionMetrics` of all regions hosted on a regionserver for a table.
`List<RegionInfo>`	`getRegions(ServerName serverName)` Get all the online regions on a region server.
`List<RegionInfo>`	`getRegions(TableName tableName)` Get the regions of a given table.
`default Collection<ServerName>`	`getRegionServers()`
`ReplicationPeerConfig`	`getReplicationPeerConfig(String peerId)` Returns the configured ReplicationPeerConfig for the specified peer.
`List<SecurityCapability>`	`getSecurityCapabilities()` Return the set of supported security capabilities.
`HTableDescriptor`	`getTableDescriptor(TableName tableName)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `getDescriptor(TableName)`.
`HTableDescriptor[]`	`getTableDescriptors(List<String> names)` Deprecated. since 2.0 version and will be removed in 3.0 version. use `listTableDescriptors(List)`
`HTableDescriptor[]`	`getTableDescriptorsByTableName(List<TableName> tableNames)` Deprecated. since 2.0 version and will be removed in 3.0 version. use `listTableDescriptors(List)`
`List<HRegionInfo>`	`getTableRegions(TableName tableName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17980). Use `getRegions(TableName)`.
`boolean`	`isAborted()` Check if the server or client was aborted.
`boolean`	`isBalancerEnabled()` Query the current state of the balancer.
`boolean`	`isCatalogJanitorEnabled()` Query on the catalog janitor state (Enabled/Disabled?).
`boolean`	`isCleanerChoreEnabled()` Query on the cleaner chore state (Enabled/Disabled?).
`boolean`	`isMasterInMaintenanceMode()` Check whether Master is in maintenance mode.
`boolean`	`isMergeEnabled()` Query the current state of the merge switch.
`boolean`	`isNormalizerEnabled()` Query the current state of the region normalizer.
`boolean`	`isProcedureFinished(String signature, String instance, Map<String,String> props)` Check the current state of the specified procedure.
`boolean`	`isSnapshotFinished(SnapshotDescription snapshot)` Check the current state of the passed snapshot.
`boolean`	`isSplitEnabled()` Query the current state of the split switch.
`default boolean`	`isSplitOrMergeEnabled(MasterSwitchType switchType)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `isSplitEnabled()` or `isMergeEnabled()` instead.
`boolean`	`isTableAvailable(TableName tableName)`
`boolean`	`isTableAvailable(TableName tableName, byte[][] splitKeys)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `isTableAvailable(TableName)`
`boolean`	`isTableDisabled(TableName tableName)`
`boolean`	`isTableEnabled(TableName tableName)`
`default List<ServerName>`	`listDeadServers()` List dead region servers.
`List<ServerName>`	`listDecommissionedRegionServers()` List region servers marked as decommissioned, which can not be assigned regions.
`NamespaceDescriptor[]`	`listNamespaceDescriptors()` List available namespace descriptors.
`List<TableCFs>`	`listReplicatedTableCFs()` Find all table and column families that are replicated from this cluster
`List<ReplicationPeerDescription>`	`listReplicationPeers()` Return a list of replication peers.
`List<ReplicationPeerDescription>`	`listReplicationPeers(Pattern pattern)` Return a list of replication peers.
`List<SnapshotDescription>`	`listSnapshots()` List completed snapshots.
`List<SnapshotDescription>`	`listSnapshots(Pattern pattern)` List all the completed snapshots matching the given pattern.
`List<SnapshotDescription>`	`listSnapshots(String regex)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listSnapshots(Pattern)` instead.
`List<TableDescriptor>`	`listTableDescriptors()` List all the userspace tables.
`List<TableDescriptor>`	`listTableDescriptors(List<TableName> tableNames)` Get tableDescriptors.
`List<TableDescriptor>`	`listTableDescriptors(Pattern pattern)` List all the userspace tables that match the given pattern.
`List<TableDescriptor>`	`listTableDescriptors(Pattern pattern, boolean includeSysTables)` List all the tables matching the given pattern.
`List<TableDescriptor>`	`listTableDescriptorsByNamespace(byte[] name)` Get list of table descriptors by namespace.
`HTableDescriptor[]`	`listTableDescriptorsByNamespace(String name)` Deprecated. since 2.0 version and will be removed in 3.0 version. use `listTableDescriptorsByNamespace(byte[])`
`TableName[]`	`listTableNames()` List all of the names of userspace tables.
`TableName[]`	`listTableNames(Pattern pattern)` List all of the names of userspace tables.
`TableName[]`	`listTableNames(Pattern pattern, boolean includeSysTables)` List all of the names of userspace tables.
`TableName[]`	`listTableNames(String regex)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableNames(Pattern)` instead.
`TableName[]`	`listTableNames(String regex, boolean includeSysTables)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableNames(Pattern, boolean)` instead.
`TableName[]`	`listTableNamesByNamespace(String name)` Get list of table names by namespace.
`HTableDescriptor[]`	`listTables()` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableDescriptors()`.
`HTableDescriptor[]`	`listTables(Pattern pattern)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableDescriptors(java.util.regex.Pattern)`.
`HTableDescriptor[]`	`listTables(Pattern pattern, boolean includeSysTables)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableDescriptors(java.util.regex.Pattern, boolean)`.
`HTableDescriptor[]`	`listTables(String regex)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableDescriptors(Pattern)` instead.
`HTableDescriptor[]`	`listTables(String regex, boolean includeSysTables)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableDescriptors(Pattern, boolean)`.
`List<SnapshotDescription>`	`listTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)` List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
`List<SnapshotDescription>`	`listTableSnapshots(String tableNameRegex, String snapshotNameRegex)` Deprecated. since 2.0 version and will be removed in 3.0 version. Use `listTableSnapshots(Pattern, Pattern)` instead.
`void`	`majorCompact(TableName tableName)` Major compact a table.
`void`	`majorCompact(TableName tableName, byte[] columnFamily)` Major compact a column family within a table.
`void`	`majorCompact(TableName tableName, byte[] columnFamily, CompactType compactType)` Major compact a column family within a table.
`void`	`majorCompact(TableName tableName, CompactType compactType)` Major compact a table.
`void`	`majorCompactRegion(byte[] regionName)` Major compact a table or an individual region.
`void`	`majorCompactRegion(byte[] regionName, byte[] columnFamily)` Major compact a column family within region.
`void`	`majorCompactRegionServer(ServerName serverName)` Major compact all regions on the region server.
`void`	`mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible)` Deprecated. Since 2.0. Will be removed in 3.0. Use `mergeRegionsAsync(byte[], byte[], boolean)` instead.
`Future<Void>`	`mergeRegionsAsync(byte[][] nameofRegionsToMerge, boolean forcible)` Merge regions.
`Future<Void>`	`mergeRegionsAsync(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible)` Merge two regions.
`boolean`	`mergeSwitch(boolean enabled, boolean synchronous)` Turn the merge switch on or off.
`default void`	`modifyColumn(TableName tableName, ColumnFamilyDescriptor columnFamily)` Deprecated. As of release 2.0.0. This will be removed in HBase 3.0.0. Use `modifyColumnFamily(TableName, ColumnFamilyDescriptor)`.
`void`	`modifyColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily)` Modify an existing column family on a table.
`Future<Void>`	`modifyColumnFamilyAsync(TableName tableName, ColumnFamilyDescriptor columnFamily)` Modify an existing column family on a table.
`void`	`modifyNamespace(NamespaceDescriptor descriptor)` Modify an existing namespace.
`Future<Void>`	`modifyNamespaceAsync(NamespaceDescriptor descriptor)` Modify an existing namespace.
`void`	`modifyTable(TableDescriptor td)` Modify an existing table, more IRB friendly version.
`void`	`modifyTable(TableName tableName, TableDescriptor td)` Deprecated. since 2.0 version and will be removed in 3.0 version. use `modifyTable(TableDescriptor)`
`Future<Void>`	`modifyTableAsync(TableDescriptor td)` Modify an existing table, more IRB (ruby) friendly version.
`Future<Void>`	`modifyTableAsync(TableName tableName, TableDescriptor td)` Deprecated. since 2.0 version and will be removed in 3.0 version. use `modifyTableAsync(TableDescriptor)`
`void`	`move(byte[] encodedRegionName, byte[] destServerName)` Move the region `r` to `dest`.
`boolean`	`normalize()` Invoke region normalizer.
`boolean`	`normalizerSwitch(boolean on)` Turn region normalizer on or off.
`void`	`offline(byte[] regionName)` Offline specified region from master's in-memory state.
`void`	`recommissionRegionServer(ServerName server, List<byte[]> encodedRegionNames)` Remove decommission marker from a region server to allow regions assignments.
`void`	`removeReplicationPeer(String peerId)` Remove a peer and stop the replication.
`Future<Void>`	`removeReplicationPeerAsync(String peerId)` Remove a replication peer but does not block and wait for it.
`void`	`removeReplicationPeerTableCFs(String id, Map<TableName,List<String>> tableCfs)` Remove some table-cfs from config of the specified peer.
`void`	`restoreSnapshot(byte[] snapshotName)` Restore the specified snapshot on the original table.
`void`	`restoreSnapshot(byte[] snapshotName, boolean takeFailSafeSnapshot)` Restore the specified snapshot on the original table.
`void`	`restoreSnapshot(String snapshotName)` Restore the specified snapshot on the original table.
`void`	`restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot)` Restore the specified snapshot on the original table.
`void`	`restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot, boolean restoreAcl)` Restore the specified snapshot on the original table.
`Future<Void>`	`restoreSnapshotAsync(String snapshotName)` Restore the specified snapshot on the original table.
`void`	`rollWALWriter(ServerName serverName)` Roll the log writer.
`int`	`runCatalogJanitor()` Ask for a scan of the catalog table.
`default int`	`runCatalogScan()` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `runCatalogJanitor()`} instead.
`boolean`	`runCleanerChore()` Ask for cleaner chore to run.
`default boolean`	`setBalancerRunning(boolean on, boolean synchronous)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `balancerSwitch(boolean, boolean)` instead.
`default boolean`	`setCleanerChoreRunning(boolean on)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `cleanerChoreSwitch(boolean)`} instead.
`default boolean`	`setNormalizerRunning(boolean on)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `normalizerSwitch(boolean)`} instead.
`void`	`setQuota(QuotaSettings quota)` Apply the new quota settings.
`default boolean[]`	`setSplitOrMergeEnabled(boolean enabled, boolean synchronous, MasterSwitchType... switchTypes)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `splitSwitch(boolean, boolean)` or `mergeSwitch(boolean, boolean)` instead.
`void`	`shutdown()` Shuts down the HBase cluster.
`void`	`snapshot(byte[] snapshotName, TableName tableName)` Create a timestamp consistent snapshot for the given table.
`void`	`snapshot(SnapshotDescription snapshot)` Take a snapshot and wait for the server to complete that snapshot (blocking).
`void`	`snapshot(String snapshotName, TableName tableName)` Take a snapshot for the given table.
`void`	`snapshot(String snapshotName, TableName tableName, SnapshotType type)` Create typed snapshot of the table.
`void`	`snapshotAsync(SnapshotDescription snapshot)` Take a snapshot without waiting for the server to complete that snapshot (asynchronous) Only a single snapshot should be taken at a time, or results may be undefined.
`void`	`split(TableName tableName)` + Split a table.
`void`	`split(TableName tableName, byte[] splitPoint)` Split a table.
`void`	`splitRegion(byte[] regionName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `splitRegionAsync(byte[], byte[])`.
`void`	`splitRegion(byte[] regionName, byte[] splitPoint)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use `splitRegionAsync(byte[], byte[])`.
`Future<Void>`	`splitRegionAsync(byte[] regionName, byte[] splitPoint)` Split an individual region.
`boolean`	`splitSwitch(boolean enabled, boolean synchronous)` Turn the split switch on or off.
`void`	`stopMaster()` Shuts down the current HBase master only.
`void`	`stopRegionServer(String hostnamePort)` Stop the designated regionserver.
`boolean`	`tableExists(TableName tableName)`
`default void`	`takeSnapshotAsync(SnapshotDescription snapshot)` Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use `snapshotAsync(SnapshotDescription)` instead.
`void`	`truncateTable(TableName tableName, boolean preserveSplits)` Truncate a table.
`Future<Void>`	`truncateTableAsync(TableName tableName, boolean preserveSplits)` Truncate the table but does not block and wait for it to be completely enabled.
`void`	`unassign(byte[] regionName, boolean force)` Unassign a region from current hosting regionserver.
`void`	`updateConfiguration()` Update the configuration and trigger an online config change on all the regionservers.
`void`	`updateConfiguration(ServerName server)` Update the configuration and trigger an online config change on the regionserver.
`void`	`updateReplicationPeerConfig(String peerId, ReplicationPeerConfig peerConfig)` Update the peerConfig for the specified peer.
`Future<Void>`	`updateReplicationPeerConfigAsync(String peerId, ReplicationPeerConfig peerConfig)` Update the peerConfig for the specified peer but does not block and wait for it.

- Method Detail
  - getOperationTimeout
```
int getOperationTimeout()
```
  - abort
```
void abort(String why,
           Throwable e)
```
    Description copied from interface: Abortable
    
    Abort the server or client.
    
    Specified by:
    
    abort in interface Abortable
    
    Parameters:
    
    why - Why we're aborting.
    
    e - Throwable that caused abort. Can be null.
  - isAborted
```
boolean isAborted()
```
    Description copied from interface: Abortable
    
    Check if the server or client was aborted.
    
    Specified by:
    
    isAborted in interface Abortable
    
    Returns:
    
    true if the server or client was aborted, false otherwise
  - getConnection
```
Connection getConnection()
```
    Returns:
    
    Connection used by this object.
  - tableExists
```
boolean tableExists(TableName tableName)
             throws IOException
```
    Parameters:
    
    tableName - Table to check.
    
    Returns:
    
    true if table exists already.
    
    Throws:
    
    IOException
  - listTables
```
@Deprecated
HTableDescriptor[] listTables()
                                   throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableDescriptors().
    
    List all the userspace tables.
    
    Returns:
    
    an array of read-only HTableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    listTableDescriptors()
  - listTableDescriptors
```
List<TableDescriptor> listTableDescriptors()
                                    throws IOException
```
    List all the userspace tables.
    
    Returns:
    
    a list of TableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTables
```
@Deprecated
HTableDescriptor[] listTables(Pattern pattern)
                                   throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableDescriptors(java.util.regex.Pattern).
    
    List all the userspace tables that match the given pattern.
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    Returns:
    
    an array of read-only HTableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    listTables(), listTableDescriptors(Pattern)
  - listTableDescriptors
```
List<TableDescriptor> listTableDescriptors(Pattern pattern)
                                    throws IOException
```
    List all the userspace tables that match the given pattern.
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    Returns:
    
    a list of TableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    listTables()
  - listTables
```
@Deprecated
HTableDescriptor[] listTables(String regex)
                                   throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableDescriptors(Pattern) instead.
    
    List all the userspace tables matching the given regular expression.
    
    Parameters:
    
    regex - The regular expression to match against
    
    Returns:
    
    a list of read-only HTableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    listTableDescriptors(Pattern)
  - listTables
```
@Deprecated
HTableDescriptor[] listTables(Pattern pattern,
                                          boolean includeSysTables)
                                   throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableDescriptors(java.util.regex.Pattern, boolean).
    
    List all the tables matching the given pattern.
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    Returns:
    
    an array of read-only HTableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    listTables(), listTableDescriptors(java.util.regex.Pattern, boolean)
  - listTableDescriptors
```
List<TableDescriptor> listTableDescriptors(Pattern pattern,
                                           boolean includeSysTables)
                                    throws IOException
```
    List all the tables matching the given pattern.
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    Returns:
    
    a list of TableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    listTables()
  - listTables
```
@Deprecated
HTableDescriptor[] listTables(String regex,
                                          boolean includeSysTables)
                                   throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableDescriptors(Pattern, boolean).
    
    List all the tables matching the given pattern.
    
    Parameters:
    
    regex - The regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    Returns:
    
    an array of read-only HTableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    listTables(java.util.regex.Pattern, boolean)
  - listTableNames
```
TableName[] listTableNames()
                    throws IOException
```
    List all of the names of userspace tables.
    
    Returns:
    
    TableName[] table names
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
TableName[] listTableNames(Pattern pattern)
                    throws IOException
```
    List all of the names of userspace tables.
    
    Parameters:
    
    pattern - The regular expression to match against
    
    Returns:
    
    array of table names
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
@Deprecated
TableName[] listTableNames(String regex)
                                throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableNames(Pattern) instead.
    
    List all of the names of userspace tables.
    
    Parameters:
    
    regex - The regular expression to match against
    
    Returns:
    
    TableName[] table names
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
TableName[] listTableNames(Pattern pattern,
                           boolean includeSysTables)
                    throws IOException
```
    List all of the names of userspace tables.
    
    Parameters:
    
    pattern - The regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    Returns:
    
    TableName[] table names
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
@Deprecated
TableName[] listTableNames(String regex,
                                       boolean includeSysTables)
                                throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableNames(Pattern, boolean) instead.
    
    List all of the names of userspace tables.
    
    Parameters:
    
    regex - The regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    Returns:
    
    TableName[] table names
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getTableDescriptor
```
@Deprecated
HTableDescriptor getTableDescriptor(TableName tableName)
                                         throws TableNotFoundException,
                                                IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use getDescriptor(TableName).
    
    Get a table descriptor.
    
    Parameters:
    
    tableName - as a TableName
    
    Returns:
    
    the read-only tableDescriptor
    
    Throws:
    
    TableNotFoundException
    
    IOException - if a remote or network exception occurs
  - getDescriptor
```
TableDescriptor getDescriptor(TableName tableName)
                       throws TableNotFoundException,
                              IOException
```
    Get a table descriptor.
    
    Parameters:
    
    tableName - as a TableName
    
    Returns:
    
    the tableDescriptor
    
    Throws:
    
    TableNotFoundException
    
    IOException - if a remote or network exception occurs
  - createTable
```
void createTable(TableDescriptor desc)
          throws IOException
```
    Creates a new table. Synchronous operation.
    
    Parameters:
    
    desc - table descriptor for table
    
    Throws:
    
    IllegalArgumentException - if the table name is reserved
    
    MasterNotRunningException - if master is not running
    
    TableExistsException - if table already exists (If concurrent threads, the table may have been created between test-for-existence and attempt-at-creation).
    
    IOException - if a remote or network exception occurs
  - createTable
```
void createTable(TableDescriptor desc,
                 byte[] startKey,
                 byte[] endKey,
                 int numRegions)
          throws IOException
```
    Creates a new table with the specified number of regions. The start key specified will become the end key of the first region of the table, and the end key specified will become the start key of the last region of the table (the first region has a null start key and the last region has a null end key). BigInteger math will be used to divide the key range specified into enough segments to make the required number of total regions. Synchronous operation.
    
    Parameters:
    
    desc - table descriptor for table
    
    startKey - beginning of key range
    
    endKey - end of key range
    
    numRegions - the total number of regions to create
    
    Throws:
    
    IllegalArgumentException - if the table name is reserved
    
    MasterNotRunningException - if master is not running
    
    TableExistsException - if table already exists (If concurrent threads, the table may have been created between test-for-existence and attempt-at-creation).
    
    IOException
  - createTable
```
void createTable(TableDescriptor desc,
                 byte[][] splitKeys)
          throws IOException
```
    Creates a new table with an initial set of empty regions defined by the specified split keys. The total number of regions created will be the number of split keys plus one. Synchronous operation. Note : Avoid passing empty split key.
    
    Parameters:
    
    desc - table descriptor for table
    
    splitKeys - array of split keys for the initial regions of the table
    
    Throws:
    
    IllegalArgumentException - if the table name is reserved, if the split keys are repeated and if the split key has empty byte array.
    
    MasterNotRunningException - if master is not running
    
    TableExistsException - if table already exists (If concurrent threads, the table may have been created between test-for-existence and attempt-at-creation).
    
    IOException
  - createTableAsync
```
Future<Void> createTableAsync(TableDescriptor desc,
                              byte[][] splitKeys)
                       throws IOException
```
    Creates a new table but does not block and wait for it to come online. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete. Throws IllegalArgumentException Bad table name, if the split keys are repeated and if the split key has empty byte array.
    
    Parameters:
    
    desc - table descriptor for table
    
    splitKeys - keys to check if the table has been created with all split keys
    
    Returns:
    
    the result of the async creation. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteTable
```
void deleteTable(TableName tableName)
          throws IOException
```
    Deletes a table. Synchronous operation.
    
    Parameters:
    
    tableName - name of table to delete
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteTableAsync
```
Future<Void> deleteTableAsync(TableName tableName)
                       throws IOException
```
    Deletes the table but does not block and wait for it to be completely removed. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of table to delete
    
    Returns:
    
    the result of the async delete. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteTables
```
@Deprecated
HTableDescriptor[] deleteTables(String regex)
                                     throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using listTableDescriptors(Pattern) and deleteTable(TableName)
    
    Deletes tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTableDescriptors(Pattern) and deleteTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be deleted. The return htds are read-only
    
    Throws:
    
    IOException
    
    See Also:
    
    deleteTables(java.util.regex.Pattern), deleteTable(org.apache.hadoop.hbase.TableName)
  - deleteTables
```
@Deprecated
HTableDescriptor[] deleteTables(Pattern pattern)
                                     throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using listTableDescriptors(java.util.regex.Pattern) and deleteTable(TableName)
    
    Delete tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTableDescriptors(java.util.regex.Pattern) and deleteTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be deleted The return htds are read-only
    
    Throws:
    
    IOException
  - truncateTable
```
void truncateTable(TableName tableName,
                   boolean preserveSplits)
            throws IOException
```
    Truncate a table. Synchronous operation.
    
    Parameters:
    
    tableName - name of table to truncate
    
    preserveSplits - true if the splits should be preserved
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - truncateTableAsync
```
Future<Void> truncateTableAsync(TableName tableName,
                                boolean preserveSplits)
                         throws IOException
```
    Truncate the table but does not block and wait for it to be completely enabled. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of table to delete
    
    preserveSplits - true if the splits should be preserved
    
    Returns:
    
    the result of the async truncate. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - enableTable
```
void enableTable(TableName tableName)
          throws IOException
```
    Enable a table. May timeout. Use enableTableAsync(org.apache.hadoop.hbase.TableName) and isTableEnabled(org.apache.hadoop.hbase.TableName) instead. The table has to be in disabled state for it to be enabled.
    
    Parameters:
    
    tableName - name of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs There could be couple types of IOException TableNotFoundException means the table doesn't exist. TableNotDisabledException means the table isn't in disabled state.
    
    See Also:
    
    isTableEnabled(org.apache.hadoop.hbase.TableName), disableTable(org.apache.hadoop.hbase.TableName), enableTableAsync(org.apache.hadoop.hbase.TableName)
  - enableTableAsync
```
Future<Void> enableTableAsync(TableName tableName)
                       throws IOException
```
    Enable the table but does not block and wait for it to be completely enabled. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of table to delete
    
    Returns:
    
    the result of the async enable. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - enableTables
```
@Deprecated
HTableDescriptor[] enableTables(String regex)
                                     throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using listTableDescriptors(Pattern) and enableTable(org.apache.hadoop.hbase.TableName)
    
    Enable tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTableDescriptors(Pattern) and enableTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be enabled. The return HTDs are read-only.
    
    Throws:
    
    IOException
    
    See Also:
    
    enableTables(java.util.regex.Pattern), enableTable(org.apache.hadoop.hbase.TableName)
  - enableTables
```
@Deprecated
HTableDescriptor[] enableTables(Pattern pattern)
                                     throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using listTableDescriptors(java.util.regex.Pattern) and enableTable(org.apache.hadoop.hbase.TableName)
    
    Enable tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTableDescriptors(java.util.regex.Pattern) and enableTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be enabled. The return HTDs are read-only.
    
    Throws:
    
    IOException
  - disableTableAsync
```
Future<Void> disableTableAsync(TableName tableName)
                        throws IOException
```
    Disable the table but does not block and wait for it to be completely disabled. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of table to delete
    
    Returns:
    
    the result of the async disable. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - disableTable
```
void disableTable(TableName tableName)
           throws IOException
```
    Disable table and wait on completion. May timeout eventually. Use disableTableAsync(org.apache.hadoop.hbase.TableName) and isTableDisabled(org.apache.hadoop.hbase.TableName) instead. The table has to be in enabled state for it to be disabled.
    
    Parameters:
    
    tableName -
    
    Throws:
    
    IOException - There could be couple types of IOException TableNotFoundException means the table doesn't exist. TableNotEnabledException means the table isn't in enabled state.
  - disableTables
```
@Deprecated
HTableDescriptor[] disableTables(String regex)
                                      throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using listTableDescriptors(Pattern) and disableTable(org.apache.hadoop.hbase.TableName)
    
    Disable tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTableDescriptors(Pattern) and disableTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be disabled The return htds are read-only
    
    Throws:
    
    IOException
    
    See Also:
    
    disableTables(java.util.regex.Pattern), disableTable(org.apache.hadoop.hbase.TableName)
  - disableTables
```
@Deprecated
HTableDescriptor[] disableTables(Pattern pattern)
                                      throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version This is just a trivial helper method without any magic. Consider using listTableDescriptors(java.util.regex.Pattern) and disableTable(org.apache.hadoop.hbase.TableName)
    
    Disable tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTableDescriptors(java.util.regex.Pattern) and disableTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be disabled The return htds are read-only
    
    Throws:
    
    IOException
  - isTableEnabled
```
boolean isTableEnabled(TableName tableName)
                throws IOException
```
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if table is on-line
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableDisabled
```
boolean isTableDisabled(TableName tableName)
                 throws IOException
```
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if table is off-line
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableAvailable
```
boolean isTableAvailable(TableName tableName)
                  throws IOException
```
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if all regions of the table are available
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableAvailable
```
@Deprecated
boolean isTableAvailable(TableName tableName,
                                     byte[][] splitKeys)
                              throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use isTableAvailable(TableName)
    
    Use this api to check if the table has been created with the specified number of splitkeys which was used while creating the given table. Note : If this api is used after a table's region gets splitted, the api may return false.
    
    Parameters:
    
    tableName - name of table to check
    
    splitKeys - keys to check if the table has been created with all split keys
    
    Throws:
    
    IOException - if a remote or network excpetion occurs
  - getAlterStatus
```
@Deprecated
Pair<Integer,Integer> getAlterStatus(TableName tableName)
                                          throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. No longer needed now you get a Future on an operation.
    
    Get the status of an alter (a.k.a modify) command - indicates how many regions have received the updated schema Asynchronous operation.
    
    Parameters:
    
    tableName - TableName instance
    
    Returns:
    
    Pair indicating the number of regions updated Pair.getFirst() is the regions that are yet to be updated Pair.getSecond() is the total number of regions of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getAlterStatus
```
@Deprecated
Pair<Integer,Integer> getAlterStatus(byte[] tableName)
                                          throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. No longer needed now you get a Future on an operation.
    
    Get the status of alter (a.k.a modify) command - indicates how many regions have received the updated schema Asynchronous operation.
    
    Parameters:
    
    tableName - name of the table to get the status of
    
    Returns:
    
    Pair indicating the number of regions updated Pair.getFirst() is the regions that are yet to be updated Pair.getSecond() is the total number of regions of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - addColumn
```
@Deprecated
default void addColumn(TableName tableName,
                                   ColumnFamilyDescriptor columnFamily)
                            throws IOException
```
    Deprecated. As of release 2.0.0. This will be removed in HBase 3.0.0. Use addColumnFamily(TableName, ColumnFamilyDescriptor).
    
    Add a column family to an existing table. Synchronous operation. Use addColumnFamilyAsync(TableName, ColumnFamilyDescriptor) instead because it returns a Future from which you can learn whether success or failure.
    
    Parameters:
    
    tableName - name of the table to add column family to
    
    columnFamily - column family descriptor of column family to be added
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - addColumnFamily
```
void addColumnFamily(TableName tableName,
                     ColumnFamilyDescriptor columnFamily)
              throws IOException
```
    Add a column family to an existing table. Synchronous operation. Use addColumnFamilyAsync(TableName, ColumnFamilyDescriptor) instead because it returns a Future from which you can learn whether success or failure.
    
    Parameters:
    
    tableName - name of the table to add column family to
    
    columnFamily - column family descriptor of column family to be added
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - addColumnFamilyAsync
```
Future<Void> addColumnFamilyAsync(TableName tableName,
                                  ColumnFamilyDescriptor columnFamily)
                           throws IOException
```
    Add a column family to an existing table. Asynchronous operation. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of the table to add column family to
    
    columnFamily - column family descriptor of column family to be added
    
    Returns:
    
    the result of the async add column family. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteColumn
```
@Deprecated
void deleteColumn(TableName tableName,
                              byte[] columnFamily)
                       throws IOException
```
    Deprecated. As of release 2.0.0. This will be removed in HBase 3.0.0. Use deleteColumnFamily(TableName, byte[])}.
    
    Delete a column family from a table. Synchronous operation. Use deleteColumnFamily(TableName, byte[]) instead because it returns a Future from which you can learn whether success or failure.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteColumnFamily
```
void deleteColumnFamily(TableName tableName,
                        byte[] columnFamily)
                 throws IOException
```
    Delete a column family from a table. Synchronous operation. Use deleteColumnFamily(TableName, byte[]) instead because it returns a Future from which you can learn whether success or failure.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteColumnFamilyAsync
```
Future<Void> deleteColumnFamilyAsync(TableName tableName,
                                     byte[] columnFamily)
                              throws IOException
```
    Delete a column family from a table. Asynchronous operation. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
    
    Returns:
    
    the result of the async delete column family. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - modifyColumn
```
@Deprecated
default void modifyColumn(TableName tableName,
                                      ColumnFamilyDescriptor columnFamily)
                               throws IOException
```
    Deprecated. As of release 2.0.0. This will be removed in HBase 3.0.0. Use modifyColumnFamily(TableName, ColumnFamilyDescriptor).
    
    Modify an existing column family on a table. Synchronous operation. Use modifyColumnFamilyAsync(TableName, ColumnFamilyDescriptor) instead because it returns a Future from which you can learn whether success or failure.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - new column family descriptor to use
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - modifyColumnFamily
```
void modifyColumnFamily(TableName tableName,
                        ColumnFamilyDescriptor columnFamily)
                 throws IOException
```
    Modify an existing column family on a table. Synchronous operation. Use modifyColumnFamilyAsync(TableName, ColumnFamilyDescriptor) instead because it returns a Future from which you can learn whether success or failure.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - new column family descriptor to use
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - modifyColumnFamilyAsync
```
Future<Void> modifyColumnFamilyAsync(TableName tableName,
                                     ColumnFamilyDescriptor columnFamily)
                              throws IOException
```
    Modify an existing column family on a table. Asynchronous operation. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - new column family descriptor to use
    
    Returns:
    
    the result of the async modify column family. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
@Deprecated
void closeRegion(String regionname,
                             String serverName)
                      throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use unassign(byte[], boolean).
    
    Uses unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    Parameters:
    
    regionname - region name to close
    
    serverName - Deprecated. Not used.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
@Deprecated
void closeRegion(byte[] regionname,
                             String serverName)
                      throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use unassign(byte[], boolean).
    
    Uses unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    Parameters:
    
    regionname - region name to close
    
    serverName - Deprecated. Not used.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - closeRegionWithEncodedRegionName
```
@Deprecated
boolean closeRegionWithEncodedRegionName(String encodedRegionName,
                                                     String serverName)
                                              throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use unassign(byte[], boolean).
    
    Uses unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    Parameters:
    
    encodedRegionName - The encoded region name; i.e. the hash that makes up the region name suffix: e.g. if regionname is TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396., then the encoded region name is: 527db22f95c8a9e0116f0cc13c680396.
    
    serverName - Deprecated. Not used.
    
    Returns:
    
    Deprecated. Returns true always.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
@Deprecated
void closeRegion(ServerName sn,
                             HRegionInfo hri)
                      throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18231). Use unassign(byte[], boolean).
    
    Used unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    Parameters:
    
    sn - Deprecated. Not used.
    
    Throws:
    
    IOException
  - getOnlineRegions
```
@Deprecated
List<HRegionInfo> getOnlineRegions(ServerName sn)
                                        throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17980). Use getRegions(ServerName sn).
    
    Get all the online regions on a region server.
    
    Throws:
    
    IOException
  - getRegions
```
List<RegionInfo> getRegions(ServerName serverName)
                     throws IOException
```
    Get all the online regions on a region server.
    
    Returns:
    
    List of RegionInfo
    
    Throws:
    
    IOException
  - flush
```
void flush(TableName tableName)
    throws IOException
```
    Flush a table. Synchronous operation.
    
    Parameters:
    
    tableName - table to flush
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - flushRegion
```
void flushRegion(byte[] regionName)
          throws IOException
```
    Flush an individual region. Synchronous operation.
    
    Parameters:
    
    regionName - region to flush
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - flushRegionServer
```
void flushRegionServer(ServerName serverName)
                throws IOException
```
    Flush all regions on the region server. Synchronous operation.
    
    Parameters:
    
    serverName - the region server name to flush
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - compact
```
void compact(TableName tableName)
      throws IOException
```
    Compact a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to compact
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - compactRegion
```
void compactRegion(byte[] regionName)
            throws IOException
```
    Compact an individual region. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    regionName - region to compact
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - compact
```
void compact(TableName tableName,
             byte[] columnFamily)
      throws IOException
```
    Compact a column family within a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to compact
    
    columnFamily - column family within a table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - compactRegion
```
void compactRegion(byte[] regionName,
                   byte[] columnFamily)
            throws IOException
```
    Compact a column family within a region. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    regionName - region to compact
    
    columnFamily - column family within a region
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - compact
```
void compact(TableName tableName,
             CompactType compactType)
      throws IOException,
             InterruptedException
```
    Compact a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to compact
    
    compactType - CompactType
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    InterruptedException
  - compact
```
void compact(TableName tableName,
             byte[] columnFamily,
             CompactType compactType)
      throws IOException,
             InterruptedException
```
    Compact a column family within a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to compact
    
    columnFamily - column family within a table
    
    compactType - CompactType
    
    Throws:
    
    IOException - if not a mob column family or if a remote or network exception occurs
    
    InterruptedException
  - majorCompact
```
void majorCompact(TableName tableName)
           throws IOException
```
    Major compact a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to major compact
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - majorCompactRegion
```
void majorCompactRegion(byte[] regionName)
                 throws IOException
```
    Major compact a table or an individual region. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    regionName - region to major compact
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - majorCompact
```
void majorCompact(TableName tableName,
                  byte[] columnFamily)
           throws IOException
```
    Major compact a column family within a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to major compact
    
    columnFamily - column family within a table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - majorCompactRegion
```
void majorCompactRegion(byte[] regionName,
                        byte[] columnFamily)
                 throws IOException
```
    Major compact a column family within region. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    regionName - egion to major compact
    
    columnFamily - column family within a region
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - majorCompact
```
void majorCompact(TableName tableName,
                  CompactType compactType)
           throws IOException,
                  InterruptedException
```
    Major compact a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to compact
    
    compactType - CompactType
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    InterruptedException
  - majorCompact
```
void majorCompact(TableName tableName,
                  byte[] columnFamily,
                  CompactType compactType)
           throws IOException,
                  InterruptedException
```
    Major compact a column family within a table. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    tableName - table to compact
    
    columnFamily - column family within a table
    
    compactType - CompactType
    
    Throws:
    
    IOException - if not a mob column family or if a remote or network exception occurs
    
    InterruptedException
  - compactRegionServer
```
@Deprecated
default void compactRegionServer(ServerName sn,
                                             boolean major)
                                      throws IOException,
                                             InterruptedException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use compactRegionServer(ServerName) or majorCompactRegionServer(ServerName).
    
    Compact all regions on the region server. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    sn - the region server name
    
    major - if it's major compaction
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    InterruptedException
  - compactRegionServer
```
void compactRegionServer(ServerName serverName)
                  throws IOException
```
    Compact all regions on the region server. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    serverName - the region server name
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - majorCompactRegionServer
```
void majorCompactRegionServer(ServerName serverName)
                       throws IOException
```
    Major compact all regions on the region server. Asynchronous operation in that this method requests that a Compaction run and then it returns. It does not wait on the completion of Compaction (it can take a while).
    
    Parameters:
    
    serverName - the region server name
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - move
```
void move(byte[] encodedRegionName,
          byte[] destServerName)
   throws IOException
```
    Move the region r to dest.
    
    Parameters:
    
    encodedRegionName - The encoded region name; i.e. the hash that makes up the region name suffix: e.g. if regionname is TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396., then the encoded region name is: 527db22f95c8a9e0116f0cc13c680396.
    
    destServerName - The servername of the destination regionserver. If passed the empty byte array we'll assign to a random server. A server name is made of host, port and startcode. Here is an example: host187.example.com,60020,1289493121758
    
    Throws:
    
    IOException - if we can't find a region named encodedRegionName
  - assign
```
void assign(byte[] regionName)
     throws IOException
```
    Assign a Region.
    
    Parameters:
    
    regionName - Region name to assign.
    
    Throws:
    
    IOException
  - unassign
```
void unassign(byte[] regionName,
              boolean force)
       throws IOException
```
    Unassign a region from current hosting regionserver. Region will then be assigned to a regionserver chosen at random. Region could be reassigned back to the same server. Use move(byte[], byte[]) if you want to control the region movement.
    
    Parameters:
    
    regionName - Region to unassign. Will clear any existing RegionPlan if one found.
    
    force - If true, force unassign (Will remove region from regions-in-transition too if present. If results in double assignment use hbck -fix to resolve. To be used by experts).
    
    Throws:
    
    IOException
  - offline
```
void offline(byte[] regionName)
      throws IOException
```
    Offline specified region from master's in-memory state. It will not attempt to reassign the region as in unassign. This API can be used when a region not served by any region server and still online as per Master's in memory state. If this API is incorrectly used on active region then master will loose track of that region. This is a special method that should be used by experts or hbck.
    
    Parameters:
    
    regionName - Region to offline.
    
    Throws:
    
    IOException
  - setBalancerRunning
```
@Deprecated
default boolean setBalancerRunning(boolean on,
                                               boolean synchronous)
                                        throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use balancerSwitch(boolean, boolean) instead.
    
    Turn the load balancer on or off.
    
    Parameters:
    
    synchronous - If true, it waits until current balance() call, if outstanding, to return.
    
    Returns:
    
    Previous balancer value
    
    Throws:
    
    IOException
  - balancerSwitch
```
boolean balancerSwitch(boolean onOrOff,
                       boolean synchronous)
                throws IOException
```
    Turn the load balancer on or off.
    
    Parameters:
    
    onOrOff - Set to true to enable, false to disable.
    
    synchronous - If true, it waits until current balance() call, if outstanding, to return.
    
    Returns:
    
    Previous balancer value
    
    Throws:
    
    IOException
  - balancer
```
@Deprecated
default boolean balancer()
                              throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use balance() instead.
    
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. Can NOT run for various reasons. Check logs.
    
    Returns:
    
    true if balancer ran, false otherwise.
    
    Throws:
    
    IOException
  - balance
```
boolean balance()
         throws IOException
```
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. Can NOT run for various reasons. Check logs.
    
    Returns:
    
    true if balancer ran, false otherwise.
    
    Throws:
    
    IOException
  - balancer
```
@Deprecated
default boolean balancer(boolean force)
                              throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use balance(boolean) instead.
    
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. If there is region in transition, force parameter of true would still run balancer. Can *not* run for other reasons. Check logs.
    
    Parameters:
    
    force - whether we should force balance even if there is region in transition
    
    Returns:
    
    true if balancer ran, false otherwise.
    
    Throws:
    
    IOException
  - balance
```
boolean balance(boolean force)
         throws IOException
```
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. If there is region in transition, force parameter of true would still run balancer. Can *not* run for other reasons. Check logs.
    
    Parameters:
    
    force - whether we should force balance even if there is region in transition
    
    Returns:
    
    true if balancer ran, false otherwise.
    
    Throws:
    
    IOException
  - isBalancerEnabled
```
boolean isBalancerEnabled()
                   throws IOException
```
    Query the current state of the balancer.
    
    Returns:
    
    true if the balancer is enabled, false otherwise.
    
    Throws:
    
    IOException
  - clearBlockCache
```
CacheEvictionStats clearBlockCache(TableName tableName)
                            throws IOException
```
    Clear all the blocks corresponding to this table from BlockCache. For expert-admins. Calling this API will drop all the cached blocks specific to a table from BlockCache. This can significantly impact the query performance as the subsequent queries will have to retrieve the blocks from underlying filesystem.
    
    Parameters:
    
    tableName - table to clear block cache
    
    Returns:
    
    CacheEvictionStats related to the eviction
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - normalize
```
boolean normalize()
           throws IOException
```
    Invoke region normalizer. Can NOT run for various reasons. Check logs.
    
    Returns:
    
    true if region normalizer ran, false otherwise.
    
    Throws:
    
    IOException
  - isNormalizerEnabled
```
boolean isNormalizerEnabled()
                     throws IOException
```
    Query the current state of the region normalizer.
    
    Returns:
    
    true if region normalizer is enabled, false otherwise.
    
    Throws:
    
    IOException
  - setNormalizerRunning
```
@Deprecated
default boolean setNormalizerRunning(boolean on)
                                          throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use normalizerSwitch(boolean)} instead.
    
    Turn region normalizer on or off.
    
    Returns:
    
    Previous normalizer value
    
    Throws:
    
    IOException
  - normalizerSwitch
```
boolean normalizerSwitch(boolean on)
                  throws IOException
```
    Turn region normalizer on or off.
    
    Returns:
    
    Previous normalizer value
    
    Throws:
    
    IOException
  - enableCatalogJanitor
```
@Deprecated
default boolean enableCatalogJanitor(boolean enable)
                                          throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use catalogJanitorSwitch(boolean)} instead.
    
    Enable/Disable the catalog janitor.
    
    Parameters:
    
    enable - if true enables the catalog janitor
    
    Returns:
    
    the previous state
    
    Throws:
    
    IOException
  - catalogJanitorSwitch
```
boolean catalogJanitorSwitch(boolean onOrOff)
                      throws IOException
```
    Enable/Disable the catalog janitor/
    
    Parameters:
    
    onOrOff - if true enables the catalog janitor
    
    Returns:
    
    the previous state
    
    Throws:
    
    IOException
  - runCatalogScan
```
@Deprecated
default int runCatalogScan()
                                throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use runCatalogJanitor()} instead.
    
    Ask for a scan of the catalog table.
    
    Returns:
    
    the number of entries cleaned
    
    Throws:
    
    IOException
  - runCatalogJanitor
```
int runCatalogJanitor()
               throws IOException
```
    Ask for a scan of the catalog table.
    
    Returns:
    
    the number of entries cleaned
    
    Throws:
    
    IOException
  - isCatalogJanitorEnabled
```
boolean isCatalogJanitorEnabled()
                         throws IOException
```
    Query on the catalog janitor state (Enabled/Disabled?).
    
    Throws:
    
    IOException
  - setCleanerChoreRunning
```
@Deprecated
default boolean setCleanerChoreRunning(boolean on)
                                            throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use cleanerChoreSwitch(boolean)} instead.
    
    Enable/Disable the cleaner chore.
    
    Parameters:
    
    on - if true enables the cleaner chore
    
    Returns:
    
    the previous state
    
    Throws:
    
    IOException
  - cleanerChoreSwitch
```
boolean cleanerChoreSwitch(boolean onOrOff)
                    throws IOException
```
    Enable/Disable the cleaner chore.
    
    Parameters:
    
    onOrOff - if true enables the cleaner chore
    
    Returns:
    
    the previous state
    
    Throws:
    
    IOException
  - runCleanerChore
```
boolean runCleanerChore()
                 throws IOException
```
    Ask for cleaner chore to run.
    
    Returns:
    
    true if cleaner chore ran, false otherwise
    
    Throws:
    
    IOException
  - isCleanerChoreEnabled
```
boolean isCleanerChoreEnabled()
                       throws IOException
```
    Query on the cleaner chore state (Enabled/Disabled?).
    
    Throws:
    
    IOException
  - mergeRegions
```
@Deprecated
void mergeRegions(byte[] nameOfRegionA,
                              byte[] nameOfRegionB,
                              boolean forcible)
                       throws IOException
```
    Deprecated. Since 2.0. Will be removed in 3.0. Use mergeRegionsAsync(byte[], byte[], boolean) instead.
    
    Merge two regions. Asynchronous operation.
    
    Parameters:
    
    nameOfRegionA - encoded or full name of region a
    
    nameOfRegionB - encoded or full name of region b
    
    forcible - true if do a compulsory merge, otherwise we will only merge two adjacent regions
    
    Throws:
    
    IOException
  - mergeRegionsAsync
```
Future<Void> mergeRegionsAsync(byte[] nameOfRegionA,
                               byte[] nameOfRegionB,
                               boolean forcible)
                        throws IOException
```
    Merge two regions. Asynchronous operation.
    
    Parameters:
    
    nameOfRegionA - encoded or full name of region a
    
    nameOfRegionB - encoded or full name of region b
    
    forcible - true if do a compulsory merge, otherwise we will only merge two adjacent regions
    
    Throws:
    
    IOException
  - mergeRegionsAsync
```
Future<Void> mergeRegionsAsync(byte[][] nameofRegionsToMerge,
                               boolean forcible)
                        throws IOException
```
    Merge regions. Asynchronous operation.
    
    Parameters:
    
    nameofRegionsToMerge - encoded or full name of daughter regions
    
    forcible - true if do a compulsory merge, otherwise we will only merge adjacent regions
    
    Throws:
    
    IOException
  - split
```
void split(TableName tableName)
    throws IOException
```
    + Split a table. The method will execute split action for each region in table. + Asynchronous operation.
    
    Parameters:
    
    tableName - table to split
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - splitRegion
```
@Deprecated
void splitRegion(byte[] regionName)
                      throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use splitRegionAsync(byte[], byte[]).
    
    Split an individual region. Asynchronous operation.
    
    Parameters:
    
    regionName - region to split
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - split
```
void split(TableName tableName,
           byte[] splitPoint)
    throws IOException
```
    Split a table. Asynchronous operation.
    
    Parameters:
    
    tableName - table to split
    
    splitPoint - the explicit position to split on
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - splitRegion
```
@Deprecated
void splitRegion(byte[] regionName,
                             byte[] splitPoint)
                      throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use splitRegionAsync(byte[], byte[]).
    
    Split an individual region. Asynchronous operation.
    
    Parameters:
    
    regionName - region to split
    
    splitPoint - the explicit position to split on
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - splitRegionAsync
```
Future<Void> splitRegionAsync(byte[] regionName,
                              byte[] splitPoint)
                       throws IOException
```
    Split an individual region. Asynchronous operation.
    
    Parameters:
    
    regionName - region to split
    
    splitPoint - the explicit position to split on
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - modifyTable
```
@Deprecated
void modifyTable(TableName tableName,
                             TableDescriptor td)
                      throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. use modifyTable(TableDescriptor)
    
    Modify an existing table, more IRB friendly version.
    
    Parameters:
    
    tableName - name of table.
    
    td - modified description of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - modifyTable
```
void modifyTable(TableDescriptor td)
          throws IOException
```
    Modify an existing table, more IRB friendly version.
    
    Parameters:
    
    td - modified description of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - modifyTableAsync
```
@Deprecated
Future<Void> modifyTableAsync(TableName tableName,
                                          TableDescriptor td)
                                   throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. use modifyTableAsync(TableDescriptor)
    
    Modify an existing table, more IRB friendly version. Asynchronous operation. This means that it may be a while before your schema change is updated across all of the table. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    tableName - name of table.
    
    td - modified description of the table
    
    Returns:
    
    the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the operation to complete
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - modifyTableAsync
```
Future<Void> modifyTableAsync(TableDescriptor td)
                       throws IOException
```
    Modify an existing table, more IRB (ruby) friendly version. Asynchronous operation. This means that it may be a while before your schema change is updated across all of the table. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    td - description of the table
    
    Returns:
    
    the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the operation to complete
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - shutdown
```
void shutdown()
       throws IOException
```
    Shuts down the HBase cluster.
    
    Notice that, a success shutdown call may ends with an error since the remote server has already been shutdown.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - stopMaster
```
void stopMaster()
         throws IOException
```
    Shuts down the current HBase master only. Does not shutdown the cluster.
    
    Notice that, a success stopMaster call may ends with an error since the remote server has already been shutdown.
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    See Also:
    
    shutdown()
  - isMasterInMaintenanceMode
```
boolean isMasterInMaintenanceMode()
                           throws IOException
```
    Check whether Master is in maintenance mode.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - stopRegionServer
```
void stopRegionServer(String hostnamePort)
               throws IOException
```
    Stop the designated regionserver.
    
    Parameters:
    
    hostnamePort - Hostname and port delimited by a : as in example.org:1234
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getClusterStatus
```
@Deprecated
default ClusterStatus getClusterStatus()
                                            throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. use getClusterMetrics()
    Get whole cluster status, containing status about:
```
 hbase version
 cluster id
 primary/backup master(s)
 master's coprocessors
 live/dead regionservers
 balancer
 regions in transition
 
```
    Returns:
    
    cluster status
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getClusterMetrics
```
default ClusterMetrics getClusterMetrics()
                                  throws IOException
```
    Get whole cluster metrics, containing status about:
```
 hbase version
 cluster id
 primary/backup master(s)
 master's coprocessors
 live/dead regionservers
 balancer
 regions in transition
 
```
    Returns:
    
    cluster metrics
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getClusterMetrics
```
ClusterMetrics getClusterMetrics(EnumSet<ClusterMetrics.Option> options)
                          throws IOException
```
    Get cluster status with a set of ClusterMetrics.Option to get desired status.
    
    Returns:
    
    cluster status
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getMaster
```
default ServerName getMaster()
                      throws IOException
```
    Returns:
    
    current master server name
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getBackupMasters
```
default Collection<ServerName> getBackupMasters()
                                         throws IOException
```
    Returns:
    
    current backup master list
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionServers
```
default Collection<ServerName> getRegionServers()
                                         throws IOException
```
    Returns:
    
    current live region servers list
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionMetrics
```
default List<RegionMetrics> getRegionMetrics(ServerName serverName)
                                      throws IOException
```
    Get RegionMetrics of all regions hosted on a regionserver.
    
    Parameters:
    
    serverName - region server from which RegionMetrics is required.
    
    Returns:
    
    a RegionMetrics list of all regions hosted on a region server
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionMetrics
```
List<RegionMetrics> getRegionMetrics(ServerName serverName,
                                     TableName tableName)
                              throws IOException
```
    Get RegionMetrics of all regions hosted on a regionserver for a table.
    
    Parameters:
    
    serverName - region server from which RegionMetrics is required.
    
    tableName - get RegionMetrics of regions belonging to the table
    
    Returns:
    
    region metrics map of all regions of a table hosted on a region server
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getConfiguration
```
org.apache.hadoop.conf.Configuration getConfiguration()
```
    Returns:
    
    Configuration used by the instance.
  - createNamespace
```
void createNamespace(NamespaceDescriptor descriptor)
              throws IOException
```
    Create a new namespace. Blocks until namespace has been successfully created or an exception is thrown.
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace.
    
    Throws:
    
    IOException
  - createNamespaceAsync
```
Future<Void> createNamespaceAsync(NamespaceDescriptor descriptor)
                           throws IOException
```
    Create a new namespace.
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace
    
    Returns:
    
    the result of the async create namespace operation. Use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException
  - modifyNamespace
```
void modifyNamespace(NamespaceDescriptor descriptor)
              throws IOException
```
    Modify an existing namespace. Blocks until namespace has been successfully modified or an exception is thrown.
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace
    
    Throws:
    
    IOException
  - modifyNamespaceAsync
```
Future<Void> modifyNamespaceAsync(NamespaceDescriptor descriptor)
                           throws IOException
```
    Modify an existing namespace.
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace
    
    Returns:
    
    the result of the async modify namespace operation. Use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException
  - deleteNamespace
```
void deleteNamespace(String name)
              throws IOException
```
    Delete an existing namespace. Only empty namespaces (no tables) can be removed. Blocks until namespace has been successfully deleted or an exception is thrown.
    
    Parameters:
    
    name - namespace name
    
    Throws:
    
    IOException
  - deleteNamespaceAsync
```
Future<Void> deleteNamespaceAsync(String name)
                           throws IOException
```
    Delete an existing namespace. Only empty namespaces (no tables) can be removed.
    
    Parameters:
    
    name - namespace name
    
    Returns:
    
    the result of the async delete namespace operation. Use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException
  - getNamespaceDescriptor
```
NamespaceDescriptor getNamespaceDescriptor(String name)
                                    throws NamespaceNotFoundException,
                                           IOException
```
    Get a namespace descriptor by name.
    
    Parameters:
    
    name - name of namespace descriptor
    
    Returns:
    
    A descriptor
    
    Throws:
    
    NamespaceNotFoundException
    
    IOException - if a remote or network exception occurs
  - listNamespaceDescriptors
```
NamespaceDescriptor[] listNamespaceDescriptors()
                                        throws IOException
```
    List available namespace descriptors.
    
    Returns:
    
    List of descriptors
    
    Throws:
    
    IOException
  - listTableDescriptorsByNamespace
```
@Deprecated
HTableDescriptor[] listTableDescriptorsByNamespace(String name)
                                                        throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. use listTableDescriptorsByNamespace(byte[])
    
    Get list of table descriptors by namespace.
    
    Parameters:
    
    name - namespace name
    
    Returns:
    
    HTD[] the read-only tableDescriptors
    
    Throws:
    
    IOException
  - listTableDescriptorsByNamespace
```
List<TableDescriptor> listTableDescriptorsByNamespace(byte[] name)
                                               throws IOException
```
    Get list of table descriptors by namespace.
    
    Parameters:
    
    name - namespace name
    
    Returns:
    
    returns a list of TableDescriptors
    
    Throws:
    
    IOException
  - listTableNamesByNamespace
```
TableName[] listTableNamesByNamespace(String name)
                               throws IOException
```
    Get list of table names by namespace.
    
    Parameters:
    
    name - namespace name
    
    Returns:
    
    The list of table names in the namespace
    
    Throws:
    
    IOException
  - getTableRegions
```
@Deprecated
List<HRegionInfo> getTableRegions(TableName tableName)
                                       throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17980). Use getRegions(TableName).
    
    Get the regions of a given table.
    
    Parameters:
    
    tableName - the name of the table
    
    Returns:
    
    List of HRegionInfo.
    
    Throws:
    
    IOException
  - getRegions
```
List<RegionInfo> getRegions(TableName tableName)
                     throws IOException
```
    Get the regions of a given table.
    
    Parameters:
    
    tableName - the name of the table
    
    Returns:
    
    List of RegionInfo.
    
    Throws:
    
    IOException
  - close
```
void close()
    throws IOException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    IOException
  - getTableDescriptorsByTableName
```
@Deprecated
HTableDescriptor[] getTableDescriptorsByTableName(List<TableName> tableNames)
                                                       throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. use listTableDescriptors(List)
    
    Get tableDescriptors.
    
    Parameters:
    
    tableNames - List of table names
    
    Returns:
    
    HTD[] the read-only tableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTableDescriptors
```
List<TableDescriptor> listTableDescriptors(List<TableName> tableNames)
                                    throws IOException
```
    Get tableDescriptors.
    
    Parameters:
    
    tableNames - List of table names
    
    Returns:
    
    returns a list of TableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getTableDescriptors
```
@Deprecated
HTableDescriptor[] getTableDescriptors(List<String> names)
                                            throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. use listTableDescriptors(List)
    
    Get tableDescriptors.
    
    Parameters:
    
    names - List of table names
    
    Returns:
    
    HTD[] the read-only tableDescriptors
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - abortProcedure
```
@Deprecated
boolean abortProcedure(long procId,
                                   boolean mayInterruptIfRunning)
                            throws IOException
```
    Deprecated. Since 2.1.1 -- to be removed.
    
    Abort a procedure. Do not use. Usually it is ignored but if not, it can do more damage than good. See hbck2.
    
    Parameters:
    
    procId - ID of the procedure to abort
    
    mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?
    
    Returns:
    
    true if aborted, false if procedure already completed or does not exist
    
    Throws:
    
    IOException
  - abortProcedureAsync
```
@Deprecated
Future<Boolean> abortProcedureAsync(long procId,
                                                boolean mayInterruptIfRunning)
                                         throws IOException
```
    Deprecated. Since 2.1.1 -- to be removed.
    
    Abort a procedure but does not block and wait for completion. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete. Do not use. Usually it is ignored but if not, it can do more damage than good. See hbck2.
    
    Parameters:
    
    procId - ID of the procedure to abort
    
    mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?
    
    Returns:
    
    true if aborted, false if procedure already completed or does not exist
    
    Throws:
    
    IOException
  - getProcedures
```
String getProcedures()
              throws IOException
```
    Get procedures.
    
    Returns:
    
    procedure list in JSON
    
    Throws:
    
    IOException
  - getLocks
```
String getLocks()
         throws IOException
```
    Get locks.
    
    Returns:
    
    lock list in JSON
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - rollWALWriter
```
void rollWALWriter(ServerName serverName)
            throws IOException,
                   FailedLogCloseException
```
    Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file. Note that the actual rolling of the log writer is asynchronous and may not be complete when this method returns. As a side effect of this call, the named region server may schedule store flushes at the request of the wal.
    
    Parameters:
    
    serverName - The servername of the regionserver.
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    FailedLogCloseException
  - getMasterCoprocessors
```
@Deprecated
default String[] getMasterCoprocessors()
                                            throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. use getMasterCoprocessorNames()
    
    Helper that delegates to getClusterMetrics().getMasterCoprocessorNames().
    
    Returns:
    
    an array of master coprocessors
    
    Throws:
    
    IOException
    
    See Also:
    
    ClusterMetrics.getMasterCoprocessorNames()
  - getMasterCoprocessorNames
```
default List<String> getMasterCoprocessorNames()
                                        throws IOException
```
    Helper that delegates to getClusterMetrics().getMasterCoprocessorNames().
    
    Returns:
    
    an array of master coprocessors
    
    Throws:
    
    IOException
    
    See Also:
    
    ClusterMetrics.getMasterCoprocessorNames()
  - getCompactionState
```
CompactionState getCompactionState(TableName tableName)
                            throws IOException
```
    Get the current compaction state of a table. It could be in a major compaction, a minor compaction, both, or none.
    
    Parameters:
    
    tableName - table to examine
    
    Returns:
    
    the current compaction state
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getCompactionState
```
CompactionState getCompactionState(TableName tableName,
                                   CompactType compactType)
                            throws IOException
```
    Get the current compaction state of a table. It could be in a compaction, or none.
    
    Parameters:
    
    tableName - table to examine
    
    compactType - CompactType
    
    Returns:
    
    the current compaction state
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getCompactionStateForRegion
```
CompactionState getCompactionStateForRegion(byte[] regionName)
                                     throws IOException
```
    Get the current compaction state of region. It could be in a major compaction, a minor compaction, both, or none.
    
    Parameters:
    
    regionName - region to examine
    
    Returns:
    
    the current compaction state
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getLastMajorCompactionTimestamp
```
long getLastMajorCompactionTimestamp(TableName tableName)
                              throws IOException
```
    Get the timestamp of the last major compaction for the passed table The timestamp of the oldest HFile resulting from a major compaction of that table, or 0 if no such HFile could be found.
    
    Parameters:
    
    tableName - table to examine
    
    Returns:
    
    the last major compaction timestamp or 0
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getLastMajorCompactionTimestampForRegion
```
long getLastMajorCompactionTimestampForRegion(byte[] regionName)
                                       throws IOException
```
    Get the timestamp of the last major compaction for the passed region. The timestamp of the oldest HFile resulting from a major compaction of that region, or 0 if no such HFile could be found.
    
    Parameters:
    
    regionName - region to examine
    
    Returns:
    
    the last major compaction timestamp or 0
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - snapshot
```
void snapshot(String snapshotName,
              TableName tableName)
       throws IOException,
              SnapshotCreationException,
              IllegalArgumentException
```
    Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be taken. If the table is disabled, an offline snapshot is taken. Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]).
    
    Parameters:
    
    snapshotName - name of the snapshot to be created
    
    tableName - name of the table for which snapshot is created
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshot
```
void snapshot(byte[] snapshotName,
              TableName tableName)
       throws IOException,
              SnapshotCreationException,
              IllegalArgumentException
```
    Create a timestamp consistent snapshot for the given table. Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase.
    
    Parameters:
    
    snapshotName - name of the snapshot to be created
    
    tableName - name of the table for which snapshot is created
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshot
```
void snapshot(String snapshotName,
              TableName tableName,
              SnapshotType type)
       throws IOException,
              SnapshotCreationException,
              IllegalArgumentException
```
    Create typed snapshot of the table. Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]).
    
    Parameters:
    
    snapshotName - name to give the snapshot on the filesystem. Must be unique from all other snapshots stored on the cluster
    
    tableName - name of the table to snapshot
    
    type - type of snapshot to take
    
    Throws:
    
    IOException - we fail to reach the master
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshot
```
void snapshot(SnapshotDescription snapshot)
       throws IOException,
              SnapshotCreationException,
              IllegalArgumentException
```
    Take a snapshot and wait for the server to complete that snapshot (blocking). Only a single snapshot should be taken at a time for an instance of HBase, or results may be undefined (you can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a single cluster). Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]). You should probably use snapshot(String, org.apache.hadoop.hbase.TableName) or snapshot(byte[], org.apache.hadoop.hbase.TableName) unless you are sure about the type of snapshot that you want to take.
    
    Parameters:
    
    snapshot - snapshot to take
    
    Throws:
    
    IOException - or we lose contact with the master.
    
    SnapshotCreationException - if snapshot failed to be taken
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - takeSnapshotAsync
```
@Deprecated
default void takeSnapshotAsync(SnapshotDescription snapshot)
                                    throws IOException,
                                           SnapshotCreationException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use snapshotAsync(SnapshotDescription) instead.
    
    Take a snapshot without waiting for the server to complete that snapshot (asynchronous) Only a single snapshot should be taken at a time, or results may be undefined.
    
    Parameters:
    
    snapshot - snapshot to take
    
    Throws:
    
    IOException - if the snapshot did not succeed or we lose contact with the master.
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshotAsync
```
void snapshotAsync(SnapshotDescription snapshot)
            throws IOException,
                   SnapshotCreationException
```
    Take a snapshot without waiting for the server to complete that snapshot (asynchronous) Only a single snapshot should be taken at a time, or results may be undefined.
    
    Parameters:
    
    snapshot - snapshot to take
    
    Throws:
    
    IOException - if the snapshot did not succeed or we lose contact with the master.
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - isSnapshotFinished
```
boolean isSnapshotFinished(SnapshotDescription snapshot)
                    throws IOException,
                           HBaseSnapshotException,
                           UnknownSnapshotException
```
    Check the current state of the passed snapshot. There are three possible states:
    1. running - returns false
    2. finished - returns true
    3. finished with error - throws the exception that caused the snapshot to fail
    The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been run/started since the snapshot you are checking, you will receive an UnknownSnapshotException.
    Parameters:
    
    snapshot - description of the snapshot to check
    
    Returns:
    
    true if the snapshot is completed, false if the snapshot is still running
    
    Throws:
    
    IOException - if we have a network issue
    
    HBaseSnapshotException - if the snapshot failed
    
    UnknownSnapshotException - if the requested snapshot is unknown
  - restoreSnapshot
```
void restoreSnapshot(byte[] snapshotName)
              throws IOException,
                     RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If the "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted.
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - restoreSnapshot
```
void restoreSnapshot(String snapshotName)
              throws IOException,
                     RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If the "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted.
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - restoreSnapshotAsync
```
Future<Void> restoreSnapshotAsync(String snapshotName)
                           throws IOException,
                                  RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If the "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted.
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    Returns:
    
    the result of the async restore snapshot. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
  - restoreSnapshot
```
void restoreSnapshot(byte[] snapshotName,
                     boolean takeFailSafeSnapshot)
              throws IOException,
                     RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted. The failsafe snapshot name is configurable by using the property "hbase.snapshot.restore.failsafe.name".
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - restoreSnapshot
```
void restoreSnapshot(String snapshotName,
                     boolean takeFailSafeSnapshot)
              throws IOException,
                     RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted. The failsafe snapshot name is configurable by using the property "hbase.snapshot.restore.failsafe.name".
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - restoreSnapshot
```
void restoreSnapshot(String snapshotName,
                     boolean takeFailSafeSnapshot,
                     boolean restoreAcl)
              throws IOException,
                     RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted. The failsafe snapshot name is configurable by using the property "hbase.snapshot.restore.failsafe.name".
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
    
    restoreAcl - true to restore acl of snapshot
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - cloneSnapshot
```
void cloneSnapshot(byte[] snapshotName,
                   TableName tableName)
            throws IOException,
                   TableExistsException,
                   RestoreSnapshotException
```
    Create a new table by cloning the snapshot content.
    
    Parameters:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be created already exists
    
    RestoreSnapshotException - if snapshot failed to be cloned
    
    IllegalArgumentException - if the specified table has not a valid name
  - cloneSnapshot
```
void cloneSnapshot(String snapshotName,
                   TableName tableName,
                   boolean restoreAcl)
            throws IOException,
                   TableExistsException,
                   RestoreSnapshotException
```
    Create a new table by cloning the snapshot content.
    
    Parameters:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
    
    restoreAcl - true to clone acl into newly created table
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be created already exists
    
    RestoreSnapshotException - if snapshot failed to be cloned
    
    IllegalArgumentException - if the specified table has not a valid name
  - cloneSnapshot
```
void cloneSnapshot(String snapshotName,
                   TableName tableName)
            throws IOException,
                   TableExistsException,
                   RestoreSnapshotException
```
    Create a new table by cloning the snapshot content.
    
    Parameters:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be created already exists
    
    RestoreSnapshotException - if snapshot failed to be cloned
    
    IllegalArgumentException - if the specified table has not a valid name
  - cloneSnapshotAsync
```
Future<Void> cloneSnapshotAsync(String snapshotName,
                                TableName tableName)
                         throws IOException,
                                TableExistsException
```
    Create a new table by cloning the snapshot content, but does not block and wait for it to be completely cloned. You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
    
    Returns:
    
    the result of the async clone snapshot. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be cloned already exists
  - execProcedure
```
void execProcedure(String signature,
                   String instance,
                   Map<String,String> props)
            throws IOException
```
    Execute a distributed procedure on a cluster.
    
    Parameters:
    
    signature - A distributed procedure is uniquely identified by its signature (default the root ZK node name of the procedure).
    
    instance - The instance name of the procedure. For some procedures, this parameter is optional.
    
    props - Property/Value pairs of properties passing to the procedure
    
    Throws:
    
    IOException
  - execProcedureWithRet
```
@Deprecated
default byte[] execProcedureWithRet(String signature,
                                                String instance,
                                                Map<String,String> props)
                                         throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use execProcedureWithReturn(String, String, Map) } instead.
    
    Execute a distributed procedure on a cluster.
    
    Parameters:
    
    signature - A distributed procedure is uniquely identified by its signature (default the root ZK node name of the procedure).
    
    instance - The instance name of the procedure. For some procedures, this parameter is optional.
    
    props - Property/Value pairs of properties passing to the procedure
    
    Returns:
    
    data returned after procedure execution. null if no return data.
    
    Throws:
    
    IOException
  - execProcedureWithReturn
```
byte[] execProcedureWithReturn(String signature,
                               String instance,
                               Map<String,String> props)
                        throws IOException
```
    Execute a distributed procedure on a cluster.
    
    Parameters:
    
    signature - A distributed procedure is uniquely identified by its signature (default the root ZK node name of the procedure).
    
    instance - The instance name of the procedure. For some procedures, this parameter is optional.
    
    props - Property/Value pairs of properties passing to the procedure
    
    Returns:
    
    data returned after procedure execution. null if no return data.
    
    Throws:
    
    IOException
  - isProcedureFinished
```
boolean isProcedureFinished(String signature,
                            String instance,
                            Map<String,String> props)
                     throws IOException
```
    Check the current state of the specified procedure. There are three possible states:
    1. running - returns false
    2. finished - returns true
    3. finished with error - throws the exception that caused the procedure to fail
    Parameters:
    
    signature - The signature that uniquely identifies a procedure
    
    instance - The instance name of the procedure
    
    props - Property/Value pairs of properties passing to the procedure
    
    Returns:
    
    true if the specified procedure is finished successfully, false if it is still running
    
    Throws:
    
    IOException - if the specified procedure finished with error
  - listSnapshots
```
List<SnapshotDescription> listSnapshots()
                                 throws IOException
```
    List completed snapshots.
    
    Returns:
    
    a list of snapshot descriptors for completed snapshots
    
    Throws:
    
    IOException - if a network error occurs
  - listSnapshots
```
@Deprecated
List<SnapshotDescription> listSnapshots(String regex)
                                             throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listSnapshots(Pattern) instead.
    
    List all the completed snapshots matching the given regular expression.
    
    Parameters:
    
    regex - The regular expression to match against
    
    Returns:
    
    list of SnapshotDescription
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listSnapshots
```
List<SnapshotDescription> listSnapshots(Pattern pattern)
                                 throws IOException
```
    List all the completed snapshots matching the given pattern.
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    Returns:
    
    list of SnapshotDescription
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTableSnapshots
```
@Deprecated
List<SnapshotDescription> listTableSnapshots(String tableNameRegex,
                                                         String snapshotNameRegex)
                                                  throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use listTableSnapshots(Pattern, Pattern) instead.
    
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
    
    Returns:
    
    list of completed SnapshotDescription
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listTableSnapshots
```
List<SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,
                                             Pattern snapshotNamePattern)
                                      throws IOException
```
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
    
    Returns:
    
    list of completed SnapshotDescription
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshot
```
void deleteSnapshot(byte[] snapshotName)
             throws IOException
```
    Delete an existing snapshot.
    
    Parameters:
    
    snapshotName - name of the snapshot
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshot
```
void deleteSnapshot(String snapshotName)
             throws IOException
```
    Delete an existing snapshot.
    
    Parameters:
    
    snapshotName - name of the snapshot
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshots
```
@Deprecated
void deleteSnapshots(String regex)
                          throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use deleteSnapshots(Pattern) instead.
    
    Delete existing snapshots whose names match the pattern passed.
    
    Parameters:
    
    regex - The regular expression to match against
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshots
```
void deleteSnapshots(Pattern pattern)
              throws IOException
```
    Delete existing snapshots whose names match the pattern passed.
    
    Parameters:
    
    pattern - pattern for names of the snapshot to match
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteTableSnapshots
```
@Deprecated
void deleteTableSnapshots(String tableNameRegex,
                                      String snapshotNameRegex)
                               throws IOException
```
    Deprecated. since 2.0 version and will be removed in 3.0 version. Use deleteTableSnapshots(Pattern, Pattern) instead.
    
    Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - deleteTableSnapshots
```
void deleteTableSnapshots(Pattern tableNamePattern,
                          Pattern snapshotNamePattern)
                   throws IOException
```
    Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - setQuota
```
void setQuota(QuotaSettings quota)
       throws IOException
```
    Apply the new quota settings.
    
    Parameters:
    
    quota - the quota settings
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getQuotaRetriever
```
@Deprecated
QuotaRetriever getQuotaRetriever(QuotaFilter filter)
                                      throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use getQuota(QuotaFilter).
    
    Return a QuotaRetriever to list the quotas based on the filter.
    
    Parameters:
    
    filter - the quota settings filter
    
    Returns:
    
    the quota retriever
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getQuota
```
List<QuotaSettings> getQuota(QuotaFilter filter)
                      throws IOException
```
    List the quotas based on the filter.
    
    Parameters:
    
    filter - the quota settings filter
    
    Returns:
    
    the QuotaSetting list
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - coprocessorService
```
CoprocessorRpcChannel coprocessorService()
```
    Creates and returns a RpcChannel instance connected to the active master.
    The obtained RpcChannel instance can be used to access a published coprocessor Service using standard protobuf service invocations:
    CoprocessorRpcChannel channel = myAdmin.coprocessorService(); MyService.BlockingInterface service = MyService.newBlockingStub(channel); MyCallRequest request = MyCallRequest.newBuilder() ... .build(); MyCallResponse response = service.myCall(null, request);
    Returns:
    
    A MasterCoprocessorRpcChannel instance
  - coprocessorService
```
CoprocessorRpcChannel coprocessorService(ServerName serverName)
```
    Creates and returns a RpcChannel instance connected to the passed region server.
    The obtained RpcChannel instance can be used to access a published coprocessor Service using standard protobuf service invocations:
    CoprocessorRpcChannel channel = myAdmin.coprocessorService(serverName); MyService.BlockingInterface service = MyService.newBlockingStub(channel); MyCallRequest request = MyCallRequest.newBuilder() ... .build(); MyCallResponse response = service.myCall(null, request);
    Parameters:
    
    serverName - the server name to which the endpoint call is made
    
    Returns:
    
    A RegionServerCoprocessorRpcChannel instance
  - updateConfiguration
```
void updateConfiguration(ServerName server)
                  throws IOException
```
    Update the configuration and trigger an online config change on the regionserver.
    
    Parameters:
    
    server - : The server whose config needs to be updated.
    
    Throws:
    
    IOException
  - updateConfiguration
```
void updateConfiguration()
                  throws IOException
```
    Update the configuration and trigger an online config change on all the regionservers.
    
    Throws:
    
    IOException
  - getMasterInfoPort
```
default int getMasterInfoPort()
                       throws IOException
```
    Get the info port of the current master if one is available.
    
    Returns:
    
    master info port
    
    Throws:
    
    IOException
  - getSecurityCapabilities
```
List<SecurityCapability> getSecurityCapabilities()
                                          throws IOException
```
    Return the set of supported security capabilities.
    
    Throws:
    
    IOException
    
    UnsupportedOperationException
  - setSplitOrMergeEnabled
```
@Deprecated
default boolean[] setSplitOrMergeEnabled(boolean enabled,
                                                     boolean synchronous,
                                                     MasterSwitchType... switchTypes)
                                              throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use splitSwitch(boolean, boolean) or mergeSwitch(boolean, boolean) instead.
    
    Turn the Split or Merge switches on or off.
    
    Parameters:
    
    enabled - enabled or not
    
    synchronous - If true, it waits until current split() call, if outstanding, to return.
    
    switchTypes - switchType list MasterSwitchType
    
    Returns:
    
    Previous switch value array
    
    Throws:
    
    IOException
  - splitSwitch
```
boolean splitSwitch(boolean enabled,
                    boolean synchronous)
             throws IOException
```
    Turn the split switch on or off.
    
    Parameters:
    
    enabled - enabled or not
    
    synchronous - If true, it waits until current split() call, if outstanding, to return.
    
    Returns:
    
    Previous switch value
    
    Throws:
    
    IOException
  - mergeSwitch
```
boolean mergeSwitch(boolean enabled,
                    boolean synchronous)
             throws IOException
```
    Turn the merge switch on or off.
    
    Parameters:
    
    enabled - enabled or not
    
    synchronous - If true, it waits until current merge() call, if outstanding, to return.
    
    Returns:
    
    Previous switch value
    
    Throws:
    
    IOException
  - isSplitOrMergeEnabled
```
@Deprecated
default boolean isSplitOrMergeEnabled(MasterSwitchType switchType)
                                           throws IOException
```
    Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use isSplitEnabled() or isMergeEnabled() instead.
    
    Query the current state of the switch.
    
    Returns:
    
    true if the switch is enabled, false otherwise.
    
    Throws:
    
    IOException
  - isSplitEnabled
```
boolean isSplitEnabled()
                throws IOException
```
    Query the current state of the split switch.
    
    Returns:
    
    true if the switch is enabled, false otherwise.
    
    Throws:
    
    IOException
  - isMergeEnabled
```
boolean isMergeEnabled()
                throws IOException
```
    Query the current state of the merge switch.
    
    Returns:
    
    true if the switch is enabled, false otherwise.
    
    Throws:
    
    IOException
  - addReplicationPeer
```
default void addReplicationPeer(String peerId,
                                ReplicationPeerConfig peerConfig)
                         throws IOException
```
    Add a new replication peer for replicating data to slave cluster.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication peer
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - addReplicationPeer
```
void addReplicationPeer(String peerId,
                        ReplicationPeerConfig peerConfig,
                        boolean enabled)
                 throws IOException
```
    Add a new replication peer for replicating data to slave cluster.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication peer
    
    enabled - peer state, true if ENABLED and false if DISABLED
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - addReplicationPeerAsync
```
default Future<Void> addReplicationPeerAsync(String peerId,
                                             ReplicationPeerConfig peerConfig)
                                      throws IOException
```
    Add a new replication peer but does not block and wait for it.
    You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication peer
    
    Returns:
    
    the result of the async operation
    
    Throws:
    
    IOException - IOException if a remote or network exception occurs
  - addReplicationPeerAsync
```
Future<Void> addReplicationPeerAsync(String peerId,
                                     ReplicationPeerConfig peerConfig,
                                     boolean enabled)
                              throws IOException
```
    Add a new replication peer but does not block and wait for it.
    You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication peer
    
    enabled - peer state, true if ENABLED and false if DISABLED
    
    Returns:
    
    the result of the async operation
    
    Throws:
    
    IOException - IOException if a remote or network exception occurs
  - removeReplicationPeer
```
void removeReplicationPeer(String peerId)
                    throws IOException
```
    Remove a peer and stop the replication.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - removeReplicationPeerAsync
```
Future<Void> removeReplicationPeerAsync(String peerId)
                                 throws IOException
```
    Remove a replication peer but does not block and wait for it.
    You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Returns:
    
    the result of the async operation
    
    Throws:
    
    IOException - IOException if a remote or network exception occurs
  - enableReplicationPeer
```
void enableReplicationPeer(String peerId)
                    throws IOException
```
    Restart the replication stream to the specified peer.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - enableReplicationPeerAsync
```
Future<Void> enableReplicationPeerAsync(String peerId)
                                 throws IOException
```
    Enable a replication peer but does not block and wait for it.
    You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Returns:
    
    the result of the async operation
    
    Throws:
    
    IOException - IOException if a remote or network exception occurs
  - disableReplicationPeer
```
void disableReplicationPeer(String peerId)
                     throws IOException
```
    Stop the replication stream to the specified peer.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - disableReplicationPeerAsync
```
Future<Void> disableReplicationPeerAsync(String peerId)
                                  throws IOException
```
    Disable a replication peer but does not block and wait for it.
    You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Returns:
    
    the result of the async operation
    
    Throws:
    
    IOException - IOException if a remote or network exception occurs
  - getReplicationPeerConfig
```
ReplicationPeerConfig getReplicationPeerConfig(String peerId)
                                        throws IOException
```
    Returns the configured ReplicationPeerConfig for the specified peer.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Returns:
    
    ReplicationPeerConfig for the peer
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - updateReplicationPeerConfig
```
void updateReplicationPeerConfig(String peerId,
                                 ReplicationPeerConfig peerConfig)
                          throws IOException
```
    Update the peerConfig for the specified peer.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - new config for the replication peer
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - updateReplicationPeerConfigAsync
```
Future<Void> updateReplicationPeerConfigAsync(String peerId,
                                              ReplicationPeerConfig peerConfig)
                                       throws IOException
```
    Update the peerConfig for the specified peer but does not block and wait for it.
    You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw ExecutionException if there was an error while executing the operation or TimeoutException in case the wait timeout was not long enough to allow the operation to complete.
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - new config for the replication peer
    
    Returns:
    
    the result of the async operation
    
    Throws:
    
    IOException - IOException if a remote or network exception occurs
  - appendReplicationPeerTableCFs
```
void appendReplicationPeerTableCFs(String id,
                                   Map<TableName,List<String>> tableCfs)
                            throws ReplicationException,
                                   IOException
```
    Append the replicable table column family config from the specified peer.
    
    Parameters:
    
    id - a short that identifies the cluster
    
    tableCfs - A map from tableName to column family names
    
    Throws:
    
    ReplicationException - if tableCfs has conflict with existing config
    
    IOException - if a remote or network exception occurs
  - removeReplicationPeerTableCFs
```
void removeReplicationPeerTableCFs(String id,
                                   Map<TableName,List<String>> tableCfs)
                            throws ReplicationException,
                                   IOException
```
    Remove some table-cfs from config of the specified peer.
    
    Parameters:
    
    id - a short name that identifies the cluster
    
    tableCfs - A map from tableName to column family names
    
    Throws:
    
    ReplicationException - if tableCfs has conflict with existing config
    
    IOException - if a remote or network exception occurs
  - listReplicationPeers
```
List<ReplicationPeerDescription> listReplicationPeers()
                                               throws IOException
```
    Return a list of replication peers.
    
    Returns:
    
    a list of replication peers description
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - listReplicationPeers
```
List<ReplicationPeerDescription> listReplicationPeers(Pattern pattern)
                                               throws IOException
```
    Return a list of replication peers.
    
    Parameters:
    
    pattern - The compiled regular expression to match peer id
    
    Returns:
    
    a list of replication peers description
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - decommissionRegionServers
```
void decommissionRegionServers(List<ServerName> servers,
                               boolean offload)
                        throws IOException
```
    Mark region server(s) as decommissioned to prevent additional regions from getting assigned to them. Optionally unload the regions on the servers. If there are multiple servers to be decommissioned, decommissioning them at the same time can prevent wasteful region movements. Region unloading is asynchronous.
    
    Parameters:
    
    servers - The list of servers to decommission.
    
    offload - True to offload the regions from the decommissioned servers
    
    Throws:
    
    IOException
  - listDecommissionedRegionServers
```
List<ServerName> listDecommissionedRegionServers()
                                          throws IOException
```
    List region servers marked as decommissioned, which can not be assigned regions.
    
    Returns:
    
    List of decommissioned region servers.
    
    Throws:
    
    IOException
  - recommissionRegionServer
```
void recommissionRegionServer(ServerName server,
                              List<byte[]> encodedRegionNames)
                       throws IOException
```
    Remove decommission marker from a region server to allow regions assignments. Load regions onto the server if a list of regions is given. Region loading is asynchronous.
    
    Parameters:
    
    server - The server to recommission.
    
    encodedRegionNames - Regions to load onto the server.
    
    Throws:
    
    IOException
  - listReplicatedTableCFs
```
List<TableCFs> listReplicatedTableCFs()
                               throws IOException
```
    Find all table and column families that are replicated from this cluster
    
    Returns:
    
    the replicated table-cfs list of this cluster.
    
    Throws:
    
    IOException
  - enableTableReplication
```
void enableTableReplication(TableName tableName)
                     throws IOException
```
    Enable a table's replication switch.
    
    Parameters:
    
    tableName - name of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - disableTableReplication
```
void disableTableReplication(TableName tableName)
                      throws IOException
```
    Disable a table's replication switch.
    
    Parameters:
    
    tableName - name of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - clearCompactionQueues
```
void clearCompactionQueues(ServerName serverName,
                           Set<String> queues)
                    throws IOException,
                           InterruptedException
```
    Clear compacting queues on a regionserver.
    
    Parameters:
    
    serverName - the region server name
    
    queues - the set of queue name
    
    Throws:
    
    IOException - if a remote or network exception occurs
    
    InterruptedException
  - listDeadServers
```
default List<ServerName> listDeadServers()
                                  throws IOException
```
    List dead region servers.
    
    Returns:
    
    List of dead region servers.
    
    Throws:
    
    IOException
  - clearDeadServers
```
List<ServerName> clearDeadServers(List<ServerName> servers)
                           throws IOException
```
    Clear dead region servers from master.
    
    Parameters:
    
    servers - list of dead region servers.
    
    Returns:
    
    List of servers that are not cleared
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - cloneTableSchema
```
void cloneTableSchema(TableName tableName,
                      TableName newTableName,
                      boolean preserveSplits)
               throws IOException
```
    Create a new table by cloning the existent table schema.
    
    Parameters:
    
    tableName - name of the table to be cloned
    
    newTableName - name of the new table where the table will be created
    
    preserveSplits - True if the splits should be preserved
    
    Throws:
    
    IOException - if a remote or network exception occurs

Interface Admin

Method Summary

Method Detail

getOperationTimeout

abort

isAborted

getConnection

tableExists

listTables

listTableDescriptors

listTables

listTableDescriptors

listTables

listTables

listTableDescriptors

listTables

listTableNames

listTableNames

listTableNames

listTableNames

listTableNames

getTableDescriptor

getDescriptor

createTable

createTable

createTable

createTableAsync

deleteTable

deleteTableAsync

deleteTables

deleteTables

truncateTable

truncateTableAsync

enableTable

enableTableAsync

enableTables

enableTables

disableTableAsync

disableTable

disableTables

disableTables

isTableEnabled

isTableDisabled

isTableAvailable

isTableAvailable

getAlterStatus

getAlterStatus

addColumn

addColumnFamily

addColumnFamilyAsync

deleteColumn

deleteColumnFamily

deleteColumnFamilyAsync

modifyColumn

modifyColumnFamily

modifyColumnFamilyAsync

closeRegion

closeRegion

closeRegionWithEncodedRegionName

closeRegion

getOnlineRegions

getRegions

flush

flushRegion

flushRegionServer

compact

compactRegion

compact

compactRegion

compact

compact

majorCompact

majorCompactRegion

majorCompact

majorCompactRegion

majorCompact

majorCompact

compactRegionServer

compactRegionServer

majorCompactRegionServer