HBaseAdmin (Apache HBase - Client 1.4.14 API)

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

所有已实现的接口:

Closeable, AutoCloseable, Abortable, Admin
```
@InterfaceAudience.Private
@InterfaceStability.Evolving
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.ProcedureFuture<V>
Future that waits on a procedure result.
- 从接口继承的嵌套类/接口 org.apache.hadoop.hbase.client.Admin
  Admin.MasterSwitchType

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

构造器概要

构造器
构造器和说明
`HBaseAdmin(org.apache.hadoop.conf.Configuration c)` 已过时。 Constructing HBaseAdmin objects manually has been deprecated. Use `Connection.getAdmin()` to obtain an instance of `Admin` instead.
`HBaseAdmin(Connection connection)` 已过时。 Constructing HBaseAdmin objects manually has been deprecated. Use `Connection.getAdmin()` to obtain an instance of `Admin` instead.

方法概要

方法
限定符和类型	方法和说明
`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 it be completely removed.
`void`	`addColumn(byte[] tableName, HColumnDescriptor column)` Add a column to an existing table.
`void`	`addColumn(String tableName, HColumnDescriptor column)` Add a column to an existing table.
`void`	`addColumn(TableName tableName, HColumnDescriptor column)` Add a column to an existing table.
`void`	`assign(byte[] regionName)`
`boolean`	`balancer()` Invoke the balancer.
`boolean`	`balancer(boolean force)` Invoke the balancer.
`static void`	`checkHBaseAvailable(org.apache.hadoop.conf.Configuration conf)` Check to see if HBase is running.
`List<ServerName>`	`clearDeadServers(List<ServerName> servers)` Clear dead region servers from master.
`void`	`cloneSnapshot(byte[] snapshotName, byte[] tableName)` Create a new table by cloning the snapshot content.
`void`	`cloneSnapshot(byte[] snapshotName, TableName tableName)` Create a new table by cloning the snapshot content.
`void`	`cloneSnapshot(String snapshotName, String 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.
`void`	`close()`
`void`	`closeRegion(byte[] regionname, String serverName)` Close a region.
`void`	`closeRegion(ServerName sn, HRegionInfo hri)` Close a region.
`void`	`closeRegion(String regionname, String serverName)` Close a region.
`boolean`	`closeRegionWithEncodedRegionName(String encodedRegionName, String serverName)` For expert-admins.
`void`	`compact(byte[] tableNameOrRegionName)` 已过时。 Use `compact(org.apache.hadoop.hbase.TableName)` or `(byte[])` instead.
`void`	`compact(byte[] tableNameOrRegionName, byte[] columnFamily)` 已过时。 Use `compact(org.apache.hadoop.hbase.TableName)` or `(byte[], byte[])` instead.
`void`	`compact(String tableNameOrRegionName)` 已过时。 Use `compact(org.apache.hadoop.hbase.TableName)` or `(byte[])` instead.
`void`	`compact(String tableOrRegionName, String columnFamily)` 已过时。 Use `compact(org.apache.hadoop.hbase.TableName)` or `(byte[], byte[])` instead.
`void`	`compact(TableName tableName)` Compact a table.
`void`	`compact(TableName tableName, byte[] columnFamily)` Compact a column family within a table.
`void`	`compactRegion(byte[] regionName)` Compact an individual region.
`void`	`compactRegion(byte[] regionName, byte[] columnFamily)` Compact a column family within a region.
`void`	`compactRegionServer(ServerName sn, boolean major)` Compact all regions on the region server
`CoprocessorRpcChannel`	`coprocessorService()` Creates and returns a `RpcChannel` instance connected to the active master.
`CoprocessorRpcChannel`	`coprocessorService(ServerName sn)` Creates and returns a `RpcChannel` instance connected to the passed region server.
`void`	`createNamespace(NamespaceDescriptor descriptor)` Create a new namespace
`void`	`createTable(HTableDescriptor desc)` Creates a new table.
`void`	`createTable(HTableDescriptor desc, byte[][] splitKeys)` Creates a new table with an initial set of empty regions defined by the specified split keys.
`void`	`createTable(HTableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)` Creates a new table with the specified number of regions.
`void`	`createTableAsync(HTableDescriptor desc, byte[][] splitKeys)` Creates a new table but does not block and wait for it to come online.
`void`	`deleteColumn(byte[] tableName, String columnName)` Delete a column from a table.
`void`	`deleteColumn(String tableName, String columnName)` Delete a column from a table.
`void`	`deleteColumn(TableName tableName, byte[] columnName)` Delete a column from a table.
`void`	`deleteNamespace(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(byte[] tableName)`
`void`	`deleteTable(String tableName)`
`void`	`deleteTable(TableName tableName)` Deletes a table.
`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`	`disableTable(byte[] tableName)`
`void`	`disableTable(String tableName)`
`void`	`disableTable(TableName tableName)` Disable table and wait on completion.
`void`	`disableTableAsync(byte[] tableName)`
`void`	`disableTableAsync(String tableName)`
`void`	`disableTableAsync(TableName tableName)` Starts the disable of a table.
`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.
`boolean`	`enableCatalogJanitor(boolean enable)` Enable/Disable the catalog janitor
`void`	`enableTable(byte[] tableName)`
`void`	`enableTable(String tableName)`
`void`	`enableTable(TableName tableName)` Enable a table.
`void`	`enableTableAsync(byte[] tableName)`
`void`	`enableTableAsync(String tableName)`
`void`	`enableTableAsync(TableName tableName)` Brings a table on-line (enables it).
`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.
`void`	`execProcedure(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`byte[]`	`execProcedureWithRet(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster synchronously with return data
`void`	`flush(byte[] tableNameOrRegionName)` 已过时。 Use `flush(org.apache.hadoop.hbase.TableName)` or `(byte[])` instead.
`void`	`flush(String tableNameOrRegionName)` 已过时。 Use `flush(org.apache.hadoop.hbase.TableName)` or `(byte[])` instead.
`void`	`flush(TableName tableName)` Flush a table.
`void`	`flushRegion(byte[] regionName)` Flush an individual region.
`Pair<Integer,Integer>`	`getAlterStatus(byte[] tableName)` Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
`Pair<Integer,Integer>`	`getAlterStatus(TableName tableName)` Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
`ClusterStatus`	`getClusterStatus()`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState`	`getCompactionState(byte[] tableNameOrRegionName)` 已过时。 Use `getCompactionState(org.apache.hadoop.hbase.TableName)` or `getCompactionStateForRegion(byte[])` instead.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState`	`getCompactionState(String tableNameOrRegionName)` 已过时。 Use `getCompactionState(org.apache.hadoop.hbase.TableName)` or `getCompactionStateForRegion(byte[])` instead.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState`	`getCompactionState(TableName tableName)` Get the current compaction state of a table.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState`	`getCompactionStateForRegion(byte[] regionName)` Get the current compaction state of region.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()`
`HConnection`	`getConnection()`
`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[]`	`getMasterCoprocessors()` Helper delegage to getClusterStatus().getMasterCoprocessors().
`int`	`getMasterInfoPort()` Get the info port of the current master if one is available.
`NamespaceDescriptor`	`getNamespaceDescriptor(String name)` Get a namespace descriptor by name
`List<HRegionInfo>`	`getOnlineRegions(ServerName sn)` Get all the online regions on a region server.
`int`	`getOperationTimeout()`
`QuotaRetriever`	`getQuotaRetriever(QuotaFilter filter)` Return a Quota Scanner to list the quotas based on the filter.
`List<SecurityCapability>`	`getSecurityCapabilities()` Return the set of supported security capabilities.
`HTableDescriptor`	`getTableDescriptor(byte[] tableName)`
`HTableDescriptor`	`getTableDescriptor(TableName tableName)` Method for getting the tableDescriptor
`HTableDescriptor[]`	`getTableDescriptors(List<String> names)` Get tableDescriptors
`HTableDescriptor[]`	`getTableDescriptorsByTableName(List<TableName> tableNames)` Get tableDescriptors
`String[]`	`getTableNames()` 已过时。 Use `Admin.listTableNames()` instead
`String[]`	`getTableNames(Pattern pattern)` 已过时。 Use `Admin.listTableNames(Pattern)` instead.
`String[]`	`getTableNames(String regex)` 已过时。 Use `Admin.listTableNames(Pattern)` instead.
`List<HRegionInfo>`	`getTableRegions(byte[] tableName)`
`List<HRegionInfo>`	`getTableRegions(TableName tableName)` get the regions of a given table.
`boolean`	`isAborted()` Check if the server or client was aborted.
`boolean`	`isBalancerEnabled()` Query the state of the balancer from the Master.
`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`	`isMasterRunning()` 已过时。 this has been deprecated without a replacement
`boolean`	`isNormalizerEnabled()` Query the current state of the region normalizer
`boolean`	`isProcedureFinished(String signature, String instance, Map<String,String> props)` Check the current state of the specified procedure.
`boolean`	`isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)` Check the current state of the passed snapshot.
`boolean`	`isSplitOrMergeEnabled(Admin.MasterSwitchType switchType)` Query the current state of the switch
`boolean`	`isTableAvailable(byte[] tableName)`
`boolean`	`isTableAvailable(byte[] tableName, byte[][] splitKeys)`
`boolean`	`isTableAvailable(String tableName)`
`boolean`	`isTableAvailable(String tableName, byte[][] splitKeys)`
`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(byte[] tableName)`
`boolean`	`isTableDisabled(String tableName)`
`boolean`	`isTableDisabled(TableName tableName)`
`boolean`	`isTableEnabled(byte[] tableName)`
`boolean`	`isTableEnabled(String tableName)`
`boolean`	`isTableEnabled(TableName tableName)`
`List<ServerName>`	`listDeadServers()` List dead region servers.
`NamespaceDescriptor[]`	`listNamespaceDescriptors()` List available namespace descriptors
`ProcedureInfo[]`	`listProcedures()` List procedures
`List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>`	`listSnapshots()` List completed snapshots.
`List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>`	`listSnapshots(Pattern pattern)` List all the completed snapshots matching the given pattern.
`List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>`	`listSnapshots(String regex)` List all the completed snapshots matching the given regular expression.
`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 matching 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<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>`	`listTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)` List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
`List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.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(byte[] tableNameOrRegionName)` 已过时。 Use `majorCompact(org.apache.hadoop.hbase.TableName)` or `majorCompactRegion(byte[])` instead.
`void`	`majorCompact(byte[] tableNameOrRegionName, byte[] columnFamily)` 已过时。 Use `majorCompact(org.apache.hadoop.hbase.TableName, byte[])` or `majorCompactRegion(byte[], byte[])` instead.
`void`	`majorCompact(String tableNameOrRegionName)` 已过时。 Use `majorCompact(org.apache.hadoop.hbase.TableName)` or `majorCompactRegion(byte[])` instead.
`void`	`majorCompact(String tableNameOrRegionName, String columnFamily)` 已过时。 Use `majorCompact(org.apache.hadoop.hbase.TableName, byte[])` or `majorCompactRegion(byte[], byte[])` instead.
`void`	`majorCompact(TableName tableName)` Major compact a table.
`void`	`majorCompact(TableName tableName, byte[] columnFamily)` Major compact a column family within 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`	`mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible)` Merge two regions.
`void`	`modifyColumn(byte[] tableName, HColumnDescriptor descriptor)` Modify an existing column family on a table.
`void`	`modifyColumn(String tableName, HColumnDescriptor descriptor)` Modify an existing column family on a table.
`void`	`modifyColumn(TableName tableName, HColumnDescriptor descriptor)` Modify an existing column family on a table.
`void`	`modifyNamespace(NamespaceDescriptor descriptor)` Modify an existing namespace
`void`	`modifyTable(byte[] tableName, HTableDescriptor htd)`
`void`	`modifyTable(String tableName, HTableDescriptor htd)`
`void`	`modifyTable(TableName tableName, HTableDescriptor htd)` Modify an existing table, more IRB friendly version.
`void`	`move(byte[] encodedRegionName, byte[] destServerName)` Move the region `r` to `dest`.
`boolean`	`normalize()` Invoke region normalizer.
`void`	`offline(byte[] regionName)` Offline specified region from master's in-memory state.
`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.
`byte[][]`	`rollHLogWriter(String serverName)` 已过时。 use `rollWALWriter(ServerName)`
`void`	`rollWALWriter(ServerName serverName)` Roll the log writer.
`int`	`runCatalogScan()` Ask for a scan of the catalog table
`boolean`	`runCleanerChore()` Ask for cleaner chore to run
`boolean`	`setBalancerRunning(boolean on, boolean synchronous)` Turn the load balancer on or off.
`boolean`	`setCleanerChoreRunning(boolean on)` Enable/Disable the cleaner chore
`boolean`	`setNormalizerRunning(boolean on)` Turn region normalizer on or off.
`void`	`setQuota(QuotaSettings quota)` Apply the new quota settings.
`boolean[]`	`setSplitOrMergeEnabled(boolean enabled, boolean synchronous, Admin.MasterSwitchType... switchTypes)` Turn the Split or Merge switches on or off.
`void`	`shutdown()` Shuts down the HBase cluster
`void`	`snapshot(byte[] snapshotName, byte[] tableName)`
`void`	`snapshot(byte[] snapshotName, byte[] tableName, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type flushType)` Create snapshot for the given table of given flush type.
`void`	`snapshot(byte[] snapshotName, TableName tableName)` public void snapshot(final String snapshotName, Create a timestamp consistent snapshot for the given table.
`void`	`snapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)` Take a snapshot and wait for the server to complete that snapshot (blocking).
`void`	`snapshot(String snapshotName, byte[] tableName, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)`
`void`	`snapshot(String snapshotName, String tableName)`
`void`	`snapshot(String snapshotName, String tableName, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)`
`void`	`snapshot(String snapshotName, TableName tableName)` Take a snapshot for the given table.
`void`	`snapshot(String snapshotName, TableName tableName, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)` Create typed snapshot of the table.
`void`	`split(byte[] tableNameOrRegionName)` 已过时。 Use `split(org.apache.hadoop.hbase.TableName)` or `(byte[])` instead.
`void`	`split(byte[] tableNameOrRegionName, byte[] splitPoint)` 已过时。 Use `split(org.apache.hadoop.hbase.TableName, byte[])` or `splitRegion(byte[], byte[])` instead.
`void`	`split(ServerName sn, HRegionInfo hri, byte[] splitPoint)`
`void`	`split(String tableNameOrRegionName)` 已过时。 Use `split(org.apache.hadoop.hbase.TableName)` or `(byte[])` instead.
`void`	`split(String tableNameOrRegionName, String splitPoint)` 已过时。 Use `split(org.apache.hadoop.hbase.TableName, byte[])` or `splitRegion(byte[], byte[])` instead.
`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.
`void`	`stopMaster()` Shuts down the current HBase master only.
`void`	`stopRegionServer(String hostnamePort)` Stop the designated regionserver
`boolean`	`tableExists(byte[] tableName)`
`boolean`	`tableExists(String tableName)`
`boolean`	`tableExists(TableName tableName)`
`org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SnapshotResponse`	`takeSnapshotAsync(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)` Take a snapshot without waiting for the server to complete that snapshot (asynchronous) Only a single snapshot should be taken at a time, or results may be undefined.
`void`	`truncateTable(TableName tableName, boolean preserveSplits)` Truncate a table.
`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

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

- 构造器详细资料
  - HBaseAdmin
```
@Deprecated
public HBaseAdmin(org.apache.hadoop.conf.Configuration c)
           throws MasterNotRunningException,
                  ZooKeeperConnectionException,
                  IOException
```
    已过时。 Constructing HBaseAdmin objects manually has been deprecated. Use Connection.getAdmin() to obtain an instance of Admin instead.
    
    Constructor. See HBaseAdmin(Connection connection)
    
    参数:
    c - Configuration object. Copied internally.
    
    抛出:
    
    MasterNotRunningException
    
    ZooKeeperConnectionException
    
    IOException
  - HBaseAdmin
```
@Deprecated
public HBaseAdmin(Connection connection)
           throws MasterNotRunningException,
                  ZooKeeperConnectionException
```
    已过时。 Constructing HBaseAdmin objects manually has been deprecated. Use Connection.getAdmin() to obtain an instance of Admin instead.
    
    Constructor for externally managed Connections. The connection to master will be created when required by admin functions.
    
    参数:
    connection - The Connection instance to use
    
    抛出:
    
    MasterNotRunningException
    
    ZooKeeperConnectionException - are not thrown anymore but kept into the interface for backward api compatibility
- 方法详细资料
  - 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
```
    Abort a procedure
    
    指定者:
    
    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
  - abortProcedureAsync
```
public Future<Boolean> abortProcedureAsync(long procId,
                                  boolean mayInterruptIfRunning)
                                    throws IOException
```
    Abort a procedure but does not block and wait for it 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.
    
    指定者:
    
    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
  - getConnection
```
public HConnection getConnection()
```
    指定者:
    
    getConnection 在接口中 Admin
    
    返回:
    HConnection used by this object.
  - isMasterRunning
```
@Deprecated
public boolean isMasterRunning()
                        throws MasterNotRunningException,
                               ZooKeeperConnectionException
```
    已过时。 this has been deprecated without a replacement
    
    返回:
    - true if the master server is running. Throws an exception otherwise.
    
    抛出:
    
    ZooKeeperConnectionException
    
    MasterNotRunningException
  - tableExists
```
public boolean tableExists(TableName tableName)
                    throws IOException
```
    指定者:
    
    tableExists 在接口中 Admin
    
    参数:
    tableName - Table to check.
    
    返回:
    True if table exists already.
    
    抛出:
    
    IOException
  - tableExists
```
public boolean tableExists(byte[] tableName)
                    throws IOException
```
    抛出:
    
    IOException
  - tableExists
```
public boolean tableExists(String tableName)
                    throws IOException
```
    抛出:
    
    IOException
  - listTables
```
public HTableDescriptor[] listTables()
                              throws IOException
```
    从接口复制的说明: Admin
    
    List all the userspace tables.
    
    指定者:
    
    listTables 在接口中 Admin
    
    返回:
    - returns an array of HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTables
```
public HTableDescriptor[] listTables(Pattern pattern)
                              throws IOException
```
    从接口复制的说明: Admin
    
    List all the userspace tables matching the given pattern.
    
    指定者:
    
    listTables 在接口中 Admin
    
    参数:
    pattern - The compiled regular expression to match against
    
    返回:
    - returns an array of HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    另请参阅:
    Admin.listTables()
  - 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
    
    返回:
    - returns an array of HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    另请参阅:
    Admin.listTables(java.util.regex.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
    
    返回:
    - returns an array of HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    另请参阅:
    Admin.listTables()
  - 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
    
    返回:
    - returns an array of HTableDescriptors
    
    抛出:
    
    IOException - if a remote or network exception occurs
    另请参阅:
    Admin.listTables(java.util.regex.Pattern, boolean)
  - getTableNames
```
@Deprecated
public String[] getTableNames()
                       throws IOException
```
    已过时。 Use Admin.listTableNames() instead
    
    List all of the names of userspace tables.
    
    返回:
    String[] table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getTableNames
```
@Deprecated
public String[] getTableNames(Pattern pattern)
                       throws IOException
```
    已过时。 Use Admin.listTableNames(Pattern) instead.
    
    List all of the names of userspace tables matching the given regular expression.
    
    参数:
    pattern - The regular expression to match against
    
    返回:
    String[] table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getTableNames
```
@Deprecated
public String[] getTableNames(String regex)
                       throws IOException
```
    已过时。 Use Admin.listTableNames(Pattern) instead.
    
    List all of the names of userspace tables matching the given regular expression.
    
    参数:
    regex - The regular expression to match against
    
    返回:
    String[] table names
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - 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
    
    返回:
    TableName[] 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 TableNotFoundException,
                                           IOException
```
    Method for getting the tableDescriptor
    
    指定者:
    
    getTableDescriptor 在接口中 Admin
    
    参数:
    tableName - as a byte []
    
    返回:
    the tableDescriptor
    
    抛出:
    
    TableNotFoundException
    
    IOException - if a remote or network exception occurs
  - getTableDescriptor
```
public HTableDescriptor getTableDescriptor(byte[] tableName)
                                    throws TableNotFoundException,
                                           IOException
```
    抛出:
    
    TableNotFoundException
    
    IOException
  - createTable
```
public void createTable(HTableDescriptor desc)
                 throws IOException
```
    Creates a new table. Synchronous operation.
    
    指定者:
    
    createTable 在接口中 Admin
    
    参数:
    desc - table descriptor for table
    
    抛出:
    
    IllegalArgumentException - if the table name is reserved
    
    MasterNotRunningException - if master is not running
    
    TableExistsException - if table already exists (If concurrent threads, the table may have been created between test-for-existence and attempt-at-creation).
    
    IOException - if a remote or network exception occurs
  - createTable
```
public void createTable(HTableDescriptor desc,
               byte[] startKey,
               byte[] endKey,
               int numRegions)
                 throws IOException
```
    Creates a new table with the specified number of regions. The start key specified will become the end key of the first region of the table, and the end key specified will become the start key of the last region of the table (the first region has a null start key and the last region has a null end key). BigInteger math will be used to divide the key range specified into enough segments to make the required number of total regions. Synchronous operation.
    
    指定者:
    
    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
    
    抛出:
    
    IllegalArgumentException - if the table name is reserved
    
    MasterNotRunningException - if master is not running
    
    TableExistsException - if table already exists (If concurrent threads, the table may have been created between test-for-existence and attempt-at-creation).
    
    IOException
  - createTable
```
public void createTable(HTableDescriptor desc,
               byte[][] splitKeys)
                 throws IOException
```
    Creates a new table with an initial set of empty regions defined by the specified split keys. The total number of regions created will be the number of split keys plus one. Synchronous operation. Note : Avoid passing empty split key.
    
    指定者:
    
    createTable 在接口中 Admin
    
    参数:
    desc - table descriptor for table
    splitKeys - array of split keys for the initial regions of the table
    
    抛出:
    
    IllegalArgumentException - if the table name is reserved, if the split keys are repeated and if the split key has empty byte array.
    
    MasterNotRunningException - if master is not running
    
    TableExistsException - if table already exists (If concurrent threads, the table may have been created between test-for-existence and attempt-at-creation).
    
    IOException
  - createTableAsync
```
public void createTableAsync(HTableDescriptor desc,
                    byte[][] splitKeys)
                      throws IOException
```
    Creates a new table but does not block and wait for it to come online. Asynchronous operation. To check if the table exists, use isTableAvailable(org.apache.hadoop.hbase.TableName) -- it is not safe to create an HTable instance to this table before it is available. Note : Avoid passing empty split key.
    
    指定者:
    
    createTableAsync 在接口中 Admin
    
    参数:
    desc - table descriptor for table
    
    抛出:
    
    IllegalArgumentException - Bad table name, if the split keys are repeated and if the split key has empty byte array.
    
    MasterNotRunningException - if master is not running
    
    TableExistsException - if table already exists (If concurrent threads, the table may have been created between test-for-existence and attempt-at-creation).
    
    IOException
  - deleteTable
```
public void deleteTable(String tableName)
                 throws IOException
```
    抛出:
    
    IOException
  - deleteTable
```
public void deleteTable(byte[] tableName)
                 throws IOException
```
    抛出:
    
    IOException
  - deleteTable
```
public void deleteTable(TableName tableName)
                 throws IOException
```
    Deletes a table. Synchronous operation.
    
    指定者:
    
    deleteTable 在接口中 Admin
    
    参数:
    tableName - name of table to delete
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteTables
```
public HTableDescriptor[] deleteTables(String regex)
                                throws IOException
```
    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 listTables(java.lang.String) and deleteTable(byte[])
    
    指定者:
    
    deleteTables 在接口中 Admin
    
    参数:
    regex - The regular expression to match table names against
    
    返回:
    Table descriptors for tables that couldn't be deleted
    
    抛出:
    
    IOException
    另请参阅:
    deleteTables(java.util.regex.Pattern), deleteTable(java.lang.String)
  - 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(byte[])
    
    指定者:
    
    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
```
    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
  - enableTable
```
public void enableTable(TableName tableName)
                 throws IOException
```
    Enable a table. May timeout. Use enableTableAsync(byte[]) and isTableEnabled(byte[]) 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.
    另请参阅:
    isTableEnabled(byte[]), disableTable(byte[]), enableTableAsync(byte[])
  - enableTable
```
public void enableTable(byte[] tableName)
                 throws IOException
```
    抛出:
    
    IOException
  - enableTable
```
public void enableTable(String tableName)
                 throws IOException
```
    抛出:
    
    IOException
  - enableTableAsync
```
public void enableTableAsync(TableName tableName)
                      throws IOException
```
    Brings a table on-line (enables it). Method returns immediately though enable of table may take some time to complete, especially if the table is large (All regions are opened as part of enabling process). Check isTableEnabled(byte[]) to learn when table is fully online. If table is taking too long to online, check server logs.
    
    指定者:
    
    enableTableAsync 在接口中 Admin
    
    参数:
    tableName -
    
    抛出:
    
    IOException
    从以下版本开始:
    
    0.90.0
  - enableTableAsync
```
public void enableTableAsync(byte[] tableName)
                      throws IOException
```
    抛出:
    
    IOException
  - enableTableAsync
```
public void enableTableAsync(String tableName)
                      throws IOException
```
    抛出:
    
    IOException
  - enableTables
```
public HTableDescriptor[] enableTables(String regex)
                                throws IOException
```
    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 listTables(java.lang.String) and enableTable(byte[])
    
    指定者:
    
    enableTables 在接口中 Admin
    
    参数:
    regex - The regular expression to match table names against
    
    抛出:
    
    IOException
    另请参阅:
    enableTables(java.util.regex.Pattern), enableTable(java.lang.String)
  - enableTables
```
public HTableDescriptor[] enableTables(Pattern pattern)
                                throws IOException
```
    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 listTables(java.util.regex.Pattern) and enableTable(byte[])
    
    指定者:
    
    enableTables 在接口中 Admin
    
    参数:
    pattern - The pattern to match table names against
    
    抛出:
    
    IOException
  - disableTableAsync
```
public void disableTableAsync(TableName tableName)
                       throws IOException
```
    Starts the disable of a table. If it is being served, the master will tell the servers to stop serving it. This method returns immediately. The disable of a table can take some time if the table is large (all regions are closed as part of table disable operation). Call isTableDisabled(byte[]) to check for when disable completes. If table is taking too long to online, check server logs.
    
    指定者:
    
    disableTableAsync 在接口中 Admin
    
    参数:
    tableName - name of table
    
    抛出:
    
    IOException - if a remote or network exception occurs
    从以下版本开始:
    
    0.90.0
    
    另请参阅:
    isTableDisabled(byte[]), isTableEnabled(byte[])
  - disableTableAsync
```
public void disableTableAsync(byte[] tableName)
                       throws IOException
```
    抛出:
    
    IOException
  - disableTableAsync
```
public void disableTableAsync(String tableName)
                       throws IOException
```
    抛出:
    
    IOException
  - disableTable
```
public void disableTable(TableName tableName)
                  throws IOException
```
    Disable table and wait on completion. May timeout eventually. Use disableTableAsync(byte[]) and isTableDisabled(String) instead. The table has to be in enabled state for it to be disabled.
    
    指定者:
    
    disableTable 在接口中 Admin
    
    参数:
    tableName -
    
    抛出:
    
    IOException - There could be couple types of IOException TableNotFoundException means the table doesn't exist. TableNotEnabledException means the table isn't in enabled state.
  - disableTable
```
public void disableTable(byte[] tableName)
                  throws IOException
```
    抛出:
    
    IOException
  - disableTable
```
public void disableTable(String tableName)
                  throws IOException
```
    抛出:
    
    IOException
  - disableTables
```
public HTableDescriptor[] disableTables(String regex)
                                 throws IOException
```
    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 listTables(java.lang.String) and disableTable(byte[])
    
    指定者:
    
    disableTables 在接口中 Admin
    
    参数:
    regex - The regular expression to match table names against
    
    返回:
    Table descriptors for tables that couldn't be disabled
    
    抛出:
    
    IOException
    另请参阅:
    disableTables(java.util.regex.Pattern), disableTable(java.lang.String)
  - disableTables
```
public HTableDescriptor[] disableTables(Pattern pattern)
                                 throws IOException
```
    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 listTables(java.util.regex.Pattern) and disableTable(byte[])
    
    指定者:
    
    disableTables 在接口中 Admin
    
    参数:
    pattern - The pattern to match table names against
    
    返回:
    Table descriptors for tables that couldn't be disabled
    
    抛出:
    
    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
  - isTableEnabled
```
public boolean isTableEnabled(byte[] tableName)
                       throws IOException
```
    抛出:
    
    IOException
  - isTableEnabled
```
public boolean isTableEnabled(String tableName)
                       throws IOException
```
    抛出:
    
    IOException
  - 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
  - isTableDisabled
```
public boolean isTableDisabled(byte[] tableName)
                        throws IOException
```
    抛出:
    
    IOException
  - isTableDisabled
```
public boolean isTableDisabled(String tableName)
                        throws IOException
```
    抛出:
    
    IOException
  - 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(byte[] tableName)
                         throws IOException
```
    抛出:
    
    IOException
  - isTableAvailable
```
public boolean isTableAvailable(String tableName)
                         throws IOException
```
    抛出:
    
    IOException
  - isTableAvailable
```
public boolean isTableAvailable(TableName tableName,
                       byte[][] splitKeys)
                         throws IOException
```
    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
  - isTableAvailable
```
public boolean isTableAvailable(byte[] tableName,
                       byte[][] splitKeys)
                         throws IOException
```
    抛出:
    
    IOException
  - isTableAvailable
```
public boolean isTableAvailable(String tableName,
                       byte[][] splitKeys)
                         throws IOException
```
    抛出:
    
    IOException
  - getAlterStatus
```
public Pair<Integer,Integer> getAlterStatus(TableName tableName)
                                     throws IOException
```
    Get the status of alter 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
```
    Get the status of alter 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
  - addColumn
```
public void addColumn(byte[] tableName,
             HColumnDescriptor column)
               throws IOException
```
    Add a column to an existing table. Asynchronous operation.
    
    参数:
    tableName - name of the table to add column to
    column - column descriptor of column to be added
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - addColumn
```
public void addColumn(String tableName,
             HColumnDescriptor column)
               throws IOException
```
    Add a column to an existing table. Asynchronous operation.
    
    参数:
    tableName - name of the table to add column to
    column - column descriptor of column to be added
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - addColumn
```
public void addColumn(TableName tableName,
             HColumnDescriptor column)
               throws IOException
```
    Add a column to an existing table. Asynchronous operation.
    
    指定者:
    
    addColumn 在接口中 Admin
    
    参数:
    tableName - name of the table to add column to
    column - column descriptor of column to be added
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteColumn
```
public void deleteColumn(byte[] tableName,
                String columnName)
                  throws IOException
```
    Delete a column from a table. Asynchronous operation.
    
    参数:
    tableName - name of table
    columnName - name of column to be deleted
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteColumn
```
public void deleteColumn(String tableName,
                String columnName)
                  throws IOException
```
    Delete a column from a table. Asynchronous operation.
    
    参数:
    tableName - name of table
    columnName - name of column to be deleted
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteColumn
```
public void deleteColumn(TableName tableName,
                byte[] columnName)
                  throws IOException
```
    Delete a column from a table. Asynchronous operation.
    
    指定者:
    
    deleteColumn 在接口中 Admin
    
    参数:
    tableName - name of table
    columnName - name of column to be deleted
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyColumn
```
public void modifyColumn(String tableName,
                HColumnDescriptor descriptor)
                  throws IOException
```
    Modify an existing column family on a table. Asynchronous operation.
    
    参数:
    tableName - name of table
    descriptor - new column descriptor to use
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyColumn
```
public void modifyColumn(byte[] tableName,
                HColumnDescriptor descriptor)
                  throws IOException
```
    Modify an existing column family on a table. Asynchronous operation.
    
    参数:
    tableName - name of table
    descriptor - new column descriptor to use
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyColumn
```
public void modifyColumn(TableName tableName,
                HColumnDescriptor descriptor)
                  throws IOException
```
    Modify an existing column family on a table. Asynchronous operation.
    
    指定者:
    
    modifyColumn 在接口中 Admin
    
    参数:
    tableName - name of table
    descriptor - new column descriptor to use
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
public void closeRegion(String regionname,
               String serverName)
                 throws IOException
```
    Close a region. For expert-admins. Runs close on the regionserver. The master will not be informed of the close.
    
    指定者:
    
    closeRegion 在接口中 Admin
    
    参数:
    regionname - region name to close
    serverName - If supplied, we'll use this location rather than the one currently in hbase:meta
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
public void closeRegion(byte[] regionname,
               String serverName)
                 throws IOException
```
    Close a region. For expert-admins Runs close on the regionserver. The master will not be informed of the close.
    
    指定者:
    
    closeRegion 在接口中 Admin
    
    参数:
    regionname - region name to close
    serverName - The servername of the regionserver. If passed null we will use servername found in the hbase:meta table. A server name is made of host, port and startcode. Here is an example: host187.example.com,60020,1289493121758
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegionWithEncodedRegionName
```
public boolean closeRegionWithEncodedRegionName(String encodedRegionName,
                                       String serverName)
                                         throws IOException
```
    For expert-admins. Runs close on the regionserver. Closes a region based on the encoded region name. The region server name is mandatory. If the servername is provided then based on the online regions in the specified regionserver the specified region will be closed. The master will not be informed of the close. Note that the regionname is the encoded regionname.
    
    指定者:
    
    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.
    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
    
    返回:
    true if the region was closed, false if not.
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - closeRegion
```
public void closeRegion(ServerName sn,
               HRegionInfo hri)
                 throws IOException
```
    Close a region. For expert-admins Runs close on the regionserver. The master will not be informed of the close.
    
    指定者:
    
    closeRegion 在接口中 Admin
    
    参数:
    sn -
    hri -
    
    抛出:
    
    IOException
  - getOnlineRegions
```
public List<HRegionInfo> getOnlineRegions(ServerName sn)
                                   throws IOException
```
    Get all the online regions on a region server.
    
    指定者:
    
    getOnlineRegions 在接口中 Admin
    
    抛出:
    
    IOException
  - flush
```
public void flush(TableName tableName)
           throws IOException
```
    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
```
    Flush an individual region. Synchronous operation.
    
    指定者:
    
    flushRegion 在接口中 Admin
    
    参数:
    regionName - region to flush
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - flush
```
@Deprecated
public void flush(String tableNameOrRegionName)
           throws IOException,
                  InterruptedException
```
    已过时。 Use flush(org.apache.hadoop.hbase.TableName) or (byte[]) instead.
    
    抛出:
    
    IOException
    
    InterruptedException
  - flush
```
@Deprecated
public void flush(byte[] tableNameOrRegionName)
           throws IOException,
                  InterruptedException
```
    已过时。 Use flush(org.apache.hadoop.hbase.TableName) or (byte[]) instead.
    
    抛出:
    
    IOException
    
    InterruptedException
  - compact
```
public void compact(TableName tableName)
             throws IOException
```
    Compact a table. Asynchronous operation.
    
    指定者:
    
    compact 在接口中 Admin
    
    参数:
    tableName - table to compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compactRegion
```
public void compactRegion(byte[] regionName)
                   throws IOException
```
    Compact an individual region. Asynchronous operation.
    
    指定者:
    
    compactRegion 在接口中 Admin
    
    参数:
    regionName - region to compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compact
```
@Deprecated
public void compact(String tableNameOrRegionName)
             throws IOException
```
    已过时。 Use compact(org.apache.hadoop.hbase.TableName) or (byte[]) instead.
    
    抛出:
    
    IOException
  - compact
```
@Deprecated
public void compact(byte[] tableNameOrRegionName)
             throws IOException
```
    已过时。 Use compact(org.apache.hadoop.hbase.TableName) or (byte[]) instead.
    
    抛出:
    
    IOException
  - compact
```
public void compact(TableName tableName,
           byte[] columnFamily)
             throws IOException
```
    Compact a column family within a table. Asynchronous operation.
    
    指定者:
    
    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.
    
    指定者:
    
    compactRegion 在接口中 Admin
    
    参数:
    regionName - region to compact
    columnFamily - column family within a region
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - compact
```
@Deprecated
public void compact(String tableOrRegionName,
                      String columnFamily)
             throws IOException
```
    已过时。 Use compact(org.apache.hadoop.hbase.TableName) or (byte[], byte[]) instead.
    
    抛出:
    
    IOException
  - compact
```
@Deprecated
public void compact(byte[] tableNameOrRegionName,
                      byte[] columnFamily)
             throws IOException
```
    已过时。 Use compact(org.apache.hadoop.hbase.TableName) or (byte[], byte[]) instead.
    
    抛出:
    
    IOException
  - compactRegionServer
```
public void compactRegionServer(ServerName sn,
                       boolean major)
                         throws IOException,
                                InterruptedException
```
    Compact all regions on the region server
    
    指定者:
    
    compactRegionServer 在接口中 Admin
    
    参数:
    sn - the region server name
    major - if it's major compaction
    
    抛出:
    
    IOException
    
    InterruptedException
  - majorCompact
```
public void majorCompact(TableName tableName)
                  throws IOException
```
    Major compact a table. Asynchronous operation.
    
    指定者:
    
    majorCompact 在接口中 Admin
    
    参数:
    tableName - table to major compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompactRegion
```
public void majorCompactRegion(byte[] regionName)
                        throws IOException
```
    Major compact a table or an individual region. Asynchronous operation.
    
    指定者:
    
    majorCompactRegion 在接口中 Admin
    
    参数:
    regionName - region to major compact
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompact
```
@Deprecated
public void majorCompact(String tableNameOrRegionName)
                  throws IOException
```
    已过时。 Use majorCompact(org.apache.hadoop.hbase.TableName) or majorCompactRegion(byte[]) instead.
    
    抛出:
    
    IOException
  - majorCompact
```
@Deprecated
public void majorCompact(byte[] tableNameOrRegionName)
                  throws IOException
```
    已过时。 Use majorCompact(org.apache.hadoop.hbase.TableName) or majorCompactRegion(byte[]) instead.
    
    抛出:
    
    IOException
  - majorCompact
```
public void majorCompact(TableName tableName,
                byte[] columnFamily)
                  throws IOException
```
    Major compact a column family within a table. Asynchronous operation.
    
    指定者:
    
    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
```
    Major compact a column family within region. Asynchronous operation.
    
    指定者:
    
    majorCompactRegion 在接口中 Admin
    
    参数:
    regionName - egion to major compact
    columnFamily - column family within a region
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - majorCompact
```
@Deprecated
public void majorCompact(String tableNameOrRegionName,
                           String columnFamily)
                  throws IOException
```
    已过时。 Use majorCompact(org.apache.hadoop.hbase.TableName, byte[]) or majorCompactRegion(byte[], byte[]) instead.
    
    抛出:
    
    IOException
  - majorCompact
```
@Deprecated
public void majorCompact(byte[] tableNameOrRegionName,
                           byte[] columnFamily)
                  throws IOException
```
    已过时。 Use majorCompact(org.apache.hadoop.hbase.TableName, byte[]) or majorCompactRegion(byte[], byte[]) instead.
    
    抛出:
    
    IOException
  - move
```
public void move(byte[] encodedRegionName,
        byte[] destServerName)
          throws IOException
```
    Move the region r to dest.
    
    指定者:
    
    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. If passed the empty byte array we'll assign to a random server. A server name is made of host, port and startcode. Here is an example: host187.example.com,60020,1289493121758
    
    抛出:
    
    UnknownRegionException - Thrown if we can't find a region named encodedRegionName
    
    IOException - if we can't find a region named encodedRegionName
  - assign
```
public void assign(byte[] regionName)
            throws MasterNotRunningException,
                   ZooKeeperConnectionException,
                   IOException
```
    指定者:
    
    assign 在接口中 Admin
    
    参数:
    regionName - Region name to assign.
    
    抛出:
    
    MasterNotRunningException
    
    ZooKeeperConnectionException
    
    IOException
  - unassign
```
public void unassign(byte[] regionName,
            boolean force)
              throws MasterNotRunningException,
                     ZooKeeperConnectionException,
                     IOException
```
    Unassign a region from current hosting regionserver. Region will then be assigned to a regionserver chosen at random. Region could be reassigned back to the same server. Use move(byte[], byte[]) if you want to control the region movement.
    
    指定者:
    
    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).
    
    抛出:
    
    MasterNotRunningException
    
    ZooKeeperConnectionException
    
    IOException
  - offline
```
public void offline(byte[] regionName)
             throws IOException
```
    Offline specified region from master's in-memory state. It will not attempt to reassign the region as in unassign. This API can be used when a region not served by any region server and still online as per Master's in memory state. If this API is incorrectly used on active region then master will loose track of that region. This is a special method that should be used by experts or hbck.
    
    指定者:
    
    offline 在接口中 Admin
    
    参数:
    regionName - Region to offline.
    
    抛出:
    
    IOException
  - setBalancerRunning
```
public boolean setBalancerRunning(boolean on,
                         boolean synchronous)
                           throws IOException
```
    Turn the load balancer on or off.
    
    指定者:
    
    setBalancerRunning 在接口中 Admin
    
    参数:
    on - If true, enable balancer. If false, disable balancer.
    synchronous - If true, it waits until current balance() call, if outstanding, to return.
    
    返回:
    Previous balancer value
    
    抛出:
    
    IOException
  - balancer
```
public boolean balancer()
                 throws IOException
```
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. Can NOT run for various reasons. Check logs.
    
    指定者:
    
    balancer 在接口中 Admin
    
    返回:
    True if balancer ran, false otherwise.
    
    抛出:
    
    IOException
  - balancer
```
public boolean balancer(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.
    
    指定者:
    
    balancer 在接口中 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
```
    Query the state of the balancer from the Master. It's not a guarantee that the balancer is actually running this very moment, but that it will run.
    
    指定者:
    
    isBalancerEnabled 在接口中 Admin
    
    返回:
    True if the balancer is enabled, false otherwise.
    
    抛出:
    
    IOException
  - 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
```
    Query the current state of the region normalizer
    
    指定者:
    
    isNormalizerEnabled 在接口中 Admin
    
    返回:
    true if region normalizer is enabled, false otherwise.
    
    抛出:
    
    IOException
  - setNormalizerRunning
```
public boolean setNormalizerRunning(boolean on)
                             throws IOException
```
    Turn region normalizer on or off.
    
    指定者:
    
    setNormalizerRunning 在接口中 Admin
    
    返回:
    Previous normalizer value
    
    抛出:
    
    IOException
  - enableCatalogJanitor
```
public boolean enableCatalogJanitor(boolean enable)
                             throws IOException
```
    Enable/Disable the catalog janitor
    
    指定者:
    
    enableCatalogJanitor 在接口中 Admin
    
    参数:
    enable - if true enables the catalog janitor
    
    返回:
    the previous state
    
    抛出:
    
    MasterNotRunningException
    
    IOException
  - runCatalogScan
```
public int runCatalogScan()
                   throws IOException
```
    Ask for a scan of the catalog table
    
    指定者:
    
    runCatalogScan 在接口中 Admin
    
    返回:
    the number of entries cleaned
    
    抛出:
    
    MasterNotRunningException
    
    IOException
  - isCatalogJanitorEnabled
```
public boolean isCatalogJanitorEnabled()
                                throws IOException
```
    Query on the catalog janitor state (Enabled/Disabled?)
    
    指定者:
    
    isCatalogJanitorEnabled 在接口中 Admin
    
    抛出:
    
    MasterNotRunningException
    
    IOException
  - setCleanerChoreRunning
```
public boolean setCleanerChoreRunning(boolean on)
                               throws IOException
```
    从接口复制的说明: Admin
    
    Enable/Disable the cleaner chore
    
    指定者:
    
    setCleanerChoreRunning 在接口中 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
  - mergeRegions
```
public void mergeRegions(byte[] nameOfRegionA,
                byte[] nameOfRegionB,
                boolean forcible)
                  throws IOException
```
    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
  - split
```
public void split(TableName tableName)
           throws IOException
```
    Split a 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
```
    Split an individual region. Asynchronous operation.
    
    指定者:
    
    splitRegion 在接口中 Admin
    
    参数:
    regionName - region to split
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - split
```
@Deprecated
public void split(String tableNameOrRegionName)
           throws IOException,
                  InterruptedException
```
    已过时。 Use split(org.apache.hadoop.hbase.TableName) or (byte[]) instead.
    
    抛出:
    
    IOException
    
    InterruptedException
  - split
```
@Deprecated
public void split(byte[] tableNameOrRegionName)
           throws IOException,
                  InterruptedException
```
    已过时。 Use split(org.apache.hadoop.hbase.TableName) or (byte[]) instead.
    
    抛出:
    
    IOException
    
    InterruptedException
  - split
```
public void split(TableName tableName,
         byte[] splitPoint)
           throws IOException
```
    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
```
    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
  - split
```
@Deprecated
public void split(String tableNameOrRegionName,
                    String splitPoint)
           throws IOException
```
    已过时。 Use split(org.apache.hadoop.hbase.TableName, byte[]) or splitRegion(byte[], byte[]) instead.
    
    抛出:
    
    IOException
  - split
```
@Deprecated
public void split(byte[] tableNameOrRegionName,
                    byte[] splitPoint)
           throws IOException
```
    已过时。 Use split(org.apache.hadoop.hbase.TableName, byte[]) or splitRegion(byte[], byte[]) instead.
    
    抛出:
    
    IOException
  - split
```
public void split(ServerName sn,
         HRegionInfo hri,
         byte[] splitPoint)
           throws IOException
```
    抛出:
    
    IOException
  - modifyTable
```
public void modifyTable(TableName tableName,
               HTableDescriptor htd)
                 throws IOException
```
    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.
    
    指定者:
    
    modifyTable 在接口中 Admin
    
    参数:
    tableName - name of table.
    htd - modified description of the table
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - modifyTable
```
public void modifyTable(byte[] tableName,
               HTableDescriptor htd)
                 throws IOException
```
    抛出:
    
    IOException
  - modifyTable
```
public void modifyTable(String tableName,
               HTableDescriptor htd)
                 throws IOException
```
    抛出:
    
    IOException
  - shutdown
```
public void shutdown()
              throws IOException
```
    Shuts down the HBase cluster
    
    指定者:
    
    shutdown 在接口中 Admin
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - stopMaster
```
public void stopMaster()
                throws IOException
```
    Shuts down the current HBase master only. Does not shutdown the cluster.
    
    指定者:
    
    stopMaster 在接口中 Admin
    
    抛出:
    
    IOException - if a remote or network exception occurs
    另请参阅:
    shutdown()
  - stopRegionServer
```
public void stopRegionServer(String hostnamePort)
                      throws IOException
```
    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
    
    返回:
    cluster status
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getClusterStatus
```
public ClusterStatus getClusterStatus()
                               throws IOException
```
    指定者:
    
    getClusterStatus 在接口中 Admin
    
    返回:
    cluster status
    
    抛出:
    
    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
```
    Create a new namespace
    
    指定者:
    
    createNamespace 在接口中 Admin
    
    参数:
    descriptor - descriptor which describes the new namespace
    
    抛出:
    
    IOException
  - modifyNamespace
```
public void modifyNamespace(NamespaceDescriptor descriptor)
                     throws IOException
```
    Modify an existing namespace
    
    指定者:
    
    modifyNamespace 在接口中 Admin
    
    参数:
    descriptor - descriptor which describes the new namespace
    
    抛出:
    
    IOException
  - deleteNamespace
```
public void deleteNamespace(String name)
                     throws IOException
```
    Delete an existing namespace. Only empty namespaces (no tables) can be removed.
    
    指定者:
    
    deleteNamespace 在接口中 Admin
    
    参数:
    name - namespace name
    
    抛出:
    
    IOException
  - getNamespaceDescriptor
```
public NamespaceDescriptor getNamespaceDescriptor(String name)
                                           throws NamespaceNotFoundException,
                                                  IOException
```
    Get a namespace descriptor by name
    
    指定者:
    
    getNamespaceDescriptor 在接口中 Admin
    
    参数:
    name - name of namespace descriptor
    
    返回:
    A descriptor
    
    抛出:
    
    IOException
    
    NamespaceNotFoundException
  - listNamespaceDescriptors
```
public NamespaceDescriptor[] listNamespaceDescriptors()
                                               throws IOException
```
    List available namespace descriptors
    
    指定者:
    
    listNamespaceDescriptors 在接口中 Admin
    
    返回:
    List of descriptors
    
    抛出:
    
    IOException
  - listProcedures
```
public ProcedureInfo[] listProcedures()
                               throws IOException
```
    List procedures
    
    指定者:
    
    listProcedures 在接口中 Admin
    
    返回:
    procedure list
    
    抛出:
    
    IOException
  - listTableDescriptorsByNamespace
```
public HTableDescriptor[] listTableDescriptorsByNamespace(String name)
                                                   throws IOException
```
    Get list of table descriptors by namespace
    
    指定者:
    
    listTableDescriptorsByNamespace 在接口中 Admin
    
    参数:
    name - namespace name
    
    返回:
    A descriptor
    
    抛出:
    
    IOException
  - listTableNamesByNamespace
```
public TableName[] listTableNamesByNamespace(String name)
                                      throws IOException
```
    Get list of table names by namespace
    
    指定者:
    
    listTableNamesByNamespace 在接口中 Admin
    
    参数:
    name - namespace name
    
    返回:
    The list of table names in the namespace
    
    抛出:
    
    IOException
  - checkHBaseAvailable
```
public static void checkHBaseAvailable(org.apache.hadoop.conf.Configuration conf)
                                throws MasterNotRunningException,
                                       ZooKeeperConnectionException,
                                       com.google.protobuf.ServiceException,
                                       IOException
```
    Check to see if HBase is running. Throw an exception if not.
    
    参数:
    conf - system configuration
    
    抛出:
    
    MasterNotRunningException - if the master is not running
    
    ZooKeeperConnectionException - if unable to connect to zookeeper
    
    com.google.protobuf.ServiceException
    
    IOException
  - getTableRegions
```
public List<HRegionInfo> getTableRegions(TableName tableName)
                                  throws IOException
```
    get the regions of a given table.
    
    指定者:
    
    getTableRegions 在接口中 Admin
    
    参数:
    tableName - the name of the table
    
    返回:
    Ordered list of HRegionInfo.
    
    抛出:
    
    IOException
  - getTableRegions
```
public List<HRegionInfo> getTableRegions(byte[] tableName)
                                  throws IOException
```
    抛出:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 Admin
    
    抛出:
    
    IOException
  - getTableDescriptorsByTableName
```
public HTableDescriptor[] getTableDescriptorsByTableName(List<TableName> tableNames)
                                                  throws IOException
```
    Get tableDescriptors
    
    指定者:
    
    getTableDescriptorsByTableName 在接口中 Admin
    
    参数:
    tableNames - List of table names
    
    返回:
    HTD[] the tableDescriptor
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getTableDescriptors
```
public HTableDescriptor[] getTableDescriptors(List<String> names)
                                       throws IOException
```
    Get tableDescriptors
    
    指定者:
    
    getTableDescriptors 在接口中 Admin
    
    参数:
    names - List of table names
    
    返回:
    HTD[] the tableDescriptor
    
    抛出:
    
    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
  - getMasterCoprocessors
```
public String[] getMasterCoprocessors()
```
    从接口复制的说明: Admin
    
    Helper delegage to getClusterStatus().getMasterCoprocessors().
    
    指定者:
    
    getMasterCoprocessors 在接口中 Admin
    
    返回:
    an array of master coprocessors
    另请参阅:
    ClusterStatus.getMasterCoprocessors()
  - getCompactionState
```
public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionState(TableName tableName)
                                                                                                                throws IOException
```
    Get the current compaction state of a table. It could be in a major compaction, a minor compaction, both, or none.
    
    指定者:
    
    getCompactionState 在接口中 Admin
    
    参数:
    tableName - table to examine
    
    返回:
    the current compaction state
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getCompactionStateForRegion
```
public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionStateForRegion(byte[] regionName)
                                                                                                                         throws IOException
```
    Get the current compaction state of region. It could be in a major compaction, a minor compaction, both, or none.
    
    指定者:
    
    getCompactionStateForRegion 在接口中 Admin
    
    参数:
    regionName - region to examine
    
    返回:
    the current compaction state
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - getCompactionState
```
@Deprecated
public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionState(String tableNameOrRegionName)
                                                                                                                throws IOException,
                                                                                                                       InterruptedException
```
    已过时。 Use getCompactionState(org.apache.hadoop.hbase.TableName) or getCompactionStateForRegion(byte[]) instead.
    
    抛出:
    
    IOException
    
    InterruptedException
  - getCompactionState
```
@Deprecated
public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionState(byte[] tableNameOrRegionName)
                                                                                                                throws IOException,
                                                                                                                       InterruptedException
```
    已过时。 Use getCompactionState(org.apache.hadoop.hbase.TableName) or getCompactionStateForRegion(byte[]) instead.
    
    抛出:
    
    IOException
    
    InterruptedException
  - snapshot
```
public void snapshot(String snapshotName,
            TableName tableName)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be taken. If the table is disabled, an offline snapshot is taken.
    Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming.
    Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]).
    
    指定者:
    
    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,
            String tableName)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    抛出:
    
    IOException
    
    SnapshotCreationException
    
    IllegalArgumentException
  - snapshot
