AsyncAdmin (Apache HBase - Client 2.0.0-alpha-1 API)

All Known Implementing Classes:

AsyncHBaseAdmin
```
@InterfaceAudience.Private
public interface AsyncAdmin
```
The asynchronous administrative API for HBase.
This feature is still under development, so marked as IA.Private. Will change to public when done. Use it with caution.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<Boolean>`	`abortProcedure(long procId, boolean mayInterruptIfRunning)` abort a procedure
`CompletableFuture<Void>`	`addColumnFamily(TableName tableName, HColumnDescriptor columnFamily)` Add a column family to an existing table.
`CompletableFuture<Void>`	`addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig)` Add a new replication peer for replicating data to slave cluster
`CompletableFuture<Void>`	`appendReplicationPeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs)` Append the replicable table-cf config of the specified peer
`CompletableFuture<Void>`	`assign(byte[] regionName)`
`CompletableFuture<Boolean>`	`balancer()` Invoke the balancer.
`CompletableFuture<Boolean>`	`balancer(boolean force)` Invoke the balancer.
`CompletableFuture<Void>`	`cloneSnapshot(String snapshotName, TableName tableName)` Create a new table by cloning the snapshot content.
`CompletableFuture<Void>`	`closeRegion(byte[] regionname, String serverName)` Close a region.
`CompletableFuture<Void>`	`closeRegion(ServerName sn, HRegionInfo hri)` Close a region.
`CompletableFuture<Void>`	`closeRegion(String regionname, String serverName)` Close a region.
`CompletableFuture<Boolean>`	`closeRegionWithEncodedRegionName(String encodedRegionName, String serverName)` For expert-admins.
`CompletableFuture<Void>`	`compact(TableName tableName)` Compact a table.
`CompletableFuture<Void>`	`compact(TableName tableName, byte[] columnFamily)` Compact a column family within a table.
`CompletableFuture<Void>`	`compactRegion(byte[] regionName)` Compact an individual region.
`CompletableFuture<Void>`	`compactRegion(byte[] regionName, byte[] columnFamily)` Compact a column family within a region.
`CompletableFuture<Void>`	`compactRegionServer(ServerName sn)` Compact all regions on the region server.
`CompletableFuture<Void>`	`createNamespace(NamespaceDescriptor descriptor)` Create a new namespace.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc)` Creates a new table.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc, byte[][] splitKeys)` Creates a new table with an initial set of empty regions defined by the specified split keys.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)` Creates a new table with the specified number of regions.
`CompletableFuture<Void>`	`deleteColumnFamily(TableName tableName, byte[] columnFamily)` Delete a column family from a table.
`CompletableFuture<Void>`	`deleteNamespace(String name)` Delete an existing namespace.
`CompletableFuture<Void>`	`deleteSnapshot(String snapshotName)` Delete an existing snapshot.
`CompletableFuture<Void>`	`deleteSnapshots(Pattern pattern)` Delete existing snapshots whose names match the pattern passed.
`CompletableFuture<Void>`	`deleteSnapshots(String regex)` Delete existing snapshots whose names match the pattern passed.
`CompletableFuture<Void>`	`deleteTable(TableName tableName)` Deletes a table.
`CompletableFuture<TableDescriptor[]>`	`deleteTables(Pattern pattern)` Delete tables matching the passed in pattern and wait on completion.
`CompletableFuture<TableDescriptor[]>`	`deleteTables(String regex)` Deletes tables matching the passed in pattern and wait on completion.
`CompletableFuture<Void>`	`deleteTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)` Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
`CompletableFuture<Void>`	`deleteTableSnapshots(String tableNameRegex, String snapshotNameRegex)` Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
`CompletableFuture<Void>`	`disableReplicationPeer(String peerId)` Stop the replication stream to the specified peer
`CompletableFuture<Void>`	`disableTable(TableName tableName)` Disable a table.
`CompletableFuture<TableDescriptor[]>`	`disableTables(Pattern pattern)` Disable tables matching the passed in pattern.
`CompletableFuture<TableDescriptor[]>`	`disableTables(String regex)` Disable tables matching the passed in pattern.
`CompletableFuture<Void>`	`enableReplicationPeer(String peerId)` Restart the replication stream to the specified peer
`CompletableFuture<Void>`	`enableTable(TableName tableName)` Enable a table.
`CompletableFuture<TableDescriptor[]>`	`enableTables(Pattern pattern)` Enable tables matching the passed in pattern.
`CompletableFuture<TableDescriptor[]>`	`enableTables(String regex)` Enable tables matching the passed in pattern.
`CompletableFuture<Void>`	`execProcedure(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`CompletableFuture<byte[]>`	`execProcedureWithRet(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`CompletableFuture<Void>`	`flush(TableName tableName)` Flush a table.
`CompletableFuture<Void>`	`flushRegion(byte[] regionName)` Flush an individual region.
`CompletableFuture<Pair<Integer,Integer>>`	`getAlterStatus(TableName tableName)` Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
`org.apache.hadoop.hbase.client.AsyncConnectionImpl`	`getConnection()`
`CompletableFuture<NamespaceDescriptor>`	`getNamespaceDescriptor(String name)` Get a namespace descriptor by name
`CompletableFuture<List<HRegionInfo>>`	`getOnlineRegions(ServerName sn)` Get all the online regions on a region server.
`CompletableFuture<List<QuotaSettings>>`	`getQuota(QuotaFilter filter)` List the quotas based on the filter.
`CompletableFuture<ReplicationPeerConfig>`	`getReplicationPeerConfig(String peerId)` Returns the configured ReplicationPeerConfig for the specified peer
`CompletableFuture<TableDescriptor>`	`getTableDescriptor(TableName tableName)` Method for getting the tableDescriptor
`CompletableFuture<Boolean>`	`isBalancerEnabled()` Query the current state of the balancer.
`CompletableFuture<Boolean>`	`isProcedureFinished(String signature, String instance, Map<String,String> props)` Check the current state of the specified procedure.
`CompletableFuture<Boolean>`	`isSnapshotFinished(SnapshotDescription snapshot)` Check the current state of the passed snapshot.
`CompletableFuture<Boolean>`	`isTableAvailable(TableName tableName)`
`CompletableFuture<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.
`CompletableFuture<Boolean>`	`isTableDisabled(TableName tableName)`
`CompletableFuture<Boolean>`	`isTableEnabled(TableName tableName)`
`CompletableFuture<NamespaceDescriptor[]>`	`listNamespaceDescriptors()` List available namespace descriptors
`CompletableFuture<ProcedureInfo[]>`	`listProcedures()` List procedures
`CompletableFuture<List<TableCFs>>`	`listReplicatedTableCFs()` Find all table and column families that are replicated from this cluster
`CompletableFuture<List<ReplicationPeerDescription>>`	`listReplicationPeers()` Return a list of replication peers.
`CompletableFuture<List<ReplicationPeerDescription>>`	`listReplicationPeers(Pattern pattern)` Return a list of replication peers.
`CompletableFuture<List<ReplicationPeerDescription>>`	`listReplicationPeers(String regex)` Return a list of replication peers.
`CompletableFuture<List<SnapshotDescription>>`	`listSnapshots()` List completed snapshots.
`CompletableFuture<List<SnapshotDescription>>`	`listSnapshots(Pattern pattern)` List all the completed snapshots matching the given pattern.
`CompletableFuture<List<SnapshotDescription>>`	`listSnapshots(String regex)` List all the completed snapshots matching the given regular expression.
`CompletableFuture<TableName[]>`	`listTableNames()` List all of the names of userspace tables.
`CompletableFuture<TableName[]>`	`listTableNames(Pattern pattern, boolean includeSysTables)` List all of the names of userspace tables.
`CompletableFuture<TableName[]>`	`listTableNames(String regex, boolean includeSysTables)` List all of the names of userspace tables.
`CompletableFuture<TableDescriptor[]>`	`listTables()` List all the userspace tables.
`CompletableFuture<TableDescriptor[]>`	`listTables(Pattern pattern, boolean includeSysTables)` List all the tables matching the given pattern.
`CompletableFuture<TableDescriptor[]>`	`listTables(String regex, boolean includeSysTables)` List all the tables matching the given pattern.
`CompletableFuture<List<SnapshotDescription>>`	`listTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)` List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
`CompletableFuture<List<SnapshotDescription>>`	`listTableSnapshots(String tableNameRegex, String snapshotNameRegex)` List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
`CompletableFuture<Void>`	`majorCompact(TableName tableName)` Major compact a table.
`CompletableFuture<Void>`	`majorCompact(TableName tableName, byte[] columnFamily)` Major compact a column family within a table.
`CompletableFuture<Void>`	`majorCompactRegion(byte[] regionName)` Major compact a table or an individual region.
`CompletableFuture<Void>`	`majorCompactRegion(byte[] regionName, byte[] columnFamily)` Major compact a column family within region.
`CompletableFuture<Void>`	`majorCompactRegionServer(ServerName sn)` Compact all regions on the region server.
`CompletableFuture<Void>`	`mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible)` Merge two regions.
`CompletableFuture<Void>`	`modifyColumnFamily(TableName tableName, HColumnDescriptor columnFamily)` Modify an existing column family on a table.
`CompletableFuture<Void>`	`modifyNamespace(NamespaceDescriptor descriptor)` Modify an existing namespace.
`CompletableFuture<Void>`	`move(byte[] regionName, byte[] destServerName)` Move the region `r` to `dest`.
`CompletableFuture<Void>`	`offline(byte[] regionName)` Offline specified region from master's in-memory state.
`CompletableFuture<Void>`	`removeReplicationPeer(String peerId)` Remove a peer and stop the replication
`CompletableFuture<Void>`	`removeReplicationPeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs)` Remove some table-cfs from config of the specified peer
`CompletableFuture<Void>`	`restoreSnapshot(String snapshotName)` Restore the specified snapshot on the original table.
`CompletableFuture<Void>`	`restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot)` Restore the specified snapshot on the original table.
`CompletableFuture<Boolean>`	`setBalancerRunning(boolean on)` Turn the load balancer on or off.
`CompletableFuture<Void>`	`setQuota(QuotaSettings quota)` Apply the new quota settings.
`CompletableFuture<Void>`	`snapshot(SnapshotDescription snapshot)` Take a snapshot and wait for the server to complete that snapshot asynchronously.
`CompletableFuture<Void>`	`snapshot(String snapshotName, TableName tableName)` Take a snapshot for the given table.
`CompletableFuture<Void>`	`snapshot(String snapshotName, TableName tableName, SnapshotType type)` Create typed snapshot of the table.
`CompletableFuture<Void>`	`split(TableName tableName)` Split a table.
`CompletableFuture<Void>`	`split(TableName tableName, byte[] splitPoint)` Split a table.
`CompletableFuture<Void>`	`splitRegion(byte[] regionName)` Split an individual region.
`CompletableFuture<Void>`	`splitRegion(byte[] regionName, byte[] splitPoint)` Split an individual region.
`CompletableFuture<Boolean>`	`tableExists(TableName tableName)`
`CompletableFuture<Void>`	`truncateTable(TableName tableName, boolean preserveSplits)` Truncate a table.
`CompletableFuture<Void>`	`unassign(byte[] regionName, boolean force)` Unassign a region from current hosting regionserver.
`CompletableFuture<Void>`	`updateReplicationPeerConfig(String peerId, ReplicationPeerConfig peerConfig)` Update the peerConfig for the specified peer

- Method Detail
  - getConnection
```
org.apache.hadoop.hbase.client.AsyncConnectionImpl getConnection()
```
    Returns:
    
    Async Connection used by this object.
  - tableExists
```
CompletableFuture<Boolean> tableExists(TableName tableName)
```
    Parameters:
    
    tableName - Table to check.
    
    Returns:
    
    True if table exists already. The return value will be wrapped by a CompletableFuture.
  - listTables
```
CompletableFuture<TableDescriptor[]> listTables()
```
    List all the userspace tables.
    
    Returns:
    
    - returns an array of TableDescriptors wrapped by a CompletableFuture.
    
    See Also:
    
    listTables(Pattern, boolean)
  - listTables
```
CompletableFuture<TableDescriptor[]> listTables(String regex,
                                                boolean includeSysTables)
