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 C77C7200BCA for ; Mon, 21 Nov 2016 18:56:15 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id C5FA3160AEF; Mon, 21 Nov 2016 17:56:15 +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 700D0160B21 for ; Mon, 21 Nov 2016 18:56:13 +0100 (CET) Received: (qmail 57409 invoked by uid 500); 21 Nov 2016 17:56:09 -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 56671 invoked by uid 99); 21 Nov 2016 17:56:09 -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, 21 Nov 2016 17:56:08 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C9280F0DC1; Mon, 21 Nov 2016 17:56:08 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: stack@apache.org To: commits@hbase.apache.org Date: Mon, 21 Nov 2016 17:56:28 -0000 Message-Id: <99433dd32eb54b848862f94881a56b53@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [21/52] [partial] hbase-site git commit: Published site at ec9c9e201a8fadcbdd08d67a20547f79bd105ac6. archived-at: Mon, 21 Nov 2016 17:56:16 -0000 http://git-wip-us.apache.org/repos/asf/hbase-site/blob/d023c665/devapidocs/org/apache/hadoop/hbase/client/Admin.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/Admin.html b/devapidocs/org/apache/hadoop/hbase/client/Admin.html index 5884ea8..b4384e1 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/Admin.html +++ b/devapidocs/org/apache/hadoop/hbase/client/Admin.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":38,"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":38,"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,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":38,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":6,"i90":6,"i91":6,"i92":6,"i93":6,"i94":6,"i95":6,"i96":6,"i97":6,"i98":6,"i99":6,"i100":6,"i101":6,"i102":6,"i103":6,"i104":6,"i105":6,"i106":6,"i107":6,"i108":6,"i109":6,"i110":6,"i111":6,"i112":6,"i113":6,"i114":6,"i115":6,"i116":6,"i117":6,"i118":38,"i119":6,"i120":3 8,"i121":6,"i122":6,"i123":6,"i124":6,"i125":6,"i126":6,"i127":6,"i128":6,"i129":6,"i130":6,"i131":6,"i132":6,"i133":6,"i134":6,"i135":6,"i136":6,"i137":6,"i138":6,"i139":6,"i140":6,"i141":6,"i142":6,"i143":6,"i144":6,"i145":6,"i146":6,"i147":6,"i148":6,"i149":6,"i150":6,"i151":6,"i152":6,"i153":6,"i154":6,"i155":6,"i156":6,"i157":6,"i158":6}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":38,"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":38,"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,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":38,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":6,"i90":6,"i91":6,"i92":6,"i93":6,"i94":6,"i95":6,"i96":6,"i97":6,"i98":6,"i99":6,"i100":6,"i101":6,"i102":6,"i103":6,"i104":6,"i105":6,"i106":6,"i107":6,"i108":6,"i109":6,"i110":6,"i111":6,"i112":6,"i113":6,"i114":6,"i115":6,"i116":6,"i117":6,"i118":6,"i119":6,"i120":38 ,"i121":6,"i122":38,"i123":6,"i124":6,"i125":6,"i126":6,"i127":6,"i128":6,"i129":6,"i130":6,"i131":6,"i132":6,"i133":6,"i134":6,"i135":6,"i136":6,"i137":6,"i138":6,"i139":6,"i140":6,"i141":6,"i142":6,"i143":6,"i144":6,"i145":6,"i146":6,"i147":6,"i148":6,"i149":6,"i150":6,"i151":6,"i152":6,"i153":6,"i154":6,"i155":6,"i156":6,"i157":6,"i158":6,"i159":6,"i160":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -111,7 +111,7 @@ var activeTableTab = "activeTableTab";
@InterfaceAudience.Public
  @InterfaceStability.Evolving
-public interface Admin
+public interface Admin
 extends Abortable, Closeable