```
public void snapshot(byte[] snapshotName,
            byte[] tableName,
            org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type flushType)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    Create snapshot for the given table of given flush type.
    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.
    
    参数:
    snapshotName - name of the snapshot to be created
    tableName - name of the table for which snapshot is created
    flushType - if the snapshot should be taken without flush memstore first
    
    抛出:
    
    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
```
    public void snapshot(final String snapshotName, Create a timestamp consistent snapshot for the given table. final byte[] tableName) throws IOException,
    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.
    
    指定者:
    
    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,
            byte[] tableName)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    抛出:
    
    IOException
    
    SnapshotCreationException
    
    IllegalArgumentException
  - snapshot
```
public void snapshot(String snapshotName,
            TableName tableName,
            org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    Create typed snapshot of the table.
    Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming.
    Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]).
    
    指定者:
    
    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(String snapshotName,
            String tableName,
            org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    抛出:
    
    IOException
    
    SnapshotCreationException
    
    IllegalArgumentException
  - snapshot
```
public void snapshot(String snapshotName,
            byte[] tableName,
            org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    抛出:
    
    IOException
    
    SnapshotCreationException
    
    IllegalArgumentException
  - snapshot
```
public void snapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException
```
    Take a snapshot and wait for the server to complete that snapshot (blocking).
    Only a single snapshot should be taken at a time for an instance of HBase, or results may be undefined (you can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a single cluster).
    Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming.
    Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]).
    You should probably use snapshot(String, String) or snapshot(byte[], byte[]) unless you are sure about the type of snapshot that you want to take.
    
    指定者:
    
    snapshot 在接口中 Admin
    
    参数:
    snapshot - 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
  - takeSnapshotAsync