```
    List all the tables matching the given pattern.
    
    Parameters:
    
    regex - The regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    - returns an array of TableDescriptors wrapped by a CompletableFuture.
    
    See Also:
    
    listTables(Pattern, boolean)
  - listTables
```
CompletableFuture<TableDescriptor[]> listTables(Pattern pattern,
                                                boolean includeSysTables)
```
    List all the tables matching the given pattern.
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    - returns an array of TableDescriptors wrapped by a CompletableFuture.
  - listTableNames
```
CompletableFuture<TableName[]> listTableNames()
```
    List all of the names of userspace tables.
    
    Returns:
    
    TableName[] an array of table names wrapped by a CompletableFuture.
    
    See Also:
    
    listTableNames(Pattern, boolean)
  - listTableNames
```
CompletableFuture<TableName[]> listTableNames(String regex,
                                              boolean includeSysTables)
```
    List all of the names of userspace tables.
    
    Parameters:
    
    regex - The regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    TableName[] an array of table names wrapped by a CompletableFuture.
    
    See Also:
    
    listTableNames(Pattern, boolean)
  - listTableNames
```
CompletableFuture<TableName[]> listTableNames(Pattern pattern,
                                              boolean includeSysTables)
```
    List all of the names of userspace tables.
    
    Parameters:
    
    pattern - The regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    TableName[] an array of table names wrapped by a CompletableFuture.
  - getTableDescriptor
```
CompletableFuture<TableDescriptor> getTableDescriptor(TableName tableName)
```
    Method for getting the tableDescriptor
    
    Parameters:
    
    tableName - as a TableName
    
    Returns:
    
    the read-only tableDescriptor wrapped by a CompletableFuture.
  - createTable
```
CompletableFuture<Void> createTable(TableDescriptor desc)
```
    Creates a new table.
    
    Parameters:
    
    desc - table descriptor for table
  - createTable
```
CompletableFuture<Void> createTable(TableDescriptor desc,
                                    byte[] startKey,
                                    byte[] endKey,
                                    int numRegions)
