HBaseAdmin (Apache HBase - Client 2.2.1 API)

java.lang.Object
- org.apache.hadoop.hbase.client.HBaseAdmin

所有已实现的接口:

Closeable, AutoCloseable, Abortable, Admin
```
@InterfaceAudience.Private
public class HBaseAdmin
extends Object
implements Admin
```
HBaseAdmin is no longer a client API. It is marked InterfaceAudience.Private indicating that this is an HBase-internal class as defined in https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/InterfaceClassification.html There are no guarantees for backwards source / binary compatibility and methods or class can change or go away without deprecation. Use Connection.getAdmin() to obtain an instance of Admin instead of constructing an HBaseAdmin directly.
Connection should be an unmanaged connection obtained via ConnectionFactory.createConnection(Configuration)

另请参阅:

ConnectionFactory, Connection, Admin

嵌套类概要

嵌套类
限定符和类型	类和说明
`protected static class`	`HBaseAdmin.NamespaceFuture`
`protected static class`	`HBaseAdmin.ProcedureFuture<V>` Future that waits on a procedure result.
`protected static class`	`HBaseAdmin.TableFuture<V>`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`abort(String why, Throwable e)` Abort the server or client.
`boolean`	`abortProcedure(long procId, boolean mayInterruptIfRunning)` Abort a procedure.
`Future<Boolean>`	`abortProcedureAsync(long procId, boolean mayInterruptIfRunning)` Abort a procedure but does not block and wait for completion.
`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.
`void`	`addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig, boolean enabled)` Add a new replication peer for replicating data to slave cluster.
`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.
`static void`	`available(org.apache.hadoop.conf.Configuration conf)` Is HBase available?
`boolean`	`balance()` Invoke the balancer.
`boolean`	`balance(boolean force)` Invoke the balancer.
`boolean`	`balancerSwitch(boolean on, boolean synchronous)` Turn the load balancer on or off.
`boolean`	`catalogJanitorSwitch(boolean enable)` Enable/Disable the catalog janitor/
`boolean`	`cleanerChoreSwitch(boolean on)` Enable/Disable the cleaner chore.
`CacheEvictionStats`	`clearBlockCache(TableName tableName)` Clear all the blocks corresponding to this table from BlockCache.
`void`	`clearCompactionQueues(ServerName sn, 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 unused)` 已过时。
`void`	`closeRegion(ServerName unused, HRegionInfo hri)` 已过时。
`void`	`closeRegion(String regionName, String unused)` 已过时。
`boolean`	`closeRegionWithEncodedRegionName(String encodedRegionName, String unused)` 已过时。
`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.
`Map<ServerName,Boolean>`	`compactionSwitch(boolean switchState, List<String> serverNamesList)` Turn the compaction on or off.
`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.
`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)` Creates a new table but does not block and wait for it to come online.
`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)` 已过时。 Since 2.0. Will be removed in 3.0. Use `deleteColumnFamily(TableName, byte[])` instead.
`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)` Delete existing snapshots whose names match the pattern passed.
`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)` Delete tables matching the passed in pattern and wait on completion.
`HTableDescriptor[]`	`deleteTables(String regex)` Deletes tables matching the passed in pattern and wait on completion.
`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)` Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
`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)` Disable tables matching the passed in pattern and wait on completion.
`HTableDescriptor[]`	`disableTables(String regex)` Disable tables matching the passed in pattern and wait on completion.
`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)` Enable tables matching the passed in pattern and wait on completion.
`HTableDescriptor[]`	`enableTables(String regex)` Enable tables matching the passed in pattern and wait on completion.
`boolean`	`exceedThrottleQuotaSwitch(boolean enable)` Switch the exceed throttle quota.
`void`	`execProcedure(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`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)` Get the status of `alter` (a.k.a `modify`) command - indicates how many regions have received the updated schema Asynchronous operation.
`Pair<Integer,Integer>`	`getAlterStatus(TableName tableName)` Get the status of an `alter` (a.k.a `modify`) command - indicates how many regions have received the updated schema Asynchronous operation.
`ClusterMetrics`	`getClusterMetrics(EnumSet<ClusterMetrics.Option> options)` Get cluster status with a set of `ClusterMetrics.Option` to get desired status.
`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()`
`SpaceQuotaSnapshot`	`getCurrentSpaceQuotaSnapshot(String namespace)` Returns the Master's view of a quota on the given `namespace` or null if the Master has no quota information on that namespace.
`SpaceQuotaSnapshot`	`getCurrentSpaceQuotaSnapshot(TableName tableName)` Returns the Master's view of a quota on the given `tableName` or null if the Master has no quota information on that table.
`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.
`NamespaceDescriptor`	`getNamespaceDescriptor(String name)` Get a namespace descriptor by name.
`List<HRegionInfo>`	`getOnlineRegions(ServerName sn)` 已过时。 As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getRegions(ServerName)`.
`int`	`getOperationTimeout()`
`String`	`getProcedures()` Get procedures.
`List<QuotaSettings>`	`getQuota(QuotaFilter filter)` List the quotas based on the filter.
`QuotaRetriever`	`getQuotaRetriever(QuotaFilter filter)` Return a QuotaRetriever to list the quotas based on the filter.
`List<RegionMetrics>`	`getRegionMetrics(ServerName serverName, TableName tableName)` Get `RegionMetrics` of all regions hosted on a regionserver for a table.
`List<RegionInfo>`	`getRegions(ServerName sn)` Get all the online regions on a region server.
`List<RegionInfo>`	`getRegions(TableName tableName)` Get the regions of a given table.
`Map<TableName,SpaceQuotaSnapshot>`	`getRegionServerSpaceQuotaSnapshots(ServerName serverName)` Fetches the observed `SpaceQuotaSnapshotView`s observed by a RegionServer.
`ReplicationPeerConfig`	`getReplicationPeerConfig(String peerId)` Returns the configured ReplicationPeerConfig for the specified peer.
`List<SecurityCapability>`	`getSecurityCapabilities()` Return the set of supported security capabilities.
`Map<TableName,Long>`	`getSpaceQuotaTableSizes()` Fetches the table sizes on the filesystem as tracked by the HBase Master.
`HTableDescriptor`	`getTableDescriptor(TableName tableName)` Get a table descriptor.
`HTableDescriptor[]`	`getTableDescriptors(List<String> names)` Get tableDescriptors.
`HTableDescriptor[]`	`getTableDescriptorsByTableName(List<TableName> tableNames)` Get tableDescriptors.
`List<HRegionInfo>`	`getTableRegions(TableName tableName)` 已过时。 As of release 2.0.0, this will be removed in HBase 3.0.0 Use `getRegions(TableName)`.
`List<UserPermission>`	`getUserPermissions(GetUserPermissionsRequest getUserPermissionsRequest)` Get the global/namespace/table permissions for user
`void`	`grant(UserPermission userPermission, boolean mergeExistingPermissions)` Grants user specific permissions
`List<Boolean>`	`hasUserPermissions(String userName, List<Permission> permissions)` Check if the user has specific permissions
`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`	`isRpcThrottleEnabled()` Get if the rpc throttle is enabled.
`boolean`	`isSnapshotFinished(SnapshotDescription snapshotDesc)` Check the current state of the passed snapshot.
`boolean`	`isSplitEnabled()` Query the current state of the split switch.
`boolean`	`isTableAvailable(TableName tableName)`
`boolean`	`isTableAvailable(TableName tableName, byte[][] splitKeys)` 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.
`boolean`	`isTableDisabled(TableName tableName)`
`boolean`	`isTableEnabled(TableName tableName)`
`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)` List all the completed snapshots matching the given regular expression.
`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)` Get list of table descriptors by namespace.
`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)` List all of the names of userspace tables.
`TableName[]`	`listTableNames(String regex, boolean includeSysTables)` List all of the names of userspace tables.
`TableName[]`	`listTableNamesByNamespace(String name)` Get list of table names by namespace.
`HTableDescriptor[]`	`listTables()` List all the userspace tables.
`HTableDescriptor[]`	`listTables(Pattern pattern)` List all the userspace tables that match the given pattern.
`HTableDescriptor[]`	`listTables(Pattern pattern, boolean includeSysTables)` List all the tables matching the given pattern.
`HTableDescriptor[]`	`listTables(String regex)` List all the userspace tables matching the given regular expression.
`HTableDescriptor[]`	`listTables(String regex, boolean includeSysTables)` List all the tables matching the given pattern.
`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)` List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
`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)` 已过时。 Since 2.0. Will be removed in 3.0. Use `Admin.mergeRegionsAsync(byte[], byte[], boolean)` instead.
`Future<Void>`	`mergeRegionsAsync(byte[][] nameofRegionsToMerge, boolean forcible)` Merge two regions.
`void`	`mergeRegionsSync(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible)` Merge two regions.
`boolean`	`mergeSwitch(boolean enabled, boolean synchronous)` Turn the merge switch on or off.
`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)` Modify an existing table, more IRB friendly version.
`Future<Void>`	`modifyTableAsync(TableDescriptor td)` Modify an existing table, more IRB (ruby) friendly version.
`Future<Void>`	`modifyTableAsync(TableName tableName, TableDescriptor td)` Modify an existing table, more IRB friendly version.
`void`	`move(byte[] encodedRegionName)` Move the region `encodedRegionName` to a random server.
`void`	`move(byte[] encodedRegionName, ServerName destServerName)` Move the region `rencodedRegionName` to `destServerName`.
`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`	`revoke(UserPermission userPermission)` Revokes user specific permissions
`byte[][]`	`rollHLogWriter(String serverName)` 已过时。 use `rollWALWriter(ServerName)`
`void`	`rollWALWriter(ServerName serverName)` Roll the log writer.
`int`	`runCatalogJanitor()` Ask for a scan of the catalog table.
`boolean`	`runCleanerChore()` Ask for cleaner chore to run.
`void`	`setQuota(QuotaSettings quota)` Apply the new quota settings.
`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 snapshotDesc)` 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 snapshotDesc)` 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)` Split an individual region.
`void`	`splitRegion(byte[] regionName, byte[] splitPoint)` Split an individual region.
`Future<Void>`	`splitRegionAsync(byte[] regionName)` Split an individual region.
`Future<Void>`	`splitRegionAsync(byte[] regionName, byte[] splitPoint)` Split an individual region.
`void`	`splitRegionSync(byte[] regionName, byte[] splitPoint)` Split one region.
`void`	`splitRegionSync(byte[] regionName, byte[] splitPoint, long timeout, TimeUnit units)` Split one 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`	`switchRpcThrottle(boolean enable)` Switch the rpc throttle enable state.
`boolean`	`tableExists(TableName tableName)`
`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.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getOperationTimeout
```
public int getOperationTimeout()
```
    指定者:
    
    getOperationTimeout 在接口中 Admin
  - abort
```
public void abort(String why,
                  Throwable e)
```
    从接口复制的说明: Abortable
    
    Abort the server or client.
    
    指定者:
    
    abort 在接口中 Abortable
    
    指定者:
    
    abort 在接口中 Admin
    
    参数:
    
    why - Why we're aborting.
    
    e - Throwable that caused abort. Can be null.
  - isAborted
```
public boolean isAborted()
```
    从接口复制的说明: Abortable
    
    Check if the server or client was aborted.
    
    指定者:
    
    isAborted 在接口中 Abortable
    
    指定者:
    
    isAborted 在接口中 Admin
    
    返回:
    
    true if the server or client was aborted, false otherwise
  - abortProcedure
```
public boolean abortProcedure(long procId,
                              boolean mayInterruptIfRunning)
                       throws IOException