```
public org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SnapshotResponse takeSnapshotAsync(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                                                                                           throws IOException,
                                                                                                  SnapshotCreationException
```
    Take a snapshot without waiting for the server to complete that snapshot (asynchronous)
    Only a single snapshot should be taken at a time, or results may be undefined.
    
    指定者:
    
    takeSnapshotAsync 在接口中 Admin
    
    参数:
    snapshot - snapshot to take
    
    返回:
    response from the server indicating the max time to wait for the snapshot
    
    抛出:
    
    IOException - if the snapshot did not succeed or we lose contact with the master.
    
    SnapshotCreationException - if snapshot creation failed
    
    IllegalArgumentException - if the snapshot request is formatted incorrectly
  - isSnapshotFinished
```
public boolean isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                           throws IOException,
                                  HBaseSnapshotException,
                                  UnknownSnapshotException
```
    Check the current state of the passed snapshot.
    There are three possible states:
    1. running - returns false
    2. finished - returns true
    3. finished with error - throws the exception that caused the snapshot to fail
    The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been run/started since the snapshot your are checking, you will recieve an UnknownSnapshotException.
    指定者:
    
    isSnapshotFinished 在接口中 Admin
    
    参数:
    snapshot - 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
```
    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
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - restoreSnapshot
```
public void restoreSnapshot(String snapshotName)
                     throws IOException,
                            RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If the "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted.
    
    指定者:
    
    restoreSnapshot 在接口中 Admin
    
    参数:
    snapshotName - name of the snapshot to restore
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - restoreSnapshot
```
public void restoreSnapshot(byte[] snapshotName,
                   boolean takeFailSafeSnapshot)
                     throws IOException,
                            RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted. The failsafe snapshot name is configurable by using the property "hbase.snapshot.restore.failsafe.name".
    
    指定者:
    
    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
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - restoreSnapshot
```
public void restoreSnapshot(String snapshotName,
                   boolean takeFailSafeSnapshot,
                   boolean restoreAcl)
                     throws IOException,
                            RestoreSnapshotException