```
    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.
    
    Parameters:
    
    desc - table descriptor for table
    
    startKey - beginning of key range
    
    endKey - end of key range
    
    numRegions - the total number of regions to create
  - createTable
```
CompletableFuture<Void> createTable(TableDescriptor desc,
                                    byte[][] splitKeys)
```
    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. Note : Avoid passing empty split key.
    
    Parameters:
    
    desc - table descriptor for table
    
    splitKeys - array of split keys for the initial regions of the table
  - deleteTable
```
CompletableFuture<Void> deleteTable(TableName tableName)
```
    Deletes a table.
    
    Parameters:
    
    tableName - name of table to delete
  - deleteTables
```
CompletableFuture<TableDescriptor[]> deleteTables(String regex)
```
    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(String, boolean) and deleteTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be deleted. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - deleteTables
```
CompletableFuture<TableDescriptor[]> deleteTables(Pattern pattern)
```
    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(Pattern, boolean) and deleteTable(org.apache.hadoop.hbase.TableName)
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be deleted. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - truncateTable
```
CompletableFuture<Void> truncateTable(TableName tableName,
                                      boolean preserveSplits)
```
    Truncate a table.
    
    Parameters:
    
    tableName - name of table to truncate
    
    preserveSplits - True if the splits should be preserved
  - enableTable
```
CompletableFuture<Void> enableTable(TableName tableName)
```
    Enable a table. The table has to be in disabled state for it to be enabled.
    
    Parameters:
    
    tableName - name of the table
  - enableTables
```
CompletableFuture<TableDescriptor[]> enableTables(String regex)
```
    Enable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTables(Pattern, boolean) and enableTable(TableName)
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be enabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - enableTables
```
CompletableFuture<TableDescriptor[]> enableTables(Pattern pattern)
```
    Enable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTables(Pattern, boolean) and enableTable(TableName)
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be enabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - disableTable
```
CompletableFuture<Void> disableTable(TableName tableName)
```
    Disable a table. The table has to be in enabled state for it to be disabled.
    
    Parameters:
    
    tableName -
  - disableTables
```
CompletableFuture<TableDescriptor[]> disableTables(String regex)
```
    Disable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTables(Pattern, boolean) and disableTable(TableName)
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be disabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - disableTables
```
CompletableFuture<TableDescriptor[]> disableTables(Pattern pattern)
```
    Disable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using listTables(Pattern, boolean) and disableTable(TableName)
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be disabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - isTableDisabled
```
CompletableFuture<Boolean> isTableDisabled(TableName tableName)
```
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if table is off-line. The return value will be wrapped by a CompletableFuture.
  - isTableAvailable
```
CompletableFuture<Boolean> isTableAvailable(TableName tableName)
```
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if all regions of the table are available. The return value will be wrapped by a CompletableFuture.
  - isTableAvailable
```
CompletableFuture<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. Note : If this api is used after a table's region gets splitted, the api may return false. The return value will be wrapped by a CompletableFuture.
    
    Parameters:
    
    tableName - name of table to check
    
    splitKeys - keys to check if the table has been created with all split keys
  - getAlterStatus