```
    从接口复制的说明: Admin
    
    Abort a procedure. Do not use. Usually it is ignored but if not, it can do more damage than good. See hbck2.
    
    指定者:
    
    abortProcedure 在接口中 Admin
    
    参数:
    
    procId - ID of the procedure to abort
    
    mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?
    
    返回:
    
    true if aborted, false if procedure already completed or does not exist
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    HBASE-21223
  - abortProcedureAsync
```
public Future<Boolean> abortProcedureAsync(long procId,
                                           boolean mayInterruptIfRunning)
                                    throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    abortProcedureAsync 在接口中 Admin
    
    参数:
    
    procId - ID of the procedure to abort
    
    mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?
    
    返回:
    
    true if aborted, false if procedure already completed or does not exist
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    HBASE-21223
  - listTableDescriptors
```
public List<TableDescriptor> listTableDescriptors()
                                           throws IOException
```
    从接口复制的说明: Admin
    
    List all the userspace tables.
    
    指定者:
    
    listTableDescriptors 在接口中 Admin
    
    返回:
    
    a list of TableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableDescriptors
```
public List<TableDescriptor> listTableDescriptors(Pattern pattern)
                                           throws IOException
```
    从接口复制的说明: Admin
    
    List all the userspace tables that match the given pattern.
    
    指定者:
    
    listTableDescriptors 在接口中 Admin
    
    参数:
    
    pattern - The compiled regular expression to match against
    
    返回:
    
    a list of TableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.listTables()
  - listTableDescriptors
```
public List<TableDescriptor> listTableDescriptors(Pattern pattern,
                                                  boolean includeSysTables)
                                           throws IOException
```
    从接口复制的说明: Admin
    
    List all the tables matching the given pattern.
    
    指定者:
    
    listTableDescriptors 在接口中 Admin
    
    参数:
    
    pattern - The compiled regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    返回:
    
    a list of TableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.listTables()
  - getDescriptor
```
public TableDescriptor getDescriptor(TableName tableName)
                              throws TableNotFoundException,
                                     IOException
```
    从接口复制的说明: Admin
    
    Get a table descriptor.
    
    指定者:
    
    getDescriptor 在接口中 Admin
    
    参数:
    
    tableName - as a TableName
    
    返回:
    
    the tableDescriptor
    
    抛出:
    
    TableNotFoundException
    
    IOException - if a remote or network exception occurs
  - modifyTable
```
public void modifyTable(TableDescriptor td)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Modify an existing table, more IRB friendly version.
    
    指定者:
    
    modifyTable 在接口中 Admin
    
    参数:
    
    td - modified description of the table
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyTableAsync
```
public Future<Void> modifyTableAsync(TableDescriptor td)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    modifyTableAsync 在接口中 Admin
    
    参数:
    
    td - description of the table
    
    返回:
    
    the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the operation to complete
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableDescriptorsByNamespace
```
public List<TableDescriptor> listTableDescriptorsByNamespace(byte[] name)
                                                      throws IOException
```
    从接口复制的说明: Admin
    
    Get list of table descriptors by namespace.
    
    指定者:
    
    listTableDescriptorsByNamespace 在接口中 Admin
    
    参数:
    
    name - namespace name
    
    返回:
    
    returns a list of TableDescriptors
    
    抛出:
    
    IOException
  - listTableDescriptors
```
public List<TableDescriptor> listTableDescriptors(List<TableName> tableNames)
                                           throws IOException
```
    从接口复制的说明: Admin
    
    Get tableDescriptors.
    
    指定者:
    
    listTableDescriptors 在接口中 Admin
    
    参数:
    
    tableNames - List of table names
    
    返回:
    
    returns a list of TableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getRegions
```
public List<RegionInfo> getRegions(ServerName sn)
                            throws IOException
```
    从接口复制的说明: Admin
    
    Get all the online regions on a region server.
    
    指定者:
    
    getRegions 在接口中 Admin
    
    返回:
    
    List of RegionInfo
    
    抛出:
    
    IOException
  - getRegions
```
public List<RegionInfo> getRegions(TableName tableName)
                            throws IOException
```
    从接口复制的说明: Admin
    
    Get the regions of a given table.
    
    指定者:
    
    getRegions 在接口中 Admin
    
    参数:
    
    tableName - the name of the table
    
    返回:
    
    List of RegionInfo.
    
    抛出:
    
    IOException
  - getConnection
```
public Connection getConnection()
```
    指定者:
    
    getConnection 在接口中 Admin
    
    返回:
    
    Connection used by this object.
  - tableExists
```
public boolean tableExists(TableName tableName)
                    throws IOException
```
    指定者:
    
    tableExists 在接口中 Admin
    
    参数:
    
    tableName - Table to check.
    
    返回:
    
    true if table exists already.
    
    抛出:
    
    IOException
  - listTables
```
public HTableDescriptor[] listTables()
                              throws IOException
```
    从接口复制的说明: Admin
    
    List all the userspace tables.
    
    指定者:
    
    listTables 在接口中 Admin
    
    返回:
    
    an array of read-only HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.listTableDescriptors()
  - listTables
```
public HTableDescriptor[] listTables(Pattern pattern)
                              throws IOException
```
    从接口复制的说明: Admin
    
    List all the userspace tables that match the given pattern.
    
    指定者:
    
    listTables 在接口中 Admin
    
    参数:
    
    pattern - The compiled regular expression to match against
    
    返回:
    
    an array of read-only HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.listTables(), Admin.listTableDescriptors(Pattern)
  - listTables
```
public HTableDescriptor[] listTables(String regex)
                              throws IOException
```
    从接口复制的说明: Admin
    
    List all the userspace tables matching the given regular expression.
    
    指定者:
    
    listTables 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match against
    
    返回:
    
    a list of read-only HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.listTableDescriptors(Pattern)
  - listTables
```
public HTableDescriptor[] listTables(Pattern pattern,
                                     boolean includeSysTables)
                              throws IOException
```
    从接口复制的说明: Admin
    
    List all the tables matching the given pattern.
    
    指定者:
    
    listTables 在接口中 Admin
    
    参数:
    
    pattern - The compiled regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    返回:
    
    an array of read-only HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.listTables(), Admin.listTableDescriptors(java.util.regex.Pattern, boolean)
  - listTables
```
public HTableDescriptor[] listTables(String regex,
                                     boolean includeSysTables)
                              throws IOException
```
    从接口复制的说明: Admin
    
    List all the tables matching the given pattern.
    
    指定者:
    
    listTables 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    返回:
    
    an array of read-only HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.listTables(java.util.regex.Pattern, boolean)
  - listTableNames
```
public TableName[] listTableNames()
                           throws IOException
```
    从接口复制的说明: Admin
    
    List all of the names of userspace tables.
    
    指定者:
    
    listTableNames 在接口中 Admin
    
    返回:
    
    TableName[] table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
public TableName[] listTableNames(Pattern pattern)
                           throws IOException
```
    从接口复制的说明: Admin
    
    List all of the names of userspace tables.
    
    指定者:
    
    listTableNames 在接口中 Admin
    
    参数:
    
    pattern - The regular expression to match against
    
    返回:
    
    array of table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
public TableName[] listTableNames(String regex)
                           throws IOException
```
    从接口复制的说明: Admin
    
    List all of the names of userspace tables.
    
    指定者:
    
    listTableNames 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match against
    
    返回:
    
    TableName[] table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
public TableName[] listTableNames(Pattern pattern,
                                  boolean includeSysTables)
                           throws IOException
```
    从接口复制的说明: Admin
    
    List all of the names of userspace tables.
    
    指定者:
    
    listTableNames 在接口中 Admin
    
    参数:
    
    pattern - The regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    返回:
    
    TableName[] table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableNames
```
public TableName[] listTableNames(String regex,
                                  boolean includeSysTables)
                           throws IOException
```
    从接口复制的说明: Admin
    
    List all of the names of userspace tables.
    
    指定者:
    
    listTableNames 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match against
    
    includeSysTables - false to match only against userspace tables
    
    返回:
    
    TableName[] table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getTableDescriptor
```
public HTableDescriptor getTableDescriptor(TableName tableName)
                                    throws IOException
```
    从接口复制的说明: Admin
    
    Get a table descriptor.
    
    指定者:
    
    getTableDescriptor 在接口中 Admin
    
    参数:
    
    tableName - as a TableName
    
    返回:
    
    the read-only tableDescriptor
    
    抛出:
    
    TableNotFoundException
    
    IOException - if a remote or network exception occurs
  - createTable
```
public void createTable(TableDescriptor desc)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Creates a new table. Synchronous operation.
    
    指定者:
    
    createTable 在接口中 Admin
    
    参数:
    
    desc - table descriptor for table
    
    抛出:
    
    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
```
public void createTable(TableDescriptor desc,
                        byte[] startKey,
                        byte[] endKey,
                        int numRegions)
                 throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    createTable 在接口中 Admin
    
    参数:
    
    desc - table descriptor for table
    
    startKey - beginning of key range
    
    endKey - end of key range
    
    numRegions - the total number of regions to create
    
    抛出:
    
    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
```
public void createTable(TableDescriptor desc,
                        byte[][] splitKeys)
                 throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    createTable 在接口中 Admin
    
    参数:
    
    desc - table descriptor for table
    
    splitKeys - array of split keys for the initial regions of the table
    
    抛出:
    
    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
```
public Future<Void> createTableAsync(TableDescriptor desc,
                                     byte[][] splitKeys)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    createTableAsync 在接口中 Admin
    
    参数:
    
    desc - table descriptor for table
    
    splitKeys - keys to check if the table has been created with all split keys
    
    返回:
    
    the result of the async creation. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteTable
```
public void deleteTable(TableName tableName)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Deletes a table. Synchronous operation.
    
    指定者:
    
    deleteTable 在接口中 Admin
    
    参数:
    
    tableName - name of table to delete
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteTableAsync
```
public Future<Void> deleteTableAsync(TableName tableName)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    deleteTableAsync 在接口中 Admin
    
    参数:
    
    tableName - name of table to delete
    
    返回:
    
    the result of the async delete. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteTables
```
public HTableDescriptor[] deleteTables(String regex)
                                throws IOException
```
    从接口复制的说明: Admin
    
    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 Admin.listTableDescriptors(Pattern) and Admin.deleteTable(org.apache.hadoop.hbase.TableName)
    
    指定者:
    
    deleteTables 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match table names against
    
    返回:
    
    Table descriptors for tables that couldn't be deleted. The return htds are read-only
    
    抛出:
    
    IOException
    
    另请参阅:
    
    Admin.deleteTables(java.util.regex.Pattern), Admin.deleteTable(org.apache.hadoop.hbase.TableName)
  - deleteTables
```
public HTableDescriptor[] deleteTables(Pattern pattern)
                                throws IOException
```
    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 listTables(java.util.regex.Pattern) and deleteTable(TableName)
    
    指定者:
    
    deleteTables 在接口中 Admin
    
    参数:
    
    pattern - The pattern to match table names against
    
    返回:
    
    Table descriptors for tables that couldn't be deleted
    
    抛出:
    
    IOException
  - truncateTable
```
public void truncateTable(TableName tableName,
                          boolean preserveSplits)
                   throws IOException