```
    Restore the specified snapshot on the original table. (The table must be disabled) If 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted. The failsafe snapshot name is configurable by using the property "hbase.snapshot.restore.failsafe.name".
    
    指定者:
    
    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 into table.
    
    抛出:
    
    IOException - if a remote or network exception occurs
    
    RestoreSnapshotException - if snapshot failed to be restored
    
    IllegalArgumentException - if the restore request is formatted incorrectly
  - 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
  - cloneSnapshot
```
public void cloneSnapshot(byte[] snapshotName,
                 byte[] tableName)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException
```
    Create a new table by cloning the snapshot content.
    
    参数:
    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
    
    IllegalArgumentException - if the specified table has not a valid name
  - cloneSnapshot
```
public void cloneSnapshot(byte[] snapshotName,
                 TableName tableName)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException
```
    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
    
    IllegalArgumentException - if the specified table has not a valid name
  - cloneSnapshot
```
public void cloneSnapshot(String snapshotName,
                 String tableName)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException,
                          InterruptedException
```
    Create a new table by cloning the snapshot content.
    
    参数:
    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
    
    IllegalArgumentException - if the specified table has not a valid name
    
    InterruptedException
  - cloneSnapshot
```
public void cloneSnapshot(String snapshotName,
                 TableName tableName,
                 boolean restoreAcl)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException
