http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1a616706/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html index 9d535df..92c1c97 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html @@ -507,259 +507,259 @@ <span class="sourceLineNo">499</span> * @param peerId a short name that identifies the peer<a name="line.499"></a> <span class="sourceLineNo">500</span> * @param peerConfig configuration for the replication slave cluster<a name="line.500"></a> <span class="sourceLineNo">501</span> */<a name="line.501"></a> -<span class="sourceLineNo">502</span> CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.502"></a> -<span class="sourceLineNo">503</span> ReplicationPeerConfig peerConfig);<a name="line.503"></a> -<span class="sourceLineNo">504</span><a name="line.504"></a> -<span class="sourceLineNo">505</span> /**<a name="line.505"></a> -<span class="sourceLineNo">506</span> * Remove a peer and stop the replication<a name="line.506"></a> -<span class="sourceLineNo">507</span> * @param peerId a short name that identifies the peer<a name="line.507"></a> -<span class="sourceLineNo">508</span> */<a name="line.508"></a> -<span class="sourceLineNo">509</span> CompletableFuture<Void> removeReplicationPeer(String peerId);<a name="line.509"></a> -<span class="sourceLineNo">510</span><a name="line.510"></a> -<span class="sourceLineNo">511</span> /**<a name="line.511"></a> -<span class="sourceLineNo">512</span> * Restart the replication stream to the specified peer<a name="line.512"></a> -<span class="sourceLineNo">513</span> * @param peerId a short name that identifies the peer<a name="line.513"></a> -<span class="sourceLineNo">514</span> */<a name="line.514"></a> -<span class="sourceLineNo">515</span> CompletableFuture<Void> enableReplicationPeer(String peerId);<a name="line.515"></a> -<span class="sourceLineNo">516</span><a name="line.516"></a> -<span class="sourceLineNo">517</span> /**<a name="line.517"></a> -<span class="sourceLineNo">518</span> * Stop the replication stream to the specified peer<a name="line.518"></a> -<span class="sourceLineNo">519</span> * @param peerId a short name that identifies the peer<a name="line.519"></a> -<span class="sourceLineNo">520</span> */<a name="line.520"></a> -<span class="sourceLineNo">521</span> CompletableFuture<Void> disableReplicationPeer(String peerId);<a name="line.521"></a> -<span class="sourceLineNo">522</span><a name="line.522"></a> -<span class="sourceLineNo">523</span> /**<a name="line.523"></a> -<span class="sourceLineNo">524</span> * Returns the configured ReplicationPeerConfig for the specified peer<a name="line.524"></a> -<span class="sourceLineNo">525</span> * @param peerId a short name that identifies the peer<a name="line.525"></a> -<span class="sourceLineNo">526</span> * @return ReplicationPeerConfig for the peer wrapped by a {@link CompletableFuture}.<a name="line.526"></a> -<span class="sourceLineNo">527</span> */<a name="line.527"></a> -<span class="sourceLineNo">528</span> CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId);<a name="line.528"></a> -<span class="sourceLineNo">529</span><a name="line.529"></a> -<span class="sourceLineNo">530</span> /**<a name="line.530"></a> -<span class="sourceLineNo">531</span> * Update the peerConfig for the specified peer<a name="line.531"></a> -<span class="sourceLineNo">532</span> * @param peerId a short name that identifies the peer<a name="line.532"></a> -<span class="sourceLineNo">533</span> * @param peerConfig new config for the peer<a name="line.533"></a> -<span class="sourceLineNo">534</span> */<a name="line.534"></a> -<span class="sourceLineNo">535</span> CompletableFuture<Void> updateReplicationPeerConfig(String peerId,<a name="line.535"></a> -<span class="sourceLineNo">536</span> ReplicationPeerConfig peerConfig);<a name="line.536"></a> -<span class="sourceLineNo">537</span><a name="line.537"></a> -<span class="sourceLineNo">538</span> /**<a name="line.538"></a> -<span class="sourceLineNo">539</span> * Append the replicable table-cf config of the specified peer<a name="line.539"></a> -<span class="sourceLineNo">540</span> * @param peerId a short that identifies the cluster<a name="line.540"></a> -<span class="sourceLineNo">541</span> * @param tableCfs A map from tableName to column family names<a name="line.541"></a> -<span class="sourceLineNo">542</span> */<a name="line.542"></a> -<span class="sourceLineNo">543</span> CompletableFuture<Void> appendReplicationPeerTableCFs(String peerId,<a name="line.543"></a> -<span class="sourceLineNo">544</span> Map<TableName, ? extends Collection<String>> tableCfs);<a name="line.544"></a> -<span class="sourceLineNo">545</span><a name="line.545"></a> -<span class="sourceLineNo">546</span> /**<a name="line.546"></a> -<span class="sourceLineNo">547</span> * Remove some table-cfs from config of the specified peer<a name="line.547"></a> -<span class="sourceLineNo">548</span> * @param peerId a short name that identifies the cluster<a name="line.548"></a> -<span class="sourceLineNo">549</span> * @param tableCfs A map from tableName to column family names<a name="line.549"></a> -<span class="sourceLineNo">550</span> */<a name="line.550"></a> -<span class="sourceLineNo">551</span> CompletableFuture<Void> removeReplicationPeerTableCFs(String peerId,<a name="line.551"></a> -<span class="sourceLineNo">552</span> Map<TableName, ? extends Collection<String>> tableCfs);<a name="line.552"></a> -<span class="sourceLineNo">553</span><a name="line.553"></a> -<span class="sourceLineNo">554</span> /**<a name="line.554"></a> -<span class="sourceLineNo">555</span> * Return a list of replication peers.<a name="line.555"></a> -<span class="sourceLineNo">556</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.556"></a> -<span class="sourceLineNo">557</span> * {@link CompletableFuture}.<a name="line.557"></a> -<span class="sourceLineNo">558</span> */<a name="line.558"></a> -<span class="sourceLineNo">559</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers();<a name="line.559"></a> -<span class="sourceLineNo">560</span><a name="line.560"></a> -<span class="sourceLineNo">561</span> /**<a name="line.561"></a> -<span class="sourceLineNo">562</span> * Return a list of replication peers.<a name="line.562"></a> -<span class="sourceLineNo">563</span> * @param pattern The compiled regular expression to match peer id<a name="line.563"></a> -<span class="sourceLineNo">564</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.564"></a> -<span class="sourceLineNo">565</span> * {@link CompletableFuture}.<a name="line.565"></a> -<span class="sourceLineNo">566</span> */<a name="line.566"></a> -<span class="sourceLineNo">567</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(Pattern pattern);<a name="line.567"></a> -<span class="sourceLineNo">568</span><a name="line.568"></a> -<span class="sourceLineNo">569</span> /**<a name="line.569"></a> -<span class="sourceLineNo">570</span> * Find all table and column families that are replicated from this cluster<a name="line.570"></a> -<span class="sourceLineNo">571</span> * @return the replicated table-cfs list of this cluster. The return value will be wrapped by a<a name="line.571"></a> -<span class="sourceLineNo">572</span> * {@link CompletableFuture}.<a name="line.572"></a> -<span class="sourceLineNo">573</span> */<a name="line.573"></a> -<span class="sourceLineNo">574</span> CompletableFuture<List<TableCFs>> listReplicatedTableCFs();<a name="line.574"></a> -<span class="sourceLineNo">575</span><a name="line.575"></a> -<span class="sourceLineNo">576</span> /**<a name="line.576"></a> -<span class="sourceLineNo">577</span> * Enable a table's replication switch.<a name="line.577"></a> -<span class="sourceLineNo">578</span> * @param tableName name of the table<a name="line.578"></a> -<span class="sourceLineNo">579</span> */<a name="line.579"></a> -<span class="sourceLineNo">580</span> CompletableFuture<Void> enableTableReplication(TableName tableName);<a name="line.580"></a> -<span class="sourceLineNo">581</span><a name="line.581"></a> -<span class="sourceLineNo">582</span> /**<a name="line.582"></a> -<span class="sourceLineNo">583</span> * Disable a table's replication switch.<a name="line.583"></a> -<span class="sourceLineNo">584</span> * @param tableName name of the table<a name="line.584"></a> -<span class="sourceLineNo">585</span> */<a name="line.585"></a> -<span class="sourceLineNo">586</span> CompletableFuture<Void> disableTableReplication(TableName tableName);<a name="line.586"></a> -<span class="sourceLineNo">587</span><a name="line.587"></a> -<span class="sourceLineNo">588</span> /**<a name="line.588"></a> -<span class="sourceLineNo">589</span> * Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be<a name="line.589"></a> -<span class="sourceLineNo">590</span> * taken. If the table is disabled, an offline snapshot is taken. Snapshots are considered unique<a name="line.590"></a> -<span class="sourceLineNo">591</span> * based on <b>the name of the snapshot</b>. Attempts to take a snapshot with the same name (even<a name="line.591"></a> -<span class="sourceLineNo">592</span> * a different type or with different parameters) will fail with a<a name="line.592"></a> -<span class="sourceLineNo">593</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.593"></a> -<span class="sourceLineNo">594</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.594"></a> -<span class="sourceLineNo">595</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.595"></a> -<span class="sourceLineNo">596</span> * @param snapshotName name of the snapshot to be created<a name="line.596"></a> -<span class="sourceLineNo">597</span> * @param tableName name of the table for which snapshot is created<a name="line.597"></a> -<span class="sourceLineNo">598</span> */<a name="line.598"></a> -<span class="sourceLineNo">599</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName) {<a name="line.599"></a> -<span class="sourceLineNo">600</span> return snapshot(snapshotName, tableName, SnapshotType.FLUSH);<a name="line.600"></a> -<span class="sourceLineNo">601</span> }<a name="line.601"></a> -<span class="sourceLineNo">602</span><a name="line.602"></a> -<span class="sourceLineNo">603</span> /**<a name="line.603"></a> -<span class="sourceLineNo">604</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.604"></a> -<span class="sourceLineNo">605</span> * snapshot</b>. Attempts to take a snapshot with the same name (even a different type or with<a name="line.605"></a> -<span class="sourceLineNo">606</span> * different parameters) will fail with a<a name="line.606"></a> -<span class="sourceLineNo">607</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.607"></a> -<span class="sourceLineNo">608</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.608"></a> -<span class="sourceLineNo">609</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.609"></a> -<span class="sourceLineNo">610</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.610"></a> -<span class="sourceLineNo">611</span> * snapshots stored on the cluster<a name="line.611"></a> -<span class="sourceLineNo">612</span> * @param tableName name of the table to snapshot<a name="line.612"></a> -<span class="sourceLineNo">613</span> * @param type type of snapshot to take<a name="line.613"></a> -<span class="sourceLineNo">614</span> */<a name="line.614"></a> -<span class="sourceLineNo">615</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName,<a name="line.615"></a> -<span class="sourceLineNo">616</span> SnapshotType type) {<a name="line.616"></a> -<span class="sourceLineNo">617</span> return snapshot(new SnapshotDescription(snapshotName, tableName, type));<a name="line.617"></a> -<span class="sourceLineNo">618</span> }<a name="line.618"></a> -<span class="sourceLineNo">619</span><a name="line.619"></a> -<span class="sourceLineNo">620</span> /**<a name="line.620"></a> -<span class="sourceLineNo">621</span> * Take a snapshot and wait for the server to complete that snapshot asynchronously. Only a single<a name="line.621"></a> -<span class="sourceLineNo">622</span> * snapshot should be taken at a time for an instance of HBase, or results may be undefined (you<a name="line.622"></a> -<span class="sourceLineNo">623</span> * can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a<a name="line.623"></a> -<span class="sourceLineNo">624</span> * single cluster). Snapshots are considered unique based on <b>the name of the snapshot</b>.<a name="line.624"></a> -<span class="sourceLineNo">625</span> * Attempts to take a snapshot with the same name (even a different type or with different<a name="line.625"></a> -<span class="sourceLineNo">626</span> * parameters) will fail with a {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException}<a name="line.626"></a> -<span class="sourceLineNo">627</span> * indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in<a name="line.627"></a> -<span class="sourceLineNo">628</span> * HBase. See {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.628"></a> -<span class="sourceLineNo">629</span> * You should probably use {@link #snapshot(String, org.apache.hadoop.hbase.TableName)} unless you<a name="line.629"></a> -<span class="sourceLineNo">630</span> * are sure about the type of snapshot that you want to take.<a name="line.630"></a> -<span class="sourceLineNo">631</span> * @param snapshot snapshot to take<a name="line.631"></a> -<span class="sourceLineNo">632</span> */<a name="line.632"></a> -<span class="sourceLineNo">633</span> CompletableFuture<Void> snapshot(SnapshotDescription snapshot);<a name="line.633"></a> -<span class="sourceLineNo">634</span><a name="line.634"></a> -<span class="sourceLineNo">635</span> /**<a name="line.635"></a> -<span class="sourceLineNo">636</span> * Check the current state of the passed snapshot. There are three possible states:<a name="line.636"></a> -<span class="sourceLineNo">637</span> * <ol><a name="line.637"></a> -<span class="sourceLineNo">638</span> * <li>running - returns <tt>false</tt></li><a name="line.638"></a> -<span class="sourceLineNo">639</span> * <li>finished - returns <tt>true</tt></li><a name="line.639"></a> -<span class="sourceLineNo">640</span> * <li>finished with error - throws the exception that caused the snapshot to fail</li><a name="line.640"></a> -<span class="sourceLineNo">641</span> * </ol><a name="line.641"></a> -<span class="sourceLineNo">642</span> * The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been<a name="line.642"></a> -<span class="sourceLineNo">643</span> * run/started since the snapshot you are checking, you will receive an<a name="line.643"></a> -<span class="sourceLineNo">644</span> * {@link org.apache.hadoop.hbase.snapshot.UnknownSnapshotException}.<a name="line.644"></a> -<span class="sourceLineNo">645</span> * @param snapshot description of the snapshot to check<a name="line.645"></a> -<span class="sourceLineNo">646</span> * @return <tt>true</tt> if the snapshot is completed, <tt>false</tt> if the snapshot is still<a name="line.646"></a> -<span class="sourceLineNo">647</span> * running<a name="line.647"></a> -<span class="sourceLineNo">648</span> */<a name="line.648"></a> -<span class="sourceLineNo">649</span> CompletableFuture<Boolean> isSnapshotFinished(SnapshotDescription snapshot);<a name="line.649"></a> -<span class="sourceLineNo">650</span><a name="line.650"></a> -<span class="sourceLineNo">651</span> /**<a name="line.651"></a> -<span class="sourceLineNo">652</span> * Restore the specified snapshot on the original table. (The table must be disabled) If the<a name="line.652"></a> -<span class="sourceLineNo">653</span> * "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a<a name="line.653"></a> -<span class="sourceLineNo">654</span> * snapshot of the current table is taken before executing the restore operation. In case of<a name="line.654"></a> -<span class="sourceLineNo">655</span> * restore failure, the failsafe snapshot will be restored. If the restore completes without<a name="line.655"></a> -<span class="sourceLineNo">656</span> * problem the failsafe snapshot is deleted.<a name="line.656"></a> -<span class="sourceLineNo">657</span> * @param snapshotName name of the snapshot to restore<a name="line.657"></a> -<span class="sourceLineNo">658</span> */<a name="line.658"></a> -<span class="sourceLineNo">659</span> CompletableFuture<Void> restoreSnapshot(String snapshotName);<a name="line.659"></a> -<span class="sourceLineNo">660</span><a name="line.660"></a> -<span class="sourceLineNo">661</span> /**<a name="line.661"></a> -<span class="sourceLineNo">662</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.662"></a> -<span class="sourceLineNo">663</span> * 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before<a name="line.663"></a> -<span class="sourceLineNo">664</span> * executing the restore operation. In case of restore failure, the failsafe snapshot will be<a name="line.664"></a> -<span class="sourceLineNo">665</span> * restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.665"></a> -<span class="sourceLineNo">666</span> * failsafe snapshot name is configurable by using the property<a name="line.666"></a> -<span class="sourceLineNo">667</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.667"></a> +<span class="sourceLineNo">502</span> default CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.502"></a> +<span class="sourceLineNo">503</span> ReplicationPeerConfig peerConfig) {<a name="line.503"></a> +<span class="sourceLineNo">504</span> return addReplicationPeer(peerId, peerConfig, true);<a name="line.504"></a> +<span class="sourceLineNo">505</span> }<a name="line.505"></a> +<span class="sourceLineNo">506</span><a name="line.506"></a> +<span class="sourceLineNo">507</span> /**<a name="line.507"></a> +<span class="sourceLineNo">508</span> * Add a new replication peer for replicating data to slave cluster<a name="line.508"></a> +<span class="sourceLineNo">509</span> * @param peerId a short name that identifies the peer<a name="line.509"></a> +<span class="sourceLineNo">510</span> * @param peerConfig configuration for the replication slave cluster<a name="line.510"></a> +<span class="sourceLineNo">511</span> * @param enabled peer state, true if ENABLED and false if DISABLED<a name="line.511"></a> +<span class="sourceLineNo">512</span> */<a name="line.512"></a> +<span class="sourceLineNo">513</span> CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.513"></a> +<span class="sourceLineNo">514</span> ReplicationPeerConfig peerConfig, boolean enabled);<a name="line.514"></a> +<span class="sourceLineNo">515</span><a name="line.515"></a> +<span class="sourceLineNo">516</span> /**<a name="line.516"></a> +<span class="sourceLineNo">517</span> * Remove a peer and stop the replication<a name="line.517"></a> +<span class="sourceLineNo">518</span> * @param peerId a short name that identifies the peer<a name="line.518"></a> +<span class="sourceLineNo">519</span> */<a name="line.519"></a> +<span class="sourceLineNo">520</span> CompletableFuture<Void> removeReplicationPeer(String peerId);<a name="line.520"></a> +<span class="sourceLineNo">521</span><a name="line.521"></a> +<span class="sourceLineNo">522</span> /**<a name="line.522"></a> +<span class="sourceLineNo">523</span> * Restart the replication stream to the specified peer<a name="line.523"></a> +<span class="sourceLineNo">524</span> * @param peerId a short name that identifies the peer<a name="line.524"></a> +<span class="sourceLineNo">525</span> */<a name="line.525"></a> +<span class="sourceLineNo">526</span> CompletableFuture<Void> enableReplicationPeer(String peerId);<a name="line.526"></a> +<span class="sourceLineNo">527</span><a name="line.527"></a> +<span class="sourceLineNo">528</span> /**<a name="line.528"></a> +<span class="sourceLineNo">529</span> * Stop the replication stream to the specified peer<a name="line.529"></a> +<span class="sourceLineNo">530</span> * @param peerId a short name that identifies the peer<a name="line.530"></a> +<span class="sourceLineNo">531</span> */<a name="line.531"></a> +<span class="sourceLineNo">532</span> CompletableFuture<Void> disableReplicationPeer(String peerId);<a name="line.532"></a> +<span class="sourceLineNo">533</span><a name="line.533"></a> +<span class="sourceLineNo">534</span> /**<a name="line.534"></a> +<span class="sourceLineNo">535</span> * Returns the configured ReplicationPeerConfig for the specified peer<a name="line.535"></a> +<span class="sourceLineNo">536</span> * @param peerId a short name that identifies the peer<a name="line.536"></a> +<span class="sourceLineNo">537</span> * @return ReplicationPeerConfig for the peer wrapped by a {@link CompletableFuture}.<a name="line.537"></a> +<span class="sourceLineNo">538</span> */<a name="line.538"></a> +<span class="sourceLineNo">539</span> CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId);<a name="line.539"></a> +<span class="sourceLineNo">540</span><a name="line.540"></a> +<span class="sourceLineNo">541</span> /**<a name="line.541"></a> +<span class="sourceLineNo">542</span> * Update the peerConfig for the specified peer<a name="line.542"></a> +<span class="sourceLineNo">543</span> * @param peerId a short name that identifies the peer<a name="line.543"></a> +<span class="sourceLineNo">544</span> * @param peerConfig new config for the peer<a name="line.544"></a> +<span class="sourceLineNo">545</span> */<a name="line.545"></a> +<span class="sourceLineNo">546</span> CompletableFuture<Void> updateReplicationPeerConfig(String peerId,<a name="line.546"></a> +<span class="sourceLineNo">547</span> ReplicationPeerConfig peerConfig);<a name="line.547"></a> +<span class="sourceLineNo">548</span><a name="line.548"></a> +<span class="sourceLineNo">549</span> /**<a name="line.549"></a> +<span class="sourceLineNo">550</span> * Append the replicable table-cf config of the specified peer<a name="line.550"></a> +<span class="sourceLineNo">551</span> * @param peerId a short that identifies the cluster<a name="line.551"></a> +<span class="sourceLineNo">552</span> * @param tableCfs A map from tableName to column family names<a name="line.552"></a> +<span class="sourceLineNo">553</span> */<a name="line.553"></a> +<span class="sourceLineNo">554</span> CompletableFuture<Void> appendReplicationPeerTableCFs(String peerId,<a name="line.554"></a> +<span class="sourceLineNo">555</span> Map<TableName, ? extends Collection<String>> tableCfs);<a name="line.555"></a> +<span class="sourceLineNo">556</span><a name="line.556"></a> +<span class="sourceLineNo">557</span> /**<a name="line.557"></a> +<span class="sourceLineNo">558</span> * Remove some table-cfs from config of the specified peer<a name="line.558"></a> +<span class="sourceLineNo">559</span> * @param peerId a short name that identifies the cluster<a name="line.559"></a> +<span class="sourceLineNo">560</span> * @param tableCfs A map from tableName to column family names<a name="line.560"></a> +<span class="sourceLineNo">561</span> */<a name="line.561"></a> +<span class="sourceLineNo">562</span> CompletableFuture<Void> removeReplicationPeerTableCFs(String peerId,<a name="line.562"></a> +<span class="sourceLineNo">563</span> Map<TableName, ? extends Collection<String>> tableCfs);<a name="line.563"></a> +<span class="sourceLineNo">564</span><a name="line.564"></a> +<span class="sourceLineNo">565</span> /**<a name="line.565"></a> +<span class="sourceLineNo">566</span> * Return a list of replication peers.<a name="line.566"></a> +<span class="sourceLineNo">567</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.567"></a> +<span class="sourceLineNo">568</span> * {@link CompletableFuture}.<a name="line.568"></a> +<span class="sourceLineNo">569</span> */<a name="line.569"></a> +<span class="sourceLineNo">570</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers();<a name="line.570"></a> +<span class="sourceLineNo">571</span><a name="line.571"></a> +<span class="sourceLineNo">572</span> /**<a name="line.572"></a> +<span class="sourceLineNo">573</span> * Return a list of replication peers.<a name="line.573"></a> +<span class="sourceLineNo">574</span> * @param pattern The compiled regular expression to match peer id<a name="line.574"></a> +<span class="sourceLineNo">575</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.575"></a> +<span class="sourceLineNo">576</span> * {@link CompletableFuture}.<a name="line.576"></a> +<span class="sourceLineNo">577</span> */<a name="line.577"></a> +<span class="sourceLineNo">578</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(Pattern pattern);<a name="line.578"></a> +<span class="sourceLineNo">579</span><a name="line.579"></a> +<span class="sourceLineNo">580</span> /**<a name="line.580"></a> +<span class="sourceLineNo">581</span> * Find all table and column families that are replicated from this cluster<a name="line.581"></a> +<span class="sourceLineNo">582</span> * @return the replicated table-cfs list of this cluster. The return value will be wrapped by a<a name="line.582"></a> +<span class="sourceLineNo">583</span> * {@link CompletableFuture}.<a name="line.583"></a> +<span class="sourceLineNo">584</span> */<a name="line.584"></a> +<span class="sourceLineNo">585</span> CompletableFuture<List<TableCFs>> listReplicatedTableCFs();<a name="line.585"></a> +<span class="sourceLineNo">586</span><a name="line.586"></a> +<span class="sourceLineNo">587</span> /**<a name="line.587"></a> +<span class="sourceLineNo">588</span> * Enable a table's replication switch.<a name="line.588"></a> +<span class="sourceLineNo">589</span> * @param tableName name of the table<a name="line.589"></a> +<span class="sourceLineNo">590</span> */<a name="line.590"></a> +<span class="sourceLineNo">591</span> CompletableFuture<Void> enableTableReplication(TableName tableName);<a name="line.591"></a> +<span class="sourceLineNo">592</span><a name="line.592"></a> +<span class="sourceLineNo">593</span> /**<a name="line.593"></a> +<span class="sourceLineNo">594</span> * Disable a table's replication switch.<a name="line.594"></a> +<span class="sourceLineNo">595</span> * @param tableName name of the table<a name="line.595"></a> +<span class="sourceLineNo">596</span> */<a name="line.596"></a> +<span class="sourceLineNo">597</span> CompletableFuture<Void> disableTableReplication(TableName tableName);<a name="line.597"></a> +<span class="sourceLineNo">598</span><a name="line.598"></a> +<span class="sourceLineNo">599</span> /**<a name="line.599"></a> +<span class="sourceLineNo">600</span> * Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be<a name="line.600"></a> +<span class="sourceLineNo">601</span> * taken. If the table is disabled, an offline snapshot is taken. Snapshots are considered unique<a name="line.601"></a> +<span class="sourceLineNo">602</span> * based on <b>the name of the snapshot</b>. Attempts to take a snapshot with the same name (even<a name="line.602"></a> +<span class="sourceLineNo">603</span> * a different type or with different parameters) will fail with a<a name="line.603"></a> +<span class="sourceLineNo">604</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.604"></a> +<span class="sourceLineNo">605</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.605"></a> +<span class="sourceLineNo">606</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.606"></a> +<span class="sourceLineNo">607</span> * @param snapshotName name of the snapshot to be created<a name="line.607"></a> +<span class="sourceLineNo">608</span> * @param tableName name of the table for which snapshot is created<a name="line.608"></a> +<span class="sourceLineNo">609</span> */<a name="line.609"></a> +<span class="sourceLineNo">610</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName) {<a name="line.610"></a> +<span class="sourceLineNo">611</span> return snapshot(snapshotName, tableName, SnapshotType.FLUSH);<a name="line.611"></a> +<span class="sourceLineNo">612</span> }<a name="line.612"></a> +<span class="sourceLineNo">613</span><a name="line.613"></a> +<span class="sourceLineNo">614</span> /**<a name="line.614"></a> +<span class="sourceLineNo">615</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.615"></a> +<span class="sourceLineNo">616</span> * snapshot</b>. Attempts to take a snapshot with the same name (even a different type or with<a name="line.616"></a> +<span class="sourceLineNo">617</span> * different parameters) will fail with a<a name="line.617"></a> +<span class="sourceLineNo">618</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.618"></a> +<span class="sourceLineNo">619</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.619"></a> +<span class="sourceLineNo">620</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.620"></a> +<span class="sourceLineNo">621</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.621"></a> +<span class="sourceLineNo">622</span> * snapshots stored on the cluster<a name="line.622"></a> +<span class="sourceLineNo">623</span> * @param tableName name of the table to snapshot<a name="line.623"></a> +<span class="sourceLineNo">624</span> * @param type type of snapshot to take<a name="line.624"></a> +<span class="sourceLineNo">625</span> */<a name="line.625"></a> +<span class="sourceLineNo">626</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName,<a name="line.626"></a> +<span class="sourceLineNo">627</span> SnapshotType type) {<a name="line.627"></a> +<span class="sourceLineNo">628</span> return snapshot(new SnapshotDescription(snapshotName, tableName, type));<a name="line.628"></a> +<span class="sourceLineNo">629</span> }<a name="line.629"></a> +<span class="sourceLineNo">630</span><a name="line.630"></a> +<span class="sourceLineNo">631</span> /**<a name="line.631"></a> +<span class="sourceLineNo">632</span> * Take a snapshot and wait for the server to complete that snapshot asynchronously. Only a single<a name="line.632"></a> +<span class="sourceLineNo">633</span> * snapshot should be taken at a time for an instance of HBase, or results may be undefined (you<a name="line.633"></a> +<span class="sourceLineNo">634</span> * can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a<a name="line.634"></a> +<span class="sourceLineNo">635</span> * single cluster). Snapshots are considered unique based on <b>the name of the snapshot</b>.<a name="line.635"></a> +<span class="sourceLineNo">636</span> * Attempts to take a snapshot with the same name (even a different type or with different<a name="line.636"></a> +<span class="sourceLineNo">637</span> * parameters) will fail with a {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException}<a name="line.637"></a> +<span class="sourceLineNo">638</span> * indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in<a name="line.638"></a> +<span class="sourceLineNo">639</span> * HBase. See {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.639"></a> +<span class="sourceLineNo">640</span> * You should probably use {@link #snapshot(String, org.apache.hadoop.hbase.TableName)} unless you<a name="line.640"></a> +<span class="sourceLineNo">641</span> * are sure about the type of snapshot that you want to take.<a name="line.641"></a> +<span class="sourceLineNo">642</span> * @param snapshot snapshot to take<a name="line.642"></a> +<span class="sourceLineNo">643</span> */<a name="line.643"></a> +<span class="sourceLineNo">644</span> CompletableFuture<Void> snapshot(SnapshotDescription snapshot);<a name="line.644"></a> +<span class="sourceLineNo">645</span><a name="line.645"></a> +<span class="sourceLineNo">646</span> /**<a name="line.646"></a> +<span class="sourceLineNo">647</span> * Check the current state of the passed snapshot. There are three possible states:<a name="line.647"></a> +<span class="sourceLineNo">648</span> * <ol><a name="line.648"></a> +<span class="sourceLineNo">649</span> * <li>running - returns <tt>false</tt></li><a name="line.649"></a> +<span class="sourceLineNo">650</span> * <li>finished - returns <tt>true</tt></li><a name="line.650"></a> +<span class="sourceLineNo">651</span> * <li>finished with error - throws the exception that caused the snapshot to fail</li><a name="line.651"></a> +<span class="sourceLineNo">652</span> * </ol><a name="line.652"></a> +<span class="sourceLineNo">653</span> * The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been<a name="line.653"></a> +<span class="sourceLineNo">654</span> * run/started since the snapshot you are checking, you will receive an<a name="line.654"></a> +<span class="sourceLineNo">655</span> * {@link org.apache.hadoop.hbase.snapshot.UnknownSnapshotException}.<a name="line.655"></a> +<span class="sourceLineNo">656</span> * @param snapshot description of the snapshot to check<a name="line.656"></a> +<span class="sourceLineNo">657</span> * @return <tt>true</tt> if the snapshot is completed, <tt>false</tt> if the snapshot is still<a name="line.657"></a> +<span class="sourceLineNo">658</span> * running<a name="line.658"></a> +<span class="sourceLineNo">659</span> */<a name="line.659"></a> +<span class="sourceLineNo">660</span> CompletableFuture<Boolean> isSnapshotFinished(SnapshotDescription snapshot);<a name="line.660"></a> +<span class="sourceLineNo">661</span><a name="line.661"></a> +<span class="sourceLineNo">662</span> /**<a name="line.662"></a> +<span class="sourceLineNo">663</span> * Restore the specified snapshot on the original table. (The table must be disabled) If the<a name="line.663"></a> +<span class="sourceLineNo">664</span> * "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a<a name="line.664"></a> +<span class="sourceLineNo">665</span> * snapshot of the current table is taken before executing the restore operation. In case of<a name="line.665"></a> +<span class="sourceLineNo">666</span> * restore failure, the failsafe snapshot will be restored. If the restore completes without<a name="line.666"></a> +<span class="sourceLineNo">667</span> * problem the failsafe snapshot is deleted.<a name="line.667"></a> <span class="sourceLineNo">668</span> * @param snapshotName name of the snapshot to restore<a name="line.668"></a> -<span class="sourceLineNo">669</span> * @param takeFailSafeSnapshot true if the failsafe snapshot should be taken<a name="line.669"></a> -<span class="sourceLineNo">670</span> */<a name="line.670"></a> -<span class="sourceLineNo">671</span> CompletableFuture<Void> restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot);<a name="line.671"></a> -<span class="sourceLineNo">672</span><a name="line.672"></a> -<span class="sourceLineNo">673</span> /**<a name="line.673"></a> -<span class="sourceLineNo">674</span> * Create a new table by cloning the snapshot content.<a name="line.674"></a> -<span class="sourceLineNo">675</span> * @param snapshotName name of the snapshot to be cloned<a name="line.675"></a> -<span class="sourceLineNo">676</span> * @param tableName name of the table where the snapshot will be restored<a name="line.676"></a> -<span class="sourceLineNo">677</span> */<a name="line.677"></a> -<span class="sourceLineNo">678</span> CompletableFuture<Void> cloneSnapshot(String snapshotName, TableName tableName);<a name="line.678"></a> -<span class="sourceLineNo">679</span><a name="line.679"></a> -<span class="sourceLineNo">680</span> /**<a name="line.680"></a> -<span class="sourceLineNo">681</span> * List completed snapshots.<a name="line.681"></a> -<span class="sourceLineNo">682</span> * @return a list of snapshot descriptors for completed snapshots wrapped by a<a name="line.682"></a> -<span class="sourceLineNo">683</span> * {@link CompletableFuture}<a name="line.683"></a> -<span class="sourceLineNo">684</span> */<a name="line.684"></a> -<span class="sourceLineNo">685</span> CompletableFuture<List<SnapshotDescription>> listSnapshots();<a name="line.685"></a> -<span class="sourceLineNo">686</span><a name="line.686"></a> -<span class="sourceLineNo">687</span> /**<a name="line.687"></a> -<span class="sourceLineNo">688</span> * List all the completed snapshots matching the given pattern.<a name="line.688"></a> -<span class="sourceLineNo">689</span> * @param pattern The compiled regular expression to match against<a name="line.689"></a> -<span class="sourceLineNo">690</span> * @return - returns a List of SnapshotDescription wrapped by a {@link CompletableFuture}<a name="line.690"></a> -<span class="sourceLineNo">691</span> */<a name="line.691"></a> -<span class="sourceLineNo">692</span> CompletableFuture<List<SnapshotDescription>> listSnapshots(Pattern pattern);<a name="line.692"></a> -<span class="sourceLineNo">693</span><a name="line.693"></a> -<span class="sourceLineNo">694</span> /**<a name="line.694"></a> -<span class="sourceLineNo">695</span> * List all the completed snapshots matching the given table name pattern.<a name="line.695"></a> -<span class="sourceLineNo">696</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.696"></a> -<span class="sourceLineNo">697</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.697"></a> -<span class="sourceLineNo">698</span> * {@link CompletableFuture}<a name="line.698"></a> -<span class="sourceLineNo">699</span> */<a name="line.699"></a> -<span class="sourceLineNo">700</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern);<a name="line.700"></a> -<span class="sourceLineNo">701</span><a name="line.701"></a> -<span class="sourceLineNo">702</span> /**<a name="line.702"></a> -<span class="sourceLineNo">703</span> * List all the completed snapshots matching the given table name regular expression and snapshot<a name="line.703"></a> -<span class="sourceLineNo">704</span> * name regular expression.<a name="line.704"></a> -<span class="sourceLineNo">705</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.705"></a> -<span class="sourceLineNo">706</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.706"></a> -<span class="sourceLineNo">707</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.707"></a> -<span class="sourceLineNo">708</span> * {@link CompletableFuture}<a name="line.708"></a> -<span class="sourceLineNo">709</span> */<a name="line.709"></a> -<span class="sourceLineNo">710</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern,<a name="line.710"></a> -<span class="sourceLineNo">711</span> Pattern snapshotNamePattern);<a name="line.711"></a> +<span class="sourceLineNo">669</span> */<a name="line.669"></a> +<span class="sourceLineNo">670</span> CompletableFuture<Void> restoreSnapshot(String snapshotName);<a name="line.670"></a> +<span class="sourceLineNo">671</span><a name="line.671"></a> +<span class="sourceLineNo">672</span> /**<a name="line.672"></a> +<span class="sourceLineNo">673</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.673"></a> +<span class="sourceLineNo">674</span> * 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before<a name="line.674"></a> +<span class="sourceLineNo">675</span> * executing the restore operation. In case of restore failure, the failsafe snapshot will be<a name="line.675"></a> +<span class="sourceLineNo">676</span> * restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.676"></a> +<span class="sourceLineNo">677</span> * failsafe snapshot name is configurable by using the property<a name="line.677"></a> +<span class="sourceLineNo">678</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.678"></a> +<span class="sourceLineNo">679</span> * @param snapshotName name of the snapshot to restore<a name="line.679"></a> +<span class="sourceLineNo">680</span> * @param takeFailSafeSnapshot true if the failsafe snapshot should be taken<a name="line.680"></a> +<span class="sourceLineNo">681</span> */<a name="line.681"></a> +<span class="sourceLineNo">682</span> CompletableFuture<Void> restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot);<a name="line.682"></a> +<span class="sourceLineNo">683</span><a name="line.683"></a> +<span class="sourceLineNo">684</span> /**<a name="line.684"></a> +<span class="sourceLineNo">685</span> * Create a new table by cloning the snapshot content.<a name="line.685"></a> +<span class="sourceLineNo">686</span> * @param snapshotName name of the snapshot to be cloned<a name="line.686"></a> +<span class="sourceLineNo">687</span> * @param tableName name of the table where the snapshot will be restored<a name="line.687"></a> +<span class="sourceLineNo">688</span> */<a name="line.688"></a> +<span class="sourceLineNo">689</span> CompletableFuture<Void> cloneSnapshot(String snapshotName, TableName tableName);<a name="line.689"></a> +<span class="sourceLineNo">690</span><a name="line.690"></a> +<span class="sourceLineNo">691</span> /**<a name="line.691"></a> +<span class="sourceLineNo">692</span> * List completed snapshots.<a name="line.692"></a> +<span class="sourceLineNo">693</span> * @return a list of snapshot descriptors for completed snapshots wrapped by a<a name="line.693"></a> +<span class="sourceLineNo">694</span> * {@link CompletableFuture}<a name="line.694"></a> +<span class="sourceLineNo">695</span> */<a name="line.695"></a> +<span class="sourceLineNo">696</span> CompletableFuture<List<SnapshotDescription>> listSnapshots();<a name="line.696"></a> +<span class="sourceLineNo">697</span><a name="line.697"></a> +<span class="sourceLineNo">698</span> /**<a name="line.698"></a> +<span class="sourceLineNo">699</span> * List all the completed snapshots matching the given pattern.<a name="line.699"></a> +<span class="sourceLineNo">700</span> * @param pattern The compiled regular expression to match against<a name="line.700"></a> +<span class="sourceLineNo">701</span> * @return - returns a List of SnapshotDescription wrapped by a {@link CompletableFuture}<a name="line.701"></a> +<span class="sourceLineNo">702</span> */<a name="line.702"></a> +<span class="sourceLineNo">703</span> CompletableFuture<List<SnapshotDescription>> listSnapshots(Pattern pattern);<a name="line.703"></a> +<span class="sourceLineNo">704</span><a name="line.704"></a> +<span class="sourceLineNo">705</span> /**<a name="line.705"></a> +<span class="sourceLineNo">706</span> * List all the completed snapshots matching the given table name pattern.<a name="line.706"></a> +<span class="sourceLineNo">707</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.707"></a> +<span class="sourceLineNo">708</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.708"></a> +<span class="sourceLineNo">709</span> * {@link CompletableFuture}<a name="line.709"></a> +<span class="sourceLineNo">710</span> */<a name="line.710"></a> +<span class="sourceLineNo">711</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern);<a name="line.711"></a> <span class="sourceLineNo">712</span><a name="line.712"></a> <span class="sourceLineNo">713</span> /**<a name="line.713"></a> -<span class="sourceLineNo">714</span> * Delete an existing snapshot.<a name="line.714"></a> -<span class="sourceLineNo">715</span> * @param snapshotName name of the snapshot<a name="line.715"></a> -<span class="sourceLineNo">716</span> */<a name="line.716"></a> -<span class="sourceLineNo">717</span> CompletableFuture<Void> deleteSnapshot(String snapshotName);<a name="line.717"></a> -<span class="sourceLineNo">718</span><a name="line.718"></a> -<span class="sourceLineNo">719</span> /**<a name="line.719"></a> -<span class="sourceLineNo">720</span> * Delete all existing snapshots.<a name="line.720"></a> -<span class="sourceLineNo">721</span> */<a name="line.721"></a> -<span class="sourceLineNo">722</span> CompletableFuture<Void> deleteSnapshots();<a name="line.722"></a> +<span class="sourceLineNo">714</span> * List all the completed snapshots matching the given table name regular expression and snapshot<a name="line.714"></a> +<span class="sourceLineNo">715</span> * name regular expression.<a name="line.715"></a> +<span class="sourceLineNo">716</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.716"></a> +<span class="sourceLineNo">717</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.717"></a> +<span class="sourceLineNo">718</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.718"></a> +<span class="sourceLineNo">719</span> * {@link CompletableFuture}<a name="line.719"></a> +<span class="sourceLineNo">720</span> */<a name="line.720"></a> +<span class="sourceLineNo">721</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern,<a name="line.721"></a> +<span class="sourceLineNo">722</span> Pattern snapshotNamePattern);<a name="line.722"></a> <span class="sourceLineNo">723</span><a name="line.723"></a> <span class="sourceLineNo">724</span> /**<a name="line.724"></a> -<span class="sourceLineNo">725</span> * Delete existing snapshots whose names match the pattern passed.<a name="line.725"></a> -<span class="sourceLineNo">726</span> * @param pattern pattern for names of the snapshot to match<a name="line.726"></a> +<span class="sourceLineNo">725</span> * Delete an existing snapshot.<a name="line.725"></a> +<span class="sourceLineNo">726</span> * @param snapshotName name of the snapshot<a name="line.726"></a> <span class="sourceLineNo">727</span> */<a name="line.727"></a> -<span class="sourceLineNo">728</span> CompletableFuture<Void> deleteSnapshots(Pattern pattern);<a name="line.728"></a> +<span class="sourceLineNo">728</span> CompletableFuture<Void> deleteSnapshot(String snapshotName);<a name="line.728"></a> <span class="sourceLineNo">729</span><a name="line.729"></a> <span class="sourceLineNo">730</span> /**<a name="line.730"></a> -<span class="sourceLineNo">731</span> * Delete all existing snapshots matching the given table name pattern.<a name="line.731"></a> -<span class="sourceLineNo">732</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.732"></a> -<span class="sourceLineNo">733</span> */<a name="line.733"></a> -<span class="sourceLineNo">734</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern);<a name="line.734"></a> -<span class="sourceLineNo">735</span><a name="line.735"></a> -<span class="sourceLineNo">736</span> /**<a name="line.736"></a> -<span class="sourceLineNo">737</span> * Delete all existing snapshots matching the given table name regular expression and snapshot<a name="line.737"></a> -<span class="sourceLineNo">738</span> * name regular expression.<a name="line.738"></a> -<span class="sourceLineNo">739</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.739"></a> -<span class="sourceLineNo">740</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.740"></a> -<span class="sourceLineNo">741</span> */<a name="line.741"></a> -<span class="sourceLineNo">742</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern,<a name="line.742"></a> -<span class="sourceLineNo">743</span> Pattern snapshotNamePattern);<a name="line.743"></a> -<span class="sourceLineNo">744</span><a name="line.744"></a> -<span class="sourceLineNo">745</span> /**<a name="line.745"></a> -<span class="sourceLineNo">746</span> * Execute a distributed procedure on a cluster.<a name="line.746"></a> -<span class="sourceLineNo">747</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.747"></a> -<span class="sourceLineNo">748</span> * root ZK node name of the procedure).<a name="line.748"></a> -<span class="sourceLineNo">749</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.749"></a> -<span class="sourceLineNo">750</span> * optional.<a name="line.750"></a> -<span class="sourceLineNo">751</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.751"></a> +<span class="sourceLineNo">731</span> * Delete all existing snapshots.<a name="line.731"></a> +<span class="sourceLineNo">732</span> */<a name="line.732"></a> +<span class="sourceLineNo">733</span> CompletableFuture<Void> deleteSnapshots();<a name="line.733"></a> +<span class="sourceLineNo">734</span><a name="line.734"></a> +<span class="sourceLineNo">735</span> /**<a name="line.735"></a> +<span class="sourceLineNo">736</span> * Delete existing snapshots whose names match the pattern passed.<a name="line.736"></a> +<span class="sourceLineNo">737</span> * @param pattern pattern for names of the snapshot to match<a name="line.737"></a> +<span class="sourceLineNo">738</span> */<a name="line.738"></a> +<span class="sourceLineNo">739</span> CompletableFuture<Void> deleteSnapshots(Pattern pattern);<a name="line.739"></a> +<span class="sourceLineNo">740</span><a name="line.740"></a> +<span class="sourceLineNo">741</span> /**<a name="line.741"></a> +<span class="sourceLineNo">742</span> * Delete all existing snapshots matching the given table name pattern.<a name="line.742"></a> +<span class="sourceLineNo">743</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.743"></a> +<span class="sourceLineNo">744</span> */<a name="line.744"></a> +<span class="sourceLineNo">745</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern);<a name="line.745"></a> +<span class="sourceLineNo">746</span><a name="line.746"></a> +<span class="sourceLineNo">747</span> /**<a name="line.747"></a> +<span class="sourceLineNo">748</span> * Delete all existing snapshots matching the given table name regular expression and snapshot<a name="line.748"></a> +<span class="sourceLineNo">749</span> * name regular expression.<a name="line.749"></a> +<span class="sourceLineNo">750</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.750"></a> +<span class="sourceLineNo">751</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.751"></a> <span class="sourceLineNo">752</span> */<a name="line.752"></a> -<span class="sourceLineNo">753</span> CompletableFuture<Void> execProcedure(String signature, String instance,<a name="line.753"></a> -<span class="sourceLineNo">754</span> Map<String, String> props);<a name="line.754"></a> +<span class="sourceLineNo">753</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern,<a name="line.753"></a> +<span class="sourceLineNo">754</span> Pattern snapshotNamePattern);<a name="line.754"></a> <span class="sourceLineNo">755</span><a name="line.755"></a> <span class="sourceLineNo">756</span> /**<a name="line.756"></a> <span class="sourceLineNo">757</span> * Execute a distributed procedure on a cluster.<a name="line.757"></a> @@ -768,388 +768,399 @@ <span class="sourceLineNo">760</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.760"></a> <span class="sourceLineNo">761</span> * optional.<a name="line.761"></a> <span class="sourceLineNo">762</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.762"></a> -<span class="sourceLineNo">763</span> * @return data returned after procedure execution. null if no return data.<a name="line.763"></a> -<span class="sourceLineNo">764</span> */<a name="line.764"></a> -<span class="sourceLineNo">765</span> CompletableFuture<byte[]> execProcedureWithReturn(String signature, String instance,<a name="line.765"></a> -<span class="sourceLineNo">766</span> Map<String, String> props);<a name="line.766"></a> -<span class="sourceLineNo">767</span><a name="line.767"></a> -<span class="sourceLineNo">768</span> /**<a name="line.768"></a> -<span class="sourceLineNo">769</span> * Check the current state of the specified procedure. There are three possible states:<a name="line.769"></a> -<span class="sourceLineNo">770</span> * <ol><a name="line.770"></a> -<span class="sourceLineNo">771</span> * <li>running - returns <tt>false</tt></li><a name="line.771"></a> -<span class="sourceLineNo">772</span> * <li>finished - returns <tt>true</tt></li><a name="line.772"></a> -<span class="sourceLineNo">773</span> * <li>finished with error - throws the exception that caused the procedure to fail</li><a name="line.773"></a> -<span class="sourceLineNo">774</span> * </ol><a name="line.774"></a> -<span class="sourceLineNo">775</span> * @param signature The signature that uniquely identifies a procedure<a name="line.775"></a> -<span class="sourceLineNo">776</span> * @param instance The instance name of the procedure<a name="line.776"></a> -<span class="sourceLineNo">777</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.777"></a> -<span class="sourceLineNo">778</span> * @return true if the specified procedure is finished successfully, false if it is still running.<a name="line.778"></a> -<span class="sourceLineNo">779</span> * The value is wrapped by {@link CompletableFuture}<a name="line.779"></a> -<span class="sourceLineNo">780</span> */<a name="line.780"></a> -<span class="sourceLineNo">781</span> CompletableFuture<Boolean> isProcedureFinished(String signature, String instance,<a name="line.781"></a> -<span class="sourceLineNo">782</span> Map<String, String> props);<a name="line.782"></a> -<span class="sourceLineNo">783</span><a name="line.783"></a> -<span class="sourceLineNo">784</span> /**<a name="line.784"></a> -<span class="sourceLineNo">785</span> * abort a procedure<a name="line.785"></a> -<span class="sourceLineNo">786</span> * @param procId ID of the procedure to abort<a name="line.786"></a> -<span class="sourceLineNo">787</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.787"></a> -<span class="sourceLineNo">788</span> * @return true if aborted, false if procedure already completed or does not exist. the value is<a name="line.788"></a> -<span class="sourceLineNo">789</span> * wrapped by {@link CompletableFuture}<a name="line.789"></a> -<span class="sourceLineNo">790</span> */<a name="line.790"></a> -<span class="sourceLineNo">791</span> CompletableFuture<Boolean> abortProcedure(long procId, boolean mayInterruptIfRunning);<a name="line.791"></a> -<span class="sourceLineNo">792</span><a name="line.792"></a> -<span class="sourceLineNo">793</span> /**<a name="line.793"></a> -<span class="sourceLineNo">794</span> * List procedures<a name="line.794"></a> -<span class="sourceLineNo">795</span> * @return procedure list JSON wrapped by {@link CompletableFuture}<a name="line.795"></a> -<span class="sourceLineNo">796</span> */<a name="line.796"></a> -<span class="sourceLineNo">797</span> CompletableFuture<String> getProcedures();<a name="line.797"></a> -<span class="sourceLineNo">798</span><a name="line.798"></a> -<span class="sourceLineNo">799</span> /**<a name="line.799"></a> -<span class="sourceLineNo">800</span> * List locks.<a name="line.800"></a> -<span class="sourceLineNo">801</span> * @return lock list JSON wrapped by {@link CompletableFuture}<a name="line.801"></a> -<span class="sourceLineNo">802</span> */<a name="line.802"></a> -<span class="sourceLineNo">803</span> CompletableFuture<String> getLocks();<a name="line.803"></a> -<span class="sourceLineNo">804</span><a name="line.804"></a> -<span class="sourceLineNo">805</span> /**<a name="line.805"></a> -<span class="sourceLineNo">806</span> * Mark region server(s) as decommissioned to prevent additional regions from getting<a name="line.806"></a> -<span class="sourceLineNo">807</span> * assigned to them. Optionally unload the regions on the servers. If there are multiple servers<a name="line.807"></a> -<span class="sourceLineNo">808</span> * to be decommissioned, decommissioning them at the same time can prevent wasteful region<a name="line.808"></a> -<span class="sourceLineNo">809</span> * movements. Region unloading is asynchronous.<a name="line.809"></a> -<span class="sourceLineNo">810</span> * @param servers The list of servers to decommission.<a name="line.810"></a> -<span class="sourceLineNo">811</span> * @param offload True to offload the regions from the decommissioned servers<a name="line.811"></a> -<span class="sourceLineNo">812</span> */<a name="line.812"></a> -<span class="sourceLineNo">813</span> CompletableFuture<Void> decommissionRegionServers(List<ServerName> servers, boolean offload);<a name="line.813"></a> -<span class="sourceLineNo">814</span><a name="line.814"></a> -<span class="sourceLineNo">815</span> /**<a name="line.815"></a> -<span class="sourceLineNo">816</span> * List region servers marked as decommissioned, which can not be assigned regions.<a name="line.816"></a> -<span class="sourceLineNo">817</span> * @return List of decommissioned region servers wrapped by {@link CompletableFuture}<a name="line.817"></a> -<span class="sourceLineNo">818</span> */<a name="line.818"></a> -<span class="sourceLineNo">819</span> CompletableFuture<List<ServerName>> listDecommissionedRegionServers();<a name="line.819"></a> -<span class="sourceLineNo">820</span><a name="line.820"></a> -<span class="sourceLineNo">821</span> /**<a name="line.821"></a> -<span class="sourceLineNo">822</span> * Remove decommission marker from a region server to allow regions assignments. Load regions onto<a name="line.822"></a> -<span class="sourceLineNo">823</span> * the server if a list of regions is given. Region loading is asynchronous.<a name="line.823"></a> -<span class="sourceLineNo">824</span> * @param server The server to recommission.<a name="line.824"></a> -<span class="sourceLineNo">825</span> * @param encodedRegionNames Regions to load onto the server.<a name="line.825"></a> -<span class="sourceLineNo">826</span> */<a name="line.826"></a> -<span class="sourceLineNo">827</span> CompletableFuture<Void> recommissionRegionServer(ServerName server,<a name="line.827"></a> -<span class="sourceLineNo">828</span> List<byte[]> encodedRegionNames);<a name="line.828"></a> -<span class="sourceLineNo">829</span><a name="line.829"></a> -<span class="sourceLineNo">830</span> /**<a name="line.830"></a> -<span class="sourceLineNo">831</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.831"></a> -<span class="sourceLineNo">832</span> */<a name="line.832"></a> -<span class="sourceLineNo">833</span> CompletableFuture<ClusterStatus> getClusterStatus();<a name="line.833"></a> -<span class="sourceLineNo">834</span><a name="line.834"></a> -<span class="sourceLineNo">835</span> /**<a name="line.835"></a> -<span class="sourceLineNo">836</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.836"></a> +<span class="sourceLineNo">763</span> */<a name="line.763"></a> +<span class="sourceLineNo">764</span> CompletableFuture<Void> execProcedure(String signature, String instance,<a name="line.764"></a> +<span class="sourceLineNo">765</span> Map<String, String> props);<a name="line.765"></a> +<span class="sourceLineNo">766</span><a name="line.766"></a> +<span class="sourceLineNo">767</span> /**<a name="line.767"></a> +<span class="sourceLineNo">768</span> * Execute a distributed procedure on a cluster.<a name="line.768"></a> +<span class="sourceLineNo">769</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.769"></a> +<span class="sourceLineNo">770</span> * root ZK node name of the procedure).<a name="line.770"></a> +<span class="sourceLineNo">771</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.771"></a> +<span class="sourceLineNo">772</span> * optional.<a name="line.772"></a> +<span class="sourceLineNo">773</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.773"></a> +<span class="sourceLineNo">774</span> * @return data returned after procedure execution. null if no return data.<a name="line.774"></a> +<span class="sourceLineNo">775</span> */<a name="line.775"></a> +<span class="sourceLineNo">776</span> CompletableFuture<byte[]> execProcedureWithReturn(String signature, String instance,<a name="line.776"></a> +<span class="sourceLineNo">777</span> Map<String, String> props);<a name="line.777"></a> +<span class="sourceLineNo">778</span><a name="line.778"></a> +<span class="sourceLineNo">779</span> /**<a name="line.779"></a> +<span class="sourceLineNo">780</span> * Check the current state of the specified procedure. There are three possible states:<a name="line.780"></a> +<span class="sourceLineNo">781</span> * <ol><a name="line.781"></a> +<span class="sourceLineNo">782</span> * <li>running - returns <tt>false</tt></li><a name="line.782"></a> +<span class="sourceLineNo">783</span> * <li>finished - returns <tt>true</tt></li><a name="line.783"></a> +<span class="sourceLineNo">784</span> * <li>finished with error - throws the exception that caused the procedure to fail</li><a name="line.784"></a> +<span class="sourceLineNo">785</span> * </ol><a name="line.785"></a> +<span class="sourceLineNo">786</span> * @param signature The signature that uniquely identifies a procedure<a name="line.786"></a> +<span class="sourceLineNo">787</span> * @param instance The instance name of the procedure<a name="line.787"></a> +<span class="sourceLineNo">788</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.788"></a> +<span class="sourceLineNo">789</span> * @return true if the specified procedure is finished successfully, false if it is still running.<a name="line.789"></a> +<span class="sourceLineNo">790</span> * The value is wrapped by {@link CompletableFuture}<a name="line.790"></a> +<span class="sourceLineNo">791</span> */<a name="line.791"></a> +<span class="sourceLineNo">792</span> CompletableFuture<Boolean> isProcedureFinished(String signature, String instance,<a name="line.792"></a> +<span class="sourceLineNo">793</span> Map<String, String> props);<a name="line.793"></a> +<span class="sourceLineNo">794</span><a name="line.794"></a> +<span class="sourceLineNo">795</span> /**<a name="line.795"></a> +<span class="sourceLineNo">796</span> * abort a procedure<a name="line.796"></a> +<span class="sourceLineNo">797</span> * @param procId ID of the procedure to abort<a name="line.797"></a> +<span class="sourceLineNo">798</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.798"></a> +<span class="sourceLineNo">799</span> * @return true if aborted, false if procedure already completed or does not exist. the value is<a name="line.799"></a> +<span class="sourceLineNo">800</span> * wrapped by {@link CompletableFuture}<a name="line.800"></a> +<span class="sourceLineNo">801</span> */<a name="line.801"></a> +<span class="sourceLineNo">802</span> CompletableFuture<Boolean> abortProcedure(long procId, boolean mayInterruptIfRunning);<a name="line.802"></a> +<span class="sourceLineNo">803</span><a name="line.803"></a> +<span class="sourceLineNo">804</span> /**<a name="line.804"></a> +<span class="sourceLineNo">805</span> * List procedures<a name="line.805"></a> +<span class="sourceLineNo">806</span> * @return procedure list JSON wrapped by {@link CompletableFuture}<a name="line.806"></a> +<span class="sourceLineNo">807</span> */<a name="line.807"></a> +<span class="sourceLineNo">808</span> CompletableFuture<String> getProcedures();<a name="line.808"></a> +<span class="sourceLineNo">809</span><a name="line.809"></a> +<span class="sourceLineNo">810</span> /**<a name="line.810"></a> +<span class="sourceLineNo">811</span> * List locks.<a name="line.811"></a> +<span class="sourceLineNo">812</span> * @return lock list JSON wrapped by {@link CompletableFuture}<a name="line.812"></a> +<span class="sourceLineNo">813</span> */<a name="line.813"></a> +<span class="sourceLineNo">814</span> CompletableFuture<String> getLocks();<a name="line.814"></a> +<span class="sourceLineNo">815</span><a name="line.815"></a> +<span class="sourceLineNo">816</span> /**<a name="line.816"></a> +<span class="sourceLineNo">817</span> * Mark region server(s) as decommissioned to prevent additional regions from getting<a name="line.817"></a> +<span class="sourceLineNo">818</span> * assigned to them. Optionally unload the regions on the servers. If there are multiple servers<a name="line.818"></a> +<span class="sourceLineNo">819</span> * to be decommissioned, decommissioning them at the same time can prevent wasteful region<a name="line.819"></a> +<span class="sourceLineNo">820</span> * movements. Region unloading is asynchronous.<a name="line.820"></a> +<span class="sourceLineNo">821</span> * @param servers The list of servers to decommission.<a name="line.821"></a> +<span class="sourceLineNo">822</span> * @param offload True to offload the regions from the decommissioned servers<a name="line.822"></a> +<span class="sourceLineNo">823</span> */<a name="line.823"></a> +<span class="sourceLineNo">824</span> CompletableFuture<Void> decommissionRegionServers(List<ServerName> servers, boolean offload);<a name="line.824"></a> +<span class="sourceLineNo">825</span><a name="line.825"></a> +<span class="sourceLineNo">826</span> /**<a name="line.826"></a> +<span class="sourceLineNo">827</span> * List region servers marked as decommissioned, which can not be assigned regions.<a name="line.827"></a> +<span class="sourceLineNo">828</span> * @return List of decommissioned region servers wrapped by {@link CompletableFuture}<a name="line.828"></a> +<span class="sourceLineNo">829</span> */<a name="line.829"></a> +<span class="sourceLineNo">830</span> CompletableFuture<List<ServerName>> listDecommissionedRegionServers();<a name="line.830"></a> +<span class="sourceLineNo">831</span><a name="line.831"></a> +<span class="sourceLineNo">832</span> /**<a name="line.832"></a> +<span class="sourceLineNo">833</span> * Remove decommission marker from a region server to allow regions assignments. Load regions onto<a name="line.833"></a> +<span class="sourceLineNo">834</span> * the server if a list of regions is given. Region loading is asynchronous.<a name="line.834"></a> +<span class="sourceLineNo">835</span> * @param server The server to recommission.<a name="line.835"></a> +<span class="sourceLineNo">836</span> * @param encodedRegionNames Regions to load onto the server.<a name="line.836"></a> <span class="sourceLineNo">837</span> */<a name="line.837"></a> -<span class="sourceLineNo">838</span> CompletableFuture<ClusterStatus> getClusterStatus(EnumSet<Option> options);<a name="line.838"></a> -<span class="sourceLineNo">839</span><a name="line.839"></a> -<span class="sourceLineNo">840</span> /**<a name="line.840"></a> -<span class="sourceLineNo">841</span> * @return current master server name wrapped by {@link CompletableFuture}<a name="line.841"></a> -<span class="sourceLineNo">842</span> */<a name="line.842"></a> -<span class="sourceLineNo">843</span> default CompletableFuture<ServerName> getMaster() {<a name="line.843"></a> -<span class="sourceLineNo">844</span> return getClusterStatus(EnumSet.of(Option.MASTER)).thenApply(ClusterStatus::getMaster);<a name="line.844"></a> -<span class="sourceLineNo">845</span> }<a name="line.845"></a> -<span class="sourceLineNo">846</span><a name="line.846"></a> -<span class="sourceLineNo">847</span> /**<a name="line.847"></a> -<span class="sourceLineNo">848</span> * @return current backup master list wrapped by {@link CompletableFuture}<a name="line.848"></a> -<span class="sourceLineNo">849</span> */<a name="line.849"></a> -<span class="sourceLineNo">850</span> default CompletableFuture<Collection<ServerName>> getBackupMasters() {<a name="line.850"></a> -<span class="sourceLineNo">851</span> return getClusterStatus(EnumSet.of(Option.BACKUP_MASTERS)).thenApply(ClusterStatus::getBackupMasters);<a name="line.851"></a> -<span class="sourceLineNo">852</span> }<a name="line.852"></a> -<span class="sourceLineNo">853</span><a name="line.853"></a> -<span class="sourceLineNo">854</span> /**<a name="line.854"></a> -<span class="sourceLineNo">855</span> * @return current live region servers list wrapped by {@link CompletableFuture}<a name="line.855"></a> -<span class="sourceLineNo">856</span> */<a name="line.856"></a> -<span class="sourceLineNo">857</span> default CompletableFuture<Collection<ServerName>> getRegionServers() {<a name="line.857"></a> -<span class="sourceLineNo">858</span> return getClusterStatus(EnumSet.of(Option.LIVE_SERVERS)).thenApply(ClusterStatus::getServers);<a name="line.858"></a> -<span class="sourceLineNo">859</span> }<a name="line.859"></a> -<span class="sourceLineNo">860</span><a name="line.860"></a> -<span class="sourceLineNo">861</span> /**<a name="line.861"></a> -<span class="sourceLineNo">862</span> * @return a list of master coprocessors wrapped by {@link CompletableFuture}<a name="line.862"></a> -<span class="sourceLineNo">863</span> */<a name="line.863"></a> -<span class="sourceLineNo">864</span> default CompletableFuture<List<String>> getMasterCoprocessors() {<a name="line.864"></a> -<span class="sourceLineNo">865</span> return getClusterStatus(EnumSet.of(Option.MASTER_COPROCESSORS))<a name="line.865"></a> -<span class="sourceLineNo">866</span> .thenApply(ClusterStatus::getMasterCoprocessors).thenApply(Arrays::asList);<a name="line.866"></a> -<span class="sourceLineNo">867</span> }<a name="line.867"></a> -<span class="sourceLineNo">868</span><a name="line.868"></a> -<span class="sourceLineNo">869</span> /**<a name="line.869"></a> -<span class="sourceLineNo">870</span> * Get the info port of the current master if one is available.<a name="line.870"></a> -<span class="sourceLineNo">871</span> * @return master info port<a name="line.871"></a> -<span class="sourceLineNo">872</span> */<a name="line.872"></a> -<span class="sourceLineNo">873</span> default CompletableFuture<Integer> getMasterInfoPort() {<a name="line.873"></a> -<span class="sourceLineNo">874</span> return getClusterStatus(EnumSet.of(Option.MASTER_INFO_PORT)).thenApply(<a name="line.874"></a> -<span class="sourceLineNo">875</span> ClusterStatus::getMasterInfoPort);<a name="line.875"></a> -<span class="sourceLineNo">876</span> }<a name="line.876"></a> -<span class="sourceLineNo">877</span><a name="line.877"></a> -<span class="sourceLineNo">878</span> /**<a name="line.878"></a> -<span class="sourceLineNo">879</span> * Shuts down the HBase cluster.<a name="line.879"></a> -<span class="sourceLineNo">880</span> */<a name="line.880"></a> -<span class="sourceLineNo">881</span> CompletableFuture<Void> shutdown();<a name="line.881"></a> -<span class="sourceLineNo">882</span><a name="line.882"></a> -<span class="sourceLineNo">883</span> /**<a name="line.883"></a> -<span class="sourceLineNo">884</span> * Shuts down the current HBase master only.<a name="line.884"></a> -<span class="sourceLineNo">885</span> */<a name="line.885"></a> -<span class="sourceLineNo">886</span> CompletableFuture<Void> stopMaster();<a name="line.886"></a> -<span class="sourceLineNo">887</span><a name="line.887"></a> -<span class="sourceLineNo">888</span> /**<a name="line.888"></a> -<span class="sourceLineNo">889</span> * Stop the designated regionserver.<a name="line.889"></a> -<span class="sourceLineNo">890</span> * @param serverName<a name="line.890"></a> +<span class="sourceLineNo">838</span> CompletableFuture<Void> recommissionRegionServer(ServerName server,<a name="line.838"></a> +<span class="sourceLineNo">839</span> List<byte[]> encodedRegionNames);<a name="line.839"></a> +<span class="sourceLineNo">840</span><a name="line.840"></a> +<span class="sourceLineNo">841</span> /**<a name="line.841"></a> +<span class="sourceLineNo">842</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.842"></a> +<span class="sourceLineNo">843</span> */<a name="line.843"></a> +<span class="sourceLineNo">844</span> CompletableFuture<ClusterStatus> getClusterStatus();<a name="line.844"></a> +<span class="sourceLineNo">845</span><a name="line.845"></a> +<span class="sourceLineNo">846</span> /**<a name="line.846"></a> +<span class="sourceLineNo">847</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.847"></a> +<span class="sourceLineNo">848</span> */<a name="line.848"></a> +<span class="sourceLineNo">849</span> CompletableFuture<ClusterStatus> getClusterStatus(EnumSet<Option> options);<a name="line.849"></a> +<span class="sourceLineNo">850</span><a name="line.850"></a> +<span class="sourceLineNo">851</span> /**<a name="line.851"></a> +<span class="sourceLineNo">852</span> * @return current master server name wrapped by {@link CompletableFuture}<a name="line.852"></a> +<span class="sourceLineNo">853</span> */<a name="line.853"></a> +<span class="sourceLineNo">854</span> default CompletableFuture<ServerName> getMaster() {<a name="line.854"></a> +<span class="sourceLineNo">855</span> return getClusterStatus(EnumSet.of(Option.MASTER)).thenApply(ClusterStatus::getMaster);<a name="line.855"></a> +<span class="sourceLineNo">856</span> }<a name="line.856"></a> +<span class="sourceLineNo">857</span><a name="line.857"></a> +<span class="sourceLineNo">858</span> /**<a name="line.858"></a> +<span class="sourceLineNo">859</span> * @return current backup master list wrapped by {@link CompletableFuture}<a name="line.859"></a> +<span class="sourceLineNo">860</span> */<a name="line.860"></a> +<span class="sourceLineNo">861</span> default CompletableFuture<Collection<ServerName>> getBackupMasters() {<a name="line.861"></a> +<span class="sourceLineNo">862</span> return getClusterStatus(EnumSet.of(Option.BACKUP_MASTERS)).thenApply(ClusterStatus::getBackupMasters);<a name="line.862"></a> +<span class="sourceLineNo">863</span> }<a name="line.863"></a> +<span class="sourceLineNo">864</span><a name="line.864"></a> +<span class="sourceLineNo">865</span> /**<a name="line.865"></a> +<span class="sourceLineNo">866</span> * @return current live region servers list wrapped by {@link CompletableFuture}<a name="line.866"></a> +<span class="sourceLineNo">867</span> */<a name="line.867"></a> +<span class="sourceLineNo">868</span> default CompletableFuture<Collection<ServerName>> getRegionServers() {<a name="line.868"></a> +<span class="sourceLineNo">869</span> return getClusterStatus(EnumSet.of(Option.LIVE_SERVERS)).thenApply(ClusterStatus::getServers);<a name="line.869"></a> +<span class="sourceLineNo">870</span> }<a name="line.870"></a> +<span class="sourceLineNo">871</span><a name="line.871"></a> +<span class="sourceLineNo">872</span> /**<a name="line.872"></a> +<span class="sourceLineNo">873</span> * @return a list of master coprocessors wrapped by {@link CompletableFuture}<a name="line.873"></a> +<span class="sourceLineNo">874</span> */<a name="line.874"></a> +<span class="sourceLineNo">875</span> default CompletableFuture<List<String>> getMasterCoprocessors() {<a name="line.875"></a> +<span class="sourceLineNo">876</span> return getClusterStatus(EnumSet.of(Option.MASTER_COPROCESSORS))<a name="line.876"></a> +<span class="sourceLineNo">877</span> .thenApply(ClusterStatus::getMasterCoprocessors).thenApply(Arrays::asList);<a name="line.877"></a> +<span class="sourceLineNo">878</span> }<a name="line.878"></a> +<span class="sourceLineNo">879</span><a name="line.879"></a> +<span class="sourceLineNo">880</span> /**<a name="line.880"></a> +<span class="sourceLineNo">881</span> * Get the info port of the current master if one is available.<a name="line.881"></a> +<span class="sourceLineNo">882</span> * @return master info port<a name="line.882"></a> +<span class="sourceLineNo">883</span> */<a name="line.883"></a> +<span class="sourceLineNo">884</span> default CompletableFuture<Integer> getMasterInfoPort() {<a name="line.884"></a> +<span class="sourceLineNo">885</span> return getClusterStatus(EnumSet.of(Option.MASTER_INFO_PORT)).thenApply(<a name="line.885"></a> +<span class="sourceLineNo">886</span> ClusterStatus::getMasterInfoPort);<a name="line.886"></a> +<span class="sourceLineNo">887</span> }<a name="line.887"></a> +<span class="sourceLineNo">888</span><a name="line.888"></a> +<span class="sourceLineNo">889</span> /**<a name="line.889"></a> +<span class="sourceLineNo">890</span> * Shuts down the HBase cluster.<a name="line.890"></a> <span class="sourceLineNo">891</span> */<a name="line.891"></a> -<span class="sourceLineNo">892</span> CompletableFuture<Void> stopRegionServer(ServerName serverName);<a name="line.892"></a> +<span class="sourceLineNo">892</span> CompletableFuture<Void> shutdown();<a name="line.892"></a> <span class="sourceLineNo">893</span><a name="line.893"></a> <span class="sourceLineNo">894</span> /**<a name="line.894"></a> -<span class="sourceLineNo">895</span> * Update the configuration and trigger an online config change on the regionserver.<a name="line.895"></a> -<span class="sourceLineNo">896</span> * @param serverName : The server whose config needs to be updated.<a name="line.896"></a> -<span class="sourceLineNo">897</span> */<a name="line.897"></a> -<span class="sourceLineNo">898</span> CompletableFuture<Void> updateConfiguration(ServerName serverName);<a name="line.898"></a> -<span class="sourceLineNo">899</span><a name="line.899"></a> -<span class="sourceLineNo">900</span> /**<a name="line.900"></a> -<span class="sourceLineNo">901</span> * Update the configuration and trigger an online config change on all the masters and<a name="line.901"></a> -<span class="sourceLineNo">902</span> * regionservers.<a name="line.902"></a> -<span class="sourceLineNo">903</span> */<a name="line.903"></a> -<span class="sourceLineNo">904</span> CompletableFuture<Void> updateConfiguration();<a name="line.904"></a> -<span class="sourceLineNo">905</span><a name="line.905"></a> -<span class="sourceLineNo">906</span> /**<a name="line.906"></a> -<span class="sourceLineNo">907</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.907"></a> -<span class="sourceLineNo">908</span> * <p><a name="line.908"></a> -<span class="sourceLineNo">909</span> * When the returned CompletableFuture is done, it only means the rollWALWriter request was sent<a name="line.909"></a> -<span class="sourceLineNo">910</span> * to the region server and may need some time to finish the rollWALWriter operation. As a side<a name="line.910"></a> -<span class="sourceLineNo">911</span> * effect of this call, the named region server may schedule store flushes at the request of the<a name="line.911"></a> -<span class="sourceLineNo">912</span> * wal.<a name="line.912"></a> -<span class="sourceLineNo">913</span> * @param serverName The servername of the region server.<a name="line.913"></a> +<span class="sourceLineNo">895</span> * Shuts down the current HBase master only.<a name="line.895"></a> +<span class="sourceLineNo">896</span> */<a name="line.896"></a> +<span class="sourceLineNo">897</span> CompletableFuture<Void> stopMaster();<a name="line.897"></a> +<span class="sourceLineNo">898</span><a name="line.898"></a> +<span class="sourceLineNo">899</span> /**<a name="line.899"></a> +<span class="sourceLineNo">900</span> * Stop the designated regionserver.<a name="line.900"></a> +<span class="sourceLineNo">901</span> * @param serverName<a name="line.901"></a> +<span class="sourceLineNo">902</span> */<a name="line.902"></a> +<span class="sourceLineNo">903</span> CompletableFuture<Void> stopRegionServer(ServerName serverName);<a name="line.903"></a> +<span class="sourceLineNo">904</span><a name="line.904"></a> +<span class="sourceLineNo">905</span> /**<a name="line.905"></a> +<span class="sourceLineNo">906</span> * Update the configuration and trigger an online config change on the regionserver.<a name="line.906"></a> +<span class="sourceLineNo">907</span> * @param serverName : The server whose config needs to be updated.<a name="line.907"></a> +<span class="sourceLineNo">908</span> */<a name="line.908"></a> +<span class="sourceLineNo">909</span> CompletableFuture<Void> updateConfiguration(ServerName serverName);<a name="line.909"></a> +<span class="sourceLineNo">910</span><a name="line.910"></a> +<span class="sourceLineNo">911</span> /**<a name="line.911"></a> +<span class="sourceLineNo">912</span> * Update the configuration and trigger an online config change on all the masters and<a name="line.912"></a> +<span class="sourceLineNo">913</span> * regionservers.<a name="line.913"></a> <span class="sourceLineNo">914</span> */<a name="line.914"></a> -<span class="sourceLineNo">915</span> CompletableFuture<Void> rollWALWriter(ServerName serverName);<a name="line.915"></a> +<span class="sourceLineNo">915</span> CompletableFuture<Void> updateConfiguration();<a name="line.915"></a> <span class="sourceLineNo">916</span><a name="line.916"></a> <span class="sourceLineNo">917</span> /**<a name="line.917"></a> -<span class="sourceLineNo">918</span> * Clear compacting queues on a region server.<a name="line.918"></a> -<span class="sourceLineNo">919</span> * @param serverName<a name="line.919"></a> -<span class="sourceLineNo">920</span> * @param queues the set of queue name<a name="line.920"></a> -<span class="sourceLineNo">921</span> */<a name="line.921"></a> -<span class="sourceLineNo">922</span> CompletableFuture<Void> clearCompactionQueues(ServerName serverName, Set<String> queues);<a name="line.922"></a> -<span class="sourceLineNo">923</span><a name="line.923"></a> -<span class="sourceLineNo">924</span> /**<a name="line.924"></a> -<span class="sourceLineNo">925</span> * Get a list of {@link RegionLoad} of all regions hosted on a region seerver.<a name="line.925"></a> -<span class="sourceLineNo">926</span> * @param serverName<a name="line.926"></a> -<span class="sourceLineNo">927</span> * @return a list of {@link RegionLoad} wrapped by {@link CompletableFuture}<a name="line.927"></a> -<span class="sourceLineNo">928</span> */<a name="line.928"></a> -<span class="sourceLineNo">929</span> CompletableFuture<List<RegionLoad>> getRegionLoads(ServerName serverName);<a name="line.929"></a> -<span class="sourceLineNo">930</span><a name="line.930"></a> -<span class="sourceLineNo">931</span> /**<a name="line.931"></a> -<span class="sourceLineNo">932</span> * Get a list of {@link RegionLoad} of all regions hosted on a region seerver for a table.<a name="line.932"></a> -<span class="sourceLineNo">933</span> * @param serverName<a name="line.933"></a> -<span class="sourceLineNo">934</span> * @param tableName<a name="line.934"></a> -<span class="sourceLineNo">935</span> * @return a list of {@link RegionLoad} wrapped by {@link CompletableFuture}<a name="line.935"></a> -<span class="sourceLineNo">936</span> */<a name="line.936"></a> -<span class="sourceLineNo">937</span> CompletableFuture<List<RegionLoad>> getRegionLoads(ServerName serverName, TableName tableName);<a name="line.937"></a> -<span class="sourceLineNo">938</span><a name="line.938"></a> -<span class="sourceLineNo">939</span> /**<a name="line.939"></a> -<span class="sourceLineNo">940</span> * Check whether master is in maintenance mode<a name="line.940"></a> -<span class="sourceLineNo">941</span> * @return true if master is in maintenance mode, false otherwise. The return value will be<a name="line.941"></a> -<span class="sourceLineNo">942</span> * wrapped by a {@link CompletableFuture}<a name="line.942"></a> -<span class="sourceLineNo">943</span> */<a name="line.943"></a> -<span class="sourceLineNo">944</span> CompletableFuture<Boolean> isMasterInMaintenanceMode();<a name="line.944"></a> -<span class="sourceLineNo">945</span><a name="line.945"></a> -<span class="sourceLineNo">946</span> /**<a name="line.946"></a> -<span class="sourceLineNo">947
<TRUNCATED>