```
    从接口复制的说明: Admin
    
    Truncate a table. Synchronous operation.
    
    指定者:
    
    truncateTable 在接口中 Admin
    
    参数:
    
    tableName - name of table to truncate
    
    preserveSplits - true if the splits should be preserved
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - truncateTableAsync
```
public Future<Void> truncateTableAsync(TableName tableName,
                                       boolean preserveSplits)
                                throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    truncateTableAsync 在接口中 Admin
    
    参数:
    
    tableName - name of table to delete
    
    preserveSplits - true if the splits should be preserved
    
    返回:
    
    the result of the async truncate. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - enableTable
```
public void enableTable(TableName tableName)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Enable a table. May timeout. Use Admin.enableTableAsync(org.apache.hadoop.hbase.TableName) and Admin.isTableEnabled(org.apache.hadoop.hbase.TableName) instead. The table has to be in disabled state for it to be enabled.
    
    指定者:
    
    enableTable 在接口中 Admin
    
    参数:
    
    tableName - name of the table
    
    抛出:
    
    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.
    
    另请参阅:
    
    Admin.isTableEnabled(org.apache.hadoop.hbase.TableName), Admin.disableTable(org.apache.hadoop.hbase.TableName), Admin.enableTableAsync(org.apache.hadoop.hbase.TableName)
  - enableTableAsync
```
public Future<Void> enableTableAsync(TableName tableName)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    enableTableAsync 在接口中 Admin
    
    参数:
    
    tableName - name of table to delete
    
    返回:
    
    the result of the async enable. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - enableTables
```
public HTableDescriptor[] enableTables(String regex)
                                throws IOException
```
    从接口复制的说明: Admin
    
    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 Admin.listTableDescriptors(Pattern) and Admin.enableTable(org.apache.hadoop.hbase.TableName)
    
    指定者:
    
    enableTables 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match table names against
    
    返回:
    
    Table descriptors for tables that couldn't be enabled. The return HTDs are read-only.
    
    抛出:
    
    IOException
    
    另请参阅:
    
    Admin.enableTables(java.util.regex.Pattern), Admin.enableTable(org.apache.hadoop.hbase.TableName)
  - enableTables
```
public HTableDescriptor[] enableTables(Pattern pattern)
                                throws IOException
```
    从接口复制的说明: Admin
    
    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 Admin.listTableDescriptors(java.util.regex.Pattern) and Admin.enableTable(org.apache.hadoop.hbase.TableName)
    
    指定者:
    
    enableTables 在接口中 Admin
    
    参数:
    
    pattern - The pattern to match table names against
    
    返回:
    
    Table descriptors for tables that couldn't be enabled. The return HTDs are read-only.
    
    抛出:
    
    IOException
  - disableTable
```
public void disableTable(TableName tableName)
                  throws IOException
```
    从接口复制的说明: Admin
    
    Disable table and wait on completion. May timeout eventually. Use Admin.disableTableAsync(org.apache.hadoop.hbase.TableName) and Admin.isTableDisabled(org.apache.hadoop.hbase.TableName) instead. The table has to be in enabled state for it to be disabled.
    
    指定者:
    
    disableTable 在接口中 Admin
    
    抛出:
    
    IOException - There could be couple types of IOException TableNotFoundException means the table doesn't exist. TableNotEnabledException means the table isn't in enabled state.
  - disableTableAsync
```
public Future<Void> disableTableAsync(TableName tableName)
                               throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    disableTableAsync 在接口中 Admin
    
    参数:
    
    tableName - name of table to delete
    
    返回:
    
    the result of the async disable. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - disableTables
```
public HTableDescriptor[] disableTables(String regex)
                                 throws IOException
```
    从接口复制的说明: Admin
    
    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 Admin.listTableDescriptors(Pattern) and Admin.disableTable(org.apache.hadoop.hbase.TableName)
    
    指定者:
    
    disableTables 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match table names against
    
    返回:
    
    Table descriptors for tables that couldn't be disabled The return htds are read-only
    
    抛出:
    
    IOException
    
    另请参阅:
    
    Admin.disableTables(java.util.regex.Pattern), Admin.disableTable(org.apache.hadoop.hbase.TableName)
  - disableTables
```
public HTableDescriptor[] disableTables(Pattern pattern)
                                 throws IOException
```
    从接口复制的说明: Admin
    
    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 Admin.listTableDescriptors(java.util.regex.Pattern) and Admin.disableTable(org.apache.hadoop.hbase.TableName)
    
    指定者:
    
    disableTables 在接口中 Admin
    
    参数:
    
    pattern - The pattern to match table names against
    
    返回:
    
    Table descriptors for tables that couldn't be disabled The return htds are read-only
    
    抛出:
    
    IOException
  - isTableEnabled
```
public boolean isTableEnabled(TableName tableName)
                       throws IOException
```
    指定者:
    
    isTableEnabled 在接口中 Admin
    
    参数:
    
    tableName - name of table to check
    
    返回:
    
    true if table is on-line
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - isTableDisabled
```
public boolean isTableDisabled(TableName tableName)
                        throws IOException
```
    指定者:
    
    isTableDisabled 在接口中 Admin
    
    参数:
    
    tableName - name of table to check
    
    返回:
    
    true if table is off-line
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - isTableAvailable
```
public boolean isTableAvailable(TableName tableName)
                         throws IOException
```
    指定者:
    
    isTableAvailable 在接口中 Admin
    
    参数:
    
    tableName - name of table to check
    
    返回:
    
    true if all regions of the table are available
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - isTableAvailable
```
public boolean isTableAvailable(TableName tableName,
                                byte[][] splitKeys)
                         throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    isTableAvailable 在接口中 Admin
    
    参数:
    
    tableName - name of table to check
    
    splitKeys - keys to check if the table has been created with all split keys
    
    抛出:
    
    IOException - if a remote or network excpetion occurs
  - getAlterStatus
```
public Pair<Integer,Integer> getAlterStatus(TableName tableName)
                                     throws IOException
```
    从接口复制的说明: Admin
    
    Get the status of an alter (a.k.a modify) command - indicates how many regions have received the updated schema Asynchronous operation.
    
    指定者:
    
    getAlterStatus 在接口中 Admin
    
    参数:
    
    tableName - TableName instance
    
    返回:
    
    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
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getAlterStatus
```
public Pair<Integer,Integer> getAlterStatus(byte[] tableName)
                                     throws IOException
```
    从接口复制的说明: Admin
    
    Get the status of alter (a.k.a modify) command - indicates how many regions have received the updated schema Asynchronous operation.
    
    指定者:
    
    getAlterStatus 在接口中 Admin
    
    参数:
    
    tableName - name of the table to get the status of
    
    返回:
    
    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
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - addColumnFamily
```
public void addColumnFamily(TableName tableName,
                            ColumnFamilyDescriptor columnFamily)
                     throws IOException
```
    从接口复制的说明: Admin
    
    Add a column family to an existing table. Synchronous operation. Use Admin.addColumnFamilyAsync(TableName, ColumnFamilyDescriptor) instead because it returns a Future from which you can learn whether success or failure.
    
    指定者:
    
    addColumnFamily 在接口中 Admin
    
    参数:
    
    tableName - name of the table to add column family to
    
    columnFamily - column family descriptor of column family to be added
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - addColumnFamilyAsync
```
public Future<Void> addColumnFamilyAsync(TableName tableName,
                                         ColumnFamilyDescriptor columnFamily)
                                  throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    addColumnFamilyAsync 在接口中 Admin
    
    参数:
    
    tableName - name of the table to add column family to
    
    columnFamily - column family descriptor of column family to be added
    
    返回:
    
    the result of the async add column family. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteColumn
```
@Deprecated
public void deleteColumn(TableName tableName,
                                     byte[] columnFamily)
                              throws IOException
```
    已过时。 Since 2.0. Will be removed in 3.0. Use deleteColumnFamily(TableName, byte[]) instead.
    
    Delete a column family from a table. Synchronous operation. Use Admin.deleteColumnFamily(TableName, byte[]) instead because it returns a Future from which you can learn whether success or failure.
    
    指定者:
    
    deleteColumn 在接口中 Admin
    
    参数:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteColumnFamily
```
public void deleteColumnFamily(TableName tableName,
                               byte[] columnFamily)
                        throws IOException
```
    从接口复制的说明: Admin
    
    Delete a column family from a table. Synchronous operation. Use Admin.deleteColumnFamily(TableName, byte[]) instead because it returns a Future from which you can learn whether success or failure.
    
    指定者:
    
    deleteColumnFamily 在接口中 Admin
    
    参数:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteColumnFamilyAsync
```
public Future<Void> deleteColumnFamilyAsync(TableName tableName,
                                            byte[] columnFamily)
                                     throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    deleteColumnFamilyAsync 在接口中 Admin
    
    参数:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
    
    返回:
    
    the result of the async delete column family. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyColumnFamily
```
public void modifyColumnFamily(TableName tableName,
                               ColumnFamilyDescriptor columnFamily)
                        throws IOException
```
    从接口复制的说明: Admin
    
    Modify an existing column family on a table. Synchronous operation. Use Admin.modifyColumnFamilyAsync(TableName, ColumnFamilyDescriptor) instead because it returns a Future from which you can learn whether success or failure.
    
    指定者:
    
    modifyColumnFamily 在接口中 Admin
    
    参数:
    
    tableName - name of table
    
    columnFamily - new column family descriptor to use
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyColumnFamilyAsync
```
public Future<Void> modifyColumnFamilyAsync(TableName tableName,
                                            ColumnFamilyDescriptor columnFamily)
                                     throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    modifyColumnFamilyAsync 在接口中 Admin
    
    参数:
    
    tableName - name of table
    
    columnFamily - new column family descriptor to use
    
    返回:
    
    the result of the async modify column family. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
@Deprecated
public void closeRegion(String regionName,
                                    String unused)
                             throws IOException
```
    已过时。
    
    从接口复制的说明: Admin
    
    Uses Admin.unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    指定者:
    
    closeRegion 在接口中 Admin
    
    参数:
    
    regionName - region name to close
    
    unused - Deprecated. Not used.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
@Deprecated
public void closeRegion(byte[] regionName,
                                    String unused)
                             throws IOException
```
    已过时。
    
    从接口复制的说明: Admin
    
    Uses Admin.unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    指定者:
    
    closeRegion 在接口中 Admin
    
    参数:
    
    regionName - region name to close
    
    unused - Deprecated. Not used.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegionWithEncodedRegionName
```
@Deprecated
public boolean closeRegionWithEncodedRegionName(String encodedRegionName,
                                                            String unused)
                                                     throws IOException
```
    已过时。
    
    从接口复制的说明: Admin
    
    Uses Admin.unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    指定者:
    
    closeRegionWithEncodedRegionName 在接口中 Admin
    
    参数:
    
    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.
    
    unused - Deprecated. Not used.
    
    返回:
    
    Deprecated. Returns true always.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
@Deprecated
public void closeRegion(ServerName unused,
                                    HRegionInfo hri)
                             throws IOException
```
    已过时。
    
    从接口复制的说明: Admin
    
    Used Admin.unassign(byte[], boolean) to unassign the region. For expert-admins.
    
    指定者:
    
    closeRegion 在接口中 Admin
    
    参数:
    
    unused - Deprecated. Not used.
    
    抛出:
    
    IOException
  - getOnlineRegions
