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 CB1C6200D42 for ; Fri, 17 Nov 2017 16:22:40 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id C9D6C160C0A; Fri, 17 Nov 2017 15:22:40 +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 5F8FA160C0B for ; Fri, 17 Nov 2017 16:22:38 +0100 (CET) Received: (qmail 26982 invoked by uid 500); 17 Nov 2017 15:22:37 -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 26656 invoked by uid 99); 17 Nov 2017 15:22:37 -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; Fri, 17 Nov 2017 15:22:37 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id F0CE0F5F38; Fri, 17 Nov 2017 15:22:35 +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: Fri, 17 Nov 2017 15:22:56 -0000 Message-Id: In-Reply-To: <92e792aed0034c20b8a89fb0daf921ca@git.apache.org> References: <92e792aed0034c20b8a89fb0daf921ca@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [22/51] [partial] hbase-site git commit: Published site at . archived-at: Fri, 17 Nov 2017 15:22:41 -0000 http://git-wip-us.apache.org/repos/asf/hbase-site/blob/e60b829c/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html index b189369..063cf50 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html @@ -34,2491 +34,2624 @@ 026import java.util.List; 027import java.util.Map; 028import java.util.Set; -029import java.util.concurrent.Future; -030import java.util.regex.Pattern; -031 -032import org.apache.hadoop.conf.Configuration; -033import org.apache.hadoop.hbase.Abortable; -034import org.apache.hadoop.hbase.CacheEvictionStats; -035import org.apache.hadoop.hbase.ClusterStatus; -036import org.apache.hadoop.hbase.ClusterStatus.Option; -037import org.apache.hadoop.hbase.HRegionInfo; -038import org.apache.hadoop.hbase.HTableDescriptor; -039import org.apache.hadoop.hbase.NamespaceDescriptor; -040import org.apache.hadoop.hbase.NamespaceNotFoundException; -041import org.apache.hadoop.hbase.RegionLoad; -042import org.apache.hadoop.hbase.ServerName; -043import org.apache.hadoop.hbase.TableExistsException; -044import org.apache.hadoop.hbase.TableName; -045import org.apache.hadoop.hbase.TableNotFoundException; -046import org.apache.yetus.audience.InterfaceAudience; -047import org.apache.hadoop.hbase.client.replication.TableCFs; -048import org.apache.hadoop.hbase.client.security.SecurityCapability; -049import org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel; -050import org.apache.hadoop.hbase.quotas.QuotaFilter; -051import org.apache.hadoop.hbase.quotas.QuotaRetriever; -052import org.apache.hadoop.hbase.quotas.QuotaSettings; -053import org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException; -054import org.apache.hadoop.hbase.replication.ReplicationException; -055import org.apache.hadoop.hbase.replication.ReplicationPeerConfig; -056import org.apache.hadoop.hbase.replication.ReplicationPeerDescription; -057import org.apache.hadoop.hbase.snapshot.HBaseSnapshotException; -058import org.apache.hadoop.hbase.snapshot.RestoreSnapshotException; -059import org.apache.hadoop.hbase.snapshot.SnapshotCreationException; -060import org.apache.hadoop.hbase.snapshot.UnknownSnapshotException; -061import org.apache.hadoop.hbase.util.Pair; -062 -063/** -064 * The administrative API for HBase. Obtain an instance from {@link Connection#getAdmin()} and -065 * call {@link #close()} when done. -066 * <p>Admin can be used to create, drop, list, enable and disable and otherwise modify tables, -067 * as well as perform other administrative operations. -068 * -069 * @see ConnectionFactory -070 * @see Connection -071 * @see Table -072 * @since 0.99.0 -073 */ -074@InterfaceAudience.Public -075public interface Admin extends Abortable, Closeable { -076 int getOperationTimeout(); -077 -078 @Override -079 void abort(String why, Throwable e); -080 -081 @Override -082 boolean isAborted(); -083 -084 /** -085 * @return Connection used by this object. -086 */ -087 Connection getConnection(); -088 -089 /** -090 * @param tableName Table to check. -091 * @return <code>true</code> if table exists already. -092 * @throws IOException -093 */ -094 boolean tableExists(TableName tableName) throws IOException; -095 -096 /** -097 * List all the userspace tables. -098 * -099 * @return an array of read-only HTableDescriptors -100 * @throws IOException if a remote or network exception occurs -101 * @deprecated since 2.0 version and will be removed in 3.0 version. -102 * Use {@link #listTableDescriptors()}. -103 * @see #listTableDescriptors() -104 */ -105 @Deprecated -106 HTableDescriptor[] listTables() throws IOException; -107 -108 /** -109 * List all the userspace tables. -110 * -111 * @return a list of TableDescriptors -112 * @throws IOException if a remote or network exception occurs -113 */ -114 List<TableDescriptor> listTableDescriptors() throws IOException; -115 -116 /** -117 * List all the userspace tables that match the given pattern. -118 * -119 * @param pattern The compiled regular expression to match against -120 * @return an array of read-only HTableDescriptors -121 * @throws IOException if a remote or network exception occurs -122 * @see #listTables() -123 * @deprecated since 2.0 version and will be removed in 3.0 version. -124 * Use {@link #listTableDescriptors(java.util.regex.Pattern)}. -125 * @see #listTableDescriptors(Pattern) -126 */ -127 @Deprecated -128 HTableDescriptor[] listTables(Pattern pattern) throws IOException; -129 -130 /** -131 * List all the userspace tables that match the given pattern. -132 * -133 * @param pattern The compiled regular expression to match against -134 * @return a list of TableDescriptors -135 * @throws IOException if a remote or network exception occurs -136 * @see #listTables() -137 */ -138 List<TableDescriptor> listTableDescriptors(Pattern pattern) throws IOException; -139 -140 /** -141 * List all the userspace tables matching the given regular expression. -142 * -143 * @param regex The regular expression to match against -144 * @return a list of read-only HTableDescriptors -145 * @throws IOException if a remote or network exception occurs -146 * @see #listTableDescriptors(Pattern) -147 * @deprecated since 2.0 version and will be removed in 3.0 version. Use -148 * {@link #listTableDescriptors(Pattern)} instead. -149 */ -150 @Deprecated -151 HTableDescriptor[] listTables(String regex) throws IOException; -152 -153 /** -154 * List all the tables matching the given pattern. -155 * -156 * @param pattern The compiled regular expression to match against -157 * @param includeSysTables <code>false</code> to match only against userspace tables -158 * @return an array of read-only HTableDescriptors -159 * @throws IOException if a remote or network exception occurs -160 * @see #listTables() -161 * @deprecated since 2.0 version and will be removed in 3.0 version. -162 * Use {@link #listTableDescriptors(java.util.regex.Pattern, boolean)}. -163 * @see #listTableDescriptors(java.util.regex.Pattern, boolean) -164 */ -165 @Deprecated -166 HTableDescriptor[] listTables(Pattern pattern, boolean includeSysTables) -167 throws IOException; -168 -169 /** -170 * List all the tables matching the given pattern. -171 * -172 * @param pattern The compiled regular expression to match against -173 * @param includeSysTables <code>false</code> to match only against userspace tables -174 * @return a list of TableDescriptors -175 * @throws IOException if a remote or network exception occurs -176 * @see #listTables() -177 */ -178 List<TableDescriptor> listTableDescriptors(Pattern pattern, boolean includeSysTables) -179 throws IOException; -180 -181 /** -182 * List all the tables matching the given pattern. -183 * -184 * @param regex The regular expression to match against -185 * @param includeSysTables <code>false</code> to match only against userspace tables -186 * @return an array of read-only HTableDescriptors -187 * @throws IOException if a remote or network exception occurs -188 * @see #listTables(java.util.regex.Pattern, boolean) -189 * @deprecated since 2.0 version and will be removed in 3.0 version. -190 * Use {@link #listTableDescriptors(Pattern, boolean)}. -191 */ -192 @Deprecated -193 HTableDescriptor[] listTables(String regex, boolean includeSysTables) -194 throws IOException; -195 -196 /** -197 * List all of the names of userspace tables. -198 * -199 * @return TableName[] table names -200 * @throws IOException if a remote or network exception occurs -201 */ -202 TableName[] listTableNames() throws IOException; -203 -204 /** -205 * List all of the names of userspace tables. -206 * @param pattern The regular expression to match against -207 * @return array of table names -208 * @throws IOException if a remote or network exception occurs -209 */ -210 TableName[] listTableNames(Pattern pattern) throws IOException; -211 -212 /** -213 * List all of the names of userspace tables. -214 * @param regex The regular expression to match against -215 * @return TableName[] table names -216 * @throws IOException if a remote or network exception occurs -217 * @deprecated since 2.0 version and will be removed in 3.0 version. Use -218 * {@link #listTableNames(Pattern)} instead. -219 */ -220 @Deprecated -221 TableName[] listTableNames(String regex) throws IOException; -222 -223 /** -224 * List all of the names of userspace tables. -225 * @param pattern The regular expression to match against -226 * @param includeSysTables <code>false</code> to match only against userspace tables -227 * @return TableName[] table names -228 * @throws IOException if a remote or network exception occurs -229 */ -230 TableName[] listTableNames(Pattern pattern, boolean includeSysTables) -231 throws IOException; -232 -233 /** -234 * List all of the names of userspace tables. -235 * @param regex The regular expression to match against -236 * @param includeSysTables <code>false</code> to match only against userspace tables -237 * @return TableName[] table names -238 * @throws IOException if a remote or network exception occurs -239 * @deprecated since 2.0 version and will be removed in 3.0 version. Use -240 * {@link #listTableNames(Pattern, boolean)} instead. -241 */ -242 @Deprecated -243 TableName[] listTableNames(String regex, boolean includeSysTables) -244 throws IOException; -245 -246 /** -247 * Get a table descriptor. -248 * -249 * @param tableName as a {@link TableName} -250 * @return the read-only tableDescriptor -251 * @throws org.apache.hadoop.hbase.TableNotFoundException -252 * @throws IOException if a remote or network exception occurs -253 * @deprecated since 2.0 version and will be removed in 3.0 version. -254 * Use {@link #getDescriptor(TableName)}. -255 */ -256 @Deprecated -257 HTableDescriptor getTableDescriptor(TableName tableName) -258 throws TableNotFoundException, IOException; -259 -260 /** -261 * Get a table descriptor. -262 * -263 * @param tableName as a {@link TableName} -264 * @return the tableDescriptor -265 * @throws org.apache.hadoop.hbase.TableNotFoundException -266 * @throws IOException if a remote or network exception occurs -267 */ -268 TableDescriptor getDescriptor(TableName tableName) -269 throws TableNotFoundException, IOException; -270 -271 /** -272 * Creates a new table. Synchronous operation. -273 * -274 * @param desc table descriptor for table -275 * @throws IllegalArgumentException if the table name is reserved -276 * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running -277 * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent -278 * threads, the table may have been created between test-for-existence and attempt-at-creation). -279 * @throws IOException if a remote or network exception occurs -280 */ -281 void createTable(TableDescriptor desc) throws IOException; -282 -283 /** -284 * Creates a new table with the specified number of regions. The start key specified will become -285 * the end key of the first region of the table, and the end key specified will become the start -286 * key of the last region of the table (the first region has a null start key and the last region -287 * has a null end key). BigInteger math will be used to divide the key range specified into enough -288 * segments to make the required number of total regions. Synchronous operation. -289 * -290 * @param desc table descriptor for table -291 * @param startKey beginning of key range -292 * @param endKey end of key range -293 * @param numRegions the total number of regions to create -294 * @throws IllegalArgumentException if the table name is reserved -295 * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running -296 * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent -297 * threads, the table may have been created between test-for-existence and attempt-at-creation). -298 * @throws IOException -299 */ -300 void createTable(TableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions) -301 throws IOException; -302 -303 /** -304 * Creates a new table with an initial set of empty regions defined by the specified split keys. -305 * The total number of regions created will be the number of split keys plus one. Synchronous -306 * operation. Note : Avoid passing empty split key. -307 * -308 * @param desc table descriptor for table -309 * @param splitKeys array of split keys for the initial regions of the table -310 * @throws IllegalArgumentException if the table name is reserved, if the split keys are repeated -311 * and if the split key has empty byte array. -312 * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running -313 * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent -314 * threads, the table may have been created between test-for-existence and attempt-at-creation). -315 * @throws IOException -316 */ -317 void createTable(TableDescriptor desc, byte[][] splitKeys) throws IOException; -318 -319 /** -320 * Creates a new table but does not block and wait for it to come online. -321 * You can use Future.get(long, TimeUnit) to wait on the operation to complete. -322 * It may throw ExecutionException if there was an error while executing the operation -323 * or TimeoutException in case the wait timeout was not long enough to allow the -324 * operation to complete. -325 * Throws IllegalArgumentException Bad table name, if the split keys -326 * are repeated and if the split key has empty byte array. -327 * -328 * @param desc table descriptor for table -329 * @param splitKeys keys to check if the table has been created with all split keys -330 * @throws IOException if a remote or network exception occurs -331 * @return the result of the async creation. You can use Future.get(long, TimeUnit) -332 * to wait on the operation to complete. -333 */ -334 Future<Void> createTableAsync(TableDescriptor desc, byte[][] splitKeys) -335 throws IOException; -336 -337 /** -338 * Deletes a table. Synchronous operation. -339 * -340 * @param tableName name of table to delete -341 * @throws IOException if a remote or network exception occurs -342 */ -343 void deleteTable(TableName tableName) throws IOException; -344 -345 /** -346 * Deletes the table but does not block and wait for it to be completely removed. -347 * You can use Future.get(long, TimeUnit) to wait on the operation to complete. -348 * It may throw ExecutionException if there was an error while executing the operation -349 * or TimeoutException in case the wait timeout was not long enough to allow the -350 * operation to complete. -351 * -352 * @param tableName name of table to delete -353 * @throws IOException if a remote or network exception occurs -354 * @return the result of the async delete. You can use Future.get(long, TimeUnit) -355 * to wait on the operation to complete. -356 */ -357 Future<Void> deleteTableAsync(TableName tableName) throws IOException; -358 -359 /** -360 * Deletes tables matching the passed in pattern and wait on completion. Warning: Use this method -361 * carefully, there is no prompting and the effect is immediate. Consider using {@link -362 * #listTableDescriptors(Pattern)} -363 * and {@link #deleteTable(org.apache.hadoop.hbase.TableName)} -364 * -365 * @param regex The regular expression to match table names against -366 * @return Table descriptors for tables that couldn't be deleted. -367 * The return htds are read-only -368 * @throws IOException -369 * @see #deleteTables(java.util.regex.Pattern) -370 * @see #deleteTable(org.apache.hadoop.hbase.TableName) -371 * @deprecated since 2.0 version and will be removed in 3.0 version -372 * This is just a trivial helper method without any magic. -373 * Consider using {@link #listTableDescriptors(Pattern)} -374 * and {@link #deleteTable(TableName)} -375 */ -376 @Deprecated -377 HTableDescriptor[] deleteTables(String regex) throws IOException; -378 -379 /** -380 * Delete tables matching the passed in pattern and wait on completion. Warning: Use this method -381 * carefully, there is no prompting and the effect is immediate. Consider using {@link -382 * #listTableDescriptors(java.util.regex.Pattern)} and -383 * {@link #deleteTable(org.apache.hadoop.hbase.TableName)} -384 * -385 * @param pattern The pattern to match table names against -386 * @return Table descriptors for tables that couldn't be deleted -387 * The return htds are read-only -388 * @throws IOException -389 * @deprecated since 2.0 version and will be removed in 3.0 version -390 * This is just a trivial helper method without any magic. -391 * Consider using {@link #listTableDescriptors(java.util.regex.Pattern)} -392 * and {@link #deleteTable(TableName)} -393 */ -394 @Deprecated -395 HTableDescriptor[] deleteTables(Pattern pattern) throws IOException; -396 -397 /** -398 * Truncate a table. -399 * Synchronous operation. -400 * -401 * @param tableName name of table to truncate -402 * @param preserveSplits <code>true</code> if the splits should be preserved -403 * @throws IOException if a remote or network exception occurs -404 */ -405 void truncateTable(TableName tableName, boolean preserveSplits) -406 throws IOException; -407 -408 /** -409 * Truncate the table but does not block and wait for it to be completely enabled. You can use -410 * Future.get(long, TimeUnit) to wait on the operation to complete. It may throw -411 * ExecutionException if there was an error while executing the operation or TimeoutException in -412 * case the wait timeout was not long enough to allow the operation to complete. -413 * @param tableName name of table to delete -414 * @param preserveSplits <code>true</code> if the splits should be preserved -415 * @throws IOException if a remote or network exception occurs -416 * @return the result of the async truncate. You can use Future.get(long, TimeUnit) to wait on the -417 * operation to complete. -418 */ -419 Future<Void> truncateTableAsync(TableName tableName, boolean preserveSplits) -420 throws IOException; -421 -422 /** -423 * Enable a table. May timeout. Use {@link #enableTableAsync(org.apache.hadoop.hbase.TableName)} -424 * and {@link #isTableEnabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in -425 * disabled state for it to be enabled. -426 * -427 * @param tableName name of the table -428 * @throws IOException if a remote or network exception occurs There could be couple types of -429 * IOException TableNotFoundException means the table doesn't exist. TableNotDisabledException -430 * means the table isn't in disabled state. -431 * @see #isTableEnabled(org.apache.hadoop.hbase.TableName) -432 * @see #disableTable(org.apache.hadoop.hbase.TableName) -433 * @see #enableTableAsync(org.apache.hadoop.hbase.TableName) -434 */ -435 void enableTable(TableName tableName) throws IOException; -436 -437 /** -438 * Enable the table but does not block and wait for it to be completely enabled. -439 * You can use Future.get(long, TimeUnit) to wait on the operation to complete. -440 * It may throw ExecutionException if there was an error while executing the operation -441 * or TimeoutException in case the wait timeout was not long enough to allow the -442 * operation to complete. -443 * -444 * @param tableName name of table to delete -445 * @throws IOException if a remote or network exception occurs -446 * @return the result of the async enable. You can use Future.get(long, TimeUnit) -447 * to wait on the operation to complete. -448 */ -449 Future<Void> enableTableAsync(TableName tableName) throws IOException; -450 -451 /** -452 * Enable tables matching the passed in pattern and wait on completion. Warning: Use this method -453 * carefully, there is no prompting and the effect is immediate. Consider using {@link -454 * #listTableDescriptors(Pattern)} and {@link #enableTable(org.apache.hadoop.hbase.TableName)} -455 * -456 * @param regex The regular expression to match table names against -457 * @throws IOException -458 * @return Table descriptors for tables that couldn't be enabled. -459 * The return HTDs are read-only. -460 * @see #enableTables(java.util.regex.Pattern) -461 * @see #enableTable(org.apache.hadoop.hbase.TableName) -462 * @deprecated since 2.0 version and will be removed in 3.0 version -463 * This is just a trivial helper method without any magic. -464 * Consider using {@link #listTableDescriptors(Pattern)} -465 * and {@link #enableTable(org.apache.hadoop.hbase.TableName)} -466 */ -467 @Deprecated -468 HTableDescriptor[] enableTables(String regex) throws IOException; -469 -470 /** -471 * Enable tables matching the passed in pattern and wait on completion. Warning: Use this method -472 * carefully, there is no prompting and the effect is immediate. Consider using {@link -473 * #listTableDescriptors(java.util.regex.Pattern)} and -474 * {@link #enableTable(org.apache.hadoop.hbase.TableName)} -475 * -476 * @param pattern The pattern to match table names against -477 * @throws IOException -478 * @return Table descriptors for tables that couldn't be enabled. -479 * The return HTDs are read-only. -480 * @deprecated since 2.0 version and will be removed in 3.0 version -481 * This is just a trivial helper method without any magic. -482 * Consider using {@link #listTableDescriptors(java.util.regex.Pattern)} -483 * and {@link #enableTable(org.apache.hadoop.hbase.TableName)} -484 */ -485 @Deprecated -486 HTableDescriptor[] enableTables(Pattern pattern) throws IOException; -487 -488 /** -489 * Disable the table but does not block and wait for it to be completely disabled. -490 * You can use Future.get(long, TimeUnit) to wait on the operation to complete. -491 * It may throw ExecutionException if there was an error while executing the operation -492 * or TimeoutException in case the wait timeout was not long enough to allow the -493 * operation to complete. -494 * -495 * @param tableName name of table to delete -496 * @throws IOException if a remote or network exception occurs -497 * @return the result of the async disable. You can use Future.get(long, TimeUnit) -498 * to wait on the operation to complete. -499 */ -500 Future<Void> disableTableAsync(TableName tableName) throws IOException; -501 -502 /** -503 * Disable table and wait on completion. May timeout eventually. Use {@link -504 * #disableTableAsync(org.apache.hadoop.hbase.TableName)} and -505 * {@link #isTableDisabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in -506 * enabled state for it to be disabled. -507 * -508 * @param tableName -509 * @throws IOException There could be couple types of IOException TableNotFoundException means the -510 * table doesn't exist. TableNotEnabledException means the table isn't in enabled state. -511 */ -512 void disableTable(TableName tableName) throws IOException; -513 -514 /** -515 * Disable tables matching the passed in pattern and wait on completion. Warning: Use this method -516 * carefully, there is no prompting and the effect is immediate. Consider using {@link -517 * #listTableDescriptors(Pattern)} and {@link #disableTable(org.apache.hadoop.hbase.TableName)} -518 * -519 * @param regex The regular expression to match table names against -520 * @return Table descriptors for tables that couldn't be disabled -521 * The return htds are read-only -522 * @throws IOException -523 * @see #disableTables(java.util.regex.Pattern) -524 * @see #disableTable(org.apache.hadoop.hbase.TableName) -525 * @deprecated since 2.0 version and will be removed in 3.0 version -526 * This is just a trivial helper method without any magic. -527 * Consider using {@link #listTableDescriptors(Pattern)} -528 * and {@link #disableTable(org.apache.hadoop.hbase.TableName)} -529 */ -530 @Deprecated -531 HTableDescriptor[] disableTables(String regex) throws IOException; -532 -533 /** -534 * Disable tables matching the passed in pattern and wait on completion. Warning: Use this method -535 * carefully, there is no prompting and the effect is immediate. Consider using {@link -536 * #listTableDescriptors(java.util.regex.Pattern)} and -537 * {@link #disableTable(org.apache.hadoop.hbase.TableName)} -538 * -539 * @param pattern The pattern to match table names against -540 * @return Table descriptors for tables that couldn't be disabled -541 * The return htds are read-only -542 * @throws IOException -543 * @deprecated since 2.0 version and will be removed in 3.0 version -544 * This is just a trivial helper method without any magic. -545 * Consider using {@link #listTableDescriptors(java.util.regex.Pattern)} -546 * and {@link #disableTable(org.apache.hadoop.hbase.TableName)} -547 */ -548 @Deprecated -549 HTableDescriptor[] disableTables(Pattern pattern) throws IOException; -550 -551 /** -552 * @param tableName name of table to check -553 * @return <code>true</code> if table is on-line -554 * @throws IOException if a remote or network exception occurs -555 */ -556 boolean isTableEnabled(TableName tableName) throws IOException; -557 -558 /** -559 * @param tableName name of table to check -560 * @return <code>true</code> if table is off-line -561 * @throws IOException if a remote or network exception occurs -562 */ -563 boolean isTableDisabled(TableName tableName) throws IOException; -564 -565 /** -566 * @param tableName name of table to check -567 * @return <code>true</code> if all regions of the table are available -568 * @throws IOException if a remote or network exception occurs -569 */ -570 boolean isTableAvailable(TableName tableName) throws IOException; -571 -572 /** -573 * Use this api to check if the table has been created with the specified number of splitkeys -574 * which was used while creating the given table. Note : If this api is used after a table's -575 * region gets splitted, the api may return <code>false</code>. -576 * -577 * @param tableName name of table to check -578 * @param splitKeys keys to check if the table has been created with all split keys -579 * @throws IOException if a remote or network excpetion occurs -580 * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #isTableAvailable(TableName)} -581 */ -582 @Deprecated -583 boolean isTableAvailable(TableName tableName, byte[][] splitKeys) throws IOException; -584 -585 /** -586 * Get the status of an <code>alter</code> (a.k.a <code>modify</code>) command - indicates how -587 * many regions have received the updated schema Asynchronous operation. -588 * -589 * @param tableName TableName instance -590 * @return Pair indicating the number of regions updated Pair.getFirst() is the regions that are -591 * yet to be updated Pair.getSecond() is the total number of regions of the table -592 * @throws IOException if a remote or network exception occurs -593 * @deprecated Since 2.0.0. Will be removed in 3.0.0. No longer needed now you get a Future -594 * on an operation. -595 */ -596 @Deprecated -597 Pair<Integer, Integer> getAlterStatus(TableName tableName) throws IOException; -598 -599 /** -600 * Get the status of <code>alter</code> (a.k.a <code>modify</code>) command - indicates how many -601 * regions have received the updated schema Asynchronous operation. -602 * -603 * @param tableName name of the table to get the status of -604 * @return Pair indicating the number of regions updated Pair.getFirst() is the regions that are -605 * yet to be updated Pair.getSecond() is the total number of regions of the table -606 * @throws IOException if a remote or network exception occurs -607 * @deprecated Since 2.0.0. Will be removed in 3.0.0. No longer needed now you get a Future -608 * on an operation. -609 */ -610 @Deprecated -611 Pair<Integer, Integer> getAlterStatus(byte[] tableName) throws IOException; -612 -613 /** -614 * Add a column family to an existing table. Synchronous operation. -615 * Use {@link #addColumnFamilyAsync(TableName, ColumnFamilyDescriptor)} instead because it -616 * returns a {@link Future} from which you can learn whether success or failure. -617 * -618 * @param tableName name of the table to add column family to -619 * @param columnFamily column family descriptor of column family to be added -620 * @throws IOException if a remote or network exception occurs -621 * @deprecated As of release 2.0.0. -622 * This will be removed in HBase 3.0.0. -623 * Use {@link #addColumnFamily(TableName, ColumnFamilyDescriptor)}. -624 */ -625 @Deprecated -626 default void addColumn(TableName tableName, ColumnFamilyDescriptor columnFamily) -627 throws IOException { -628 addColumnFamily(tableName, columnFamily); -629 } -630 -631 /** -632 * Add a column family to an existing table. Synchronous operation. -633 * Use {@link #addColumnFamilyAsync(TableName, ColumnFamilyDescriptor)} instead because it -634 * returns a {@link Future} from which you can learn whether success or failure. -635 * -636 * @param tableName name of the table to add column family to -637 * @param columnFamily column family descriptor of column family to be added -638 * @throws IOException if a remote or network exception occurs -639 */ -640 void addColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily) -641 throws IOException; -642 -643 /** -644 * Add a column family to an existing table. Asynchronous operation. -645 * You can use Future.get(long, TimeUnit) to wait on the operation to complete. -646 * It may throw ExecutionException if there was an error while executing the operation -647 * or TimeoutException in case the wait timeout was not long enough to allow the -648 * operation to complete. -649 * -650 * @param tableName name of the table to add column family to -651 * @param columnFamily column family descriptor of column family to be added -652 * @throws IOException if a remote or network exception occurs -653 * @return the result of the async add column family. You can use Future.get(long, TimeUnit) to -654 * wait on the operation to complete. -655 */ -656 Future<Void> addColumnFamilyAsync(TableName tableName, ColumnFamilyDescriptor columnFamily) -657 throws IOException; -658 -659 /** -660 * Delete a column family from a table. Synchronous operation. -661 * Use {@link #deleteColumnFamily(TableName, byte[])} instead because it -662 * returns a {@link Future} from which you can learn whether success or failure. -663 * -664 * @param tableName name of table -665 * @param columnFamily name of column family to be deleted -666 * @throws IOException if a remote or network exception occurs -667 * @deprecated As of release 2.0.0. -668 * This will be removed in HBase 3.0.0. -669 * Use {@link #deleteColumnFamily(TableName, byte[])}}. -670 */ -671 @Deprecated -672 void deleteColumn(TableName tableName, byte[] columnFamily) throws IOException; -673 -674 /** -675 * Delete a column family from a table. Synchronous operation. -676 * Use {@link #deleteColumnFamily(TableName, byte[])} instead because it -677 * returns a {@link Future} from which you can learn whether success or failure. -678 * @param tableName name of table -679 * @param columnFamily name of column family to be deleted -680 * @throws IOException if a remote or network exception occurs -681 */ -682 void deleteColumnFamily(TableName tableName, byte[] columnFamily) throws IOException; -683 -684 /** -685 * Delete a column family from a table. Asynchronous operation. -686 * You can use Future.get(long, TimeUnit) to wait on the operation to complete. -687 * It may throw ExecutionException if there was an error while executing the operation -688 * or TimeoutException in case the wait timeout was not long enough to allow the -689 * operation to complete. -690 * -691 * @param tableName name of table -692 * @param columnFamily name of column family to be deleted -693 * @throws IOException if a remote or network exception occurs -694 * @return the result of the async delete column family. You can use Future.get(long, TimeUnit) to -695 * wait on the operation to complete. -696 */ -697 Future<Void> deleteColumnFamilyAsync(TableName tableName, byte[] columnFamily) -698 throws IOException; -699 -700 /** -701 * Modify an existing column family on a table. Synchronous operation. -702 * Use {@link #modifyColumnFamilyAsync(TableName, ColumnFamilyDescriptor)} instead because it -703 * returns a {@link Future} from which you can learn whether success or failure. -704 * @param tableName name of table -705 * @param columnFamily new column family descriptor to use -706 * @throws IOException if a remote or network exception occurs -707 * @deprecated As of release 2.0.0. -708 * This will be removed in HBase 3.0.0. -709 * Use {@link #modifyColumnFamily(TableName, ColumnFamilyDescriptor)}. -710 */ -711 @Deprecated -712 default void modifyColumn(TableName tableName, ColumnFamilyDescriptor columnFamily) -713 throws IOException { -714 modifyColumnFamily(tableName, columnFamily); -715 } -716 -717 /** -718 * Modify an existing column family on a table. Synchronous operation. -719 * Use {@link #modifyColumnFamilyAsync(TableName, ColumnFamilyDescriptor)} instead because it -720 * returns a {@link Future} from which you can learn whether success or failure. -721 * @param tableName name of table -722 * @param columnFamily new column family descriptor to use -723 * @throws IOException if a remote or network exception occurs -724 */ -725 void modifyColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily) -726 throws IOException; -727 -728 /** -729 * Modify an existing column family on a table. Asynchronous operation. -730 * You can use Future.get(long, TimeUnit) to wait on the operation to complete. -731 * It may throw ExecutionException if there was an error while executing the operation -732 * or TimeoutException in case the wait timeout was not long enough to allow the -733 * operation to complete. -734 * -735 * @param tableName name of table -736 * @param columnFamily new column family descriptor to use -737 * @throws IOException if a remote or network exception occurs -738 * @return the result of the async modify column family. You can use Future.get(long, TimeUnit) to -739 * wait on the operation to complete. -740 */ -741 Future<Void> modifyColumnFamilyAsync(TableName tableName, ColumnFamilyDescriptor columnFamily) -742 throws IOException; -743 -744 /** -745 * Uses {@link #unassign(byte[], boolean)} to unassign the region. For expert-admins. -746 * -747 * @param regionname region name to close -748 * @param serverName Deprecated. Not used. -749 * @throws IOException if a remote or network exception occurs -750 * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. -751 * Use {@link #unassign(byte[], boolean)}. -752 */ -753 @Deprecated -754 void closeRegion(String regionname, String serverName) throws IOException; -755 -756 /** -757 * Uses {@link #unassign(byte[], boolean)} to unassign the region. For expert-admins. -758 * -759 * @param regionname region name to close -760 * @param serverName Deprecated. Not used. -761 * @throws IOException if a remote or network exception occurs -762 * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. -763 * Use {@link #unassign(byte[], boolean)}. -764 */ -765 @Deprecated -766 void closeRegion(byte[] regionname, String serverName) throws IOException; -767 -768 /** -769 * Uses {@link #unassign(byte[], boolean)} to unassign the region. For expert-admins. -770 * -771 * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name -772 * suffix: e.g. if regionname is -773 * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>, -774 * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>. -775 * @param serverName Deprecated. Not used. -776 * @return Deprecated. Returns <code>true</code> always. -777 * @throws IOException if a remote or network exception occurs -778 * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. -779 * Use {@link #unassign(byte[], boolean)}. -780 */ -781 @Deprecated -782 boolean closeRegionWithEncodedRegionName(String encodedRegionName, String serverName) -783 throws IOException; -784 -785 /** -786 * Used {@link #unassign(byte[], boolean)} to unassign the region. For expert-admins. -787 * -788 * @param sn Deprecated. Not used. -789 * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0 -790 * (<a href="https://issues.apache.org/jira/browse/HBASE-18231">HBASE-18231</a>). -791 * Use {@link #unassign(byte[], boolean)}. -792 */ -793 @Deprecated -794 void closeRegion(final ServerName sn, final HRegionInfo hri) throws IOException; -795 -796 /** -797 * Get all the online regions on a region server. -798 * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0 -799 * (<a href="https://issues.apache.org/jira/browse/HBASE-17980">HBASE-17980</a>). -800 * Use {@link #getRegions(ServerName sn)}. -801 */ -802 @Deprecated -803 List<HRegionInfo> getOnlineRegions(ServerName sn) throws IOException; -804 -805 /** -806 * Get all the online regions on a region server. -807 * -808 * @return List of {@link RegionInfo} -809 * @throws java.io.IOException -810 */ -811 List<RegionInfo> getRegions(ServerName serverName) throws IOException; -812 -813 /** -814 * Flush a table. Synchronous operation. -815 * -816 * @param tableName table to flush -817 * @throws IOException if a remote or network exception occurs -818 */ -819 void flush(TableName tableName) throws IOException; -820 -821 /** -822 * Flush an individual region. Synchronous operation. -823 * -824 * @param regionName region to flush -825 * @throws IOException if a remote or network exception occurs -826 */ -827 void flushRegion(byte[] regionName) throws IOException; -828 -829 /** -830 * Compact a table. Asynchronous operation in that this method requests that a -831 * Compaction run and then it returns. It does not wait on the completion of Compaction -832 * (it can take a while). -833 * -834 * @param tableName table to compact -835 * @throws IOException if a remote or network exception occurs -836 */ -837 void compact(TableName tableName) throws IOException; -838 -839 /** -840 * Compact an individual region. Asynchronous operation in that this method requests that a -841 * Compaction run and then it returns. It does not wait on the completion of Compaction -842 * (it can take a while). -843 * -844 * @param regionName region to compact -845 * @throws IOException if a remote or network exception occurs -846 */ -847 void compactRegion(byte[] regionName) throws IOException; -848 -849 /** -850 * Compact a column family within a table. Asynchronous operation in that this method requests -851 * that a Compaction run and then it returns. It does not wait on the completion of Compaction -852 * (it can take a while). -853 * -854 * @param tableName table to compact -855 * @param columnFamily column family within a table -856 * @throws IOException if a remote or network exception occurs -857 */ -858 void compact(TableName tableName, byte[] columnFamily) -859 throws IOException; -860 -861 /** -862 * Compact a column family within a region. Asynchronous operation in that this method requests -863 * that a Compaction run and then it returns. It does not wait on the completion of Compaction -864 * (it can take a while). -865 * -866 * @param regionName regi