http://git-wip-us.apache.org/repos/asf/hbase-site/blob/2aec596e/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 40fb8bd..477e3fa 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html @@ -301,823 +301,821 @@ <span class="sourceLineNo">293</span> * Close a region. For expert-admins Runs close on the regionserver. The master will not be<a name="line.293"></a> <span class="sourceLineNo">294</span> * informed of the close.<a name="line.294"></a> <span class="sourceLineNo">295</span> * @param regionName region name to close<a name="line.295"></a> -<span class="sourceLineNo">296</span> * @param serverName The servername of the regionserver. If not present, we will use servername<a name="line.296"></a> -<span class="sourceLineNo">297</span> * found in the hbase:meta table. A server name is made of host, port and startcode. Here<a name="line.297"></a> -<span class="sourceLineNo">298</span> * is an example: <code> host187.example.com,60020,1289493121758</code><a name="line.298"></a> -<span class="sourceLineNo">299</span> * @return true if the region was closed, false if not. The return value will be wrapped by a<a name="line.299"></a> -<span class="sourceLineNo">300</span> * {@link CompletableFuture}.<a name="line.300"></a> -<span class="sourceLineNo">301</span> */<a name="line.301"></a> -<span class="sourceLineNo">302</span> CompletableFuture<Boolean> closeRegion(byte[] regionName, Optional<ServerName> serverName);<a name="line.302"></a> -<span class="sourceLineNo">303</span><a name="line.303"></a> -<span class="sourceLineNo">304</span> /**<a name="line.304"></a> -<span class="sourceLineNo">305</span> * Get all the online regions on a region server.<a name="line.305"></a> -<span class="sourceLineNo">306</span> */<a name="line.306"></a> -<span class="sourceLineNo">307</span> CompletableFuture<List<HRegionInfo>> getOnlineRegions(ServerName serverName);<a name="line.307"></a> -<span class="sourceLineNo">308</span><a name="line.308"></a> -<span class="sourceLineNo">309</span> /**<a name="line.309"></a> -<span class="sourceLineNo">310</span> * Get the regions of a given table.<a name="line.310"></a> -<span class="sourceLineNo">311</span> */<a name="line.311"></a> -<span class="sourceLineNo">312</span> CompletableFuture<List<HRegionInfo>> getTableRegions(TableName tableName);<a name="line.312"></a> -<span class="sourceLineNo">313</span><a name="line.313"></a> -<span class="sourceLineNo">314</span> /**<a name="line.314"></a> -<span class="sourceLineNo">315</span> * Flush a table.<a name="line.315"></a> -<span class="sourceLineNo">316</span> * @param tableName table to flush<a name="line.316"></a> -<span class="sourceLineNo">317</span> */<a name="line.317"></a> -<span class="sourceLineNo">318</span> CompletableFuture<Void> flush(TableName tableName);<a name="line.318"></a> -<span class="sourceLineNo">319</span><a name="line.319"></a> -<span class="sourceLineNo">320</span> /**<a name="line.320"></a> -<span class="sourceLineNo">321</span> * Flush an individual region.<a name="line.321"></a> -<span class="sourceLineNo">322</span> * @param regionName region to flush<a name="line.322"></a> -<span class="sourceLineNo">323</span> */<a name="line.323"></a> -<span class="sourceLineNo">324</span> CompletableFuture<Void> flushRegion(byte[] regionName);<a name="line.324"></a> -<span class="sourceLineNo">325</span><a name="line.325"></a> -<span class="sourceLineNo">326</span> /**<a name="line.326"></a> -<span class="sourceLineNo">327</span> * Compact a table. When the returned CompletableFuture is done, it only means the compact request<a name="line.327"></a> -<span class="sourceLineNo">328</span> * was sent to HBase and may need some time to finish the compact operation.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * @param tableName table to compact<a name="line.329"></a> -<span class="sourceLineNo">330</span> */<a name="line.330"></a> -<span class="sourceLineNo">331</span> default CompletableFuture<Void> compact(TableName tableName) {<a name="line.331"></a> -<span class="sourceLineNo">332</span> return compact(tableName, Optional.empty());<a name="line.332"></a> -<span class="sourceLineNo">333</span> }<a name="line.333"></a> -<span class="sourceLineNo">334</span><a name="line.334"></a> -<span class="sourceLineNo">335</span> /**<a name="line.335"></a> -<span class="sourceLineNo">336</span> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.336"></a> -<span class="sourceLineNo">337</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.337"></a> -<span class="sourceLineNo">338</span> * operation.<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @param tableName table to compact<a name="line.339"></a> -<span class="sourceLineNo">340</span> * @param columnFamily column family within a table. If not present, compact the table's all<a name="line.340"></a> -<span class="sourceLineNo">341</span> * column families.<a name="line.341"></a> -<span class="sourceLineNo">342</span> */<a name="line.342"></a> -<span class="sourceLineNo">343</span> CompletableFuture<Void> compact(TableName tableName, Optional<byte[]> columnFamily);<a name="line.343"></a> -<span class="sourceLineNo">344</span><a name="line.344"></a> -<span class="sourceLineNo">345</span> /**<a name="line.345"></a> -<span class="sourceLineNo">346</span> * Compact an individual region. When the returned CompletableFuture is done, it only means the<a name="line.346"></a> -<span class="sourceLineNo">347</span> * compact request was sent to HBase and may need some time to finish the compact operation.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @param regionName region to compact<a name="line.348"></a> -<span class="sourceLineNo">349</span> */<a name="line.349"></a> -<span class="sourceLineNo">350</span> default CompletableFuture<Void> compactRegion(byte[] regionName) {<a name="line.350"></a> -<span class="sourceLineNo">351</span> return compactRegion(regionName, Optional.empty());<a name="line.351"></a> -<span class="sourceLineNo">352</span> }<a name="line.352"></a> -<span class="sourceLineNo">353</span><a name="line.353"></a> -<span class="sourceLineNo">354</span> /**<a name="line.354"></a> -<span class="sourceLineNo">355</span> * Compact a column family within a region. When the returned CompletableFuture is done, it only<a name="line.355"></a> -<span class="sourceLineNo">356</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.356"></a> -<span class="sourceLineNo">357</span> * operation.<a name="line.357"></a> -<span class="sourceLineNo">358</span> * @param regionName region to compact<a name="line.358"></a> -<span class="sourceLineNo">359</span> * @param columnFamily column family within a region. If not present, compact the region's all<a name="line.359"></a> -<span class="sourceLineNo">360</span> * column families.<a name="line.360"></a> -<span class="sourceLineNo">361</span> */<a name="line.361"></a> -<span class="sourceLineNo">362</span> CompletableFuture<Void> compactRegion(byte[] regionName, Optional<byte[]> columnFamily);<a name="line.362"></a> -<span class="sourceLineNo">363</span><a name="line.363"></a> -<span class="sourceLineNo">364</span> /**<a name="line.364"></a> -<span class="sourceLineNo">365</span> * Major compact a table. When the returned CompletableFuture is done, it only means the compact<a name="line.365"></a> -<span class="sourceLineNo">366</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.366"></a> -<span class="sourceLineNo">367</span> * @param tableName table to major compact<a name="line.367"></a> -<span class="sourceLineNo">368</span> */<a name="line.368"></a> -<span class="sourceLineNo">369</span> default CompletableFuture<Void> majorCompact(TableName tableName) {<a name="line.369"></a> -<span class="sourceLineNo">370</span> return majorCompact(tableName, Optional.empty());<a name="line.370"></a> -<span class="sourceLineNo">371</span> }<a name="line.371"></a> -<span class="sourceLineNo">372</span><a name="line.372"></a> -<span class="sourceLineNo">373</span> /**<a name="line.373"></a> -<span class="sourceLineNo">374</span> * Major compact a column family within a table. When the returned CompletableFuture is done, it<a name="line.374"></a> -<span class="sourceLineNo">375</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.375"></a> -<span class="sourceLineNo">376</span> * operation.<a name="line.376"></a> -<span class="sourceLineNo">377</span> * @param tableName table to major compact<a name="line.377"></a> -<span class="sourceLineNo">378</span> * @param columnFamily column family within a table. If not present, major compact the table's all<a name="line.378"></a> -<span class="sourceLineNo">379</span> * column families.<a name="line.379"></a> -<span class="sourceLineNo">380</span> */<a name="line.380"></a> -<span class="sourceLineNo">381</span> CompletableFuture<Void> majorCompact(TableName tableName, Optional<byte[]> columnFamily);<a name="line.381"></a> -<span class="sourceLineNo">382</span><a name="line.382"></a> -<span class="sourceLineNo">383</span> /**<a name="line.383"></a> -<span class="sourceLineNo">384</span> * Major compact a region. When the returned CompletableFuture is done, it only means the compact<a name="line.384"></a> -<span class="sourceLineNo">385</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.385"></a> -<span class="sourceLineNo">386</span> * @param regionName region to major compact<a name="line.386"></a> -<span class="sourceLineNo">387</span> */<a name="line.387"></a> -<span class="sourceLineNo">388</span> default CompletableFuture<Void> majorCompactRegion(byte[] regionName) {<a name="line.388"></a> -<span class="sourceLineNo">389</span> return majorCompactRegion(regionName, Optional.empty());<a name="line.389"></a> -<span class="sourceLineNo">390</span> }<a name="line.390"></a> -<span class="sourceLineNo">391</span><a name="line.391"></a> -<span class="sourceLineNo">392</span> /**<a name="line.392"></a> -<span class="sourceLineNo">393</span> * Major compact a column family within region. When the returned CompletableFuture is done, it<a name="line.393"></a> -<span class="sourceLineNo">394</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.394"></a> -<span class="sourceLineNo">395</span> * operation.<a name="line.395"></a> -<span class="sourceLineNo">396</span> * @param regionName region to major compact<a name="line.396"></a> -<span class="sourceLineNo">397</span> * @param columnFamily column family within a region. If not present, major compact the region's<a name="line.397"></a> -<span class="sourceLineNo">398</span> * all column families.<a name="line.398"></a> -<span class="sourceLineNo">399</span> */<a name="line.399"></a> -<span class="sourceLineNo">400</span> CompletableFuture<Void> majorCompactRegion(byte[] regionName, Optional<byte[]> columnFamily);<a name="line.400"></a> -<span class="sourceLineNo">401</span><a name="line.401"></a> -<span class="sourceLineNo">402</span> /**<a name="line.402"></a> -<span class="sourceLineNo">403</span> * Compact all regions on the region server.<a name="line.403"></a> -<span class="sourceLineNo">404</span> * @param serverName the region server name<a name="line.404"></a> -<span class="sourceLineNo">405</span> */<a name="line.405"></a> -<span class="sourceLineNo">406</span> CompletableFuture<Void> compactRegionServer(ServerName serverName);<a name="line.406"></a> -<span class="sourceLineNo">407</span><a name="line.407"></a> -<span class="sourceLineNo">408</span> /**<a name="line.408"></a> -<span class="sourceLineNo">409</span> * Compact all regions on the region server.<a name="line.409"></a> -<span class="sourceLineNo">410</span> * @param serverName the region server name<a name="line.410"></a> -<span class="sourceLineNo">411</span> */<a name="line.411"></a> -<span class="sourceLineNo">412</span> CompletableFuture<Void> majorCompactRegionServer(ServerName serverName);<a name="line.412"></a> -<span class="sourceLineNo">413</span><a name="line.413"></a> -<span class="sourceLineNo">414</span> /**<a name="line.414"></a> -<span class="sourceLineNo">415</span> * Turn the Merge switch on or off.<a name="line.415"></a> -<span class="sourceLineNo">416</span> * @param on<a name="line.416"></a> -<span class="sourceLineNo">417</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.417"></a> -<span class="sourceLineNo">418</span> */<a name="line.418"></a> -<span class="sourceLineNo">419</span> CompletableFuture<Boolean> setMergeOn(boolean on);<a name="line.419"></a> -<span class="sourceLineNo">420</span><a name="line.420"></a> -<span class="sourceLineNo">421</span> /**<a name="line.421"></a> -<span class="sourceLineNo">422</span> * Query the current state of the Merge switch.<a name="line.422"></a> -<span class="sourceLineNo">423</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.423"></a> -<span class="sourceLineNo">424</span> * {@link CompletableFuture}<a name="line.424"></a> -<span class="sourceLineNo">425</span> */<a name="line.425"></a> -<span class="sourceLineNo">426</span> CompletableFuture<Boolean> isMergeOn();<a name="line.426"></a> -<span class="sourceLineNo">427</span><a name="line.427"></a> -<span class="sourceLineNo">428</span> /**<a name="line.428"></a> -<span class="sourceLineNo">429</span> * Turn the Split switch on or off.<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param on<a name="line.430"></a> -<span class="sourceLineNo">431</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.431"></a> -<span class="sourceLineNo">432</span> */<a name="line.432"></a> -<span class="sourceLineNo">433</span> CompletableFuture<Boolean> setSplitOn(boolean on);<a name="line.433"></a> -<span class="sourceLineNo">434</span><a name="line.434"></a> -<span class="sourceLineNo">435</span> /**<a name="line.435"></a> -<span class="sourceLineNo">436</span> * Query the current state of the Split switch.<a name="line.436"></a> -<span class="sourceLineNo">437</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.437"></a> -<span class="sourceLineNo">438</span> * {@link CompletableFuture}<a name="line.438"></a> -<span class="sourceLineNo">439</span> */<a name="line.439"></a> -<span class="sourceLineNo">440</span> CompletableFuture<Boolean> isSplitOn();<a name="line.440"></a> -<span class="sourceLineNo">441</span><a name="line.441"></a> -<span class="sourceLineNo">442</span> /**<a name="line.442"></a> -<span class="sourceLineNo">443</span> * Merge two regions.<a name="line.443"></a> -<span class="sourceLineNo">444</span> * @param nameOfRegionA encoded or full name of region a<a name="line.444"></a> -<span class="sourceLineNo">445</span> * @param nameOfRegionB encoded or full name of region b<a name="line.445"></a> -<span class="sourceLineNo">446</span> * @param forcible true if do a compulsory merge, otherwise we will only merge two adjacent<a name="line.446"></a> -<span class="sourceLineNo">447</span> * regions<a name="line.447"></a> -<span class="sourceLineNo">448</span> */<a name="line.448"></a> -<span class="sourceLineNo">449</span> CompletableFuture<Void> mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB,<a name="line.449"></a> -<span class="sourceLineNo">450</span> boolean forcible);<a name="line.450"></a> -<span class="sourceLineNo">451</span><a name="line.451"></a> -<span class="sourceLineNo">452</span> /**<a name="line.452"></a> -<span class="sourceLineNo">453</span> * Split a table. The method will execute split action for each region in table.<a name="line.453"></a> -<span class="sourceLineNo">454</span> * @param tableName table to split<a name="line.454"></a> -<span class="sourceLineNo">455</span> */<a name="line.455"></a> -<span class="sourceLineNo">456</span> CompletableFuture<Void> split(TableName tableName);<a name="line.456"></a> -<span class="sourceLineNo">457</span><a name="line.457"></a> -<span class="sourceLineNo">458</span> /**<a name="line.458"></a> -<span class="sourceLineNo">459</span> * Split an individual region.<a name="line.459"></a> -<span class="sourceLineNo">460</span> * @param regionName region to split<a name="line.460"></a> -<span class="sourceLineNo">461</span> */<a name="line.461"></a> -<span class="sourceLineNo">462</span> default CompletableFuture<Void> splitRegion(byte[] regionName) {<a name="line.462"></a> -<span class="sourceLineNo">463</span> return splitRegion(regionName, Optional.empty());<a name="line.463"></a> -<span class="sourceLineNo">464</span> }<a name="line.464"></a> -<span class="sourceLineNo">465</span><a name="line.465"></a> -<span class="sourceLineNo">466</span> /**<a name="line.466"></a> -<span class="sourceLineNo">467</span> * Split a table.<a name="line.467"></a> -<span class="sourceLineNo">468</span> * @param tableName table to split<a name="line.468"></a> -<span class="sourceLineNo">469</span> * @param splitPoint the explicit position to split on<a name="line.469"></a> -<span class="sourceLineNo">470</span> */<a name="line.470"></a> -<span class="sourceLineNo">471</span> CompletableFuture<Void> split(TableName tableName, byte[] splitPoint);<a name="line.471"></a> -<span class="sourceLineNo">472</span><a name="line.472"></a> -<span class="sourceLineNo">473</span> /**<a name="line.473"></a> -<span class="sourceLineNo">474</span> * Split an individual region.<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @param regionName region to split<a name="line.475"></a> -<span class="sourceLineNo">476</span> * @param splitPoint the explicit position to split on. If not present, it will decide by region<a name="line.476"></a> -<span class="sourceLineNo">477</span> * server.<a name="line.477"></a> -<span class="sourceLineNo">478</span> */<a name="line.478"></a> -<span class="sourceLineNo">479</span> CompletableFuture<Void> splitRegion(byte[] regionName, Optional<byte[]> splitPoint);<a name="line.479"></a> -<span class="sourceLineNo">480</span><a name="line.480"></a> -<span class="sourceLineNo">481</span> /**<a name="line.481"></a> -<span class="sourceLineNo">482</span> * @param regionName Encoded or full name of region to assign.<a name="line.482"></a> -<span class="sourceLineNo">483</span> */<a name="line.483"></a> -<span class="sourceLineNo">484</span> CompletableFuture<Void> assign(byte[] regionName);<a name="line.484"></a> -<span class="sourceLineNo">485</span><a name="line.485"></a> -<span class="sourceLineNo">486</span> /**<a name="line.486"></a> -<span class="sourceLineNo">487</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.487"></a> -<span class="sourceLineNo">488</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use<a name="line.488"></a> -<span class="sourceLineNo">489</span> * {@link #move(byte[], Optional)} if you want to control the region movement.<a name="line.489"></a> -<span class="sourceLineNo">490</span> * @param regionName Encoded or full name of region to unassign. Will clear any existing<a name="line.490"></a> -<span class="sourceLineNo">491</span> * RegionPlan if one found.<a name="line.491"></a> -<span class="sourceLineNo">492</span> * @param forcible If true, force unassign (Will remove region from regions-in-transition too if<a name="line.492"></a> -<span class="sourceLineNo">493</span> * present. If results in double assignment use hbck -fix to resolve. To be used by<a name="line.493"></a> -<span class="sourceLineNo">494</span> * experts).<a name="line.494"></a> -<span class="sourceLineNo">495</span> */<a name="line.495"></a> -<span class="sourceLineNo">496</span> CompletableFuture<Void> unassign(byte[] regionName, boolean forcible);<a name="line.496"></a> -<span class="sourceLineNo">497</span><a name="line.497"></a> -<span class="sourceLineNo">498</span> /**<a name="line.498"></a> -<span class="sourceLineNo">499</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.499"></a> -<span class="sourceLineNo">500</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.500"></a> -<span class="sourceLineNo">501</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.501"></a> -<span class="sourceLineNo">502</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.502"></a> -<span class="sourceLineNo">503</span> * experts or hbck.<a name="line.503"></a> -<span class="sourceLineNo">504</span> * @param regionName Encoded or full name of region to offline<a name="line.504"></a> -<span class="sourceLineNo">505</span> */<a name="line.505"></a> -<span class="sourceLineNo">506</span> CompletableFuture<Void> offline(byte[] regionName);<a name="line.506"></a> -<span class="sourceLineNo">507</span><a name="line.507"></a> -<span class="sourceLineNo">508</span> /**<a name="line.508"></a> -<span class="sourceLineNo">509</span> * Move the region <code>r</code> to <code>dest</code>.<a name="line.509"></a> -<span class="sourceLineNo">510</span> * @param regionName Encoded or full name of region to move.<a name="line.510"></a> -<span class="sourceLineNo">511</span> * @param destServerName The servername of the destination regionserver. If not present, we'll<a name="line.511"></a> -<span class="sourceLineNo">512</span> * assign to a random server. A server name is made of host, port and startcode. Here is<a name="line.512"></a> -<span class="sourceLineNo">513</span> * an example: <code> host187.example.com,60020,1289493121758</code><a name="line.513"></a> -<span class="sourceLineNo">514</span> */<a name="line.514"></a> -<span class="sourceLineNo">515</span> CompletableFuture<Void> move(byte[] regionName, Optional<ServerName> destServerName);<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> * Apply the new quota settings.<a name="line.518"></a> -<span class="sourceLineNo">519</span> * @param quota the quota settings<a name="line.519"></a> -<span class="sourceLineNo">520</span> */<a name="line.520"></a> -<span class="sourceLineNo">521</span> CompletableFuture<Void> setQuota(QuotaSettings quota);<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> * List the quotas based on the filter.<a name="line.524"></a> -<span class="sourceLineNo">525</span> * @param filter the quota settings filter<a name="line.525"></a> -<span class="sourceLineNo">526</span> * @return the QuotaSetting list, which wrapped by a CompletableFuture.<a name="line.526"></a> -<span class="sourceLineNo">527</span> */<a name="line.527"></a> -<span class="sourceLineNo">528</span> CompletableFuture<List<QuotaSettings>> getQuota(QuotaFilter filter);<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> * Add a new replication peer for replicating data to slave cluster<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 configuration for the replication slave cluster<a name="line.533"></a> -<span class="sourceLineNo">534</span> */<a name="line.534"></a> -<span class="sourceLineNo">535</span> CompletableFuture<Void> addReplicationPeer(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> * Remove a peer and stop the replication<a name="line.539"></a> -<span class="sourceLineNo">540</span> * @param peerId a short name that identifies the peer<a name="line.540"></a> -<span class="sourceLineNo">541</span> */<a name="line.541"></a> -<span class="sourceLineNo">542</span> CompletableFuture<Void> removeReplicationPeer(String peerId);<a name="line.542"></a> -<span class="sourceLineNo">543</span><a name="line.543"></a> -<span class="sourceLineNo">544</span> /**<a name="line.544"></a> -<span class="sourceLineNo">545</span> * Restart the replication stream to the specified peer<a name="line.545"></a> -<span class="sourceLineNo">546</span> * @param peerId a short name that identifies the peer<a name="line.546"></a> -<span class="sourceLineNo">547</span> */<a name="line.547"></a> -<span class="sourceLineNo">548</span> CompletableFuture<Void> enableReplicationPeer(String peerId);<a name="line.548"></a> -<span class="sourceLineNo">549</span><a name="line.549"></a> -<span class="sourceLineNo">550</span> /**<a name="line.550"></a> -<span class="sourceLineNo">551</span> * Stop the replication stream to the specified peer<a name="line.551"></a> -<span class="sourceLineNo">552</span> * @param peerId a short name that identifies the peer<a name="line.552"></a> -<span class="sourceLineNo">553</span> */<a name="line.553"></a> -<span class="sourceLineNo">554</span> CompletableFuture<Void> disableReplicationPeer(String peerId);<a name="line.554"></a> -<span class="sourceLineNo">555</span><a name="line.555"></a> -<span class="sourceLineNo">556</span> /**<a name="line.556"></a> -<span class="sourceLineNo">557</span> * Returns the configured ReplicationPeerConfig for the specified peer<a name="line.557"></a> -<span class="sourceLineNo">558</span> * @param peerId a short name that identifies the peer<a name="line.558"></a> -<span class="sourceLineNo">559</span> * @return ReplicationPeerConfig for the peer wrapped by a {@link CompletableFuture}.<a name="line.559"></a> -<span class="sourceLineNo">560</span> */<a name="line.560"></a> -<span class="sourceLineNo">561</span> CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId);<a name="line.561"></a> -<span class="sourceLineNo">562</span><a name="line.562"></a> -<span class="sourceLineNo">563</span> /**<a name="line.563"></a> -<span class="sourceLineNo">564</span> * Update the peerConfig for the specified peer<a name="line.564"></a> -<span class="sourceLineNo">565</span> * @param peerId a short name that identifies the peer<a name="line.565"></a> -<span class="sourceLineNo">566</span> * @param peerConfig new config for the peer<a name="line.566"></a> -<span class="sourceLineNo">567</span> */<a name="line.567"></a> -<span class="sourceLineNo">568</span> CompletableFuture<Void> updateReplicationPeerConfig(String peerId,<a name="line.568"></a> -<span class="sourceLineNo">569</span> ReplicationPeerConfig peerConfig);<a name="line.569"></a> -<span class="sourceLineNo">570</span><a name="line.570"></a> -<span class="sourceLineNo">571</span> /**<a name="line.571"></a> -<span class="sourceLineNo">572</span> * Append the replicable table-cf config of the specified peer<a name="line.572"></a> -<span class="sourceLineNo">573</span> * @param peerId a short that identifies the cluster<a name="line.573"></a> -<span class="sourceLineNo">574</span> * @param tableCfs A map from tableName to column family names<a name="line.574"></a> -<span class="sourceLineNo">575</span> */<a name="line.575"></a> -<span class="sourceLineNo">576</span> CompletableFuture<Void> appendReplicationPeerTableCFs(String peerId,<a name="line.576"></a> -<span class="sourceLineNo">577</span> Map<TableName, ? extends Collection<String>> tableCfs);<a name="line.577"></a> -<span class="sourceLineNo">578</span><a name="line.578"></a> -<span class="sourceLineNo">579</span> /**<a name="line.579"></a> -<span class="sourceLineNo">580</span> * Remove some table-cfs from config of the specified peer<a name="line.580"></a> -<span class="sourceLineNo">581</span> * @param peerId a short name that identifies the cluster<a name="line.581"></a> -<span class="sourceLineNo">582</span> * @param tableCfs A map from tableName to column family names<a name="line.582"></a> -<span class="sourceLineNo">583</span> */<a name="line.583"></a> -<span class="sourceLineNo">584</span> CompletableFuture<Void> removeReplicationPeerTableCFs(String peerId,<a name="line.584"></a> -<span class="sourceLineNo">585</span> Map<TableName, ? extends Collection<String>> tableCfs);<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> * Return a list of replication peers.<a name="line.588"></a> -<span class="sourceLineNo">589</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.589"></a> -<span class="sourceLineNo">590</span> * {@link CompletableFuture}.<a name="line.590"></a> -<span class="sourceLineNo">591</span> */<a name="line.591"></a> -<span class="sourceLineNo">592</span> default CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers() {<a name="line.592"></a> -<span class="sourceLineNo">593</span> return listReplicationPeers(Optional.empty());<a name="line.593"></a> -<span class="sourceLineNo">594</span> }<a name="line.594"></a> -<span class="sourceLineNo">595</span><a name="line.595"></a> -<span class="sourceLineNo">596</span> /**<a name="line.596"></a> -<span class="sourceLineNo">597</span> * Return a list of replication peers.<a name="line.597"></a> -<span class="sourceLineNo">598</span> * @param pattern The compiled regular expression to match peer id<a name="line.598"></a> -<span class="sourceLineNo">599</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.599"></a> -<span class="sourceLineNo">600</span> * {@link CompletableFuture}.<a name="line.600"></a> -<span class="sourceLineNo">601</span> */<a name="line.601"></a> -<span class="sourceLineNo">602</span> CompletableFuture<List<ReplicationPeerDescription>><a name="line.602"></a> -<span class="sourceLineNo">603</span> listReplicationPeers(Optional<Pattern> pattern);<a name="line.603"></a> -<span class="sourceLineNo">604</span><a name="line.604"></a> -<span class="sourceLineNo">605</span> /**<a name="line.605"></a> -<span class="sourceLineNo">606</span> * Find all table and column families that are replicated from this cluster<a name="line.606"></a> -<span class="sourceLineNo">607</span> * @return the replicated table-cfs list of this cluster. The return value will be wrapped by a<a name="line.607"></a> -<span class="sourceLineNo">608</span> * {@link CompletableFuture}.<a name="line.608"></a> -<span class="sourceLineNo">609</span> */<a name="line.609"></a> -<span class="sourceLineNo">610</span> CompletableFuture<List<TableCFs>> listReplicatedTableCFs();<a name="line.610"></a> -<span class="sourceLineNo">611</span><a name="line.611"></a> -<span class="sourceLineNo">612</span> /**<a name="line.612"></a> -<span class="sourceLineNo">613</span> * Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be<a name="line.613"></a> -<span class="sourceLineNo">614</span> * taken. If the table is disabled, an offline snapshot is taken. Snapshots are considered unique<a name="line.614"></a> -<span class="sourceLineNo">615</span> * based on <b>the name of the snapshot</b>. Attempts to take a snapshot with the same name (even<a name="line.615"></a> -<span class="sourceLineNo">616</span> * a different type or with different parameters) will fail with a<a name="line.616"></a> -<span class="sourceLineNo">617</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.617"></a> -<span class="sourceLineNo">618</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.618"></a> -<span class="sourceLineNo">619</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.619"></a> -<span class="sourceLineNo">620</span> * @param snapshotName name of the snapshot to be created<a name="line.620"></a> -<span class="sourceLineNo">621</span> * @param tableName name of the table for which snapshot is created<a name="line.621"></a> -<span class="sourceLineNo">622</span> */<a name="line.622"></a> -<span class="sourceLineNo">623</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName) {<a name="line.623"></a> -<span class="sourceLineNo">624</span> return snapshot(snapshotName, tableName, SnapshotType.FLUSH);<a name="line.624"></a> -<span class="sourceLineNo">625</span> }<a name="line.625"></a> -<span class="sourceLineNo">626</span><a name="line.626"></a> -<span class="sourceLineNo">627</span> /**<a name="line.627"></a> -<span class="sourceLineNo">628</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.628"></a> -<span class="sourceLineNo">629</span> * snapshot</b>. Attempts to take a snapshot with the same name (even a different type or with<a name="line.629"></a> -<span class="sourceLineNo">630</span> * different parameters) will fail with a<a name="line.630"></a> -<span class="sourceLineNo">631</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.631"></a> -<span class="sourceLineNo">632</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.632"></a> -<span class="sourceLineNo">633</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.633"></a> -<span class="sourceLineNo">634</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.634"></a> -<span class="sourceLineNo">635</span> * snapshots stored on the cluster<a name="line.635"></a> -<span class="sourceLineNo">636</span> * @param tableName name of the table to snapshot<a name="line.636"></a> -<span class="sourceLineNo">637</span> * @param type type of snapshot to take<a name="line.637"></a> -<span class="sourceLineNo">638</span> */<a name="line.638"></a> -<span class="sourceLineNo">639</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName,<a name="line.639"></a> -<span class="sourceLineNo">640</span> SnapshotType type) {<a name="line.640"></a> -<span class="sourceLineNo">641</span> return snapshot(new SnapshotDescription(snapshotName, tableName, type));<a name="line.641"></a> -<span class="sourceLineNo">642</span> }<a name="line.642"></a> -<span class="sourceLineNo">643</span><a name="line.643"></a> -<span class="sourceLineNo">644</span> /**<a name="line.644"></a> -<span class="sourceLineNo">645</span> * Take a snapshot and wait for the server to complete that snapshot asynchronously. Only a single<a name="line.645"></a> -<span class="sourceLineNo">646</span> * snapshot should be taken at a time for an instance of HBase, or results may be undefined (you<a name="line.646"></a> -<span class="sourceLineNo">647</span> * can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a<a name="line.647"></a> -<span class="sourceLineNo">648</span> * single cluster). Snapshots are considered unique based on <b>the name of the snapshot</b>.<a name="line.648"></a> -<span class="sourceLineNo">649</span> * Attempts to take a snapshot with the same name (even a different type or with different<a name="line.649"></a> -<span class="sourceLineNo">650</span> * parameters) will fail with a {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException}<a name="line.650"></a> -<span class="sourceLineNo">651</span> * indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in<a name="line.651"></a> -<span class="sourceLineNo">652</span> * HBase. See {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.652"></a> -<span class="sourceLineNo">653</span> * You should probably use {@link #snapshot(String, org.apache.hadoop.hbase.TableName)} unless you<a name="line.653"></a> -<span class="sourceLineNo">654</span> * are sure about the type of snapshot that you want to take.<a name="line.654"></a> -<span class="sourceLineNo">655</span> * @param snapshot snapshot to take<a name="line.655"></a> -<span class="sourceLineNo">656</span> */<a name="line.656"></a> -<span class="sourceLineNo">657</span> CompletableFuture<Void> snapshot(SnapshotDescription snapshot);<a name="line.657"></a> -<span class="sourceLineNo">658</span><a name="line.658"></a> -<span class="sourceLineNo">659</span> /**<a name="line.659"></a> -<span class="sourceLineNo">660</span> * Check the current state of the passed snapshot. There are three possible states:<a name="line.660"></a> -<span class="sourceLineNo">661</span> * <ol><a name="line.661"></a> -<span class="sourceLineNo">662</span> * <li>running - returns <tt>false</tt></li><a name="line.662"></a> -<span class="sourceLineNo">663</span> * <li>finished - returns <tt>true</tt></li><a name="line.663"></a> -<span class="sourceLineNo">664</span> * <li>finished with error - throws the exception that caused the snapshot to fail</li><a name="line.664"></a> -<span class="sourceLineNo">665</span> * </ol><a name="line.665"></a> -<span class="sourceLineNo">666</span> * The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been<a name="line.666"></a> -<span class="sourceLineNo">667</span> * run/started since the snapshot you are checking, you will receive an<a name="line.667"></a> -<span class="sourceLineNo">668</span> * {@link org.apache.hadoop.hbase.snapshot.UnknownSnapshotException}.<a name="line.668"></a> -<span class="sourceLineNo">669</span> * @param snapshot description of the snapshot to check<a name="line.669"></a> -<span class="sourceLineNo">670</span> * @return <tt>true</tt> if the snapshot is completed, <tt>false</tt> if the snapshot is still<a name="line.670"></a> -<span class="sourceLineNo">671</span> * running<a name="line.671"></a> -<span class="sourceLineNo">672</span> */<a name="line.672"></a> -<span class="sourceLineNo">673</span> CompletableFuture<Boolean> isSnapshotFinished(SnapshotDescription snapshot);<a name="line.673"></a> -<span class="sourceLineNo">674</span><a name="line.674"></a> -<span class="sourceLineNo">675</span> /**<a name="line.675"></a> -<span class="sourceLineNo">676</span> * Restore the specified snapshot on the original table. (The table must be disabled) If the<a name="line.676"></a> -<span class="sourceLineNo">677</span> * "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a<a name="line.677"></a> -<span class="sourceLineNo">678</span> * snapshot of the current table is taken before executing the restore operation. In case of<a name="line.678"></a> -<span class="sourceLineNo">679</span> * restore failure, the failsafe snapshot will be restored. If the restore completes without<a name="line.679"></a> -<span class="sourceLineNo">680</span> * problem the failsafe snapshot is deleted.<a name="line.680"></a> -<span class="sourceLineNo">681</span> * @param snapshotName name of the snapshot to restore<a name="line.681"></a> -<span class="sourceLineNo">682</span> */<a name="line.682"></a> -<span class="sourceLineNo">683</span> CompletableFuture<Void> restoreSnapshot(String snapshotName);<a name="line.683"></a> -<span class="sourceLineNo">684</span><a name="line.684"></a> -<span class="sourceLineNo">685</span> /**<a name="line.685"></a> -<span class="sourceLineNo">686</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.686"></a> -<span class="sourceLineNo">687</span> * 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before<a name="line.687"></a> -<span class="sourceLineNo">688</span> * executing the restore operation. In case of restore failure, the failsafe snapshot will be<a name="line.688"></a> -<span class="sourceLineNo">689</span> * restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.689"></a> -<span class="sourceLineNo">690</span> * failsafe snapshot name is configurable by using the property<a name="line.690"></a> -<span class="sourceLineNo">691</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.691"></a> -<span class="sourceLineNo">692</span> * @param snapshotName name of the snapshot to restore<a name="line.692"></a> -<span class="sourceLineNo">693</span> * @param takeFailSafeSnapshot true if the failsafe snapshot should be taken<a name="line.693"></a> -<span class="sourceLineNo">694</span> */<a name="line.694"></a> -<span class="sourceLineNo">695</span> CompletableFuture<Void> restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot);<a name="line.695"></a> -<span class="sourceLineNo">696</span><a name="line.696"></a> -<span class="sourceLineNo">697</span> /**<a name="line.697"></a> -<span class="sourceLineNo">698</span> * Create a new table by cloning the snapshot content.<a name="line.698"></a> -<span class="sourceLineNo">699</span> * @param snapshotName name of the snapshot to be cloned<a name="line.699"></a> -<span class="sourceLineNo">700</span> * @param tableName name of the table where the snapshot will be restored<a name="line.700"></a> -<span class="sourceLineNo">701</span> */<a name="line.701"></a> -<span class="sourceLineNo">702</span> CompletableFuture<Void> cloneSnapshot(String snapshotName, TableName tableName);<a name="line.702"></a> -<span class="sourceLineNo">703</span><a name="line.703"></a> -<span class="sourceLineNo">704</span> /**<a name="line.704"></a> -<span class="sourceLineNo">705</span> * List completed snapshots.<a name="line.705"></a> -<span class="sourceLineNo">706</span> * @return a list of snapshot descriptors for completed snapshots wrapped by a<a name="line.706"></a> -<span class="sourceLineNo">707</span> * {@link CompletableFuture}<a name="line.707"></a> -<span class="sourceLineNo">708</span> */<a name="line.708"></a> -<span class="sourceLineNo">709</span> default CompletableFuture<List<SnapshotDescription>> listSnapshots() {<a name="line.709"></a> -<span class="sourceLineNo">710</span> return listSnapshots(Optional.empty());<a name="line.710"></a> -<span class="sourceLineNo">711</span> }<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> * List all the completed snapshots matching the given pattern.<a name="line.714"></a> -<span class="sourceLineNo">715</span> * @param pattern The compiled regular expression to match against<a name="line.715"></a> -<span class="sourceLineNo">716</span> * @return - returns a List of SnapshotDescription wrapped by a {@link CompletableFuture}<a name="line.716"></a> -<span class="sourceLineNo">717</span> */<a name="line.717"></a> -<span class="sourceLineNo">718</span> CompletableFuture<List<SnapshotDescription>> listSnapshots(Optional<Pattern> pattern);<a name="line.718"></a> -<span class="sourceLineNo">719</span><a name="line.719"></a> -<span class="sourceLineNo">720</span> /**<a name="line.720"></a> -<span class="sourceLineNo">721</span> * List all the completed snapshots matching the given table name regular expression and snapshot<a name="line.721"></a> -<span class="sourceLineNo">722</span> * name regular expression.<a name="line.722"></a> -<span class="sourceLineNo">723</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.723"></a> -<span class="sourceLineNo">724</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.724"></a> -<span class="sourceLineNo">725</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.725"></a> -<span class="sourceLineNo">726</span> * {@link CompletableFuture}<a name="line.726"></a> -<span class="sourceLineNo">727</span> */<a name="line.727"></a> -<span class="sourceLineNo">728</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern,<a name="line.728"></a> -<span class="sourceLineNo">729</span> Pattern snapshotNamePattern);<a name="line.729"></a> -<span class="sourceLineNo">730</span><a name="line.730"></a> -<span class="sourceLineNo">731</span> /**<a name="line.731"></a> -<span class="sourceLineNo">732</span> * Delete an existing snapshot.<a name="line.732"></a> -<span class="sourceLineNo">733</span> * @param snapshotName name of the snapshot<a name="line.733"></a> -<span class="sourceLineNo">734</span> */<a name="line.734"></a> -<span class="sourceLineNo">735</span> CompletableFuture<Void> deleteSnapshot(String snapshotName);<a name="line.735"></a> -<span class="sourceLineNo">736</span><a name="line.736"></a> -<span class="sourceLineNo">737</span> /**<a name="line.737"></a> -<span class="sourceLineNo">738</span> * Delete existing snapshots whose names match the pattern passed.<a name="line.738"></a> -<span class="sourceLineNo">739</span> * @param pattern pattern for names of the snapshot to match<a name="line.739"></a> -<span class="sourceLineNo">740</span> */<a name="line.740"></a> -<span class="sourceLineNo">741</span> default CompletableFuture<Void> deleteSnapshots(Pattern pattern) {<a name="line.741"></a> -<span class="sourceLineNo">742</span> return deleteTableSnapshots(null, pattern);<a name="line.742"></a> -<span class="sourceLineNo">743</span> }<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> * Delete all existing snapshots matching the given table name regular expression and snapshot<a name="line.746"></a> -<span class="sourceLineNo">747</span> * name regular expression.<a name="line.747"></a> -<span class="sourceLineNo">748</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.748"></a> -<span class="sourceLineNo">749</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.749"></a> -<span class="sourceLineNo">750</span> */<a name="line.750"></a> -<span class="sourceLineNo">751</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern,<a name="line.751"></a> -<span class="sourceLineNo">752</span> Pattern snapshotNamePattern);<a name="line.752"></a> -<span class="sourceLineNo">753</span><a name="line.753"></a> -<span class="sourceLineNo">754</span> /**<a name="line.754"></a> -<span class="sourceLineNo">755</span> * Execute a distributed procedure on a cluster.<a name="line.755"></a> -<span class="sourceLineNo">756</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.756"></a> -<span class="sourceLineNo">757</span> * root ZK node name of the procedure).<a name="line.757"></a> -<span class="sourceLineNo">758</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.758"></a> -<span class="sourceLineNo">759</span> * optional.<a name="line.759"></a> -<span class="sourceLineNo">760</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.760"></a> -<span class="sourceLineNo">761</span> */<a name="line.761"></a> -<span class="sourceLineNo">762</span> CompletableFuture<Void> execProcedure(String signature, String instance,<a name="line.762"></a> -<span class="sourceLineNo">763</span> Map<String, String> props);<a name="line.763"></a> -<span class="sourceLineNo">764</span><a name="line.764"></a> -<span class="sourceLineNo">765</span> /**<a name="line.765"></a> -<span class="sourceLineNo">766</span> * Execute a distributed procedure on a cluster.<a name="line.766"></a> -<span class="sourceLineNo">767</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.767"></a> -<span class="sourceLineNo">768</span> * root ZK node name of the procedure).<a name="line.768"></a> -<span class="sourceLineNo">769</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.769"></a> -<span class="sourceLineNo">770</span> * optional.<a name="line.770"></a> -<span class="sourceLineNo">771</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.771"></a> -<span class="sourceLineNo">772</span> * @return data returned after procedure execution. null if no return data.<a name="line.772"></a> -<span class="sourceLineNo">773</span> */<a name="line.773"></a> -<span class="sourceLineNo">774</span> CompletableFuture<byte[]> execProcedureWithRet(String signature, String instance,<a name="line.774"></a> -<span class="sourceLineNo">775</span> Map<String, String> props);<a name="line.775"></a> -<span class="sourceLineNo">776</span><a name="line.776"></a> -<span class="sourceLineNo">777</span> /**<a name="line.777"></a> -<span class="sourceLineNo">778</span> * Check the current state of the specified procedure. There are three possible states:<a name="line.778"></a> -<span class="sourceLineNo">779</span> * <ol><a name="line.779"></a> -<span class="sourceLineNo">780</span> * <li>running - returns <tt>false</tt></li><a name="line.780"></a> -<span class="sourceLineNo">781</span> * <li>finished - returns <tt>true</tt></li><a name="line.781"></a> -<span class="sourceLineNo">782</span> * <li>finished with error - throws the exception that caused the procedure to fail</li><a name="line.782"></a> -<span class="sourceLineNo">783</span> * </ol><a name="line.783"></a> -<span class="sourceLineNo">784</span> * @param signature The signature that uniquely identifies a procedure<a name="line.784"></a> -<span class="sourceLineNo">785</span> * @param instance The instance name of the procedure<a name="line.785"></a> -<span class="sourceLineNo">786</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.786"></a> -<span class="sourceLineNo">787</span> * @return true if the specified procedure is finished successfully, false if it is still running.<a name="line.787"></a> -<span class="sourceLineNo">788</span> * The value is wrapped by {@link CompletableFuture}<a name="line.788"></a> -<span class="sourceLineNo">789</span> */<a name="line.789"></a> -<span class="sourceLineNo">790</span> CompletableFuture<Boolean> isProcedureFinished(String signature, String instance,<a name="line.790"></a> -<span class="sourceLineNo">791</span> Map<String, String> props);<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> * abort a procedure<a name="line.794"></a> -<span class="sourceLineNo">795</span> * @param procId ID of the procedure to abort<a name="line.795"></a> -<span class="sourceLineNo">796</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.796"></a> -<span class="sourceLineNo">797</span> * @return true if aborted, false if procedure already completed or does not exist. the value is<a name="line.797"></a> -<span class="sourceLineNo">798</span> * wrapped by {@link CompletableFuture}<a name="line.798"></a> -<span class="sourceLineNo">799</span> */<a name="line.799"></a> -<span class="sourceLineNo">800</span> CompletableFuture<Boolean> abortProcedure(long procId, boolean mayInterruptIfRunning);<a name="line.800"></a> -<span class="sourceLineNo">801</span><a name="line.801"></a> -<span class="sourceLineNo">802</span> /**<a name="line.802"></a> -<span class="sourceLineNo">803</span> * List procedures<a name="line.803"></a> -<span class="sourceLineNo">804</span> * @return procedure list wrapped by {@link CompletableFuture}<a name="line.804"></a> -<span class="sourceLineNo">805</span> */<a name="line.805"></a> -<span class="sourceLineNo">806</span> CompletableFuture<List<ProcedureInfo>> listProcedures();<a name="line.806"></a> -<span class="sourceLineNo">807</span><a name="line.807"></a> -<span class="sourceLineNo">808</span> /**<a name="line.808"></a> -<span class="sourceLineNo">809</span> * List procedure locks.<a name="line.809"></a> -<span class="sourceLineNo">810</span> * @return lock list wrapped by {@link CompletableFuture}<a name="line.810"></a> -<span class="sourceLineNo">811</span> */<a name="line.811"></a> -<span class="sourceLineNo">812</span> CompletableFuture<List<LockInfo>> listProcedureLocks();<a name="line.812"></a> -<span class="sourceLineNo">813</span><a name="line.813"></a> -<span class="sourceLineNo">814</span> /**<a name="line.814"></a> -<span class="sourceLineNo">815</span> * Mark a region server as draining to prevent additional regions from getting assigned to it.<a name="line.815"></a> -<span class="sourceLineNo">816</span> * @param servers<a name="line.816"></a> -<span class="sourceLineNo">817</span> */<a name="line.817"></a> -<span class="sourceLineNo">818</span> CompletableFuture<Void> drainRegionServers(List<ServerName> servers);<a name="line.818"></a> -<span class="sourceLineNo">819</span><a name="line.819"></a> -<span class="sourceLineNo">820</span> /**<a name="line.820"></a> -<span class="sourceLineNo">821</span> * List region servers marked as draining to not get additional regions assigned to them.<a name="line.821"></a> -<span class="sourceLineNo">822</span> * @return List of draining region servers wrapped by {@link CompletableFuture}<a name="line.822"></a> -<span class="sourceLineNo">823</span> */<a name="line.823"></a> -<span class="sourceLineNo">824</span> CompletableFuture<List<ServerName>> listDrainingRegionServers();<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> * Remove drain from a region server to allow additional regions assignments.<a name="line.827"></a> -<span class="sourceLineNo">828</span> * @param servers List of region servers to remove drain from.<a name="line.828"></a> -<span class="sourceLineNo">829</span> */<a name="line.829"></a> -<span class="sourceLineNo">830</span> CompletableFuture<Void> removeDrainFromRegionServers(List<ServerName> servers);<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> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.833"></a> -<span class="sourceLineNo">834</span> */<a name="line.834"></a> -<span class="sourceLineNo">835</span> CompletableFuture<ClusterStatus> getClusterStatus();<a name="line.835"></a> -<span class="sourceLineNo">836</span><a name="line.836"></a> -<span class="sourceLineNo">837</span> /**<a name="line.837"></a> -<span class="sourceLineNo">838</span> * @return current master server name wrapped by {@link CompletableFuture}<a name="line.838"></a> -<span class="sourceLineNo">839</span> */<a name="line.839"></a> -<span class="sourceLineNo">840</span> default CompletableFuture<ServerName> getMaster() {<a name="line.840"></a> -<span class="sourceLineNo">841</span> return getClusterStatus().thenApply(ClusterStatus::getMaster);<a name="line.841"></a> -<span class="sourceLineNo">842</span> }<a name="line.842"></a> -<span class="sourceLineNo">843</span><a name="line.843"></a> -<span class="sourceLineNo">844</span> /**<a name="line.844"></a> -<span class="sourceLineNo">845</span> * @return current backup master list wrapped by {@link CompletableFuture}<a name="line.845"></a> -<span class="sourceLineNo">846</span> */<a name="line.846"></a> -<span class="sourceLineNo">847</span> default CompletableFuture<Collection<ServerName>> getBackupMasters() {<a name="line.847"></a> -<span class="sourceLineNo">848</span> return getClusterStatus().thenApply(ClusterStatus::getBackupMasters);<a name="line.848"></a> -<span class="sourceLineNo">849</span> }<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 live region servers list 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<Collection<ServerName>> getRegionServers() {<a name="line.854"></a> -<span class="sourceLineNo">855</span> return getClusterStatus().thenApply(ClusterStatus::getServers);<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> * Get a list of {@link RegionLoad} of all regions hosted on a region seerver.<a name="line.859"></a> -<span class="sourceLineNo">860</span> * @param serverName<a name="line.860"></a> -<span class="sourceLineNo">861</span> * @return a list of {@link RegionLoad} wrapped by {@link CompletableFuture}<a name="line.861"></a> -<span class="sourceLineNo">862</span> */<a name="line.862"></a> -<span class="sourceLineNo">863</span> default CompletableFuture<List<RegionLoad>> getRegionLoads(ServerName serverName) {<a name="line.863"></a> -<span class="sourceLineNo">864</span> return getRegionLoads(serverName, Optional.empty());<a name="line.864"></a> -<span class="sourceLineNo">865</span> }<a name="line.865"></a> -<span class="sourceLineNo">866</span><a name="line.866"></a> -<span class="sourceLineNo">867</span> /**<a name="line.867"></a> -<span class="sourceLineNo">868</span> * Shuts down the HBase cluster.<a name="line.868"></a> -<span class="sourceLineNo">869</span> */<a name="line.869"></a> -<span class="sourceLineNo">870</span> CompletableFuture<Void> shutdown();<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> * Shuts down the current HBase master only.<a name="line.873"></a> -<span class="sourceLineNo">874</span> */<a name="line.874"></a> -<span class="sourceLineNo">875</span> CompletableFuture<Void> stopMaster();<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> * Stop the designated regionserver.<a name="line.878"></a> -<span class="sourceLineNo">879</span> * @param serverName<a name="line.879"></a> -<span class="sourceLineNo">880</span> */<a name="line.880"></a> -<span class="sourceLineNo">881</span> CompletableFuture<Void> stopRegionServer(ServerName serverName);<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> * Update the configuration and trigger an online config change on the regionserver.<a name="line.884"></a> -<span class="sourceLineNo">885</span> * @param serverName : The server whose config needs to be updated.<a name="line.885"></a> -<span class="sourceLineNo">886</span> */<a name="line.886"></a> -<span class="sourceLineNo">887</span> CompletableFuture<Void> updateConfiguration(ServerName serverName);<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> * Update the configuration and trigger an online config change on all the masters and<a name="line.890"></a> -<span class="sourceLineNo">891</span> * regionservers.<a name="line.891"></a> -<span class="sourceLineNo">892</span> */<a name="line.892"></a> -<span class="sourceLineNo">893</span> CompletableFuture<Void> updateConfiguration();<a name="line.893"></a> -<span class="sourceLineNo">894</span><a name="line.894"></a> -<span class="sourceLineNo">895</span> /**<a name="line.895"></a> -<span class="sourceLineNo">896</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.896"></a> -<span class="sourceLineNo">897</span> * <p><a name="line.897"></a> -<span class="sourceLineNo">898</span> * When the returned CompletableFuture is done, it only means the rollWALWriter request was sent<a name="line.898"></a> -<span class="sourceLineNo">899</span> * to the region server and may need some time to finish the rollWALWriter operation. As a side<a name="line.899"></a> -<span class="sourceLineNo">900</span> * effect of this call, the named region server may schedule store flushes at the request of the<a name="line.900"></a> -<span class="sourceLineNo">901</span> * wal.<a name="line.901"></a> -<span class="sourceLineNo">902</span> * @param serverName The servername of the region server.<a name="line.902"></a> -<span class="sourceLineNo">903</span> */<a name="line.903"></a> -<span class="sourceLineNo">904</span> CompletableFuture<Void> rollWALWriter(ServerName serverName);<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> * Clear compacting queues on a region server.<a name="line.907"></a> -<span class="sourceLineNo">908</span> * @param serverName<a name="line.908"></a> -<span class="sourceLineNo">909</span> * @param queues the set of queue name<a name="line.909"></a> -<span class="sourceLineNo">910</span> */<a name="line.910"></a> -<span class="sourceLineNo">911</span> CompletableFuture<Void> clearCompactionQueues(ServerName serverName, Set<String> queues);<a name="line.911"></a> -<span class="sourceLineNo">912</span><a name="line.912"></a> -<span class="sourceLineNo">913</span> /**<a name="line.913"></a> -<span class="sourceLineNo">914</span> * Get a list of {@link RegionLoad} of all regions hosted on a region seerver for a table.<a name="line.914"></a> -<span class="sourceLineNo">915</span> * @param serverName<a name="line.915"></a> -<span class="sourceLineNo">916</span> * @param tableName<a name="line.916"></a> -<span class="sourceLineNo">917</span> * @return a list of {@link RegionLoad} wrapped by {@link CompletableFuture}<a name="line.917"></a> -<span class="sourceLineNo">918</span> */<a name="line.918"></a> -<span class="sourceLineNo">919</span> CompletableFuture<List<RegionLoad>> getRegionLoads(ServerName serverName,<a name="line.919"></a> -<span class="sourceLineNo">920</span> Optional<TableName> tableName);<a name="line.920"></a> -<span class="sourceLineNo">921</span><a name="line.921"></a> -<span class="sourceLineNo">922</span> /**<a name="line.922"></a> -<span class="sourceLineNo">923</span> * Check whether master is in maintenance mode<a name="line.923"></a> -<span class="sourceLineNo">924</span> * @return true if master is in maintenance mode, false otherwise. The return value will be<a name="line.924"></a> -<span class="sourceLineNo">925</span> * wrapped by a {@link CompletableFuture}<a name="line.925"></a> -<span class="sourceLineNo">926</span> */<a name="line.926"></a> -<span class="sourceLineNo">927</span> CompletableFuture<Boolean> isMasterInMaintenanceMode();<a name="line.927"></a> -<span class="sourceLineNo">928</span><a name="line.928"></a> -<span class="sourceLineNo">929</span> /**<a name="line.929"></a> -<span class="sourceLineNo">930</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.930"></a> -<span class="sourceLineNo">931</span> * compaction, both, or none.<a name="line.931"></a> -<span class="sourceLineNo">932</span> * @param tableName table to examine<a name="line.932"></a> -<span class="sourceLineNo">933</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.933"></a> -<span class="sourceLineNo">934</span> */<a name="line.934"></a> -<span class="sourceLineNo">935</span> CompletableFuture<CompactionState> getCompactionState(TableName tableName);<a name="line.935"></a> -<span class="sourceLineNo">936</span><a name="line.936"></a> -<span class="sourceLineNo">937</span> /**<a name="line.937"></a> -<span class="sourceLineNo">938</span> * Get the current compaction state of region. It could be in a major compaction, a minor<a name="line.938"></a> -<span class="sourceLineNo">939</span> * compaction, both, or none.<a name="line.939"></a> -<span class="sourceLineNo">940</span> * @param regionName region to examine<a name="line.940"></a> -<span class="sourceLineNo">941</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.941"></a> -<span class="sourceLineNo">942</span> */<a name="line.942"></a> -<span class="sourceLineNo">943</span> CompletableFuture<CompactionState> getCompactionStateForRegion(byte[] regionName);<a name="line.943"></a> -<span class="sourceLineNo">944</span><a name="line.944"></a> -<span class="sourceLineNo">945</span> /**<a name="line.945"></a> -<span class="sourceLineNo">946</span> * Get the timestamp of the last major compaction for the passed table.<a name="line.946"></a> -<span class="sourceLineNo">947</span> * <p><a name="line.947"></a> -<span class="sourceLineNo">948</span> * The timestamp of the oldest HFile resulting from a major compaction of that table, or not<a name="line.948"></a> -<span class="sourceLineNo">949</span> * present if no such HFile could be found.<a name="line.949"></a> -<span class="sourceLineNo">950</span> * @param tableName table to examine<a name="line.950"></a> -<span class="sourceLineNo">951</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.951"></a> -<span class="sourceLineNo">952</span> */<a name="line.952"></a> -<span class="sourceLineNo">953</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestamp(TableName tableName);<a name="line.953"></a> -<span class="sourceLineNo">954</span><a name="line.954"></a> -<span class="sourceLineNo">955</span> /**<a name="line.955"></a> -<span class="sourceLineNo">956</span> * Get the timestamp of the last major compaction for the passed region.<a name="line.956"></a> -<span class="sourceLineNo">957</span> * <p><a name="line.957"></a> -<span class="sourceLineNo">958</span> * The timestamp of the oldest HFile resulting from a major compaction of that region, or not<a name="line.958"></a> -<span class="sourceLineNo">959</span> * present if no such HFile could be found.<a name="line.959"></a> -<span class="sourceLineNo">960</span> * @param regionName region to examine<a name="line.960"></a> -<span class="sourceLineNo">961</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.961"></a> -<span class="sourceLineNo">962</span> */<a name="line.962"></a> -<span class="sourceLineNo">963</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestampForRegion(byte[] regionName);<a name="line.963"></a> -<span class="sourceLineNo">964</span><a name="line.964"></a> -<span class="sourceLineNo">965</span> /**<a name="line.965"></a> -<span class="sourceLineNo">966</span> * @return the list of supported security capabilities. The return value will be wrapped by a<a name="line.966"></a> -<span class="sourceLineNo">967</span> * {@link CompletableFuture}.<a name="line.967"></a> -<span class="sourceLineNo">968</span> */<a name="line.968"></a> -<span class="sourceLineNo">969</span> CompletableFuture<List<SecurityCapability>> getSecurityCapabilities();<a name="line.969"></a> -<span class="sourceLineNo">970</span><a name="line.970"></a> -<span class="sourceLineNo">971</span> /**<a name="line.971"></a> -<span class="sourceLineNo">972</span> * Turn the load balancer on or off.<a name="line.972"></a> -<span class="sourceLineNo">973</span> * @param on<a name="line.973"></a> -<span class="sourceLineNo">974</span> * @return Previous balancer value wrapped by a {@link CompletableFuture}.<a name="line.974"></a> -<span class="sourceLineNo">975</span> */<a name="line.975"></a> -<span class="sourceLineNo">976</span> CompletableFuture<Boolean> setBalancerOn(boolean on);<a name="line.976"></a> -<span class="sourceLineNo">977</span><a name="line.977"></a> -<span class="sourceLineNo">978</span> /**<a name="line.978"></a> -<span class="sourceLineNo">979</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.979"></a> -<span class="sourceLineNo">980</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.980"></a> -<span class="sourceLineNo">981</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.981"></a> -<span class="sourceLineNo">982</span> * {@link CompletableFuture}.<a name="line.982"></a> -<span class="sourceLineNo">983</span> */<a name="line.983"></a> -<span class="sourceLineNo">984</span> default CompletableFuture<Boolean> balance() {<a name="line.984"></a> -<span class="sourceLineNo">985</span> return balance(false);<a name="line.985"></a> -<span class="sourceLineNo">986</span> }<a name="line.986"></a> -<span class="sourceLineNo">987</span><a name="line.987"></a> -<span class="sourceLineNo">988</span> /**<a name="line.988"></a> -<span class="sourceLineNo">989</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.989"></a> -<span class="sourceLineNo">990</span> * reassignments. If there is region in transition, force parameter of true would still run<a name="line.990"></a> -<span class="sourceLineNo">991</span> * balancer. Can *not* run for other reasons. Check logs.<a name="line.991"></a> -<span class="sourceLineNo">992</span> * @param forcible whether we should force balance even if there is region in transition.<a name="line.992"></a> -<span class="sourceLineNo">993</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.993"></a> -<span class="sourceLineNo">994</span> * {@link CompletableFuture}.<a name="line.994"></a> -<span class="sourceLineNo">995</span> */<a name="line.995"></a> -<span class="sourceLineNo">996</span> CompletableFuture<Boolean> balance(boolean forcible);<a name="line.996"></a> -<span class="sourceLineNo">997</span><a name="line.997"></a> -<span class="sourceLineNo">998</span> /**<a name="line.998"></a> -<span class="sourceLineNo">999</span> * Query the current state of the balancer.<a name="line.999"></a> -<span class="sourceLineNo">1000</span> * @return true if the balance switch is on, false otherwise. The return value will be wrapped by a<a name="line.1000"></a> -<span class="sourceLineNo">1001</span> * {@link CompletableFuture}.<a name="line.1001"></a> -<span class="sourceLineNo">1002</span> */<a name="line.1002"></a> -<span class="sourceLineNo">1003</span> CompletableFuture<Boolean> isBalancerOn();<a name="line.1003"></a> -<span class="sourceLineNo">1004</span><a name="line.1004"></a> -<span class="sourceLineNo">1005</span> /**<a name="line.1005"></a> -<span class="sourceLineNo">1006</span> * Set region normalizer on/off.<a name="line.1006"></a> -<span class="sourceLineNo">1007</span> * @param on whether normalizer should be on or off<a name="line.1007"></a> -<span class="sourceLineNo">1008</span> * @return Previous normalizer value wrapped by a {@link CompletableFuture}<a name="line.1008"></a> -<span class="sourceLineNo">1009</span> */<a name="line.1009"></a> -<span class="sourceLineNo">1010</span> CompletableFuture<Boolean> setNormalizerOn(boolean on);<a name="line.1010"></a> -<span class="sourceLineNo">1011</span><a name="line.1011"></a> -<span class="sourceLineNo">1012</span> /**<a name="line.1012"></a> -<span class="sourceLineNo">1013</span> * Query the current state of the region normalizer<a name="line.1013"></a> -<span class="sourceLineNo">1014</span> * @return true if region normalizer is on, false otherwise. The return value will be wrapped by a<a name="line.1014"></a> -<span class="sourceLineNo">1015</span> * {@link CompletableFuture}<a name="line.1015"></a> -<span class="sourceLineNo">1016</span> */<a name="line.1016"></a> -<span class="sourceLineNo">1017</span> CompletableFuture<Boolean> isNormalizerOn();<a name="line.1017"></a> -<span class="sourceLineNo">1018</span><a name="line.1018"></a> -<span class="sourceLineNo">1019</span> /**<a name="line.1019"></a> -<span class="sourceLineNo">1020</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.1020"></a> -<span class="sourceLineNo">1021</span> * @return true if region normalizer ran, false otherwise. The return value will be wrapped by a<a name="line.1021"></a> -<span class="sourceLineNo">1022</span> * {@link CompletableFuture}<a name="line.1022"></a> -<span class="sourceLineNo">1023</span> */<a name="line.1023"></a> -<span class="sourceLineNo">1024</span> CompletableFuture<Boolean> normalize();<a name="line.1024"></a> -<span class="sourceLineNo">1025</span><a name="line.1025"></a> -<span class="sourceLineNo">1026</span> /**<a name="line.1026"></a> -<span class="sourceLineNo">1027</span> * Turn the cleaner chore on/off.<a name="line.1027"></a> -<span class="sourceLineNo">1028</span> * @param on<a name="line.1028"></a> -<span class="sourceLineNo">1029</span> * @return Previous cleaner state wrapped by a {@link CompletableFuture}<a name="line.1029"></a> -<span class="sourceLineNo">1030</span> */<a name="line.1030"></a> -<span class="sourceLineNo">1031</span> CompletableFuture<Boolean> setCleanerChoreOn(boolean on);<a name="line.1031"></a> -<span class="sourceLineNo">1032</span><a name="line.1032"></a> -<span class="sourceLineNo">1033</span> /**<a name="line.1033"></a> -<span class="sourceLineNo">1034</span> * Query the current state of the cleaner chore.<a name="line.1034"></a> -<span class="sourceLineNo">1035</span> * @return true if cleaner chore is on, false otherwise. The return value will be wrapped by<a name="line.1035"></a> -<span class="sourceLineNo">1036</span> * a {@link CompletableFuture}<a name="line.1036"></a> -<span class="sourceLineNo">1037</span> */<a name="line.1037"></a> -<span class="sourceLineNo">1038</span> CompletableFuture<Boolean> isCleanerChoreOn();<a name="line.1038"></a> -<span class="sourceLineNo">1039</span><a name="line.1039"></a> -<span class="sourceLineNo">1040</span> /**<a name="line.1040"></a> -<span class="sourceLineNo">1041</span> * Ask for cleaner chore to run.<a name="line.1041"></a> -<span class="sourceLineNo">1042</span> * @return true if cleaner chore ran, false otherwise. The return value will be wrapped by a<a name="line.1042"></a> -<span class="sourceLineNo">1043</span> * {@link CompletableFuture}<a name="line.1043"></a> -<span class="sourceLineNo">1044</span> */<a name="line.1044"></a> -<span class="sourceLineNo">1045</span> CompletableFuture<Boolean> runCleanerChore();<a name="line.1045"></a> -<span class="sourceLineNo">1046</span><a name="line.1046"></a> -<span class="sourceLineNo">1047</span> /**<a name="line.1047"></a> -<span class="sourceLineNo">1048</span> * Turn the catalog janitor on/off.<a name="line.1048"></a> -<span class="sourceLineNo">1049</span> * @param on<a name="line.1049"></a> -<span class="sourceLineNo">1050</span> * @return the previous state wrapped by a {@link CompletableFuture}<a name="line.1050"></a> -<span class="sourceLineNo">1051</span> */<a name="line.1051"></a> -<span class="sourceLineNo">1052</span> CompletableFuture<Boolean> setCatalogJanitorOn(boolean on);<a name="line.1052"></a> -<span class="sourceLineNo">1053</span><a name="line.1053"></a> -<span class="sourceLineNo">1054</span> /**<a name="line.1054"></a> -<span class="sourceLineNo">1055</span> * Query on the catalog janitor state.<a name="line.1055"></a> -<span class="sourceLineNo">1056</span> * @return true if the catalog janitor is on, false otherwise. The return value will be<a name="line.1056"></a> -<span class="sourceLineNo">1057</span> * wrapped by a {@link CompletableFuture}<a name="line.1057"></a> -<span class="sourceLineNo">1058</span> */<a name="line.1058"></a> -<span class="sourceLineNo">1059</span> CompletableFuture<Boolean> isCatalogJanitorOn();<a name="line.1059"></a> -<span class="sourceLineNo">1060</span><a name="line.1060"></a> -<span class="sourceLineNo">1061</span> /**<a name="line.1061"></a> -<span class="sourceLineNo">1062</span> * Ask for a scan of the catalog table.<a name="line.1062"></a> -<span class="sourceLineNo">1063</span> * @return the number of entries cleaned. The return value will be wrapped by a<a name="line.1063"></a> -<span class="sourceLineNo">1064</span> * {@link CompletableFuture}<a name="line.1064"></a> -<span class="sourceLineNo">1065</span> */<a name="line.1065"></a> -<span class="sourceLineNo">1066</span> CompletableFuture<Integer> runCatalogJanitor();<a name="line.1066"></a> -<span class="sourceLineNo">1067</span><a name="line.1067"></a> -<span class="sourceLineNo">1068</span> /**<a name="line.1068"></a> -<span class="sourceLineNo">1069</span> * Execute the given coprocessor call on the master.<a name="line.1069"></a> -<span class="sourceLineNo">1070</span> * <p><a name="line.1070"></a> -<span class="sourceLineNo">1071</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1071"></a> -<span class="sourceLineNo">1072</span> * one line lambda expression, like:<a name="line.1072"></a> -<span class="sourceLineNo">1073</span> *<a name="line.1073"></a> -<span class="sourceLineNo">1074</span> * <pre><a name="line.1074"></a> -<span class="sourceLineNo">1075</span> * <code><a name="line.1075"></a> -<span class="sourceLineNo">1076</span> * channel -> xxxService.newStub(channel)<a name="line.1076"></a> -<span class="sourceLineNo">1077</span> * </code><a name="line.1077"></a> -<span class="sourceLineNo">1078</span> * </pre><a name="line.1078"></a> -<span class="sourceLineNo">1079</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1079"></a> -<span class="sourceLineNo">1080</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1080"></a> -<span class="sourceLineNo">1081</span> * {@link CoprocessorCallable} for more details.<a name="line.1081"></a> -<span class="sourceLineNo">1082</span> * @param <S> the type of the asynchronous stub<a name="line.1082"></a> -<span class="sourceLineNo">1083</span> * @param <R> the type of the return value<a name="line.1083"></a> -<span class="sourceLineNo">1084</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1084"></a> -<span class="sourceLineNo">1085</span> * @see CoprocessorCallable<a name="line.1085"></a> -<span class="sourceLineNo">1086</span> */<a name="line.1086"></a> -<span class="sourceLineNo">1087</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1087"></a> -<span class="sourceLineNo">1088</span> CoprocessorCallable<S, R> callable);<a name="line.1088"></a> -<span class="sourceLineNo">1089</span><a name="line.1089"></a> -<span class="sourceLineNo">1090</span> /**<a name="line.1090"></a> -<span class="sourceLineNo">1091</span> * Execute the given coprocessor call on the given region server.<a name="line.1091"></a> -<span class="sourceLineNo">1092</span> * <p><a name="line.1092"></a> -<span class="sourceLineNo">1093</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1093"></a> -<span class="sourceLineNo">1094</span> * one line lambda expression, like:<a name="line.1094"></a> -<span class="sourceLineNo">1095</span> *<a name="line.1095"></a> -<span class="sourceLineNo">1096</span> * <pre><a name="line.1096"></a> -<span class="sourceLineNo">1097</span> * <code><a name="line.1097"></a> -<span class="sourceLineNo">1098</span> * channel -> xxxService.newStub(channel)<a name="line.1098"></a> -<span class="sourceLineNo">1099</span> * </code><a name="line.1099"></a> -<span class="sourceLineNo">1100</span> * </pre><a name="line.1100"></a> -<span class="sourceLineNo">1101</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1101"></a> -<span class="sourceLineNo">1102</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1102"></a> -<span class="sourceLineNo">1103</span> * {@link CoprocessorCallable} for more details.<a name="line.1103"></a> -<span class="sourceLineNo">1104</span> * @param serverName the given region server<a name="line.1104"></a> -<span class="sourceLineNo">1105</span> * @param <S> the type of the asynchronous stub<a name="line.1105"></a> -<span class="sourceLineNo">1106</span> * @param <R> the type of the return value<a name="line.1106"></a> -<span class="sourceLineNo">1107</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1107"></a> -<span class="sourceLineNo">1108</span> * @see CoprocessorCallable<a name="line.1108"></a> -<span class="sourceLineNo">1109</span> */<a name="line.1109"></a> -<span class="sourceLineNo">1110</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1110"></a> -<span class="sourceLineNo">1111</span> CoprocessorCallable<S, R> callable, ServerName serverName);<a name="line.1111"></a> -<span class="sourceLineNo">1112</span>}<a name="line.1112"></a> +<span class="sourceLineNo">296</span> * @param serverName Deprecated. Not used anymore after deprecation.<a name="line.296"></a> +<span class="sourceLineNo">297</span> * @return Deprecated. Always returns true now.<a name="line.297"></a> +<span class="sourceLineNo">298</span> * @deprecated Since 2.0. Will be removed in 3.0. Use {@link #unassign(byte[], boolean)} instead.<a name="line.298"></a> +<span class="sourceLineNo">299</span> */<a name="line.299"></a> +<span class="sourceLineNo">300</span> CompletableFuture<Boolean> closeRegion(byte[] regionName, Optional<ServerName> serverName);<a name="line.300"></a> +<span class="sourceLineNo">301</span><a name="line.301"></a> +<span class="sourceLineNo">302</span> /**<a name="line.302"></a> +<span class="sourceLineNo">303</span> * Get all the online regions on a region server.<a name="line.303"></a> +<span class="sourceLineNo">304</span> */<a name="line.304"></a> +<span class="sourceLineNo">305</span> CompletableFuture<List<HRegionInfo>> getOnlineRegions(ServerName serverName);<a name="line.305"></a> +<span class="sourceLineNo">306</span><a name="line.306"></a> +<span class="sourceLineNo">307</span> /**<a name="line.307"></a> +<span class="sourceLineNo">308</span> * Get the regions of a given table.<a name="line.308"></a> +<span class="sourceLineNo">309</span> */<a name="line.309"></a> +<span class="sourceLineNo">310</span> CompletableFuture<List<HRegionInfo>> getTableRegions(TableName tableName);<a name="line.310"></a> +<span class="sourceLineNo">311</span><a name="line.311"></a> +<span class="sourceLineNo">312</span> /**<a name="line.312"></a> +<span class="sourceLineNo">313</span> * Flush a table.<a name="line.313"></a> +<span class="sourceLineNo">314</span> * @param tableName table to flush<a name="line.314"></a> +<span class="sourceLineNo">315</span> */<a name="line.315"></a> +<span class="sourceLineNo">316</span> CompletableFuture<Void> flush(TableName tableName);<a name="line.316"></a> +<span class="sourceLineNo">317</span><a name="line.317"></a> +<span class="sourceLineNo">318</span> /**<a name="line.318"></a> +<span class="sourceLineNo">319</span> * Flush an individual region.<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @param regionName region to flush<a name="line.320"></a> +<span class="sourceLineNo">321</span> */<a name="line.321"></a> +<span class="sourceLineNo">322</span> CompletableFuture<Void> flushRegion(byte[] regionName);<a name="line.322"></a> +<span class="sourceLineNo">323</span><a name="line.323"></a> +<span class="sourceLineNo">324</span> /**<a name="line.324"></a> +<span class="sourceLineNo">325</span> * Compact a table. When the returned CompletableFuture is done, it only means the compact request<a name="line.325"></a> +<span class="sourceLineNo">326</span> * was sent to HBase and may need some time to finish the compact operation.<a name="line.326"></a> +<span class="sourceLineNo">327</span> * @param tableName table to compact<a name="line.327"></a> +<span class="sourceLineNo">328</span> */<a name="line.328"></a> +<span class="sourceLineNo">329</span> default CompletableFuture<Void> compact(TableName tableName) {<a name="line.329"></a> +<span class="sourceLineNo">330</span> return compact(tableName, Optional.empty());<a name="line.330"></a> +<span class="sourceLineNo">331</span> }<a name="line.331"></a> +<span class="sourceLineNo">332</span><a name="line.332"></a> +<span class="sourceLineNo">333</span> /**<a name="line.333"></a> +<span class="sourceLineNo">334</span> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.334"></a> +<span class="sourceLineNo">335</span>
<TRUNCATED>