```
CompletableFuture<Pair<Integer,Integer>> getAlterStatus(TableName tableName)
```
    Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
    
    Parameters:
    
    tableName - TableName instance
    
    Returns:
    
    Pair indicating the number of regions updated Pair.getFirst() is the regions that are yet to be updated Pair.getSecond() is the total number of regions of the table. The return value will be wrapped by a CompletableFuture.
  - addColumnFamily
```
CompletableFuture<Void> addColumnFamily(TableName tableName,
                                        HColumnDescriptor columnFamily)
```
    Add a column family to an existing table.
    
    Parameters:
    
    tableName - name of the table to add column family to
    
    columnFamily - column family descriptor of column family to be added
  - deleteColumnFamily
```
CompletableFuture<Void> deleteColumnFamily(TableName tableName,
                                           byte[] columnFamily)
```
    Delete a column family from a table.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
  - modifyColumnFamily
```
CompletableFuture<Void> modifyColumnFamily(TableName tableName,
                                           HColumnDescriptor columnFamily)
```
    Modify an existing column family on a table.
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - new column family descriptor to use
  - createNamespace
```
CompletableFuture<Void> createNamespace(NamespaceDescriptor descriptor)
```
    Create a new namespace.
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace
  - modifyNamespace
```
CompletableFuture<Void> modifyNamespace(NamespaceDescriptor descriptor)
```
    Modify an existing namespace.
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace
  - deleteNamespace
```
CompletableFuture<Void> deleteNamespace(String name)
```
    Delete an existing namespace. Only empty namespaces (no tables) can be removed.
    
    Parameters:
    
    name - namespace name
  - getNamespaceDescriptor
```
CompletableFuture<NamespaceDescriptor> getNamespaceDescriptor(String name)
```
    Get a namespace descriptor by name
    
    Parameters:
    
    name - name of namespace descriptor
    
    Returns:
    
    A descriptor wrapped by a CompletableFuture.
  - listNamespaceDescriptors
