Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id A4C8A200C59 for ; Mon, 17 Apr 2017 16:59:29 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id A379E160BAE; Mon, 17 Apr 2017 14:59:29 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 5CFF9160BB2 for ; Mon, 17 Apr 2017 16:59:27 +0200 (CEST) Received: (qmail 85399 invoked by uid 500); 17 Apr 2017 14:59:24 -0000 Mailing-List: contact commits-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@hbase.apache.org Delivered-To: mailing list commits@hbase.apache.org Received: (qmail 83387 invoked by uid 99); 17 Apr 2017 14:59:23 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 17 Apr 2017 14:59:23 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 7DC69E1794; Mon, 17 Apr 2017 14:59:23 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: git-site-role@apache.org To: commits@hbase.apache.org Date: Mon, 17 Apr 2017 14:59:56 -0000 Message-Id: In-Reply-To: <323c04e270764c50b7cb7c084715d056@git.apache.org> References: <323c04e270764c50b7cb7c084715d056@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [35/51] [partial] hbase-site git commit: Published site at 82d554e3783372cc6b05489452c815b57c06f6cd. archived-at: Mon, 17 Apr 2017 14:59:29 -0000 http://git-wip-us.apache.org/repos/asf/hbase-site/blob/e4348f53/devapidocs/org/apache/hadoop/hbase/client/AsyncAdmin.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/AsyncAdmin.html b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdmin.html index b829534..472bd89 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/AsyncAdmin.html +++ b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdmin.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -106,7 +106,7 @@ var activeTableTab = "activeTableTab";