```
    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 restore acl of snapshot 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
    
    IllegalArgumentException - if the specified table has not a valid name
  - 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
  - execProcedureWithRet
```
public byte[] execProcedureWithRet(String signature,
                          String instance,
                          Map<String,String> props)
                            throws IOException
```
    Execute a distributed procedure on a cluster synchronously with return data
    
    指定者:
    
    execProcedureWithRet 在接口中 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
```
    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
```
    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<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots()
                                                                                               throws IOException
```
    List completed snapshots.
    
    指定者:
    
    listSnapshots 在接口中 Admin
    
    返回:
    a list of snapshot descriptors for completed snapshots
    
    抛出:
    
    IOException - if a network error occurs
  - listSnapshots
```
public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots(String regex)
                                                                                               throws IOException
```
    List all the completed snapshots matching the given regular expression.
    
    指定者:
    
    listSnapshots 在接口中 Admin
    
    参数:
    regex - The regular expression to match against
    
    返回:
    - returns a List of SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listSnapshots
```
public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots(Pattern pattern)
                                                                                               throws IOException
```
    List all the completed snapshots matching the given pattern.
    
    指定者:
    
    listSnapshots 在接口中 Admin
    
    参数:
    pattern - The compiled regular expression to match against
    
    返回:
    - returns a List of SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableSnapshots
```
public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listTableSnapshots(String tableNameRegex,
                                                                                                  String snapshotNameRegex)
                                                                                                    throws IOException
```
    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
    
    返回:
    returns a List of completed SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - listTableSnapshots
```
public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,
                                                                                                  Pattern snapshotNamePattern)
                                                                                                    throws IOException
```
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    指定者:
    
    listTableSnapshots 在接口中 Admin
    
    参数:
    tableNamePattern - The compiled table name regular expression to match against
    snapshotNamePattern - The compiled snapshot name regular expression to match against
    
    返回:
    returns a List of completed SnapshotDescription
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - deleteSnapshot
```
public void deleteSnapshot(byte[] snapshotName)
                    throws IOException
```
    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
```
    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
```
    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
```
    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
```
    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
```
    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
```
    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
```
    Return a Quota Scanner to list the quotas based on the filter.
    
    指定者:
    
    getQuotaRetriever 在接口中 Admin
    
    参数:
    filter - the quota settings filter
    
    返回:
    the quota scanner
    
    抛出:
    
    IOException - if a remote or network exception occurs
  - coprocessorService
```
public CoprocessorRpcChannel coprocessorService()
```
    Creates and returns a RpcChannel instance connected to the active master.
    The obtained RpcChannel instance can be used to access a published coprocessor Service using standard protobuf service invocations:
    CoprocessorRpcChannel channel = myAdmin.coprocessorService(); MyService.BlockingInterface service = MyService.newBlockingStub(channel); MyCallRequest request = MyCallRequest.newBuilder() ... .build(); MyCallResponse response = service.myCall(null, request);
    指定者:
    
    coprocessorService 在接口中 Admin
    
    返回:
    A MasterCoprocessorRpcChannel instance
  - coprocessorService
```
public CoprocessorRpcChannel coprocessorService(ServerName sn)
```
    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
    
    参数:
    sn - 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
  - getMasterInfoPort
```
public int getMasterInfoPort()
                      throws IOException