```
CompletableFuture<NamespaceDescriptor[]> listNamespaceDescriptors()
```
    List available namespace descriptors
    
    Returns:
    
    List of descriptors wrapped by a CompletableFuture.
  - isTableEnabled
```
CompletableFuture<Boolean> isTableEnabled(TableName tableName)
```
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if table is on-line. The return value will be wrapped by a CompletableFuture.
  - setBalancerRunning
```
CompletableFuture<Boolean> setBalancerRunning(boolean on)
```
    Turn the load balancer on or off.
    
    Parameters:
    
    on -
    
    Returns:
    
    Previous balancer value wrapped by a CompletableFuture.
  - balancer
```
CompletableFuture<Boolean> balancer()
```
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. Can NOT run for various reasons. Check logs.
    
    Returns:
    
    True if balancer ran, false otherwise. The return value will be wrapped by a CompletableFuture.
  - balancer
```
CompletableFuture<Boolean> balancer(boolean force)
```
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. If there is region in transition, force parameter of true would still run balancer. Can *not* run for other reasons. Check logs.
    
    Parameters:
    
    force - whether we should force balance even if there is region in transition.
    
    Returns:
    
    True if balancer ran, false otherwise. The return value will be wrapped by a CompletableFuture.
  - isBalancerEnabled
```
CompletableFuture<Boolean> isBalancerEnabled()
```
    Query the current state of the balancer.
    
    Returns:
    
    true if the balancer is enabled, false otherwise. The return value will be wrapped by a CompletableFuture.
  - closeRegion
```
CompletableFuture<Void> closeRegion(String regionname,
                                    String serverName)
```
    Close a region. For expert-admins. Runs close on the regionserver. The master will not be informed of the close.
    
    Parameters:
    
    regionname - region name to close
    
    serverName - If supplied, we'll use this location rather than the one currently in hbase:meta
  - closeRegion
```
CompletableFuture<Void> closeRegion(byte[] regionname,
                                    String serverName)
```
    Close a region. For expert-admins Runs close on the regionserver. The master will not be informed of the close.
    
    Parameters:
    
    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
  - closeRegionWithEncodedRegionName
```
CompletableFuture<Boolean> closeRegionWithEncodedRegionName(String encodedRegionName,
                                                            String serverName)
```
    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.
    
    Parameters:
    
    encodedRegionName - The encoded region name; i.e. the hash that makes up the region name suffix: e.g. if regionname is TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396., then the encoded region name is: 527db22f95c8a9e0116f0cc13c680396.
    
    serverName - 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
    
    Returns:
    
    true if the region was closed, false if not. The return value will be wrapped by a CompletableFuture.
  - closeRegion
```
CompletableFuture<Void> closeRegion(ServerName sn,
                                    HRegionInfo hri)
```
    Close a region. For expert-admins Runs close on the regionserver. The master will not be informed of the close.
    
    Parameters:
    
    sn -
    
    hri -
  - getOnlineRegions
```
CompletableFuture<List<HRegionInfo>> getOnlineRegions(ServerName sn)
```
    Get all the online regions on a region server.
  - flush
```
CompletableFuture<Void> flush(TableName tableName)
```
    Flush a table.
    
    Parameters:
    
    tableName - table to flush
  - flushRegion
```
CompletableFuture<Void> flushRegion(byte[] regionName)
```
    Flush an individual region.
    
    Parameters:
    
    regionName - region to flush
  - compact
```
CompletableFuture<Void> compact(TableName tableName)
```
    Compact a table. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    tableName - table to compact
  - compact
```
CompletableFuture<Void> compact(TableName tableName,
                                byte[] columnFamily)
```
    Compact a column family within a table. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    tableName - table to compact
    
    columnFamily - column family within a table
  - compactRegion
```
CompletableFuture<Void> compactRegion(byte[] regionName)
```
    Compact an individual region. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    regionName - region to compact
  - compactRegion
```
CompletableFuture<Void> compactRegion(byte[] regionName,
                                      byte[] columnFamily)
```
    Compact a column family within a region. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    regionName - region to compact
    
    columnFamily - column family within a region
  - majorCompact
```
CompletableFuture<Void> majorCompact(TableName tableName)
```
    Major compact a table. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    tableName - table to major compact
  - majorCompact
```
CompletableFuture<Void> majorCompact(TableName tableName,
                                     byte[] columnFamily)
```
    Major compact a column family within a table. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    tableName - table to major compact
    
    columnFamily - column family within a table
  - majorCompactRegion
```
CompletableFuture<Void> majorCompactRegion(byte[] regionName)
```
    Major compact a table or an individual region. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    regionName - region to major compact
  - majorCompactRegion
```
CompletableFuture<Void> majorCompactRegion(byte[] regionName,
                                           byte[] columnFamily)
```
    Major compact a column family within region. Asynchronous operation even if CompletableFuture.get().
    
    Parameters:
    
    regionName - egion to major compact
    
    columnFamily - column family within a region
  - compactRegionServer