@InterfaceAudience.Public
-public interface AsyncAdmin
+public interface AsyncAdmin
The asynchronous administrative API for HBase.
@@ -290,22 +290,28 @@ public interface +CompletableFuture<List<QuotaSettings>> +getQuota(QuotaFilter filter) +
List the quotas based on the filter.
+ + + CompletableFuture<HTableDescriptor> getTableDescriptor(TableName tableName)
Method for getting the tableDescriptor
- + CompletableFuture<Boolean> isBalancerEnabled()
Query the current state of the balancer.
- + CompletableFuture<Boolean> isTableAvailable(TableName tableName)  - + CompletableFuture<Boolean> isTableAvailable(TableName tableName, byte[][] splitKeys) @@ -313,61 +319,61 @@ public interface + CompletableFuture<Boolean> isTableDisabled(TableName tableName)  - + CompletableFuture<Boolean> isTableEnabled(TableName tableName)  - + CompletableFuture<NamespaceDescriptor[]> listNamespaceDescriptors()
List available namespace descriptors
- + 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<HTableDescriptor[]> listTables()
List all the userspace tables.
- + CompletableFuture<HTableDescriptor[]> listTables(Pattern pattern, boolean includeSysTables)
List all the tables matching the given pattern.
- + CompletableFuture<HTableDescriptor[]> listTables(String regex, boolean includeSysTables)
List all the tables matching the given pattern.
- + CompletableFuture<Void> mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, @@ -375,76 +381,82 @@ public interface 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<Boolean> setBalancerRunning(boolean on)
Turn the load balancer on or off.
- + +CompletableFuture<Void> +setQuota(QuotaSettings quota) +
Apply the new quota settings.
+ + + 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) @@ -472,7 +484,7 @@ public interface
  • getConnection

    -
    AsyncConnectionImpl getConnection()
    +
    AsyncConnectionImpl getConnection()
    Returns:
    Async Connection used by this object.
    @@ -485,7 +497,7 @@ public interface
  • tableExists

    -
    CompletableFuture<BooleantableExists(TableName tableName)
    +
    CompletableFuture<BooleantableExists(TableName tableName)
    Parameters:
    tableName - Table to check.
    @@ -501,7 +513,7 @@ public interface
  • listTables

    -
    CompletableFuture<HTableDescriptor[]> listTables()
    +
    CompletableFuture<HTableDescriptor[]> listTables()
    List all the userspace tables.
    Returns:
    @@ -517,7 +529,7 @@ public interface
  • listTables

    -
    CompletableFuture<HTableDescriptor[]> listTables(String regex,
    +
    CompletableFuture<HTableDescriptor[]> listTables(String regex,
                                                      boolean includeSysTables)
    List all the tables matching the given pattern.
    @@ -537,7 +549,7 @@ public interface
  • listTables

    -
    CompletableFuture<HTableDescriptor[]> listTables(Pattern pattern,
    +
    CompletableFuture<HTableDescriptor[]> listTables(Pattern pattern,
                                                      boolean includeSysTables)
    List all the tables matching the given pattern.
    @@ -555,7 +567,7 @@ public interface
  • listTableNames

    -
    CompletableFuture<TableName[]> listTableNames()
    +
    CompletableFuture<TableName[]> listTableNames()
    List all of the names of userspace tables.
    Returns:
    @@ -571,7 +583,7 @@ public interface
  • listTableNames

    -
    CompletableFuture<TableName[]> listTableNames(String regex,
    +
    CompletableFuture<TableName[]> listTableNames(String regex,
                                                   boolean includeSysTables)
    List all of the names of userspace tables.
    @@ -591,7 +603,7 @@ public interface
  • listTableNames

    -
    CompletableFuture<TableName[]> listTableNames(Pattern pattern,
    +
    CompletableFuture<TableName[]> listTableNames(Pattern pattern,
                                                   boolean includeSysTables)
    List all of the names of userspace tables.
    @@ -609,7 +621,7 @@ public interface
  • getTableDescriptor

    -
    CompletableFuture<HTableDescriptorgetTableDescriptor(TableName tableName)
    +
    CompletableFuture<HTableDescriptorgetTableDescriptor(TableName tableName)
    Method for getting the tableDescriptor
    Parameters:
    @@ -625,7 +637,7 @@ public interface
  • createTable

    -
    CompletableFuture<VoidcreateTable(HTableDescriptor desc)
    +
    CompletableFuture<VoidcreateTable(HTableDescriptor desc)
    Creates a new table.
    Parameters:
    @@ -639,7 +651,7 @@ public interface
  • createTable

    -
    CompletableFuture<VoidcreateTable(HTableDescriptor desc,
    +
    CompletableFuture<VoidcreateTable(HTableDescriptor desc,
                                         byte[] startKey,
                                         byte[] endKey,
                                         int numRegions)
    @@ -663,7 +675,7 @@ public interface
  • createTable

    -
    CompletableFuture<VoidcreateTable(HTableDescriptor desc,
    +
    CompletableFuture<VoidcreateTable(HTableDescriptor 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. @@ -681,7 +693,7 @@ public interface
  • deleteTable

    -
    CompletableFuture<VoiddeleteTable(TableName tableName)
    +
    CompletableFuture<VoiddeleteTable(TableName tableName)
    Deletes a table.
    Parameters:
    @@ -695,7 +707,7 @@ public interface
  • deleteTables

    -
    CompletableFuture<HTableDescriptor[]> deleteTables(String regex)
    +
    CompletableFuture<HTableDescriptor[]> 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 @@ -715,7 +727,7 @@ public interface
  • deleteTables

    -
    CompletableFuture<HTableDescriptor[]> deleteTables(Pattern pattern)
    +
    CompletableFuture<HTableDescriptor[]> 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 @@ -735,7 +747,7 @@ public interface
  • truncateTable

    -
    CompletableFuture<VoidtruncateTable(TableName tableName,
    +
    CompletableFuture<VoidtruncateTable(TableName tableName,
                                           boolean preserveSplits)
    Truncate a table.
    @@ -751,7 +763,7 @@ public interface
  • enableTable

    -
    CompletableFuture<VoidenableTable(TableName tableName)
    +
    CompletableFuture<VoidenableTable(TableName tableName)
    Enable a table. The table has to be in disabled state for it to be enabled.
    Parameters:
    @@ -765,7 +777,7 @@ public interface
  • enableTables

    -
    CompletableFuture<HTableDescriptor[]> enableTables(String regex)
    +
    CompletableFuture<HTableDescriptor[]> 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)
    @@ -784,7 +796,7 @@ public interface
  • enableTables

    -
    CompletableFuture<HTableDescriptor[]> enableTables(Pattern pattern)
    +
    CompletableFuture<HTableDescriptor[]> 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)
    @@ -803,7 +815,7 @@ public interface
  • disableTable

    -
    CompletableFuture<VoiddisableTable(TableName tableName)
    +
    CompletableFuture<VoiddisableTable(TableName tableName)
    Disable a table. The table has to be in enabled state for it to be disabled.
    Parameters:
    @@ -817,7 +829,7 @@ public interface
  • disableTables

    -
    CompletableFuture<HTableDescriptor[]> disableTables(String regex)
    +
    CompletableFuture<HTableDescriptor[]> 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)
    @@ -836,7 +848,7 @@ public interface
  • disableTables

    -
    CompletableFuture<HTableDescriptor[]> disableTables(Pattern pattern)
    +
    CompletableFuture<HTableDescriptor[]> 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)
    @@ -855,7 +867,7 @@ public interface
  • isTableDisabled

    -
    CompletableFuture<BooleanisTableDisabled(TableName tableName)
    +
    CompletableFuture<BooleanisTableDisabled(TableName tableName)
    Parameters:
    tableName - name of table to check
    @@ -871,7 +883,7 @@ public interface
  • isTableAvailable

    -
    CompletableFuture<BooleanisTableAvailable(TableName tableName)
    +
    CompletableFuture<BooleanisTableAvailable(TableName tableName)
    Parameters:
    tableName - name of table to check
    @@ -887,7 +899,7 @@ public interface
  • isTableAvailable

    -
    CompletableFuture<BooleanisTableAvailable(TableName tableName,
    +
    CompletableFuture<BooleanisTableAvailable(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 @@ -906,7 +918,7 @@ public interface
  • getAlterStatus

    -
    CompletableFuture<Pair<Integer,Integer>> getAlterStatus(TableName tableName)
    +
    CompletableFuture<Pair<Integer,Integer>> getAlterStatus(TableName tableName)
    Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
    @@ -925,7 +937,7 @@ public interface
  • addColumnFamily

    -
    CompletableFuture<VoidaddColumnFamily(TableName tableName,
    +
    CompletableFuture<VoidaddColumnFamily(TableName tableName,
                                             HColumnDescriptor columnFamily)
    Add a column family to an existing table.
    @@ -941,7 +953,7 @@ public interface
  • deleteColumnFamily

    -
    CompletableFuture<VoiddeleteColumnFamily(TableName tableName,
    +
    CompletableFuture<VoiddeleteColumnFamily(TableName tableName,
                                                byte[] columnFamily)
    Delete a column family from a table.
    @@ -957,7 +969,7 @@ public interface
  • modifyColumnFamily

    -
    CompletableFuture<VoidmodifyColumnFamily(TableName tableName,
    +
    CompletableFuture<VoidmodifyColumnFamily(TableName tableName,
                                                HColumnDescriptor columnFamily)
    Modify an existing column family on a table.
    @@ -973,7 +985,7 @@ public interface
  • createNamespace

    -
    CompletableFuture<VoidcreateNamespace(NamespaceDescriptor descriptor)
    +
    CompletableFuture<VoidcreateNamespace(NamespaceDescriptor descriptor)
    Create a new namespace.
    Parameters:
    @@ -987,7 +999,7 @@ public interface
  • modifyNamespace

    -
    CompletableFuture<VoidmodifyNamespace(NamespaceDescriptor descriptor)
    +
    CompletableFuture<VoidmodifyNamespace(NamespaceDescriptor descriptor)
    Modify an existing namespace.
    Parameters:
    @@ -1001,7 +1013,7 @@ public interface
  • deleteNamespace

    -
    CompletableFuture<VoiddeleteNamespace(String name)
    +
    CompletableFuture<VoiddeleteNamespace(String name)
    Delete an existing namespace. Only empty namespaces (no tables) can be removed.
    Parameters:
    @@ -1015,7 +1027,7 @@ public interface
  • getNamespaceDescriptor

    -
    CompletableFuture<NamespaceDescriptorgetNamespaceDescriptor(String name)
    +
    CompletableFuture<NamespaceDescriptorgetNamespaceDescriptor(String name)
    Get a namespace descriptor by name
    Parameters:
    @@ -1031,7 +1043,7 @@ public interface
  • listNamespaceDescriptors

    -
    CompletableFuture<NamespaceDescriptor[]> listNamespaceDescriptors()
    +
    CompletableFuture<NamespaceDescriptor[]> listNamespaceDescriptors()
    List available namespace descriptors
    Returns:
    @@ -1045,7 +1057,7 @@ public interface
  • isTableEnabled

    -
    CompletableFuture<BooleanisTableEnabled(TableName tableName)
    +
    CompletableFuture<BooleanisTableEnabled(TableName tableName)
    Parameters:
    tableName - name of table to check
    @@ -1061,7 +1073,7 @@ public interface
  • setBalancerRunning

    -
    CompletableFuture<BooleansetBalancerRunning(boolean on)
    +
    CompletableFuture<BooleansetBalancerRunning(boolean on)
    Turn the load balancer on or off.
    Parameters:
    @@ -1077,7 +1089,7 @@ public interface
  • balancer

    -
    CompletableFuture<Booleanbalancer()
    +
    CompletableFuture<Booleanbalancer()
    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.
    @@ -1093,7 +1105,7 @@ public interface
  • balancer

    -
    CompletableFuture<Booleanbalancer(boolean force)
    +
    CompletableFuture<Booleanbalancer(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.
    @@ -1112,7 +1124,7 @@ public interface
  • isBalancerEnabled

    -
    CompletableFuture<BooleanisBalancerEnabled()
    +
    CompletableFuture<BooleanisBalancerEnabled()
    Query the current state of the balancer.
    Returns:
    @@ -1127,7 +1139,7 @@ public interface
  • closeRegion

    -
    CompletableFuture<VoidcloseRegion(String regionname,
    +
    CompletableFuture<VoidcloseRegion(String regionname,
                                         String serverName)
    Close a region. For expert-admins. Runs close on the regionserver. The master will not be informed of the close.
    @@ -1145,7 +1157,7 @@ public interface
  • closeRegion

    -
    CompletableFuture<VoidcloseRegion(byte[] regionname,
    +
    CompletableFuture<VoidcloseRegion(byte[] regionname,
                                         String serverName)
    Close a region. For expert-admins Runs close on the regionserver. The master will not be informed of the close.
    @@ -1164,7 +1176,7 @@ public interface
  • closeRegionWithEncodedRegionName

    -
    CompletableFuture<BooleancloseRegionWithEncodedRegionName(String encodedRegionName,
    +
    CompletableFuture<BooleancloseRegionWithEncodedRegionName(String encodedRegionName,