```
@Deprecated
public List<HRegionInfo> getOnlineRegions(ServerName sn)
                                               throws IOException
```
    已过时。 As of release 2.0.0, this will be removed in HBase 3.0.0 Use getRegions(ServerName).
    
    从接口复制的说明: Admin
    
    Get all the online regions on a region server.
    
    指定者:
    
    getOnlineRegions 在接口中 Admin
    
    参数:
    
    sn -
    
    返回:
    
    List of HRegionInfo.
    
    抛出:
    
    IOException
  - flush
```
public void flush(TableName tableName)
           throws IOException
```
    从接口复制的说明: Admin
    
    Flush a table. Synchronous operation.
    
    指定者:
    
    flush 在接口中 Admin
    
    参数:
    
    tableName - table to flush
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - flushRegion
```
public void flushRegion(byte[] regionName)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Flush an individual region. Synchronous operation.
    
    指定者:
    
    flushRegion 在接口中 Admin
    
    参数:
    
    regionName - region to flush
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - flushRegionServer
```
public void flushRegionServer(ServerName serverName)
                       throws IOException
```
    从接口复制的说明: Admin
    
    Flush all regions on the region server. Synchronous operation.
    
    指定者:
    
    flushRegionServer 在接口中 Admin
    
    参数:
    
    serverName - the region server name to flush
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compact
```
public 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).
    
    指定者:
    
    compact 在接口中 Admin
    
    参数:
    
    tableName - table to compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compactRegion
```
public void compactRegion(byte[] regionName)
                   throws IOException
```
    从接口复制的说明: Admin
    
    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).
    
    指定者:
    
    compactRegion 在接口中 Admin
    
    参数:
    
    regionName - region to compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compact
```
public 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).
    
    指定者:
    
    compact 在接口中 Admin
    
    参数:
    
    tableName - table to compact
    
    columnFamily - column family within a table
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compactRegion
```
public 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).
    
    指定者:
    
    compactRegion 在接口中 Admin
    
    参数:
    
    regionName - region to compact
    
    columnFamily - column family within a region
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compactionSwitch
```
public Map<ServerName,Boolean> compactionSwitch(boolean switchState,
                                                List<String> serverNamesList)
                                         throws IOException
```
    从接口复制的说明: Admin
    
    Turn the compaction on or off. Disabling compactions will also interrupt any currently ongoing compactions. This state is ephemeral. The setting will be lost on restart. Compaction can also be enabled/disabled by modifying configuration hbase.regionserver.compaction.enabled in hbase-site.xml.
    
    指定者:
    
    compactionSwitch 在接口中 Admin
    
    参数:
    
    switchState - Set to true to enable, false to disable.
    
    serverNamesList - list of region servers.
    
    返回:
    
    Previous compaction states for region servers
    
    抛出:
    
    IOException
  - compactRegionServer
```
public void compactRegionServer(ServerName serverName)
                         throws IOException
```
    从接口复制的说明: Admin
    
    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).
    
    指定者:
    
    compactRegionServer 在接口中 Admin
    
    参数:
    
    serverName - the region server name
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompactRegionServer
```
public void majorCompactRegionServer(ServerName serverName)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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).
    
    指定者:
    
    majorCompactRegionServer 在接口中 Admin
    
    参数:
    
    serverName - the region server name
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompact
```
public void majorCompact(TableName tableName)
                  throws IOException
```
    从接口复制的说明: Admin
    
    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).
    
    指定者:
    
    majorCompact 在接口中 Admin
    
    参数:
    
    tableName - table to major compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompactRegion
```
public void majorCompactRegion(byte[] regionName)
                        throws IOException
```
    从接口复制的说明: Admin
    
    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).
    
    指定者:
    
    majorCompactRegion 在接口中 Admin
    
    参数:
    
    regionName - region to major compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompact
```
public 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).
    
    指定者:
    
    majorCompact 在接口中 Admin
    
    参数:
    
    tableName - table to major compact
    
    columnFamily - column family within a table
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompactRegion
```
public void majorCompactRegion(byte[] regionName,
                               byte[] columnFamily)
                        throws IOException
```
    从接口复制的说明: Admin
    
    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).
    
    指定者:
    
    majorCompactRegion 在接口中 Admin
    
    参数:
    
    regionName - egion to major compact
    
    columnFamily - column family within a region
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - move
```
public void move(byte[] encodedRegionName)
          throws IOException
```
    从接口复制的说明: Admin
    
    Move the region encodedRegionName to a random server.
    
    指定者:
    
    move 在接口中 Admin
    
    参数:
    
    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.
    
    抛出:
    
    IOException - if we can't find a region named encodedRegionName
  - move
```
public void move(byte[] encodedRegionName,
                 ServerName destServerName)
          throws IOException
```
    从接口复制的说明: Admin
    
    Move the region rencodedRegionName to destServerName.
    
    指定者:
    
    move 在接口中 Admin
    
    参数:
    
    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. A server name is made of host, port and startcode. Here is an example: host187.example.com,60020,1289493121758
    
    抛出:
    
    IOException - if we can't find a region named encodedRegionName
  - assign
```
public void assign(byte[] regionName)
            throws MasterNotRunningException,
                   ZooKeeperConnectionException,
                   IOException
```
    从接口复制的说明: Admin
    
    Assign a Region.
    
    指定者:
    
    assign 在接口中 Admin
    
    参数:
    
    regionName - Region name to assign.
    
    抛出:
    
    MasterNotRunningException
    
    ZooKeeperConnectionException
    
    IOException
  - unassign
```
public void unassign(byte[] regionName,
                     boolean force)
              throws IOException
```
    从接口复制的说明: Admin
    
    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 Admin.move(byte[], ServerName) if you want to control the region movement.
    
    指定者:
    
    unassign 在接口中 Admin
    
    参数:
    
    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).
    
    抛出:
    
    IOException
  - offline
```
public void offline(byte[] regionName)
             throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    offline 在接口中 Admin
    
    参数:
    
    regionName - Region to offline.
    
    抛出:
    
    IOException
  - balancerSwitch
```
public boolean balancerSwitch(boolean on,
                              boolean synchronous)
                       throws IOException
```
    从接口复制的说明: Admin
    
    Turn the load balancer on or off.
    
    指定者:
    
    balancerSwitch 在接口中 Admin
    
    参数:
    
    on - Set to true to enable, false to disable.
    
    synchronous - If true, it waits until current balance() call, if outstanding, to return.
    
    返回:
    
    Previous balancer value
    
    抛出:
    
    IOException
  - balance
```
public boolean balance()
                throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    balance 在接口中 Admin
    
    返回:
    
    true if balancer ran, false otherwise.
    
    抛出:
    
    IOException
  - balance
```
public boolean balance(boolean force)
                throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    balance 在接口中 Admin
    
    参数:
    
    force - whether we should force balance even if there is region in transition
    
    返回:
    
    true if balancer ran, false otherwise.
    
    抛出:
    
    IOException
  - isBalancerEnabled
```
public boolean isBalancerEnabled()
                          throws IOException
```
    从接口复制的说明: Admin
    
    Query the current state of the balancer.
    
    指定者:
    
    isBalancerEnabled 在接口中 Admin
    
    返回:
    
    true if the balancer is enabled, false otherwise.
    
    抛出:
    
    IOException
  - clearBlockCache
```
public 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.
    
    指定者:
    
    clearBlockCache 在接口中 Admin
    
    参数:
    
    tableName - table to clear block cache
    
    返回:
    
    CacheEvictionStats related to the eviction
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - normalize
```
public boolean normalize()
                  throws IOException
```
    Invoke region normalizer. Can NOT run for various reasons. Check logs.
    
    指定者:
    
    normalize 在接口中 Admin
    
    返回:
    
    True if region normalizer ran, false otherwise.
    
    抛出:
    
    IOException
  - isNormalizerEnabled
```
public boolean isNormalizerEnabled()
                            throws IOException
```
    从接口复制的说明: Admin
    
    Query the current state of the region normalizer.
    
    指定者:
    
    isNormalizerEnabled 在接口中 Admin
    
    返回:
    
    true if region normalizer is enabled, false otherwise.
    
    抛出:
    
    IOException
  - normalizerSwitch
```
public boolean normalizerSwitch(boolean on)
                         throws IOException
```
    从接口复制的说明: Admin
    
    Turn region normalizer on or off.
    
    指定者:
    
    normalizerSwitch 在接口中 Admin
    
    返回:
    
    Previous normalizer value
    
    抛出:
    
    IOException
  - catalogJanitorSwitch
```
public boolean catalogJanitorSwitch(boolean enable)
                             throws IOException
```
    从接口复制的说明: Admin
    
    Enable/Disable the catalog janitor/
    
    指定者:
    
    catalogJanitorSwitch 在接口中 Admin
    
    参数:
    
    enable - if true enables the catalog janitor
    
    返回:
    
    the previous state
    
    抛出:
    
    IOException
  - runCatalogJanitor
```
public int runCatalogJanitor()
                      throws IOException
```
    从接口复制的说明: Admin
    
    Ask for a scan of the catalog table.
    
    指定者:
    
    runCatalogJanitor 在接口中 Admin
    
    返回:
    
    the number of entries cleaned
    
    抛出:
    
    IOException
  - isCatalogJanitorEnabled
```
public boolean isCatalogJanitorEnabled()
                                throws IOException
```
    从接口复制的说明: Admin
    
    Query on the catalog janitor state (Enabled/Disabled?).
    
    指定者:
    
    isCatalogJanitorEnabled 在接口中 Admin
    
    抛出:
    
    IOException
  - cleanerChoreSwitch
```
public boolean cleanerChoreSwitch(boolean on)
                           throws IOException
```
    从接口复制的说明: Admin
    
    Enable/Disable the cleaner chore.
    
    指定者:
    
    cleanerChoreSwitch 在接口中 Admin
    
    参数:
    
    on - if true enables the cleaner chore
    
    返回:
    
    the previous state
    
    抛出:
    
    IOException
  - runCleanerChore
```
public boolean runCleanerChore()
                        throws IOException
```
    从接口复制的说明: Admin
    
    Ask for cleaner chore to run.
    
    指定者:
    
    runCleanerChore 在接口中 Admin
    
    返回:
    
    true if cleaner chore ran, false otherwise
    
    抛出:
    
    IOException
  - isCleanerChoreEnabled
```
public boolean isCleanerChoreEnabled()
                              throws IOException
```
    从接口复制的说明: Admin
    
    Query on the cleaner chore state (Enabled/Disabled?).
    
    指定者:
    
    isCleanerChoreEnabled 在接口中 Admin
    
    抛出:
    
    IOException
  - mergeRegionsSync
```
public void mergeRegionsSync(byte[] nameOfRegionA,
                             byte[] nameOfRegionB,
                             boolean forcible)
                      throws IOException
```
    Merge two regions. Synchronous operation. Note: It is not feasible to predict the length of merge. Therefore, this is for internal testing only.
    
    参数:
    
    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
    
    抛出:
    
    IOException
  - mergeRegions