```
CompletableFuture<Void> compactRegionServer(ServerName sn)
```
    Compact all regions on the region server.
    
    Parameters:
    
    sn - the region server name
  - majorCompactRegionServer
```
CompletableFuture<Void> majorCompactRegionServer(ServerName sn)
```
    Compact all regions on the region server.
    
    Parameters:
    
    sn - the region server name
  - mergeRegions
```
CompletableFuture<Void> mergeRegions(byte[] nameOfRegionA,
                                     byte[] nameOfRegionB,
                                     boolean forcible)
```
    Merge two regions.
    
    Parameters:
    
    nameOfRegionA - encoded or full name of region a
    
    nameOfRegionB - encoded or full name of region b
    
    forcible - true if do a compulsory merge, otherwise we will only merge two adjacent regions
  - split
```
CompletableFuture<Void> split(TableName tableName)
```
    Split a table. The method will execute split action for each region in table.
    
    Parameters:
    
    tableName - table to split
  - splitRegion
```
CompletableFuture<Void> splitRegion(byte[] regionName)
```
    Split an individual region.
    
    Parameters:
    
    regionName - region to split
  - split
```
CompletableFuture<Void> split(TableName tableName,
                              byte[] splitPoint)
```
    Split a table.
    
    Parameters:
    
    tableName - table to split
    
    splitPoint - the explicit position to split on
  - splitRegion
```
CompletableFuture<Void> splitRegion(byte[] regionName,
                                    byte[] splitPoint)
```
    Split an individual region.
    
    Parameters:
    
    regionName - region to split
    
    splitPoint - the explicit position to split on
  - assign
```
CompletableFuture<Void> assign(byte[] regionName)
```
    Parameters:
    
    regionName - Encoded or full name of region to assign.
  - unassign
```
CompletableFuture<Void> unassign(byte[] regionName,
                                 boolean force)
```
    Unassign a region from current hosting regionserver. Region will then be assigned to a regionserver chosen at random. Region could be reassigned back to the same server. Use move(byte[], byte[]) if you want to control the region movement.
    
    Parameters:
    
    regionName - Encoded or full name of 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).
  - offline
```
CompletableFuture<Void> offline(byte[] regionName)
```
    Offline specified region from master's in-memory state. It will not attempt to reassign the region as in unassign. This API can be used when a region not served by any region server and still online as per Master's in memory state. If this API is incorrectly used on active region then master will loose track of that region. This is a special method that should be used by experts or hbck.
    
    Parameters:
    
    regionName - Encoded or full name of region to offline
  - move
```
CompletableFuture<Void> move(byte[] regionName,
                             byte[] destServerName)
```
    Move the region r to dest.
    
    Parameters:
    
    regionName - Encoded or full name of region to move.
    
    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
  - setQuota
```
CompletableFuture<Void> setQuota(QuotaSettings quota)
```
    Apply the new quota settings.
    
    Parameters:
    
    quota - the quota settings
  - getQuota
```
CompletableFuture<List<QuotaSettings>> getQuota(QuotaFilter filter)
```
    List the quotas based on the filter.
    
    Parameters:
    
    filter - the quota settings filter
    
    Returns:
    
    the QuotaSetting list, which wrapped by a CompletableFuture.
  - addReplicationPeer
```
CompletableFuture<Void> addReplicationPeer(String peerId,
                                           ReplicationPeerConfig peerConfig)
```
    Add a new replication peer for replicating data to slave cluster
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication slave cluster
  - removeReplicationPeer
```
CompletableFuture<Void> removeReplicationPeer(String peerId)
```
    Remove a peer and stop the replication
    
    Parameters:
    
    peerId - a short name that identifies the peer
  - enableReplicationPeer
```
CompletableFuture<Void> enableReplicationPeer(String peerId)
```
    Restart the replication stream to the specified peer
    
    Parameters:
    
    peerId - a short name that identifies the peer
  - disableReplicationPeer
```
CompletableFuture<Void> disableReplicationPeer(String peerId)
```
    Stop the replication stream to the specified peer
    
    Parameters:
    
    peerId - a short name that identifies the peer
  - getReplicationPeerConfig
```
CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId)
```
    Returns the configured ReplicationPeerConfig for the specified peer
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Returns:
    
    ReplicationPeerConfig for the peer wrapped by a CompletableFuture.
  - updateReplicationPeerConfig
```
CompletableFuture<Void> updateReplicationPeerConfig(String peerId,
                                                    ReplicationPeerConfig peerConfig)
```
    Update the peerConfig for the specified peer
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - new config for the peer
  - appendReplicationPeerTableCFs