```
    从接口复制的说明: Admin
    
    Get the info port of the current master if one is available.
    
    指定者:
    
    getMasterInfoPort 在接口中 Admin
    
    返回:
    master info port
    
    抛出:
    
    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
  - getSecurityCapabilities
```
public List<SecurityCapability> getSecurityCapabilities()
                                                 throws IOException
```
    从接口复制的说明: Admin
    
    Return the set of supported security capabilities.
    
    指定者:
    
    getSecurityCapabilities 在接口中 Admin
    
    抛出:
    
    IOException
  - setSplitOrMergeEnabled
```
public boolean[] setSplitOrMergeEnabled(boolean enabled,
                               boolean synchronous,
                               Admin.MasterSwitchType... switchTypes)
                                 throws IOException
```
    从接口复制的说明: Admin
    
    Turn the Split or Merge switches on or off.
    
    指定者:
    
    setSplitOrMergeEnabled 在接口中 Admin
    
    参数:
    enabled - enabled or not
    synchronous - If true, it waits until current split() call, if outstanding, to return.
    switchTypes - switchType list Admin.MasterSwitchType
    
    返回:
    Previous switch value array
    
    抛出:
    
    IOException
  - isSplitOrMergeEnabled
```
public boolean isSplitOrMergeEnabled(Admin.MasterSwitchType switchType)
                              throws IOException