```
@Deprecated
public void mergeRegions(byte[] nameOfRegionA,
                                     byte[] nameOfRegionB,
                                     boolean forcible)
                              throws IOException
```
    已过时。 Since 2.0. Will be removed in 3.0. Use Admin.mergeRegionsAsync(byte[], byte[], boolean) instead.
    
    Merge two regions. Asynchronous operation.
    
    指定者:
    
    mergeRegions 在接口中 Admin
    
    参数:
    
    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
    
    抛出:
    
    IOException
  - mergeRegionsAsync
```
public Future<Void> mergeRegionsAsync(byte[][] nameofRegionsToMerge,
                                      boolean forcible)
                               throws IOException
```
    Merge two regions. Asynchronous operation.
    
    指定者:
    
    mergeRegionsAsync 在接口中 Admin
    
    参数:
    
    nameofRegionsToMerge - encoded or full name of daughter regions
    
    forcible - true if do a compulsory merge, otherwise we will only merge adjacent regions
    
    抛出:
    
    IOException
  - splitRegionSync
```
public void splitRegionSync(byte[] regionName,
                            byte[] splitPoint)
                     throws IOException
```
    Split one region. Synchronous operation. Note: It is not feasible to predict the length of split. Therefore, this is for internal testing only.
    
    参数:
    
    regionName - encoded or full name of region
    
    splitPoint - key where region splits
    
    抛出:
    
    IOException
  - splitRegionSync
```
public void splitRegionSync(byte[] regionName,
                            byte[] splitPoint,
                            long timeout,
                            TimeUnit units)
                     throws IOException
```
    Split one region. Synchronous operation.
    
    参数:
    
    regionName - region to be split
    
    splitPoint - split point
    
    timeout - how long to wait on split
    
    units - time units
    
    抛出:
    
    IOException
  - splitRegionAsync
```
public Future<Void> splitRegionAsync(byte[] regionName,
                                     byte[] splitPoint)
                              throws IOException
```
    从接口复制的说明: Admin
    
    Split an individual region. Asynchronous operation.
    
    指定者:
    
    splitRegionAsync 在接口中 Admin
    
    参数:
    
    regionName - region to split
    
    splitPoint - the explicit position to split on
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - split
```
public void split(TableName tableName)
           throws IOException
```
    从接口复制的说明: Admin
    
    Split a table. The method will execute split action for each region in table. Asynchronous operation.
    
    指定者:
    
    split 在接口中 Admin
    
    参数:
    
    tableName - table to split
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - splitRegion
```
public void splitRegion(byte[] regionName)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Split an individual region. Asynchronous operation.
    
    指定者:
    
    splitRegion 在接口中 Admin
    
    参数:
    
    regionName - region to split
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - split
```
public void split(TableName tableName,
                  byte[] splitPoint)
           throws IOException
```
    从接口复制的说明: Admin
    
    Split a table. Asynchronous operation.
    
    指定者:
    
    split 在接口中 Admin
    
    参数:
    
    tableName - table to split
    
    splitPoint - the explicit position to split on
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - splitRegion
```
public void splitRegion(byte[] regionName,
                        byte[] splitPoint)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Split an individual region. Asynchronous operation.
    
    指定者:
    
    splitRegion 在接口中 Admin
    
    参数:
    
    regionName - region to split
    
    splitPoint - the explicit position to split on
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyTable
```
public void modifyTable(TableName tableName,
                        TableDescriptor td)
                 throws IOException
```
    从接口复制的说明: Admin
    
    Modify an existing table, more IRB friendly version.
    
    指定者:
    
    modifyTable 在接口中 Admin
    
    参数:
    
    tableName - name of table.
    
    td - modified description of the table
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyTableAsync
```
public Future<Void> modifyTableAsync(TableName tableName,
                                     TableDescriptor td)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    modifyTableAsync 在接口中 Admin
    
    参数:
    
    tableName - name of table.
    
    td - modified description of the table
    
    返回:
    
    the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the operation to complete
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - shutdown
```
public void shutdown()
              throws IOException
```
    从接口复制的说明: Admin
    
    Shuts down the HBase cluster.
    
    Notice that, a success shutdown call may ends with an error since the remote server has already been shutdown.
    
    指定者:
    
    shutdown 在接口中 Admin
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - stopMaster
```
public void stopMaster()
                throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    stopMaster 在接口中 Admin
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    另请参阅:
    
    Admin.shutdown()
  - stopRegionServer
```
public void stopRegionServer(String hostnamePort)
                      throws IOException
```
    从接口复制的说明: Admin
    
    Stop the designated regionserver.
    
    指定者:
    
    stopRegionServer 在接口中 Admin
    
    参数:
    
    hostnamePort - Hostname and port delimited by a : as in example.org:1234
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - isMasterInMaintenanceMode
```
public boolean isMasterInMaintenanceMode()
                                  throws IOException
```
    从接口复制的说明: Admin
    
    Check whether Master is in maintenance mode.
    
    指定者:
    
    isMasterInMaintenanceMode 在接口中 Admin
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getClusterMetrics
```
public ClusterMetrics getClusterMetrics(EnumSet<ClusterMetrics.Option> options)
                                 throws IOException
```
    从接口复制的说明: Admin
    
    Get cluster status with a set of ClusterMetrics.Option to get desired status.
    
    指定者:
    
    getClusterMetrics 在接口中 Admin
    
    返回:
    
    cluster status
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getRegionMetrics
```
public List<RegionMetrics> getRegionMetrics(ServerName serverName,
                                            TableName tableName)
                                     throws IOException
```
    从接口复制的说明: Admin
    
    Get RegionMetrics of all regions hosted on a regionserver for a table.
    
    指定者:
    
    getRegionMetrics 在接口中 Admin
    
    参数:
    
    serverName - region server from which RegionMetrics is required.
    
    tableName - get RegionMetrics of regions belonging to the table
    
    返回:
    
    region metrics map of all regions of a table hosted on a region server
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```
    指定者:
    
    getConfiguration 在接口中 Admin
    
    返回:
    
    Configuration used by the instance.
  - createNamespace
```
public void createNamespace(NamespaceDescriptor descriptor)
                     throws IOException
```
    从接口复制的说明: Admin
    
    Create a new namespace. Blocks until namespace has been successfully created or an exception is thrown.
    
    指定者:
    
    createNamespace 在接口中 Admin
    
    参数:
    
    descriptor - descriptor which describes the new namespace.
    
    抛出:
    
    IOException
  - createNamespaceAsync
```
public Future<Void> createNamespaceAsync(NamespaceDescriptor descriptor)
                                  throws IOException
```
    从接口复制的说明: Admin
    
    Create a new namespace.
    
    指定者:
    
    createNamespaceAsync 在接口中 Admin
    
    参数:
    
    descriptor - descriptor which describes the new namespace
    
    返回:
    
    the result of the async create namespace operation. Use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException
  - modifyNamespace
```
public void modifyNamespace(NamespaceDescriptor descriptor)
                     throws IOException
```
    从接口复制的说明: Admin
    
    Modify an existing namespace. Blocks until namespace has been successfully modified or an exception is thrown.
    
    指定者:
    
    modifyNamespace 在接口中 Admin
    
    参数:
    
    descriptor - descriptor which describes the new namespace
    
    抛出:
    
    IOException
  - modifyNamespaceAsync
```
public Future<Void> modifyNamespaceAsync(NamespaceDescriptor descriptor)
                                  throws IOException
```
    从接口复制的说明: Admin
    
    Modify an existing namespace.
    
    指定者:
    
    modifyNamespaceAsync 在接口中 Admin
    
    参数:
    
    descriptor - descriptor which describes the new namespace
    
    返回:
    
    the result of the async modify namespace operation. Use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException
  - deleteNamespace
```
public void deleteNamespace(String name)
                     throws IOException
```
    从接口复制的说明: Admin
    
    Delete an existing namespace. Only empty namespaces (no tables) can be removed. Blocks until namespace has been successfully deleted or an exception is thrown.
    
    指定者:
    
    deleteNamespace 在接口中 Admin
    
    参数:
    
    name - namespace name
    
    抛出:
    
    IOException
  - deleteNamespaceAsync
```
public Future<Void> deleteNamespaceAsync(String name)
                                  throws IOException
```
    从接口复制的说明: Admin
    
    Delete an existing namespace. Only empty namespaces (no tables) can be removed.
    
    指定者:
    
    deleteNamespaceAsync 在接口中 Admin
    
    参数:
    
    name - namespace name
    
    返回:
    
    the result of the async delete namespace operation. Use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException
  - getNamespaceDescriptor
```
public NamespaceDescriptor getNamespaceDescriptor(String name)
                                           throws NamespaceNotFoundException,
                                                  IOException
```
    从接口复制的说明: Admin
    
    Get a namespace descriptor by name.
    
    指定者:
    
    getNamespaceDescriptor 在接口中 Admin
    
    参数:
    
    name - name of namespace descriptor
    
    返回:
    
    A descriptor
    
    抛出:
    
    NamespaceNotFoundException
    
    IOException - if a remote or network exception occurs
  - listNamespaceDescriptors
```
public NamespaceDescriptor[] listNamespaceDescriptors()
                                               throws IOException
```
    从接口复制的说明: Admin
    
    List available namespace descriptors.
    
    指定者:
    
    listNamespaceDescriptors 在接口中 Admin
    
    返回:
    
    List of descriptors
    
    抛出:
    
    IOException
  - getProcedures
```
public String getProcedures()
                     throws IOException
```
    从接口复制的说明: Admin
    
    Get procedures.
    
    指定者:
    
    getProcedures 在接口中 Admin
    
    返回:
    
    procedure list in JSON
    
    抛出:
    
    IOException
  - getLocks
```
public String getLocks()
                throws IOException
```
    从接口复制的说明: Admin
    
    Get locks.
    
    指定者:
    
    getLocks 在接口中 Admin
    
    返回:
    
    lock list in JSON
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableDescriptorsByNamespace
```
public HTableDescriptor[] listTableDescriptorsByNamespace(String name)
                                                   throws IOException
```
    从接口复制的说明: Admin
    
    Get list of table descriptors by namespace.
    
    指定者:
    
    listTableDescriptorsByNamespace 在接口中 Admin
    
    参数:
    
    name - namespace name
    
    返回:
    
    HTD[] the read-only tableDescriptors
    
    抛出:
    
    IOException
  - listTableNamesByNamespace
```
public TableName[] listTableNamesByNamespace(String name)
                                      throws IOException
```
    从接口复制的说明: Admin
    
    Get list of table names by namespace.
    
    指定者:
    
    listTableNamesByNamespace 在接口中 Admin
    
    参数:
    
    name - namespace name
    
    返回:
    
    The list of table names in the namespace
    
    抛出:
    
    IOException
  - available
```
public static void available(org.apache.hadoop.conf.Configuration conf)
                      throws MasterNotRunningException,
                             ZooKeeperConnectionException,
                             IOException
```
    Is HBase available? Throw an exception if not.
    
    参数:
    
    conf - system configuration
    
    抛出:
    
    MasterNotRunningException - if the master is not running.
    
    ZooKeeperConnectionException - if unable to connect to zookeeper. // TODO do not expose ZKConnectionException.
    
    IOException
  - getTableRegions
```
@Deprecated
public List<HRegionInfo> getTableRegions(TableName tableName)
                                              throws IOException