```
CompletableFuture<Void> appendReplicationPeerTableCFs(String id,
                                                      Map<TableName,? extends Collection<String>> tableCfs)
```
    Append the replicable table-cf config of the specified peer
    
    Parameters:
    
    id - a short that identifies the cluster
    
    tableCfs - A map from tableName to column family names
  - removeReplicationPeerTableCFs
```
CompletableFuture<Void> removeReplicationPeerTableCFs(String id,
                                                      Map<TableName,? extends Collection<String>> tableCfs)
```
    Remove some table-cfs from config of the specified peer
    
    Parameters:
    
    id - a short name that identifies the cluster
    
    tableCfs - A map from tableName to column family names
  - listReplicationPeers
```
CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers()
```
    Return a list of replication peers.
    
    Returns:
    
    a list of replication peers description. The return value will be wrapped by a CompletableFuture.
  - listReplicationPeers
```
CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(String regex)
```
    Return a list of replication peers.
    
    Parameters:
    
    regex - The regular expression to match peer id
    
    Returns:
    
    a list of replication peers description. The return value will be wrapped by a CompletableFuture.
  - listReplicationPeers
```
CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(Pattern pattern)
```
    Return a list of replication peers.
    
    Parameters:
    
    pattern - The compiled regular expression to match peer id
    
    Returns:
    
    a list of replication peers description. The return value will be wrapped by a CompletableFuture.
  - listReplicatedTableCFs
```
CompletableFuture<List<TableCFs>> listReplicatedTableCFs()
```
    Find all table and column families that are replicated from this cluster
    
    Returns:
    
    the replicated table-cfs list of this cluster. The return value will be wrapped by a CompletableFuture.
  - snapshot
```
CompletableFuture<Void> snapshot(String snapshotName,
                                 TableName tableName)
```
    Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be taken. If the table is disabled, an offline snapshot is taken. Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]).
    
    Parameters:
    
    snapshotName - name of the snapshot to be created
    
    tableName - name of the table for which snapshot is created
  - snapshot
```
CompletableFuture<Void> snapshot(String snapshotName,
                                 TableName tableName,
                                 SnapshotType type)
```
    Create typed snapshot of the table. Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]).
    
    Parameters:
    
    snapshotName - name to give the snapshot on the filesystem. Must be unique from all other snapshots stored on the cluster
    
    tableName - name of the table to snapshot
    
    type - type of snapshot to take
  - snapshot
```
CompletableFuture<Void> snapshot(SnapshotDescription snapshot)
```
    Take a snapshot and wait for the server to complete that snapshot asynchronously. Only a single snapshot should be taken at a time for an instance of HBase, or results may be undefined (you can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a single cluster). Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]). You should probably use snapshot(String, org.apache.hadoop.hbase.TableName) unless you are sure about the type of snapshot that you want to take.
    
    Parameters:
    
    snapshot - snapshot to take
  - isSnapshotFinished
```
CompletableFuture<Boolean> isSnapshotFinished(SnapshotDescription snapshot)
```
    Check the current state of the passed snapshot. There are three possible states:
    1. running - returns false
    2. finished - returns true
    3. finished with error - throws the exception that caused the snapshot to fail
    The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been run/started since the snapshot you are checking, you will receive an UnknownSnapshotException.
    Parameters:
    
    snapshot - description of the snapshot to check
    
    Returns:
    
    true if the snapshot is completed, false if the snapshot is still running
  - restoreSnapshot
```
CompletableFuture<Void> restoreSnapshot(String snapshotName)
```
    Restore the specified snapshot on the original table. (The table must be disabled) If the "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted.
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
  - restoreSnapshot
```
CompletableFuture<Void> restoreSnapshot(String snapshotName,
                                        boolean takeFailSafeSnapshot)
```
    Restore the specified snapshot on the original table. (The table must be disabled) If 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted. The failsafe snapshot name is configurable by using the property "hbase.snapshot.restore.failsafe.name".
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
  - cloneSnapshot
```
CompletableFuture<Void> cloneSnapshot(String snapshotName,
                                      TableName tableName)
```
    Create a new table by cloning the snapshot content.
    
    Parameters:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
  - listSnapshots
```
CompletableFuture<List<SnapshotDescription>> listSnapshots()
```
    List completed snapshots.
    
    Returns:
    
    a list of snapshot descriptors for completed snapshots wrapped by a CompletableFuture
  - listSnapshots
```
CompletableFuture<List<SnapshotDescription>> listSnapshots(String regex)
```
    List all the completed snapshots matching the given regular expression.
    
    Parameters:
    
    regex - The regular expression to match against
    
    Returns:
    
    - returns a List of SnapshotDescription wrapped by a CompletableFuture
  - listSnapshots
```
CompletableFuture<List<SnapshotDescription>> listSnapshots(Pattern pattern)
```
    List all the completed snapshots matching the given pattern.
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    Returns:
    
    - returns a List of SnapshotDescription wrapped by a CompletableFuture
  - listTableSnapshots