```
    从接口复制的说明: Admin
    
    Query the current state of the switch
    
    指定者:
    
    isSplitOrMergeEnabled 在接口中 Admin
    
    返回:
    true if the switch is enabled, false otherwise.
    
    抛出:
    
    IOException
  - listDeadServers
```
public List<ServerName> listDeadServers()
                                 throws IOException
```
    从接口复制的说明: Admin
    
    List dead region servers.
    
    指定者:
    
    listDeadServers 在接口中 Admin
    
    返回:
    List of dead region servers.
    
    抛出:
    
    IOException
  - 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 not cleared
    
    抛出:
    
    IOException - if a remote or network exception occurs

类 HBaseAdmin

嵌套类概要

从接口继承的嵌套类/接口 org.apache.hadoop.hbase.client.Admin

构造器概要

方法概要

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

构造器详细资料

HBaseAdmin

HBaseAdmin

方法详细资料

getOperationTimeout

abort

isAborted

abortProcedure

abortProcedureAsync

getConnection

isMasterRunning

tableExists

tableExists

tableExists

listTables

listTables

listTables

listTables

listTables

getTableNames

getTableNames

getTableNames

listTableNames

listTableNames

listTableNames

listTableNames

listTableNames

getTableDescriptor

getTableDescriptor

createTable

createTable

createTable

createTableAsync

deleteTable

deleteTable

deleteTable

deleteTables

deleteTables

truncateTable

enableTable

enableTable

enableTable

enableTableAsync

enableTableAsync

enableTableAsync

enableTables

enableTables

disableTableAsync

disableTableAsync

disableTableAsync

disableTable

disableTable

disableTable

disableTables

disableTables

isTableEnabled

isTableEnabled

isTableEnabled

isTableDisabled

isTableDisabled

isTableDisabled

isTableAvailable

isTableAvailable

isTableAvailable

isTableAvailable

isTableAvailable

isTableAvailable

getAlterStatus

getAlterStatus

addColumn

addColumn

addColumn

deleteColumn

deleteColumn