```
    已过时。 As of release 2.0.0, this will be removed in HBase 3.0.0 Use getRegions(TableName).
    
    从接口复制的说明: Admin
    
    Get the regions of a given table.
    
    指定者:
    
    getTableRegions 在接口中 Admin
    
    参数:
    
    tableName -
    
    返回:
    
    List of HRegionInfo.
    
    抛出:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 Admin
    
    抛出:
    
    IOException
  - getTableDescriptorsByTableName
```
public HTableDescriptor[] getTableDescriptorsByTableName(List<TableName> tableNames)
                                                  throws IOException
```
    从接口复制的说明: Admin
    
    Get tableDescriptors.
    
    指定者:
    
    getTableDescriptorsByTableName 在接口中 Admin
    
    参数:
    
    tableNames - List of table names
    
    返回:
    
    HTD[] the read-only tableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getTableDescriptors
```
public HTableDescriptor[] getTableDescriptors(List<String> names)
                                       throws IOException
```
    从接口复制的说明: Admin
    
    Get tableDescriptors.
    
    指定者:
    
    getTableDescriptors 在接口中 Admin
    
    参数:
    
    names - List of table names
    
    返回:
    
    HTD[] the read-only tableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - rollHLogWriter
```
@Deprecated
public byte[][] rollHLogWriter(String serverName)
                                    throws IOException,
                                           FailedLogCloseException
```
    已过时。 use rollWALWriter(ServerName)
    
    Roll the log writer. I.e. when using a file system based write ahead log, start writing log messages to a new file. Note that when talking to a version 1.0+ HBase deployment, the rolling is asynchronous. This method will return as soon as the roll is requested and the return value will always be null. Additionally, the named region server may schedule store flushes at the request of the wal handling the roll request. When talking to a 0.98 or older HBase deployment, the rolling is synchronous and the return value may be either null or a list of encoded region names.
    
    参数:
    
    serverName - The servername of the regionserver. A server name is made of host, port and startcode. This is mandatory. Here is an example: host187.example.com,60020,1289493121758
    
    返回:
    
    a set of HRegionInfo.getEncodedName() that would allow the wal to clean up some underlying files. null if there's nothing to flush.
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    FailedLogCloseException
  - rollWALWriter
```
public void rollWALWriter(ServerName serverName)
                   throws IOException,
                          FailedLogCloseException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    rollWALWriter 在接口中 Admin
    
    参数:
    
    serverName - The servername of the regionserver.
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    FailedLogCloseException
  - getCompactionState
```
public CompactionState getCompactionState(TableName tableName)
                                   throws IOException
```
    从接口复制的说明: Admin
    
    Get the current compaction state of a table. It could be in a major compaction, a minor compaction, both, or none.
    
    指定者:
    
    getCompactionState 在接口中 Admin
    
    参数:
    
    tableName - table to examine
    
    返回:
    
    the current compaction state
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getCompactionStateForRegion
```
public CompactionState getCompactionStateForRegion(byte[] regionName)
                                            throws IOException
```
    从接口复制的说明: Admin
    
    Get the current compaction state of region. It could be in a major compaction, a minor compaction, both, or none.
    
    指定者:
    
    getCompactionStateForRegion 在接口中 Admin
    
    参数:
    
    regionName - region to examine
    
    返回:
    
    the current compaction state
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - snapshot
```
public void snapshot(String snapshotName,
                     TableName tableName)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    从接口复制的说明: Admin
    
    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[]).
    
    指定者:
    
    snapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to be created
    
    tableName - name of the table for which snapshot is created
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshot
```
public void snapshot(byte[] snapshotName,
                     TableName tableName)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    snapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to be created
    
    tableName - name of the table for which snapshot is created
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshot
```
public void snapshot(String snapshotName,
                     TableName tableName,
                     SnapshotType type)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    从接口复制的说明: Admin
    
    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[]).
    
    指定者:
    
    snapshot 在接口中 Admin
    
    参数:
    
    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
    
    抛出:
    
    IOException - we fail to reach the master
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshot
```
public void snapshot(SnapshotDescription snapshotDesc)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    从接口复制的说明: Admin
    
    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 Admin.snapshot(String, org.apache.hadoop.hbase.TableName) or Admin.snapshot(byte[], org.apache.hadoop.hbase.TableName) unless you are sure about the type of snapshot that you want to take.
    
    指定者:
    
    snapshot 在接口中 Admin
    
    参数:
    
    snapshotDesc - snapshot to take
    
    抛出:
    
    IOException - or we lose contact with the master.
    
    SnapshotCreationException - if snapshot failed to be taken
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - snapshotAsync
```
public void snapshotAsync(SnapshotDescription snapshotDesc)
                   throws IOException,
                          SnapshotCreationException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    snapshotAsync 在接口中 Admin
    
    参数:
    
    snapshotDesc - snapshot to take
    
    抛出:
    
    IOException - if the snapshot did not succeed or we lose contact with the master.
    
    SnapshotCreationException - if snapshot creation failed
  - isSnapshotFinished
```
public boolean isSnapshotFinished(SnapshotDescription snapshotDesc)
                           throws IOException,
                                  HBaseSnapshotException,
                                  UnknownSnapshotException
```
    从接口复制的说明: Admin
    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.
    指定者:
    
    isSnapshotFinished 在接口中 Admin
    
    参数:
    
    snapshotDesc - description of the snapshot to check
    
    返回:
    
    true if the snapshot is completed, false if the snapshot is still running
    
    抛出:
    
    IOException - if we have a network issue
    
    HBaseSnapshotException - if the snapshot failed
    
    UnknownSnapshotException - if the requested snapshot is unknown
  - restoreSnapshot
```
public void restoreSnapshot(byte[] snapshotName)
                     throws IOException,
                            RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    restoreSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to restore
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
  - restoreSnapshot
```
public void restoreSnapshot(String snapshotName)
                     throws IOException,
                            RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    restoreSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to restore
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
  - restoreSnapshot
```
public void restoreSnapshot(byte[] snapshotName,
                            boolean takeFailSafeSnapshot)
                     throws IOException,
                            RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    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".
    
    指定者:
    
    restoreSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
  - restoreSnapshot
```
public void restoreSnapshot(String snapshotName,
                            boolean takeFailSafeSnapshot)
                     throws IOException,
                            RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    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".
    
    指定者:
    
    restoreSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
  - restoreSnapshot
```
public void restoreSnapshot(String snapshotName,
                            boolean takeFailSafeSnapshot,
                            boolean restoreAcl)
                     throws IOException,
                            RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    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".
    
    指定者:
    
    restoreSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
    
    restoreAcl - true to restore acl of snapshot
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
  - restoreSnapshotAsync
```
public Future<Void> restoreSnapshotAsync(String snapshotName)
                                  throws IOException,
                                         RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    restoreSnapshotAsync 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to restore
    
    返回:
    
    the result of the async restore snapshot. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
  - cloneSnapshot
```
public void cloneSnapshot(byte[] snapshotName,
                          TableName tableName)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    Create a new table by cloning the snapshot content.
    
    指定者:
    
    cloneSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be created already exists
    
    RestoreSnapshotException - if snapshot failed to be cloned
  - cloneSnapshot
```
public void cloneSnapshot(String snapshotName,
                          TableName tableName,
                          boolean restoreAcl)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    Create a new table by cloning the snapshot content.
    
    指定者:
    
    cloneSnapshot 在接口中 Admin
    
    参数:
    
    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
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be created already exists
    
    RestoreSnapshotException - if snapshot failed to be cloned
  - cloneSnapshot
```
public void cloneSnapshot(String snapshotName,
                          TableName tableName)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException
```
    从接口复制的说明: Admin
    
    Create a new table by cloning the snapshot content.
    
    指定者:
    
    cloneSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be created already exists
    
    RestoreSnapshotException - if snapshot failed to be cloned
  - cloneSnapshotAsync
```
public Future<Void> cloneSnapshotAsync(String snapshotName,
                                       TableName tableName)
                                throws IOException,
                                       TableExistsException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    cloneSnapshotAsync 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
    
    返回:
    
    the result of the async clone snapshot. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    TableExistsException - if table to be cloned already exists
  - execProcedureWithReturn
```
public byte[] execProcedureWithReturn(String signature,
                                      String instance,
                                      Map<String,String> props)
                               throws IOException
```
    从接口复制的说明: Admin
    
    Execute a distributed procedure on a cluster.
    
    指定者:
    
    execProcedureWithReturn 在接口中 Admin
    
    参数:
    
    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
    
    返回:
    
    data returned after procedure execution. null if no return data.
    
    抛出:
    
    IOException
  - execProcedure
```
public void execProcedure(String signature,
                          String instance,
                          Map<String,String> props)
                   throws IOException
```
    从接口复制的说明: Admin
    
    Execute a distributed procedure on a cluster.
    
    指定者:
    
    execProcedure 在接口中 Admin
    
    参数:
    
    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
    
    抛出:
    
    IOException
  - isProcedureFinished
```
public boolean isProcedureFinished(String signature,
                                   String instance,
                                   Map<String,String> props)
                            throws IOException
```
    从接口复制的说明: Admin
    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
    指定者:
    
    isProcedureFinished 在接口中 Admin
    
    参数:
    
    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
    
    返回:
    
    true if the specified procedure is finished successfully, false if it is still running
    
    抛出:
    
    IOException - if the specified procedure finished with error
  - listSnapshots
```
public List<SnapshotDescription> listSnapshots()
                                        throws IOException
```
    从接口复制的说明: Admin
    
    List completed snapshots.
    
    指定者:
    
    listSnapshots 在接口中 Admin
    
    返回:
    
    a list of snapshot descriptors for completed snapshots
    
    抛出:
    
    IOException - if a network error occurs
  - listSnapshots
```
public List<SnapshotDescription> listSnapshots(String regex)
                                        throws IOException
```
    从接口复制的说明: Admin
    
    List all the completed snapshots matching the given regular expression.
    
    指定者:
    
    listSnapshots 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match against
    
    返回:
    
    list of SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listSnapshots
```
public List<SnapshotDescription> listSnapshots(Pattern pattern)
                                        throws IOException
```
    从接口复制的说明: Admin
    
    List all the completed snapshots matching the given pattern.
    
    指定者:
    
    listSnapshots 在接口中 Admin
    
    参数:
    
    pattern - The compiled regular expression to match against
    
    返回:
    
    list of SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableSnapshots
```
public List<SnapshotDescription> listTableSnapshots(String tableNameRegex,
                                                    String snapshotNameRegex)
                                             throws IOException
```
    从接口复制的说明: Admin
    
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    指定者:
    
    listTableSnapshots 在接口中 Admin
    
    参数:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
    
    返回:
    
    list of completed SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableSnapshots
```
public List<SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,
                                                    Pattern snapshotNamePattern)
                                             throws IOException
```
    从接口复制的说明: Admin
    
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    指定者:
    
    listTableSnapshots 在接口中 Admin
    
    参数:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
    
    返回:
    
    list of completed SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshot
```
public void deleteSnapshot(byte[] snapshotName)
                    throws IOException
```
    从接口复制的说明: Admin
    
    Delete an existing snapshot.
    
    指定者:
    
    deleteSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshot
```
public void deleteSnapshot(String snapshotName)
                    throws IOException
```
    从接口复制的说明: Admin
    
    Delete an existing snapshot.
    
    指定者:
    
    deleteSnapshot 在接口中 Admin
    
    参数:
    
    snapshotName - name of the snapshot
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshots
```
public void deleteSnapshots(String regex)
                     throws IOException
```
    从接口复制的说明: Admin
    
    Delete existing snapshots whose names match the pattern passed.
    
    指定者:
    
    deleteSnapshots 在接口中 Admin
    
    参数:
    
    regex - The regular expression to match against
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshots
```
public void deleteSnapshots(Pattern pattern)
                     throws IOException
```
    从接口复制的说明: Admin
    
    Delete existing snapshots whose names match the pattern passed.
    
    指定者:
    
    deleteSnapshots 在接口中 Admin
    
    参数:
    
    pattern - pattern for names of the snapshot to match
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteTableSnapshots
```
public void deleteTableSnapshots(String tableNameRegex,
                                 String snapshotNameRegex)
                          throws IOException
```
    从接口复制的说明: Admin
    
    Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
    
    指定者:
    
    deleteTableSnapshots 在接口中 Admin
    
    参数:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteTableSnapshots
```
public void deleteTableSnapshots(Pattern tableNamePattern,
                                 Pattern snapshotNamePattern)
                          throws IOException
```
    从接口复制的说明: Admin
    
    Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
    
    指定者:
    
    deleteTableSnapshots 在接口中 Admin
    
    参数:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - setQuota
```
public void setQuota(QuotaSettings quota)
              throws IOException
```
    从接口复制的说明: Admin
    
    Apply the new quota settings.
    
    指定者:
    
    setQuota 在接口中 Admin
    
    参数:
    
    quota - the quota settings
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getQuotaRetriever
```
public QuotaRetriever getQuotaRetriever(QuotaFilter filter)
                                 throws IOException
```
    从接口复制的说明: Admin
    
    Return a QuotaRetriever to list the quotas based on the filter.
    
    指定者:
    
    getQuotaRetriever 在接口中 Admin
    
    参数:
    
    filter - the quota settings filter
    
    返回:
    
    the quota retriever
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getQuota
```
public List<QuotaSettings> getQuota(QuotaFilter filter)
                             throws IOException
```
    从接口复制的说明: Admin
    
    List the quotas based on the filter.
    
    指定者:
    
    getQuota 在接口中 Admin
    
    参数:
    
    filter - the quota settings filter
    
    返回:
    
    the QuotaSetting list
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - coprocessorService
```
public CoprocessorRpcChannel coprocessorService()
```
    从接口复制的说明: Admin
    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);
    指定者:
    
    coprocessorService 在接口中 Admin
    
    返回:
    
    A MasterCoprocessorRpcChannel instance
  - coprocessorService
```
public CoprocessorRpcChannel coprocessorService(ServerName serverName)
```
    从接口复制的说明: Admin
    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);
    指定者:
    
    coprocessorService 在接口中 Admin
    
    参数:
    
    serverName - the server name to which the endpoint call is made
    
    返回:
    
    A RegionServerCoprocessorRpcChannel instance
  - updateConfiguration
```
public void updateConfiguration(ServerName server)
                         throws IOException
```
    从接口复制的说明: Admin
    
    Update the configuration and trigger an online config change on the regionserver.
    
    指定者:
    
    updateConfiguration 在接口中 Admin
    
    参数:
    
    server - : The server whose config needs to be updated.
    
    抛出:
    
    IOException
  - updateConfiguration
```
public void updateConfiguration()
                         throws IOException
```
    从接口复制的说明: Admin
    
    Update the configuration and trigger an online config change on all the regionservers.
    
    指定者:
    
    updateConfiguration 在接口中 Admin
    
    抛出:
    
    IOException
  - getLastMajorCompactionTimestamp
```
public long getLastMajorCompactionTimestamp(TableName tableName)
                                     throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    getLastMajorCompactionTimestamp 在接口中 Admin
    
    参数:
    
    tableName - table to examine
    
    返回:
    
    the last major compaction timestamp or 0
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getLastMajorCompactionTimestampForRegion
```
public long getLastMajorCompactionTimestampForRegion(byte[] regionName)
                                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    getLastMajorCompactionTimestampForRegion 在接口中 Admin
    
    参数:
    
    regionName - region to examine
    
    返回:
    
    the last major compaction timestamp or 0
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compact
```
public 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).
    
    指定者:
    
    compact 在接口中 Admin
    
    参数:
    
    tableName - table to compact
    
    columnFamily - column family within a table
    
    compactType - CompactType
    
    抛出:
    
    IOException - if not a mob column family or if a remote or network exception occurs
    
    InterruptedException
  - compact
```
public 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).
    
    指定者:
    
    compact 在接口中 Admin
    
    参数:
    
    tableName - table to compact
    
    compactType - CompactType
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    InterruptedException
  - majorCompact
```
public 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).
    
    指定者:
    
    majorCompact 在接口中 Admin
    
    参数:
    
    tableName - table to compact
    
    columnFamily - column family within a table
    
    compactType - CompactType
    
    抛出:
    
    IOException - if not a mob column family or if a remote or network exception occurs
    
    InterruptedException
  - majorCompact
```
public 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).
    
    指定者:
    
    majorCompact 在接口中 Admin
    
    参数:
    
    tableName - table to compact
    
    compactType - CompactType
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    InterruptedException
  - getCompactionState
```
public CompactionState getCompactionState(TableName tableName,
                                          CompactType compactType)
                                   throws IOException
```
    Get the current compaction state of a table. It could be in a compaction, or none.
    
    指定者:
    
    getCompactionState 在接口中 Admin
    
    参数:
    
    tableName - table to examine
    
    compactType - CompactType
    
    返回:
    
    the current compaction state
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getSecurityCapabilities
```
public List<SecurityCapability> getSecurityCapabilities()
                                                 throws IOException
```
    从接口复制的说明: Admin
    
    Return the set of supported security capabilities.
    
    指定者:
    
    getSecurityCapabilities 在接口中 Admin
    
    抛出:
    
    IOException
  - splitSwitch
```
public boolean splitSwitch(boolean enabled,
                           boolean synchronous)
                    throws IOException
```
    从接口复制的说明: Admin
    
    Turn the split switch on or off.
    
    指定者:
    
    splitSwitch 在接口中 Admin
    
    参数:
    
    enabled - enabled or not
    
    synchronous - If true, it waits until current split() call, if outstanding, to return.
    
    返回:
    
    Previous switch value
    
    抛出:
    
    IOException
  - mergeSwitch
```
public boolean mergeSwitch(boolean enabled,
                           boolean synchronous)
                    throws IOException
```
    从接口复制的说明: Admin
    
    Turn the merge switch on or off.
    
    指定者:
    
    mergeSwitch 在接口中 Admin
    
    参数:
    
    enabled - enabled or not
    
    synchronous - If true, it waits until current merge() call, if outstanding, to return.
    
    返回:
    
    Previous switch value
    
    抛出:
    
    IOException
  - isSplitEnabled
```
public boolean isSplitEnabled()
                       throws IOException
```
    从接口复制的说明: Admin
    
    Query the current state of the split switch.
    
    指定者:
    
    isSplitEnabled 在接口中 Admin
    
    返回:
    
    true if the switch is enabled, false otherwise.
    
    抛出:
    
    IOException
  - isMergeEnabled
```
public boolean isMergeEnabled()
                       throws IOException
```
    从接口复制的说明: Admin
    
    Query the current state of the merge switch.
    
    指定者:
    
    isMergeEnabled 在接口中 Admin
    
    返回:
    
    true if the switch is enabled, false otherwise.
    
    抛出:
    
    IOException
  - addReplicationPeer
```
public void addReplicationPeer(String peerId,
                               ReplicationPeerConfig peerConfig,
                               boolean enabled)
                        throws IOException
```
    从接口复制的说明: Admin
    
    Add a new replication peer for replicating data to slave cluster.
    
    指定者:
    
    addReplicationPeer 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication peer
    
    enabled - peer state, true if ENABLED and false if DISABLED
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - addReplicationPeerAsync
```
public Future<Void> addReplicationPeerAsync(String peerId,
                                            ReplicationPeerConfig peerConfig,
                                            boolean enabled)
                                     throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    addReplicationPeerAsync 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication peer
    
    enabled - peer state, true if ENABLED and false if DISABLED
    
    返回:
    
    the result of the async operation
    
    抛出:
    
    IOException - IOException if a remote or network exception occurs
  - removeReplicationPeer
```
public void removeReplicationPeer(String peerId)
                           throws IOException
```
    从接口复制的说明: Admin
    
    Remove a peer and stop the replication.
    
    指定者:
    
    removeReplicationPeer 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - removeReplicationPeerAsync
```
public Future<Void> removeReplicationPeerAsync(String peerId)
                                        throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    removeReplicationPeerAsync 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    返回:
    
    the result of the async operation
    
    抛出:
    
    IOException - IOException if a remote or network exception occurs
  - enableReplicationPeer
```
public void enableReplicationPeer(String peerId)
                           throws IOException
```
    从接口复制的说明: Admin
    
    Restart the replication stream to the specified peer.
    
    指定者:
    
    enableReplicationPeer 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - enableReplicationPeerAsync
```
public Future<Void> enableReplicationPeerAsync(String peerId)
                                        throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    enableReplicationPeerAsync 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    返回:
    
    the result of the async operation
    
    抛出:
    
    IOException - IOException if a remote or network exception occurs
  - disableReplicationPeer
```
public void disableReplicationPeer(String peerId)
                            throws IOException
```
    从接口复制的说明: Admin
    
    Stop the replication stream to the specified peer.
    
    指定者:
    
    disableReplicationPeer 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - disableReplicationPeerAsync
```
public Future<Void> disableReplicationPeerAsync(String peerId)
                                         throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    disableReplicationPeerAsync 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    返回:
    
    the result of the async operation
    
    抛出:
    
    IOException - IOException if a remote or network exception occurs
  - getReplicationPeerConfig
```
public ReplicationPeerConfig getReplicationPeerConfig(String peerId)
                                               throws IOException
```
    从接口复制的说明: Admin
    
    Returns the configured ReplicationPeerConfig for the specified peer.
    
    指定者:
    
    getReplicationPeerConfig 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    返回:
    
    ReplicationPeerConfig for the peer
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - updateReplicationPeerConfig
```
public void updateReplicationPeerConfig(String peerId,
                                        ReplicationPeerConfig peerConfig)
                                 throws IOException
```
    从接口复制的说明: Admin
    
    Update the peerConfig for the specified peer.
    
    指定者:
    
    updateReplicationPeerConfig 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    peerConfig - new config for the replication peer
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - updateReplicationPeerConfigAsync
```
public Future<Void> updateReplicationPeerConfigAsync(String peerId,
                                                     ReplicationPeerConfig peerConfig)
                                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    updateReplicationPeerConfigAsync 在接口中 Admin
    
    参数:
    
    peerId - a short name that identifies the peer
    
    peerConfig - new config for the replication peer
    
    返回:
    
    the result of the async operation
    
    抛出:
    
    IOException - IOException if a remote or network exception occurs
  - appendReplicationPeerTableCFs
```
public void appendReplicationPeerTableCFs(String id,
                                          Map<TableName,List<String>> tableCfs)
                                   throws ReplicationException,
                                          IOException
```
    从接口复制的说明: Admin
    
    Append the replicable table column family config from the specified peer.
    
    指定者:
    
    appendReplicationPeerTableCFs 在接口中 Admin
    
    参数:
    
    id - a short that identifies the cluster
    
    tableCfs - A map from tableName to column family names
    
    抛出:
    
    ReplicationException - if tableCfs has conflict with existing config
    
    IOException - if a remote or network exception occurs
  - removeReplicationPeerTableCFs
```
public void removeReplicationPeerTableCFs(String id,
                                          Map<TableName,List<String>> tableCfs)
                                   throws ReplicationException,
                                          IOException