```
CompletableFuture<List<SnapshotDescription>> listTableSnapshots(String tableNameRegex,
                                                                String snapshotNameRegex)
```
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
    
    Returns:
    
    - returns a List of completed SnapshotDescription wrapped by a CompletableFuture
  - listTableSnapshots
```
CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern,
                                                                Pattern snapshotNamePattern)
```
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
    
    Returns:
    
    - returns a List of completed SnapshotDescription wrapped by a CompletableFuture
  - deleteSnapshot
```
CompletableFuture<Void> deleteSnapshot(String snapshotName)
```
    Delete an existing snapshot.
    
    Parameters:
    
    snapshotName - name of the snapshot
  - deleteSnapshots
```
CompletableFuture<Void> deleteSnapshots(String regex)
```
    Delete existing snapshots whose names match the pattern passed.
    
    Parameters:
    
    regex - The regular expression to match against
  - deleteSnapshots
```
CompletableFuture<Void> deleteSnapshots(Pattern pattern)
```
    Delete existing snapshots whose names match the pattern passed.
    
    Parameters:
    
    pattern - pattern for names of the snapshot to match
  - deleteTableSnapshots
```
CompletableFuture<Void> deleteTableSnapshots(String tableNameRegex,
                                             String snapshotNameRegex)
```
    Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
  - deleteTableSnapshots
```
CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern,
                                             Pattern snapshotNamePattern)
```
    Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Parameters:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
  - execProcedure
```
CompletableFuture<Void> execProcedure(String signature,
                                      String instance,
                                      Map<String,String> props)
```
    Execute a distributed procedure on a cluster.
    
    Parameters:
    
    signature - A distributed procedure is uniquely identified by its signature (default the root ZK node name of the procedure).
    
    instance - The instance name of the procedure. For some procedures, this parameter is optional.
    
    props - Property/Value pairs of properties passing to the procedure
  - execProcedureWithRet
```
CompletableFuture<byte[]> execProcedureWithRet(String signature,
                                               String instance,
                                               Map<String,String> props)
```
    Execute a distributed procedure on a cluster.
    
    Parameters:
    
    signature - A distributed procedure is uniquely identified by its signature (default the root ZK node name of the procedure).
    
    instance - The instance name of the procedure. For some procedures, this parameter is optional.
    
    props - Property/Value pairs of properties passing to the procedure
    
    Returns:
    
    data returned after procedure execution. null if no return data.
  - isProcedureFinished
```
CompletableFuture<Boolean> isProcedureFinished(String signature,
                                               String instance,
                                               Map<String,String> props)
```
    Check the current state of the specified procedure. There are three possible states:
    1. running - returns false
    2. finished - returns true
    3. finished with error - throws the exception that caused the procedure to fail
    Parameters:
    
    signature - The signature that uniquely identifies a procedure
    
    instance - The instance name of the procedure
    
    props - Property/Value pairs of properties passing to the procedure
    
    Returns:
    
    true if the specified procedure is finished successfully, false if it is still running. The value is vrapped by CompletableFuture
  - abortProcedure
```
CompletableFuture<Boolean> abortProcedure(long procId,
                                          boolean mayInterruptIfRunning)
```
    abort a procedure
    
    Parameters:
    
    procId - ID of the procedure to abort
    
    mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?
    
    Returns:
    
    true if aborted, false if procedure already completed or does not exist. the value is wrapped by CompletableFuture
  - listProcedures
```
CompletableFuture<ProcedureInfo[]> listProcedures()
```
    List procedures
    
    Returns:
    
    procedure list wrapped by CompletableFuture

Interface AsyncAdmin

Method Summary

Method Detail

getConnection

tableExists

listTables

listTables

listTables

listTableNames

listTableNames

listTableNames

getTableDescriptor

createTable

createTable

createTable

deleteTable

deleteTables

deleteTables

truncateTable

enableTable

enableTables

enableTables

disableTable

disableTables

disableTables

isTableDisabled

isTableAvailable

isTableAvailable

getAlterStatus

addColumnFamily

deleteColumnFamily

modifyColumnFamily

createNamespace

modifyNamespace

deleteNamespace

getNamespaceDescriptor

listNamespaceDescriptors

isTableEnabled

setBalancerRunning

balancer

balancer

isBalancerEnabled

closeRegion

closeRegion

closeRegionWithEncodedRegionName

closeRegion

getOnlineRegions

flush

flushRegion

compact

compact

compactRegion

compactRegion

majorCompact

majorCompact

majorCompactRegion

majorCompactRegion

compactRegionServer

majorCompactRegionServer

mergeRegions

split

splitRegion

split

splitRegion

assign

unassign

offline

move

setQuota

getQuota

addReplicationPeer

removeReplicationPeer

enableReplicationPeer

disableReplicationPeer

getReplicationPeerConfig

updateReplicationPeerConfig

appendReplicationPeerTableCFs

removeReplicationPeerTableCFs

listReplicationPeers

listReplicationPeers