The administrative API for HBase. Obtain an instance from an Connection.getAdmin() and call close() afterwards. @@ -644,66 +644,79 @@ extends +Map<byte[],RegionLoad> +getRegionLoad(ServerName sn) +
Get RegionLoad of all regions hosted on a regionserver.
+ + + +Map<byte[],RegionLoad> +getRegionLoad(ServerName sn, + TableName tableName) +
Get RegionLoad of all regions hosted on a regionserver for a table.
+ + + List<SecurityCapability> getSecurityCapabilities()
Return the set of supported security capabilities.
- + HTableDescriptor getTableDescriptor(TableName tableName)
Method for getting the tableDescriptor
- + HTableDescriptor[] getTableDescriptors(List<String> names)
Get tableDescriptors
- + HTableDescriptor[] getTableDescriptorsByTableName(List<TableName> tableNames)
Get tableDescriptors
- + 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 current state of the balancer
- + boolean isCatalogJanitorEnabled()
Query on the catalog janitor state (Enabled/Disabled?)
- + boolean isMasterInMaintenanceMode()
Check whether Master is in maintenance mode
- + boolean isNormalizerEnabled()
Query the current state of the region normalizer
- + boolean isProcedureFinished(String signature, String instance, @@ -711,23 +724,23 @@ extends Check the current state of the specified procedure.
- + boolean isSnapshotFinished(SnapshotDescription snapshot)
Check the current state of the passed snapshot.
- + boolean isSplitOrMergeEnabled(MasterSwitchType switchType)
Query the current state of the switch
- + boolean isTableAvailable(TableName tableName)  - + boolean isTableAvailable(TableName tableName, byte[][] splitKeys) @@ -735,121 +748,121 @@ extends + boolean isTableDisabled(TableName tableName)  - + boolean isTableEnabled(TableName tableName)  - + NamespaceDescriptor[] listNamespaceDescriptors()
List available namespace descriptors
- + ProcedureInfo[] listProcedures()
List procedures
- + List<SnapshotDescription> listSnapshots()
List completed snapshots.
- + List<SnapshotDescription> listSnapshots(Pattern pattern)
List all the completed snapshots matching the given pattern.
- + List<SnapshotDescription> listSnapshots(String regex)
List all the completed snapshots matching the given regular expression.
- + 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<SnapshotDescription> listTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern) @@ -857,7 +870,7 @@ extends + List<SnapshotDescription> listTableSnapshots(String tableNameRegex, String snapshotNameRegex) @@ -865,20 +878,20 @@ extends + void majorCompact(TableName tableName)
Major compact a table.
- + void majorCompact(TableName tableName, byte[] columnFamily)
Major compact a column family within a table.
- + void majorCompact(TableName tableName, byte[] columnFamily, @@ -886,27 +899,27 @@ extends Major compact a column family within a table. - + void majorCompact(TableName tableName, CompactType compactType)
Major compact a table.
- + void majorCompactRegion(byte[] regionName)
Major compact a table or an individual region.
- + void majorCompactRegion(byte[] regionName, byte[] columnFamily)
Major compact a column family within region.
- + void mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, @@ -917,7 +930,7 @@ extends + Future<Void> mergeRegionsAsync(byte[] nameOfRegionA, byte[] nameOfRegionB, @@ -925,7 +938,7 @@ extends Merge two regions. - + void modifyColumn(TableName tableName, HColumnDescriptor columnFamily) @@ -937,129 +950,129 @@ extends + void modifyColumnFamily(TableName tableName, HColumnDescriptor columnFamily)
Modify an existing column family on a table.
- + Future<Void> modifyColumnFamilyAsync(TableName tableName, HColumnDescriptor columnFamily)
Modify an existing column family on a table.
- + void modifyNamespace(NamespaceDescriptor descriptor)
Modify an existing namespace.
- + Future<Void> modifyNamespaceAsync(NamespaceDescriptor descriptor)
Modify an existing namespace
- + void modifyTable(TableName tableName, HTableDescriptor htd)
Modify an existing table, more IRB friendly version.
- + Future<Void> modifyTableAsync(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.
- + Future<Void> restoreSnapshotAsync(String snapshotName)
Restore the specified snapshot on the original table.
- + void rollWALWriter(ServerName serverName)
Roll the log writer.
- + int runCatalogScan()
Ask for a scan of the catalog table
- + boolean setBalancerRunning(boolean on, boolean synchronous)
Turn the load balancer on or off.
- + 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, @@ -1067,33 +1080,33 @@ extends Turn the Split or Merge switches on or off. - + void shutdown()
Shuts down the HBase cluster
- + void snapshot(byte[] snapshotName, TableName tableName)
Create a timestamp consistent snapshot for the given table.
- + void snapshot(SnapshotDescription snapshot)
Take a snapshot and wait for the server to complete that snapshot (blocking).
- + void snapshot(String snapshotName, TableName tableName)
Take a snapshot for the given table.
- + void snapshot(String snapshotName, TableName tableName, @@ -1101,84 +1114,84 @@ extends Create typed snapshot of the table. - + 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(TableName tableName)  - + void takeSnapshotAsync(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.
- + Future<Void> truncateTableAsync(TableName tableName, boolean preserveSplits)
Truncate the table but does not block and wait for it be completely enabled.
- + void unassign(byte[] regionName, boolean force)
Unassign a region from current hosting regionserver.
- + void updateConfiguration()
Update the configuration and trigger an online config change on all the regionservers
- + void updateConfiguration(ServerName server)
Update the configuration and trigger an online config change @@ -1206,7 +1219,7 @@ extends
  • getOperationTimeout

    -
    int getOperationTimeout()
    +
    int getOperationTimeout()
  • @@ -1215,7 +1228,7 @@ extends
  • abort

    -
    void abort(String why,
    +
    void abort(String why,
                Throwable e)
    Description copied from interface: Abortable
    Abort the server or client.
    @@ -1234,7 +1247,7 @@ extends
  • isAborted

    -
    boolean isAborted()
    +
    boolean isAborted()
    Description copied from interface: Abortable
    Check if the server or client was aborted.
    @@ -1251,7 +1264,7 @@ extends
  • getConnection

    -
    Connection getConnection()
    +
    Connection getConnection()
    Returns:
    Connection used by this object.
    @@ -1264,7 +1277,7 @@ extends
  • tableExists

    -
    boolean tableExists(TableName tableName)
    +
    boolean tableExists(TableName tableName)
                  throws IOException
    Parameters:
    @@ -1282,7 +1295,7 @@ extends
  • listTables

    -
    HTableDescriptor[] listTables()
    +
    HTableDescriptor[] listTables()
                            throws IOException
    List all the userspace tables.
    @@ -1299,7 +1312,7 @@ extends
  • listTables

    -
    HTableDescriptor[] listTables(Pattern pattern)
    +
    HTableDescriptor[] listTables(Pattern pattern)
                            throws IOException
    List all the userspace tables matching the given pattern.
    @@ -1320,7 +1333,7 @@ extends
  • listTables

    -
    HTableDescriptor[] listTables(String regex)
    +
    HTableDescriptor[] listTables(String regex)
                            throws IOException
    List all the userspace tables matching the given regular expression.
    @@ -1341,7 +1354,7 @@ extends
  • listTables

    -
    HTableDescriptor[] listTables(Pattern pattern,
    +
    HTableDescriptor[] listTables(Pattern pattern,
                                   boolean includeSysTables)
                            throws IOException
    List all the tables matching the given pattern.
    @@ -1364,7 +1377,7 @@ extends
  • listTables

    -
    HTableDescriptor[] listTables(String regex,
    +
    HTableDescriptor[] listTables(String regex,
                                   boolean includeSysTables)
                            throws IOException
    List all the tables matching the given pattern.
    @@ -1387,7 +1400,7 @@ extends
  • listTableNames

    -
    TableName[] listTableNames()
    +
    TableName[] listTableNames()
                         throws IOException
    List all of the names of userspace tables.
    @@ -1404,7 +1417,7 @@ extends
  • listTableNames

    -
    TableName[] listTableNames(Pattern pattern)
    +
    TableName[] listTableNames(Pattern pattern)
                         throws IOException
    List all of the names of userspace tables.
    @@ -1423,7 +1436,7 @@ extends
  • listTableNames

    -
    TableName[] listTableNames(String regex)
    +
    TableName[] listTableNames(String regex)
                         throws IOException
    List all of the names of userspace tables.
    @@ -1442,7 +1455,7 @@ extends
  • listTableNames

    -
    TableName[] listTableNames(Pattern pattern,
    +
    TableName[] listTableNames(Pattern pattern,
                                boolean includeSysTables)
                         throws IOException
    List all of the names of userspace tables.
    @@ -1463,7 +1476,7 @@ extends
  • listTableNames

    -
    TableName[] listTableNames(String regex,
    +
    TableName[] listTableNames(String regex,
                                boolean includeSysTables)
                         throws IOException
    List all of the names of userspace tables.
    @@ -1484,7 +1497,7 @@ extends
  • getTableDescriptor

    -
    HTableDescriptor getTableDescriptor(TableName tableName)
    +
    HTableDescriptor getTableDescriptor(TableName tableName)
                                  throws TableNotFoundException,
                                         IOException
    Method for getting the tableDescriptor
    @@ -1505,7 +1518,7 @@ extends
  • createTable

    -
    void createTable(HTableDescriptor desc)
    +
    void createTable(HTableDescriptor desc)
               throws IOException
    Creates a new table. Synchronous operation.
    @@ -1526,7 +1539,7 @@ extends
  • createTable

    -
    void createTable(HTableDescriptor desc,
    +
    void createTable(HTableDescriptor desc,
                      byte[] startKey,
                      byte[] endKey,
                      int numRegions)
    @@ -1557,7 +1570,7 @@ extends 
     
  • createTable

    -
    void createTable(HTableDescriptor desc,
    +
    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. @@ -1583,7 +1596,7 @@ extends
  • createTableAsync

    -
    Future<VoidcreateTableAsync(HTableDescriptor desc,
    +
    Future<VoidcreateTableAsync(HTableDescriptor desc,
                                   byte[][] splitKeys)
                            throws IOException
    Creates a new table but does not block and wait for it to come online. @@ -1611,7 +1624,7 @@ extends
  • deleteTable

    -
    void deleteTable(TableName tableName)
    +
    void deleteTable(TableName tableName)
               throws IOException
    Deletes a table. Synchronous operation.
    @@ -1628,7 +1641,7 @@ extends
  • deleteTableAsync

    -
    Future<VoiddeleteTableAsync(TableName tableName)
    +
    Future<VoiddeleteTableAsync(TableName tableName)
                            throws IOException
    Deletes the table 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. @@ -1652,7 +1665,7 @@ extends
  • deleteTables

    -
    HTableDescriptor[] deleteTables(String regex)
    +
    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(org.apache.hadoop.hbase.TableName)
    @@ -1675,7 +1688,7 @@ extends
  • deleteTables

    -
    HTableDescriptor[] deleteTables(Pattern pattern)
    +
    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 @@ -1696,7 +1709,7 @@ extends
  • truncateTable

    -
    void truncateTable(TableName tableName,
    +
    void truncateTable(TableName tableName,
                        boolean preserveSplits)
                 throws IOException
    Truncate a table. @@ -1716,7 +1729,7 @@ extends
  • truncateTableAsync

    -
    Future<VoidtruncateTableAsync(TableName tableName,
    +
    Future<VoidtruncateTableAsync(TableName tableName,
                                     boolean preserveSplits)
                              throws IOException
    Truncate the table but does not block and wait for it be completely enabled. You can use @@ -1741,7 +1754,7 @@ extends
  • enableTable

    -
    void enableTable(TableName tableName)
    +
    void enableTable(TableName tableName)
               throws IOException
    Enable a table. May timeout. Use enableTableAsync(org.apache.hadoop.hbase.TableName) and isTableEnabled(org.apache.hadoop.hbase.TableName) instead. The table has to be in @@ -1766,7 +1779,7 @@ extends
  • enableTableAsync

    -
    Future<