```
    从接口复制的说明: Admin
    
    Remove some table-cfs from config of the specified peer.
    
    指定者:
    
    removeReplicationPeerTableCFs 在接口中 Admin
    
    参数:
    
    id - a short name that identifies the cluster
    
    tableCfs - A map from tableName to column family names
    
    抛出:
    
    ReplicationException - if tableCfs has conflict with existing config
    
    IOException - if a remote or network exception occurs
  - listReplicationPeers
```
public List<ReplicationPeerDescription> listReplicationPeers()
                                                      throws IOException
```
    从接口复制的说明: Admin
    
    Return a list of replication peers.
    
    指定者:
    
    listReplicationPeers 在接口中 Admin
    
    返回:
    
    a list of replication peers description
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listReplicationPeers
```
public List<ReplicationPeerDescription> listReplicationPeers(Pattern pattern)
                                                      throws IOException
```
    从接口复制的说明: Admin
    
    Return a list of replication peers.
    
    指定者:
    
    listReplicationPeers 在接口中 Admin
    
    参数:
    
    pattern - The compiled regular expression to match peer id
    
    返回:
    
    a list of replication peers description
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - decommissionRegionServers
```
public void decommissionRegionServers(List<ServerName> servers,
                                      boolean offload)
                               throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    decommissionRegionServers 在接口中 Admin
    
    参数:
    
    servers - The list of servers to decommission.
    
    offload - True to offload the regions from the decommissioned servers
    
    抛出:
    
    IOException
  - listDecommissionedRegionServers
```
public List<ServerName> listDecommissionedRegionServers()
                                                 throws IOException
```
    从接口复制的说明: Admin
    
    List region servers marked as decommissioned, which can not be assigned regions.
    
    指定者:
    
    listDecommissionedRegionServers 在接口中 Admin
    
    返回:
    
    List of decommissioned region servers.
    
    抛出:
    
    IOException
  - recommissionRegionServer
```
public void recommissionRegionServer(ServerName server,
                                     List<byte[]> encodedRegionNames)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    recommissionRegionServer 在接口中 Admin
    
    参数:
    
    server - The server to recommission.
    
    encodedRegionNames - Regions to load onto the server.
    
    抛出:
    
    IOException
  - listReplicatedTableCFs
```
public List<TableCFs> listReplicatedTableCFs()
                                      throws IOException
```
    从接口复制的说明: Admin
    
    Find all table and column families that are replicated from this cluster
    
    指定者:
    
    listReplicatedTableCFs 在接口中 Admin
    
    返回:
    
    the replicated table-cfs list of this cluster.
    
    抛出:
    
    IOException
  - enableTableReplication
```
public void enableTableReplication(TableName tableName)
                            throws IOException
```
    从接口复制的说明: Admin
    
    Enable a table's replication switch.
    
    指定者:
    
    enableTableReplication 在接口中 Admin
    
    参数:
    
    tableName - name of the table
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - disableTableReplication
```
public void disableTableReplication(TableName tableName)
                             throws IOException
```
    从接口复制的说明: Admin
    
    Disable a table's replication switch.
    
    指定者:
    
    disableTableReplication 在接口中 Admin
    
    参数:
    
    tableName - name of the table
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - clearCompactionQueues
```
public void clearCompactionQueues(ServerName sn,
                                  Set<String> queues)
                           throws IOException,
                                  InterruptedException
```
    从接口复制的说明: Admin
    
    Clear compacting queues on a regionserver.
    
    指定者:
    
    clearCompactionQueues 在接口中 Admin
    
    参数:
    
    sn - the region server name
    
    queues - the set of queue name
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    InterruptedException
  - clearDeadServers
```
public List<ServerName> clearDeadServers(List<ServerName> servers)
                                  throws IOException
```
    从接口复制的说明: Admin
    
    Clear dead region servers from master.
    
    指定者:
    
    clearDeadServers 在接口中 Admin
    
    参数:
    
    servers - list of dead region servers.
    
    返回:
    
    List of servers that are not cleared
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - cloneTableSchema
```
public void cloneTableSchema(TableName tableName,
                             TableName newTableName,
                             boolean preserveSplits)
                      throws IOException
```
    从接口复制的说明: Admin
    
    Create a new table by cloning the existent table schema.
    
    指定者:
    
    cloneTableSchema 在接口中 Admin
    
    参数:
    
    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
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - switchRpcThrottle
```
public boolean switchRpcThrottle(boolean enable)
                          throws IOException
```
    从接口复制的说明: Admin
    
    Switch the rpc throttle enable state.
    
    指定者:
    
    switchRpcThrottle 在接口中 Admin
    
    参数:
    
    enable - Set to true to enable, false to disable.
    
    返回:
    
    Previous rpc throttle enabled value
    
    抛出:
    
    IOException
  - isRpcThrottleEnabled
```
public boolean isRpcThrottleEnabled()
                             throws IOException
```
    从接口复制的说明: Admin
    
    Get if the rpc throttle is enabled.
    
    指定者:
    
    isRpcThrottleEnabled 在接口中 Admin
    
    返回:
    
    True if rpc throttle is enabled
    
    抛出:
    
    IOException
  - exceedThrottleQuotaSwitch
```
public boolean exceedThrottleQuotaSwitch(boolean enable)
                                  throws IOException
```
    从接口复制的说明: Admin
    
    Switch the exceed throttle quota. If enabled, user/table/namespace throttle quota can be exceeded if region server has availble quota.
    
    指定者:
    
    exceedThrottleQuotaSwitch 在接口中 Admin
    
    参数:
    
    enable - Set to true to enable, false to disable.
    
    返回:
    
    Previous exceed throttle enabled value
    
    抛出:
    
    IOException
  - getSpaceQuotaTableSizes
```
public Map<TableName,Long> getSpaceQuotaTableSizes()
                                            throws IOException
```
    从接口复制的说明: Admin
    
    Fetches the table sizes on the filesystem as tracked by the HBase Master.
    
    指定者:
    
    getSpaceQuotaTableSizes 在接口中 Admin
    
    抛出:
    
    IOException
  - getRegionServerSpaceQuotaSnapshots
```
public Map<TableName,SpaceQuotaSnapshot> getRegionServerSpaceQuotaSnapshots(ServerName serverName)
                                                                     throws IOException
```
    从接口复制的说明: Admin
    
    Fetches the observed SpaceQuotaSnapshotViews observed by a RegionServer.
    
    指定者:
    
    getRegionServerSpaceQuotaSnapshots 在接口中 Admin
    
    抛出:
    
    IOException
  - getCurrentSpaceQuotaSnapshot
```
public SpaceQuotaSnapshot getCurrentSpaceQuotaSnapshot(String namespace)
                                                throws IOException
```
    从接口复制的说明: Admin
    
    Returns the Master's view of a quota on the given namespace or null if the Master has no quota information on that namespace.
    
    指定者:
    
    getCurrentSpaceQuotaSnapshot 在接口中 Admin
    
    抛出:
    
    IOException
  - getCurrentSpaceQuotaSnapshot
```
public SpaceQuotaSnapshot getCurrentSpaceQuotaSnapshot(TableName tableName)
                                                throws IOException
```
    从接口复制的说明: Admin
    
    Returns the Master's view of a quota on the given tableName or null if the Master has no quota information on that table.
    
    指定者:
    
    getCurrentSpaceQuotaSnapshot 在接口中 Admin
    
    抛出:
    
    IOException
  - grant
```
public void grant(UserPermission userPermission,
                  boolean mergeExistingPermissions)
           throws IOException
```
    从接口复制的说明: Admin
    
    Grants user specific permissions
    
    指定者:
    
    grant 在接口中 Admin
    
    参数:
    
    userPermission - user name and the specific permission
    
    mergeExistingPermissions - If set to false, later granted permissions will override previous granted permissions. otherwise, it'll merge with previous granted permissions.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - revoke
```
public void revoke(UserPermission userPermission)
            throws IOException
```
    从接口复制的说明: Admin
    
    Revokes user specific permissions
    
    指定者:
    
    revoke 在接口中 Admin
    
    参数:
    
    userPermission - user name and the specific permission
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getUserPermissions
```
public List<UserPermission> getUserPermissions(GetUserPermissionsRequest getUserPermissionsRequest)
                                        throws IOException
```
    从接口复制的说明: Admin
    
    Get the global/namespace/table permissions for user
    
    指定者:
    
    getUserPermissions 在接口中 Admin
    
    参数:
    
    getUserPermissionsRequest - A request contains which user, global, namespace or table permissions needed
    
    返回:
    
    The user and permission list
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - splitRegionAsync
```
public Future<Void> splitRegionAsync(byte[] regionName)
                              throws IOException
```
    从接口复制的说明: Admin
    
    Split an individual region. Asynchronous operation.
    
    指定者:
    
    splitRegionAsync 在接口中 Admin
    
    参数:
    
    regionName - region to split
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - createTableAsync
```
public Future<Void> createTableAsync(TableDescriptor desc)
                              throws IOException
```
    从接口复制的说明: Admin
    
    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.
    
    指定者:
    
    createTableAsync 在接口中 Admin
    
    参数:
    
    desc - table descriptor for table
    
    返回:
    
    the result of the async creation. You can use Future.get(long, TimeUnit) to wait on the operation to complete.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - hasUserPermissions
```
public List<Boolean> hasUserPermissions(String userName,
                                        List<Permission> permissions)
                                 throws IOException
```
    从接口复制的说明: Admin
    
    Check if the user has specific permissions
    
    指定者:
    
    hasUserPermissions 在接口中 Admin
    
    参数:
    
    userName - the user name
    
    permissions - the specific permission list
    
    返回:
    
    True if user has the specific permissions
    
    抛出:
    
    IOException - if a remote or network exception occurs

类 HBaseAdmin

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.hadoop.hbase.client.Admin

方法详细资料

getOperationTimeout

abort

isAborted

abortProcedure

abortProcedureAsync

listTableDescriptors

listTableDescriptors

listTableDescriptors

getDescriptor

modifyTable

modifyTableAsync

listTableDescriptorsByNamespace

listTableDescriptors

getRegions

getRegions

getConnection

tableExists

listTables

listTables

listTables

listTables

listTables

listTableNames

listTableNames

listTableNames

listTableNames

listTableNames

getTableDescriptor

createTable

createTable

createTable

createTableAsync

deleteTable

deleteTableAsync

deleteTables

deleteTables

truncateTable

truncateTableAsync

enableTable

enableTableAsync

enableTables

enableTables

disableTable

disableTableAsync

disableTables

disableTables

isTableEnabled

isTableDisabled

isTableAvailable

isTableAvailable

getAlterStatus

getAlterStatus

addColumnFamily

addColumnFamilyAsync

deleteColumn

deleteColumnFamily

deleteColumnFamilyAsync

modifyColumnFamily

modifyColumnFamilyAsync

closeRegion

closeRegion

closeRegionWithEncodedRegionName

closeRegion

getOnlineRegions

flush

flushRegion

flushRegionServer

compact

compactRegion

compact

compactRegion

compactionSwitch

compactRegionServer

majorCompactRegionServer