http://git-wip-us.apache.org/repos/asf/hbase-site/blob/49431b18/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 8663b8c..f331c7a 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html @@ -26,1200 +26,1213 @@ <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import com.google.protobuf.RpcChannel;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.util.Collection;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.util.EnumSet;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import java.util.Optional;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import java.util.Set;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import java.util.concurrent.CompletableFuture;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import java.util.function.Function;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import java.util.regex.Pattern;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.ClusterMetrics;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.ClusterMetrics.Option;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.RegionMetrics;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.ServerName;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.TableName;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.replication.TableCFs;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.replication.ReplicationPeerConfig;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.replication.ReplicationPeerDescription;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.42"></a> -<span class="sourceLineNo">043</span><a name="line.43"></a> -<span class="sourceLineNo">044</span>/**<a name="line.44"></a> -<span class="sourceLineNo">045</span> * The asynchronous administrative API for HBase.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * @since 2.0.0<a name="line.46"></a> -<span class="sourceLineNo">047</span> */<a name="line.47"></a> -<span class="sourceLineNo">048</span>@InterfaceAudience.Public<a name="line.48"></a> -<span class="sourceLineNo">049</span>public interface AsyncAdmin {<a name="line.49"></a> -<span class="sourceLineNo">050</span><a name="line.50"></a> -<span class="sourceLineNo">051</span> /**<a name="line.51"></a> -<span class="sourceLineNo">052</span> * @param tableName Table to check.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * @return True if table exists already. The return value will be wrapped by a<a name="line.53"></a> -<span class="sourceLineNo">054</span> * {@link CompletableFuture}.<a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span> CompletableFuture<Boolean> tableExists(TableName tableName);<a name="line.56"></a> -<span class="sourceLineNo">057</span><a name="line.57"></a> -<span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * List all the userspace tables.<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.60"></a> -<span class="sourceLineNo">061</span> */<a name="line.61"></a> -<span class="sourceLineNo">062</span> default CompletableFuture<List<TableDescriptor>> listTableDescriptors() {<a name="line.62"></a> -<span class="sourceLineNo">063</span> return listTableDescriptors(false);<a name="line.63"></a> -<span class="sourceLineNo">064</span> }<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * List all the tables.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @param includeSysTables False to match only against userspace tables<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.69"></a> -<span class="sourceLineNo">070</span> */<a name="line.70"></a> -<span class="sourceLineNo">071</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(boolean includeSysTables);<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> /**<a name="line.73"></a> -<span class="sourceLineNo">074</span> * List all the tables matching the given pattern.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @param pattern The compiled regular expression to match against<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param includeSysTables False to match only against userspace tables<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(Pattern pattern,<a name="line.79"></a> -<span class="sourceLineNo">080</span> boolean includeSysTables);<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> /**<a name="line.82"></a> -<span class="sourceLineNo">083</span> * Get list of table descriptors by namespace.<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @param name namespace name<a name="line.84"></a> -<span class="sourceLineNo">085</span> * @return returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> CompletableFuture<List<TableDescriptor>> listTableDescriptorsByNamespace(String name);<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * List all of the names of userspace tables.<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @see #listTableNames(Pattern, boolean)<a name="line.92"></a> -<span class="sourceLineNo">093</span> */<a name="line.93"></a> -<span class="sourceLineNo">094</span> default CompletableFuture<List<TableName>> listTableNames() {<a name="line.94"></a> -<span class="sourceLineNo">095</span> return listTableNames(false);<a name="line.95"></a> -<span class="sourceLineNo">096</span> }<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * List all of the names of tables.<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @param includeSysTables False to match only against userspace tables<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> CompletableFuture<List<TableName>> listTableNames(boolean includeSysTables);<a name="line.103"></a> -<span class="sourceLineNo">104</span><a name="line.104"></a> -<span class="sourceLineNo">105</span> /**<a name="line.105"></a> -<span class="sourceLineNo">106</span> * List all of the names of userspace tables.<a name="line.106"></a> -<span class="sourceLineNo">107</span> * @param pattern The regular expression to match against<a name="line.107"></a> -<span class="sourceLineNo">108</span> * @param includeSysTables False to match only against userspace tables<a name="line.108"></a> -<span class="sourceLineNo">109</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.109"></a> -<span class="sourceLineNo">110</span> */<a name="line.110"></a> -<span class="sourceLineNo">111</span> CompletableFuture<List<TableName>> listTableNames(Pattern pattern, boolean includeSysTables);<a name="line.111"></a> -<span class="sourceLineNo">112</span><a name="line.112"></a> -<span class="sourceLineNo">113</span> /**<a name="line.113"></a> -<span class="sourceLineNo">114</span> * Get list of table names by namespace.<a name="line.114"></a> -<span class="sourceLineNo">115</span> * @param name namespace name<a name="line.115"></a> -<span class="sourceLineNo">116</span> * @return The list of table names in the namespace wrapped by a {@link CompletableFuture}.<a name="line.116"></a> -<span class="sourceLineNo">117</span> */<a name="line.117"></a> -<span class="sourceLineNo">118</span> CompletableFuture<List<TableName>> listTableNamesByNamespace(String name);<a name="line.118"></a> -<span class="sourceLineNo">119</span><a name="line.119"></a> -<span class="sourceLineNo">120</span> /**<a name="line.120"></a> -<span class="sourceLineNo">121</span> * Method for getting the tableDescriptor<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @param tableName as a {@link TableName}<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @return the read-only tableDescriptor wrapped by a {@link CompletableFuture}.<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> CompletableFuture<TableDescriptor> getDescriptor(TableName tableName);<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> /**<a name="line.127"></a> -<span class="sourceLineNo">128</span> * Creates a new table.<a name="line.128"></a> -<span class="sourceLineNo">129</span> * @param desc table descriptor for table<a name="line.129"></a> -<span class="sourceLineNo">130</span> */<a name="line.130"></a> -<span class="sourceLineNo">131</span> CompletableFuture<Void> createTable(TableDescriptor desc);<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> /**<a name="line.133"></a> -<span class="sourceLineNo">134</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.134"></a> -<span class="sourceLineNo">135</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.135"></a> -<span class="sourceLineNo">136</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.136"></a> -<span class="sourceLineNo">137</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.137"></a> -<span class="sourceLineNo">138</span> * segments to make the required number of total regions.<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param desc table descriptor for table<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @param startKey beginning of key range<a name="line.140"></a> -<span class="sourceLineNo">141</span> * @param endKey end of key range<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @param numRegions the total number of regions to create<a name="line.142"></a> -<span class="sourceLineNo">143</span> */<a name="line.143"></a> -<span class="sourceLineNo">144</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[] startKey, byte[] endKey,<a name="line.144"></a> -<span class="sourceLineNo">145</span> int numRegions);<a name="line.145"></a> -<span class="sourceLineNo">146</span><a name="line.146"></a> -<span class="sourceLineNo">147</span> /**<a name="line.147"></a> -<span class="sourceLineNo">148</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.148"></a> -<span class="sourceLineNo">149</span> * The total number of regions created will be the number of split keys plus one.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * Note : Avoid passing empty split key.<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @param desc table descriptor for table<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.152"></a> -<span class="sourceLineNo">153</span> */<a name="line.153"></a> -<span class="sourceLineNo">154</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[][] splitKeys);<a name="line.154"></a> -<span class="sourceLineNo">155</span><a name="line.155"></a> -<span class="sourceLineNo">156</span> /**<a name="line.156"></a> -<span class="sourceLineNo">157</span> * Modify an existing table, more IRB friendly version.<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @param desc modified description of the table<a name="line.158"></a> -<span class="sourceLineNo">159</span> */<a name="line.159"></a> -<span class="sourceLineNo">160</span> CompletableFuture<Void> modifyTable(TableDescriptor desc);<a name="line.160"></a> -<span class="sourceLineNo">161</span><a name="line.161"></a> -<span class="sourceLineNo">162</span> /**<a name="line.162"></a> -<span class="sourceLineNo">163</span> * Deletes a table.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @param tableName name of table to delete<a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> CompletableFuture<Void> deleteTable(TableName tableName);<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> /**<a name="line.168"></a> -<span class="sourceLineNo">169</span> * Truncate a table.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @param tableName name of table to truncate<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @param preserveSplits True if the splits should be preserved<a name="line.171"></a> -<span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> CompletableFuture<Void> truncateTable(TableName tableName, boolean preserveSplits);<a name="line.173"></a> -<span class="sourceLineNo">174</span><a name="line.174"></a> -<span class="sourceLineNo">175</span> /**<a name="line.175"></a> -<span class="sourceLineNo">176</span> * Enable a table. The table has to be in disabled state for it to be enabled.<a name="line.176"></a> -<span class="sourceLineNo">177</span> * @param tableName name of the table<a name="line.177"></a> -<span class="sourceLineNo">178</span> */<a name="line.178"></a> -<span class="sourceLineNo">179</span> CompletableFuture<Void> enableTable(TableName tableName);<a name="line.179"></a> -<span class="sourceLineNo">180</span><a name="line.180"></a> -<span class="sourceLineNo">181</span> /**<a name="line.181"></a> -<span class="sourceLineNo">182</span> * Disable a table. The table has to be in enabled state for it to be disabled.<a name="line.182"></a> -<span class="sourceLineNo">183</span> * @param tableName<a name="line.183"></a> -<span class="sourceLineNo">184</span> */<a name="line.184"></a> -<span class="sourceLineNo">185</span> CompletableFuture<Void> disableTable(TableName tableName);<a name="line.185"></a> -<span class="sourceLineNo">186</span><a name="line.186"></a> -<span class="sourceLineNo">187</span> /**<a name="line.187"></a> -<span class="sourceLineNo">188</span> * @param tableName name of table to check<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @return true if table is on-line. The return value will be wrapped by a<a name="line.189"></a> -<span class="sourceLineNo">190</span> * {@link CompletableFuture}.<a name="line.190"></a> -<span class="sourceLineNo">191</span> */<a name="line.191"></a> -<span class="sourceLineNo">192</span> CompletableFuture<Boolean> isTableEnabled(TableName tableName);<a name="line.192"></a> -<span class="sourceLineNo">193</span><a name="line.193"></a> -<span class="sourceLineNo">194</span> /**<a name="line.194"></a> -<span class="sourceLineNo">195</span> * @param tableName name of table to check<a name="line.195"></a> -<span class="sourceLineNo">196</span> * @return true if table is off-line. The return value will be wrapped by a<a name="line.196"></a> -<span class="sourceLineNo">197</span> * {@link CompletableFuture}.<a name="line.197"></a> -<span class="sourceLineNo">198</span> */<a name="line.198"></a> -<span class="sourceLineNo">199</span> CompletableFuture<Boolean> isTableDisabled(TableName tableName);<a name="line.199"></a> -<span class="sourceLineNo">200</span><a name="line.200"></a> -<span class="sourceLineNo">201</span> /**<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @param tableName name of table to check<a name="line.202"></a> -<span class="sourceLineNo">203</span> * @return true if all regions of the table are available. The return value will be wrapped by a<a name="line.203"></a> -<span class="sourceLineNo">204</span> * {@link CompletableFuture}.<a name="line.204"></a> -<span class="sourceLineNo">205</span> */<a name="line.205"></a> -<span class="sourceLineNo">206</span> CompletableFuture<Boolean> isTableAvailable(TableName tableName);<a name="line.206"></a> -<span class="sourceLineNo">207</span><a name="line.207"></a> -<span class="sourceLineNo">208</span> /**<a name="line.208"></a> -<span class="sourceLineNo">209</span> * Use this api to check if the table has been created with the specified number of splitkeys<a name="line.209"></a> -<span class="sourceLineNo">210</span> * which was used while creating the given table. Note : If this api is used after a table's<a name="line.210"></a> -<span class="sourceLineNo">211</span> * region gets splitted, the api may return false. The return value will be wrapped by a<a name="line.211"></a> -<span class="sourceLineNo">212</span> * {@link CompletableFuture}.<a name="line.212"></a> -<span class="sourceLineNo">213</span> * @param tableName name of table to check<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.214"></a> -<span class="sourceLineNo">215</span> */<a name="line.215"></a> -<span class="sourceLineNo">216</span> CompletableFuture<Boolean> isTableAvailable(TableName tableName, byte[][] splitKeys);<a name="line.216"></a> -<span class="sourceLineNo">217</span><a name="line.217"></a> -<span class="sourceLineNo">218</span> /**<a name="line.218"></a> -<span class="sourceLineNo">219</span> * Add a column family to an existing table.<a name="line.219"></a> -<span class="sourceLineNo">220</span> * @param tableName name of the table to add column family to<a name="line.220"></a> -<span class="sourceLineNo">221</span> * @param columnFamily column family descriptor of column family to be added<a name="line.221"></a> -<span class="sourceLineNo">222</span> */<a name="line.222"></a> -<span class="sourceLineNo">223</span> CompletableFuture<Void> addColumnFamily(TableName tableName,<a name="line.223"></a> -<span class="sourceLineNo">224</span> ColumnFamilyDescriptor columnFamily);<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> /**<a name="line.226"></a> -<span class="sourceLineNo">227</span> * Delete a column family from a table.<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @param tableName name of table<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @param columnFamily name of column family to be deleted<a name="line.229"></a> -<span class="sourceLineNo">230</span> */<a name="line.230"></a> -<span class="sourceLineNo">231</span> CompletableFuture<Void> deleteColumnFamily(TableName tableName, byte[] columnFamily);<a name="line.231"></a> -<span class="sourceLineNo">232</span><a name="line.232"></a> -<span class="sourceLineNo">233</span> /**<a name="line.233"></a> -<span class="sourceLineNo">234</span> * Modify an existing column family on a table.<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @param tableName name of table<a name="line.235"></a> -<span class="sourceLineNo">236</span> * @param columnFamily new column family descriptor to use<a name="line.236"></a> -<span class="sourceLineNo">237</span> */<a name="line.237"></a> -<span class="sourceLineNo">238</span> CompletableFuture<Void> modifyColumnFamily(TableName tableName,<a name="line.238"></a> -<span class="sourceLineNo">239</span> ColumnFamilyDescriptor columnFamily);<a name="line.239"></a> -<span class="sourceLineNo">240</span><a name="line.240"></a> -<span class="sourceLineNo">241</span> /**<a name="line.241"></a> -<span class="sourceLineNo">242</span> * Create a new namespace.<a name="line.242"></a> -<span class="sourceLineNo">243</span> * @param descriptor descriptor which describes the new namespace<a name="line.243"></a> -<span class="sourceLineNo">244</span> */<a name="line.244"></a> -<span class="sourceLineNo">245</span> CompletableFuture<Void> createNamespace(NamespaceDescriptor descriptor);<a name="line.245"></a> -<span class="sourceLineNo">246</span><a name="line.246"></a> -<span class="sourceLineNo">247</span> /**<a name="line.247"></a> -<span class="sourceLineNo">248</span> * Modify an existing namespace.<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @param descriptor descriptor which describes the new namespace<a name="line.249"></a> -<span class="sourceLineNo">250</span> */<a name="line.250"></a> -<span class="sourceLineNo">251</span> CompletableFuture<Void> modifyNamespace(NamespaceDescriptor descriptor);<a name="line.251"></a> -<span class="sourceLineNo">252</span><a name="line.252"></a> -<span class="sourceLineNo">253</span> /**<a name="line.253"></a> -<span class="sourceLineNo">254</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.254"></a> -<span class="sourceLineNo">255</span> * @param name namespace name<a name="line.255"></a> -<span class="sourceLineNo">256</span> */<a name="line.256"></a> -<span class="sourceLineNo">257</span> CompletableFuture<Void> deleteNamespace(String name);<a name="line.257"></a> -<span class="sourceLineNo">258</span><a name="line.258"></a> -<span class="sourceLineNo">259</span> /**<a name="line.259"></a> -<span class="sourceLineNo">260</span> * Get a namespace descriptor by name<a name="line.260"></a> -<span class="sourceLineNo">261</span> * @param name name of namespace descriptor<a name="line.261"></a> -<span class="sourceLineNo">262</span> * @return A descriptor wrapped by a {@link CompletableFuture}.<a name="line.262"></a> -<span class="sourceLineNo">263</span> */<a name="line.263"></a> -<span class="sourceLineNo">264</span> CompletableFuture<NamespaceDescriptor> getNamespaceDescriptor(String name);<a name="line.264"></a> -<span class="sourceLineNo">265</span><a name="line.265"></a> -<span class="sourceLineNo">266</span> /**<a name="line.266"></a> -<span class="sourceLineNo">267</span> * List available namespace descriptors<a name="line.267"></a> -<span class="sourceLineNo">268</span> * @return List of descriptors wrapped by a {@link CompletableFuture}.<a name="line.268"></a> -<span class="sourceLineNo">269</span> */<a name="line.269"></a> -<span class="sourceLineNo">270</span> CompletableFuture<List<NamespaceDescriptor>> listNamespaceDescriptors();<a name="line.270"></a> -<span class="sourceLineNo">271</span><a name="line.271"></a> -<span class="sourceLineNo">272</span> /**<a name="line.272"></a> -<span class="sourceLineNo">273</span> * Get all the online regions on a region server.<a name="line.273"></a> -<span class="sourceLineNo">274</span> */<a name="line.274"></a> -<span class="sourceLineNo">275</span> CompletableFuture<List<RegionInfo>> getRegions(ServerName serverName);<a name="line.275"></a> -<span class="sourceLineNo">276</span><a name="line.276"></a> -<span class="sourceLineNo">277</span> /**<a name="line.277"></a> -<span class="sourceLineNo">278</span> * Get the regions of a given table.<a name="line.278"></a> -<span class="sourceLineNo">279</span> */<a name="line.279"></a> -<span class="sourceLineNo">280</span> CompletableFuture<List<RegionInfo>> getRegions(TableName tableName);<a name="line.280"></a> -<span class="sourceLineNo">281</span><a name="line.281"></a> -<span class="sourceLineNo">282</span> /**<a name="line.282"></a> -<span class="sourceLineNo">283</span> * Flush a table.<a name="line.283"></a> -<span class="sourceLineNo">284</span> * @param tableName table to flush<a name="line.284"></a> -<span class="sourceLineNo">285</span> */<a name="line.285"></a> -<span class="sourceLineNo">286</span> CompletableFuture<Void> flush(TableName tableName);<a name="line.286"></a> -<span class="sourceLineNo">287</span><a name="line.287"></a> -<span class="sourceLineNo">288</span> /**<a name="line.288"></a> -<span class="sourceLineNo">289</span> * Flush an individual region.<a name="line.289"></a> -<span class="sourceLineNo">290</span> * @param regionName region to flush<a name="line.290"></a> -<span class="sourceLineNo">291</span> */<a name="line.291"></a> -<span class="sourceLineNo">292</span> CompletableFuture<Void> flushRegion(byte[] regionName);<a name="line.292"></a> -<span class="sourceLineNo">293</span><a name="line.293"></a> -<span class="sourceLineNo">294</span> /**<a name="line.294"></a> -<span class="sourceLineNo">295</span> * Compact a table. When the returned CompletableFuture is done, it only means the compact request<a name="line.295"></a> -<span class="sourceLineNo">296</span> * was sent to HBase and may need some time to finish the compact operation.<a name="line.296"></a> -<span class="sourceLineNo">297</span> * @param tableName table to compact<a name="line.297"></a> -<span class="sourceLineNo">298</span> */<a name="line.298"></a> -<span class="sourceLineNo">299</span> default CompletableFuture<Void> compact(TableName tableName) {<a name="line.299"></a> -<span class="sourceLineNo">300</span> return compact(tableName, CompactType.NORMAL);<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> /**<a name="line.303"></a> -<span class="sourceLineNo">304</span> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.304"></a> -<span class="sourceLineNo">305</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.305"></a> -<span class="sourceLineNo">306</span> * operation.<a name="line.306"></a> -<span class="sourceLineNo">307</span> * @param tableName table to compact<a name="line.307"></a> -<span class="sourceLineNo">308</span> * @param columnFamily column family within a table. If not present, compact the table's all<a name="line.308"></a> -<span class="sourceLineNo">309</span> * column families.<a name="line.309"></a> -<span class="sourceLineNo">310</span> */<a name="line.310"></a> -<span class="sourceLineNo">311</span> default CompletableFuture<Void> compact(TableName tableName, byte[] columnFamily) {<a name="line.311"></a> -<span class="sourceLineNo">312</span> return compact(tableName, columnFamily, CompactType.NORMAL);<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> /**<a name="line.315"></a> -<span class="sourceLineNo">316</span> * Compact a table. When the returned CompletableFuture is done, it only means the compact request<a name="line.316"></a> -<span class="sourceLineNo">317</span> * was sent to HBase and may need some time to finish the compact operation.<a name="line.317"></a> -<span class="sourceLineNo">318</span> * @param tableName table to compact<a name="line.318"></a> -<span class="sourceLineNo">319</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.319"></a> -<span class="sourceLineNo">320</span> */<a name="line.320"></a> -<span class="sourceLineNo">321</span> CompletableFuture<Void> compact(TableName tableName, CompactType compactType);<a name="line.321"></a> -<span class="sourceLineNo">322</span><a name="line.322"></a> -<span class="sourceLineNo">323</span> /**<a name="line.323"></a> -<span class="sourceLineNo">324</span> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.324"></a> -<span class="sourceLineNo">325</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.325"></a> -<span class="sourceLineNo">326</span> * 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> * @param columnFamily column family within a table<a name="line.328"></a> -<span class="sourceLineNo">329</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.329"></a> -<span class="sourceLineNo">330</span> */<a name="line.330"></a> -<span class="sourceLineNo">331</span> CompletableFuture<Void> compact(TableName tableName, byte[] columnFamily,<a name="line.331"></a> -<span class="sourceLineNo">332</span> CompactType compactType);<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> * Compact an individual region. When the returned CompletableFuture is done, it only means the<a name="line.335"></a> -<span class="sourceLineNo">336</span> * compact request was sent to HBase and may need some time to finish the compact operation.<a name="line.336"></a> -<span class="sourceLineNo">337</span> * @param regionName region to compact<a name="line.337"></a> -<span class="sourceLineNo">338</span> */<a name="line.338"></a> -<span class="sourceLineNo">339</span> CompletableFuture<Void> compactRegion(byte[] regionName);<a name="line.339"></a> -<span class="sourceLineNo">340</span><a name="line.340"></a> -<span class="sourceLineNo">341</span> /**<a name="line.341"></a> -<span class="sourceLineNo">342</span> * Compact a column family within a region. When the returned CompletableFuture is done, it only<a name="line.342"></a> -<span class="sourceLineNo">343</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.343"></a> -<span class="sourceLineNo">344</span> * operation.<a name="line.344"></a> -<span class="sourceLineNo">345</span> * @param regionName region to compact<a name="line.345"></a> -<span class="sourceLineNo">346</span> * @param columnFamily column family within a region. If not present, compact the region's all<a name="line.346"></a> -<span class="sourceLineNo">347</span> * column families.<a name="line.347"></a> -<span class="sourceLineNo">348</span> */<a name="line.348"></a> -<span class="sourceLineNo">349</span> CompletableFuture<Void> compactRegion(byte[] regionName, byte[] columnFamily);<a name="line.349"></a> -<span class="sourceLineNo">350</span><a name="line.350"></a> -<span class="sourceLineNo">351</span> /**<a name="line.351"></a> -<span class="sourceLineNo">352</span> * Major compact a table. When the returned CompletableFuture is done, it only means the compact<a name="line.352"></a> -<span class="sourceLineNo">353</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.353"></a> -<span class="sourceLineNo">354</span> * @param tableName table to major compact<a name="line.354"></a> -<span class="sourceLineNo">355</span> */<a name="line.355"></a> -<span class="sourceLineNo">356</span> default CompletableFuture<Void> majorCompact(TableName tableName) {<a name="line.356"></a> -<span class="sourceLineNo">357</span> return majorCompact(tableName, CompactType.NORMAL);<a name="line.357"></a> -<span class="sourceLineNo">358</span> }<a name="line.358"></a> -<span class="sourceLineNo">359</span><a name="line.359"></a> -<span class="sourceLineNo">360</span> /**<a name="line.360"></a> -<span class="sourceLineNo">361</span> * Major compact a column family within a table. When the returned CompletableFuture is done, it<a name="line.361"></a> -<span class="sourceLineNo">362</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.362"></a> -<span class="sourceLineNo">363</span> * operation.<a name="line.363"></a> -<span class="sourceLineNo">364</span> * @param tableName table to major compact<a name="line.364"></a> -<span class="sourceLineNo">365</span> * @param columnFamily column family within a table. If not present, major compact the table's all<a name="line.365"></a> -<span class="sourceLineNo">366</span> * column families.<a name="line.366"></a> -<span class="sourceLineNo">367</span> */<a name="line.367"></a> -<span class="sourceLineNo">368</span> default CompletableFuture<Void> majorCompact(TableName tableName, byte[] columnFamily) {<a name="line.368"></a> -<span class="sourceLineNo">369</span> return majorCompact(tableName, columnFamily, CompactType.NORMAL);<a name="line.369"></a> -<span class="sourceLineNo">370</span> }<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> * Major compact a table. When the returned CompletableFuture is done, it only means the compact<a name="line.373"></a> -<span class="sourceLineNo">374</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.374"></a> -<span class="sourceLineNo">375</span> * @param tableName table to major compact<a name="line.375"></a> -<span class="sourceLineNo">376</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.376"></a> -<span class="sourceLineNo">377</span> */<a name="line.377"></a> -<span class="sourceLineNo">378</span> CompletableFuture<Void> majorCompact(TableName tableName, CompactType compactType);<a name="line.378"></a> -<span class="sourceLineNo">379</span><a name="line.379"></a> -<span class="sourceLineNo">380</span> /**<a name="line.380"></a> -<span class="sourceLineNo">381</span> * Major compact a column family within a table. When the returned CompletableFuture is done, it<a name="line.381"></a> -<span class="sourceLineNo">382</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.382"></a> -<span class="sourceLineNo">383</span> * operation.<a name="line.383"></a> -<span class="sourceLineNo">384</span> * @param tableName table to major compact<a name="line.384"></a> -<span class="sourceLineNo">385</span> * @param columnFamily column family within a table. If not present, major compact the table's all<a name="line.385"></a> -<span class="sourceLineNo">386</span> * column families.<a name="line.386"></a> -<span class="sourceLineNo">387</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.387"></a> -<span class="sourceLineNo">388</span> */<a name="line.388"></a> -<span class="sourceLineNo">389</span> CompletableFuture<Void> majorCompact(TableName tableName, byte[] columnFamily,<a name="line.389"></a> -<span class="sourceLineNo">390</span> CompactType compactType);<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 region. When the returned CompletableFuture is done, it only means the compact<a name="line.393"></a> -<span class="sourceLineNo">394</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.394"></a> -<span class="sourceLineNo">395</span> * @param regionName region to major compact<a name="line.395"></a> -<span class="sourceLineNo">396</span> */<a name="line.396"></a> -<span class="sourceLineNo">397</span> CompletableFuture<Void> majorCompactRegion(byte[] regionName);<a name="line.397"></a> -<span class="sourceLineNo">398</span><a name="line.398"></a> -<span class="sourceLineNo">399</span> /**<a name="line.399"></a> -<span class="sourceLineNo">400</span> * Major compact a column family within region. When the returned CompletableFuture is done, it<a name="line.400"></a> -<span class="sourceLineNo">401</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.401"></a> -<span class="sourceLineNo">402</span> * operation.<a name="line.402"></a> -<span class="sourceLineNo">403</span> * @param regionName region to major compact<a name="line.403"></a> -<span class="sourceLineNo">404</span> * @param columnFamily column family within a region. If not present, major compact the region's<a name="line.404"></a> -<span class="sourceLineNo">405</span> * all column families.<a name="line.405"></a> -<span class="sourceLineNo">406</span> */<a name="line.406"></a> -<span class="sourceLineNo">407</span> CompletableFuture<Void> majorCompactRegion(byte[] regionName, byte[] columnFamily);<a name="line.407"></a> -<span class="sourceLineNo">408</span><a name="line.408"></a> -<span class="sourceLineNo">409</span> /**<a name="line.409"></a> -<span class="sourceLineNo">410</span> * Compact all regions on the region server.<a name="line.410"></a> -<span class="sourceLineNo">411</span> * @param serverName the region server name<a name="line.411"></a> -<span class="sourceLineNo">412</span> */<a name="line.412"></a> -<span class="sourceLineNo">413</span> CompletableFuture<Void> compactRegionServer(ServerName serverName);<a name="line.413"></a> -<span class="sourceLineNo">414</span><a name="line.414"></a> -<span class="sourceLineNo">415</span> /**<a name="line.415"></a> -<span class="sourceLineNo">416</span> * Compact all regions on the region server.<a name="line.416"></a> -<span class="sourceLineNo">417</span> * @param serverName the region server name<a name="line.417"></a> -<span class="sourceLineNo">418</span> */<a name="line.418"></a> -<span class="sourceLineNo">419</span> CompletableFuture<Void> majorCompactRegionServer(ServerName serverName);<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> * Turn the Merge switch on or off.<a name="line.422"></a> -<span class="sourceLineNo">423</span> * @param on<a name="line.423"></a> -<span class="sourceLineNo">424</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.424"></a> -<span class="sourceLineNo">425</span> */<a name="line.425"></a> -<span class="sourceLineNo">426</span> CompletableFuture<Boolean> mergeSwitch(boolean on);<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> * Query the current state of the Merge switch.<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.430"></a> -<span class="sourceLineNo">431</span> * {@link CompletableFuture}<a name="line.431"></a> -<span class="sourceLineNo">432</span> */<a name="line.432"></a> -<span class="sourceLineNo">433</span> CompletableFuture<Boolean> isMergeEnabled();<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> * Turn the Split switch on or off.<a name="line.436"></a> -<span class="sourceLineNo">437</span> * @param on<a name="line.437"></a> -<span class="sourceLineNo">438</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.438"></a> -<span class="sourceLineNo">439</span> */<a name="line.439"></a> -<span class="sourceLineNo">440</span> CompletableFuture<Boolean> splitSwitch(boolean on);<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> * Query the current state of the Split switch.<a name="line.443"></a> -<span class="sourceLineNo">444</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.444"></a> -<span class="sourceLineNo">445</span> * {@link CompletableFuture}<a name="line.445"></a> -<span class="sourceLineNo">446</span> */<a name="line.446"></a> -<span class="sourceLineNo">447</span> CompletableFuture<Boolean> isSplitEnabled();<a name="line.447"></a> -<span class="sourceLineNo">448</span><a name="line.448"></a> -<span class="sourceLineNo">449</span> /**<a name="line.449"></a> -<span class="sourceLineNo">450</span> * Merge two regions.<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @param nameOfRegionA encoded or full name of region a<a name="line.451"></a> -<span class="sourceLineNo">452</span> * @param nameOfRegionB encoded or full name of region b<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @param forcible true if do a compulsory merge, otherwise we will only merge two adjacent<a name="line.453"></a> -<span class="sourceLineNo">454</span> * regions<a name="line.454"></a> -<span class="sourceLineNo">455</span> */<a name="line.455"></a> -<span class="sourceLineNo">456</span> CompletableFuture<Void> mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB,<a name="line.456"></a> -<span class="sourceLineNo">457</span> boolean forcible);<a name="line.457"></a> -<span class="sourceLineNo">458</span><a name="line.458"></a> -<span class="sourceLineNo">459</span> /**<a name="line.459"></a> -<span class="sourceLineNo">460</span> * Split a table. The method will execute split action for each region in table.<a name="line.460"></a> -<span class="sourceLineNo">461</span> * @param tableName table to split<a name="line.461"></a> -<span class="sourceLineNo">462</span> */<a name="line.462"></a> -<span class="sourceLineNo">463</span> CompletableFuture<Void> split(TableName tableName);<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> * Split an individual region.<a name="line.466"></a> -<span class="sourceLineNo">467</span> * @param regionName region to split<a name="line.467"></a> -<span class="sourceLineNo">468</span> */<a name="line.468"></a> -<span class="sourceLineNo">469</span> CompletableFuture<Void> splitRegion(byte[] regionName);<a name="line.469"></a> -<span class="sourceLineNo">470</span><a name="line.470"></a> -<span class="sourceLineNo">471</span> /**<a name="line.471"></a> -<span class="sourceLineNo">472</span> * Split a table.<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @param tableName table to split<a name="line.473"></a> -<span class="sourceLineNo">474</span> * @param splitPoint the explicit position to split on<a name="line.474"></a> -<span class="sourceLineNo">475</span> */<a name="line.475"></a> -<span class="sourceLineNo">476</span> CompletableFuture<Void> split(TableName tableName, byte[] splitPoint);<a name="line.476"></a> -<span class="sourceLineNo">477</span><a name="line.477"></a> -<span class="sourceLineNo">478</span> /**<a name="line.478"></a> -<span class="sourceLineNo">479</span> * Split an individual region.<a name="line.479"></a> -<span class="sourceLineNo">480</span> * @param regionName region to split<a name="line.480"></a> -<span class="sourceLineNo">481</span> * @param splitPoint the explicit position to split on. If not present, it will decide by region<a name="line.481"></a> -<span class="sourceLineNo">482</span> * server.<a name="line.482"></a> -<span class="sourceLineNo">483</span> */<a name="line.483"></a> -<span class="sourceLineNo">484</span> CompletableFuture<Void> splitRegion(byte[] regionName, byte[] splitPoint);<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> * @param regionName Encoded or full name of region to assign.<a name="line.487"></a> -<span class="sourceLineNo">488</span> */<a name="line.488"></a> -<span class="sourceLineNo">489</span> CompletableFuture<Void> assign(byte[] regionName);<a name="line.489"></a> -<span class="sourceLineNo">490</span><a name="line.490"></a> -<span class="sourceLineNo">491</span> /**<a name="line.491"></a> -<span class="sourceLineNo">492</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.492"></a> -<span class="sourceLineNo">493</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use<a name="line.493"></a> -<span class="sourceLineNo">494</span> * {@link #move(byte[], ServerName)} if you want to control the region movement.<a name="line.494"></a> -<span class="sourceLineNo">495</span> * @param regionName Encoded or full name of region to unassign. Will clear any existing<a name="line.495"></a> -<span class="sourceLineNo">496</span> * RegionPlan if one found.<a name="line.496"></a> -<span class="sourceLineNo">497</span> * @param forcible If true, force unassign (Will remove region from regions-in-transition too if<a name="line.497"></a> -<span class="sourceLineNo">498</span> * present. If results in double assignment use hbck -fix to resolve. To be used by<a name="line.498"></a> -<span class="sourceLineNo">499</span> * experts).<a name="line.499"></a> -<span class="sourceLineNo">500</span> */<a name="line.500"></a> -<span class="sourceLineNo">501</span> CompletableFuture<Void> unassign(byte[] regionName, boolean forcible);<a name="line.501"></a> -<span class="sourceLineNo">502</span><a name="line.502"></a> -<span class="sourceLineNo">503</span> /**<a name="line.503"></a> -<span class="sourceLineNo">504</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.504"></a> -<span class="sourceLineNo">505</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.505"></a> -<span class="sourceLineNo">506</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.506"></a> -<span class="sourceLineNo">507</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.507"></a> -<span class="sourceLineNo">508</span> * experts or hbck.<a name="line.508"></a> -<span class="sourceLineNo">509</span> * @param regionName Encoded or full name of region to offline<a name="line.509"></a> -<span class="sourceLineNo">510</span> */<a name="line.510"></a> -<span class="sourceLineNo">511</span> CompletableFuture<Void> offline(byte[] regionName);<a name="line.511"></a> -<span class="sourceLineNo">512</span><a name="line.512"></a> -<span class="sourceLineNo">513</span> /**<a name="line.513"></a> -<span class="sourceLineNo">514</span> * Move the region <code>r</code> to a random server.<a name="line.514"></a> -<span class="sourceLineNo">515</span> * @param regionName Encoded or full name of region to move.<a name="line.515"></a> -<span class="sourceLineNo">516</span> */<a name="line.516"></a> -<span class="sourceLineNo">517</span> CompletableFuture<Void> move(byte[] regionName);<a name="line.517"></a> -<span class="sourceLineNo">518</span><a name="line.518"></a> -<span class="sourceLineNo">519</span> /**<a name="line.519"></a> -<span class="sourceLineNo">520</span> * Move the region <code>r</code> to <code>dest</code>.<a name="line.520"></a> -<span class="sourceLineNo">521</span> * @param regionName Encoded or full name of region to move.<a name="line.521"></a> -<span class="sourceLineNo">522</span> * @param destServerName The servername of the destination regionserver. If not present, we'll<a name="line.522"></a> -<span class="sourceLineNo">523</span> * assign to a random server. A server name is made of host, port and startcode. Here is<a name="line.523"></a> -<span class="sourceLineNo">524</span> * an example: <code> host187.example.com,60020,1289493121758</code><a name="line.524"></a> -<span class="sourceLineNo">525</span> */<a name="line.525"></a> -<span class="sourceLineNo">526</span> CompletableFuture<Void> move(byte[] regionName, ServerName destServerName);<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> * Apply the new quota settings.<a name="line.529"></a> -<span class="sourceLineNo">530</span> * @param quota the quota settings<a name="line.530"></a> -<span class="sourceLineNo">531</span> */<a name="line.531"></a> -<span class="sourceLineNo">532</span> CompletableFuture<Void> setQuota(QuotaSettings quota);<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> * List the quotas based on the filter.<a name="line.535"></a> -<span class="sourceLineNo">536</span> * @param filter the quota settings filter<a name="line.536"></a> -<span class="sourceLineNo">537</span> * @return the QuotaSetting list, which wrapped by a CompletableFuture.<a name="line.537"></a> -<span class="sourceLineNo">538</span> */<a name="line.538"></a> -<span class="sourceLineNo">539</span> CompletableFuture<List<QuotaSettings>> getQuota(QuotaFilter filter);<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> * Add a new replication peer for replicating data to slave cluster<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 configuration for the replication slave cluster<a name="line.544"></a> -<span class="sourceLineNo">545</span> */<a name="line.545"></a> -<span class="sourceLineNo">546</span> default CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.546"></a> -<span class="sourceLineNo">547</span> ReplicationPeerConfig peerConfig) {<a name="line.547"></a> -<span class="sourceLineNo">548</span> return addReplicationPeer(peerId, peerConfig, true);<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> /**<a name="line.551"></a> -<span class="sourceLineNo">552</span> * Add a new replication peer for replicating data to slave cluster<a name="line.552"></a> -<span class="sourceLineNo">553</span> * @param peerId a short name that identifies the peer<a name="line.553"></a> -<span class="sourceLineNo">554</span> * @param peerConfig configuration for the replication slave cluster<a name="line.554"></a> -<span class="sourceLineNo">555</span> * @param enabled peer state, true if ENABLED and false if DISABLED<a name="line.555"></a> -<span class="sourceLineNo">556</span> */<a name="line.556"></a> -<span class="sourceLineNo">557</span> CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.557"></a> -<span class="sourceLineNo">558</span> ReplicationPeerConfig peerConfig, boolean enabled);<a name="line.558"></a> -<span class="sourceLineNo">559</span><a name="line.559"></a> -<span class="sourceLineNo">560</span> /**<a name="line.560"></a> -<span class="sourceLineNo">561</span> * Remove a peer and stop the replication<a name="line.561"></a> -<span class="sourceLineNo">562</span> * @param peerId a short name that identifies the peer<a name="line.562"></a> -<span class="sourceLineNo">563</span> */<a name="line.563"></a> -<span class="sourceLineNo">564</span> CompletableFuture<Void> removeReplicationPeer(String peerId);<a name="line.564"></a> -<span class="sourceLineNo">565</span><a name="line.565"></a> -<span class="sourceLineNo">566</span> /**<a name="line.566"></a> -<span class="sourceLineNo">567</span> * Restart the replication stream to the specified peer<a name="line.567"></a> -<span class="sourceLineNo">568</span> * @param peerId a short name that identifies the peer<a name="line.568"></a> -<span class="sourceLineNo">569</span> */<a name="line.569"></a> -<span class="sourceLineNo">570</span> CompletableFuture<Void> enableReplicationPeer(String peerId);<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> * Stop the replication stream to the specified peer<a name="line.573"></a> -<span class="sourceLineNo">574</span> * @param peerId a short name that identifies the peer<a name="line.574"></a> -<span class="sourceLineNo">575</span> */<a name="line.575"></a> -<span class="sourceLineNo">576</span> CompletableFuture<Void> disableReplicationPeer(String peerId);<a name="line.576"></a> -<span class="sourceLineNo">577</span><a name="line.577"></a> -<span class="sourceLineNo">578</span> /**<a name="line.578"></a> -<span class="sourceLineNo">579</span> * Returns the configured ReplicationPeerConfig for the specified peer<a name="line.579"></a> -<span class="sourceLineNo">580</span> * @param peerId a short name that identifies the peer<a name="line.580"></a> -<span class="sourceLineNo">581</span> * @return ReplicationPeerConfig for the peer wrapped by a {@link CompletableFuture}.<a name="line.581"></a> -<span class="sourceLineNo">582</span> */<a name="line.582"></a> -<span class="sourceLineNo">583</span> CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId);<a name="line.583"></a> -<span class="sourceLineNo">584</span><a name="line.584"></a> -<span class="sourceLineNo">585</span> /**<a name="line.585"></a> -<span class="sourceLineNo">586</span> * Update the peerConfig for the specified peer<a name="line.586"></a> -<span class="sourceLineNo">587</span> * @param peerId a short name that identifies the peer<a name="line.587"></a> -<span class="sourceLineNo">588</span> * @param peerConfig new config for the peer<a name="line.588"></a> -<span class="sourceLineNo">589</span> */<a name="line.589"></a> -<span class="sourceLineNo">590</span> CompletableFuture<Void> updateReplicationPeerConfig(String peerId,<a name="line.590"></a> -<span class="sourceLineNo">591</span> ReplicationPeerConfig peerConfig);<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> * Append the replicable table-cf config of the specified peer<a name="line.594"></a> -<span class="sourceLineNo">595</span> * @param peerId a short that identifies the cluster<a name="line.595"></a> -<span class="sourceLineNo">596</span> * @param tableCfs A map from tableName to column family names<a name="line.596"></a> -<span class="sourceLineNo">597</span> */<a name="line.597"></a> -<span class="sourceLineNo">598</span> CompletableFuture<Void> appendReplicationPeerTableCFs(String peerId,<a name="line.598"></a> -<span class="sourceLineNo">599</span> Map<TableName, List<String>> tableCfs);<a name="line.599"></a> -<span class="sourceLineNo">600</span><a name="line.600"></a> -<span class="sourceLineNo">601</span> /**<a name="line.601"></a> -<span class="sourceLineNo">602</span> * Remove some table-cfs from config of the specified peer<a name="line.602"></a> -<span class="sourceLineNo">603</span> * @param peerId a short name that identifies the cluster<a name="line.603"></a> -<span class="sourceLineNo">604</span> * @param tableCfs A map from tableName to column family names<a name="line.604"></a> -<span class="sourceLineNo">605</span> */<a name="line.605"></a> -<span class="sourceLineNo">606</span> CompletableFuture<Void> removeReplicationPeerTableCFs(String peerId,<a name="line.606"></a> -<span class="sourceLineNo">607</span> Map<TableName, List<String>> tableCfs);<a name="line.607"></a> -<span class="sourceLineNo">608</span><a name="line.608"></a> -<span class="sourceLineNo">609</span> /**<a name="line.609"></a> -<span class="sourceLineNo">610</span> * Return a list of replication peers.<a name="line.610"></a> -<span class="sourceLineNo">611</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.611"></a> -<span class="sourceLineNo">612</span> * {@link CompletableFuture}.<a name="line.612"></a> -<span class="sourceLineNo">613</span> */<a name="line.613"></a> -<span class="sourceLineNo">614</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers();<a name="line.614"></a> -<span class="sourceLineNo">615</span><a name="line.615"></a> -<span class="sourceLineNo">616</span> /**<a name="line.616"></a> -<span class="sourceLineNo">617</span> * Return a list of replication peers.<a name="line.617"></a> -<span class="sourceLineNo">618</span> * @param pattern The compiled regular expression to match peer id<a name="line.618"></a> -<span class="sourceLineNo">619</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.619"></a> -<span class="sourceLineNo">620</span> * {@link CompletableFuture}.<a name="line.620"></a> -<span class="sourceLineNo">621</span> */<a name="line.621"></a> -<span class="sourceLineNo">622</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(Pattern pattern);<a name="line.622"></a> -<span class="sourceLineNo">623</span><a name="line.623"></a> -<span class="sourceLineNo">624</span> /**<a name="line.624"></a> -<span class="sourceLineNo">625</span> * Find all table and column families that are replicated from this cluster<a name="line.625"></a> -<span class="sourceLineNo">626</span> * @return the replicated table-cfs list of this cluster. The return value will be wrapped by a<a name="line.626"></a> -<span class="sourceLineNo">627</span> * {@link CompletableFuture}.<a name="line.627"></a> -<span class="sourceLineNo">628</span> */<a name="line.628"></a> -<span class="sourceLineNo">629</span> CompletableFuture<List<TableCFs>> listReplicatedTableCFs();<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> * Enable a table's replication switch.<a name="line.632"></a> -<span class="sourceLineNo">633</span> * @param tableName name of the table<a name="line.633"></a> -<span class="sourceLineNo">634</span> */<a name="line.634"></a> -<span class="sourceLineNo">635</span> CompletableFuture<Void> enableTableReplication(TableName tableName);<a name="line.635"></a> -<span class="sourceLineNo">636</span><a name="line.636"></a> -<span class="sourceLineNo">637</span> /**<a name="line.637"></a> -<span class="sourceLineNo">638</span> * Disable a table's replication switch.<a name="line.638"></a> -<span class="sourceLineNo">639</span> * @param tableName name of the table<a name="line.639"></a> -<span class="sourceLineNo">640</span> */<a name="line.640"></a> -<span class="sourceLineNo">641</span> CompletableFuture<Void> disableTableReplication(TableName tableName);<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> * Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be<a name="line.644"></a> -<span class="sourceLineNo">645</span> * taken. If the table is disabled, an offline snapshot is taken. Snapshots are considered unique<a name="line.645"></a> -<span class="sourceLineNo">646</span> * based on <b>the name of the snapshot</b>. Attempts to take a snapshot with the same name (even<a name="line.646"></a> -<span class="sourceLineNo">647</span> * a different type or with different parameters) will fail with a<a name="line.647"></a> -<span class="sourceLineNo">648</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.648"></a> -<span class="sourceLineNo">649</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.649"></a> -<span class="sourceLineNo">650</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.650"></a> -<span class="sourceLineNo">651</span> * @param snapshotName name of the snapshot to be created<a name="line.651"></a> -<span class="sourceLineNo">652</span> * @param tableName name of the table for which snapshot is created<a name="line.652"></a> -<span class="sourceLineNo">653</span> */<a name="line.653"></a> -<span class="sourceLineNo">654</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName) {<a name="line.654"></a> -<span class="sourceLineNo">655</span> return snapshot(snapshotName, tableName, SnapshotType.FLUSH);<a name="line.655"></a> -<span class="sourceLineNo">656</span> }<a name="line.656"></a> -<span class="sourceLineNo">657</span><a name="line.657"></a> -<span class="sourceLineNo">658</span> /**<a name="line.658"></a> -<span class="sourceLineNo">659</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.659"></a> -<span class="sourceLineNo">660</span> * snapshot</b>. Attempts to take a snapshot with the same name (even a different type or with<a name="line.660"></a> -<span class="sourceLineNo">661</span> * different parameters) will fail with a<a name="line.661"></a> -<span class="sourceLineNo">662</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.662"></a> -<span class="sourceLineNo">663</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.663"></a> -<span class="sourceLineNo">664</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.664"></a> -<span class="sourceLineNo">665</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.665"></a> -<span class="sourceLineNo">666</span> * snapshots stored on the cluster<a name="line.666"></a> -<span class="sourceLineNo">667</span> * @param tableName name of the table to snapshot<a name="line.667"></a> -<span class="sourceLineNo">668</span> * @param type type of snapshot to take<a name="line.668"></a> -<span class="sourceLineNo">669</span> */<a name="line.669"></a> -<span class="sourceLineNo">670</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName,<a name="line.670"></a> -<span class="sourceLineNo">671</span> SnapshotType type) {<a name="line.671"></a> -<span class="sourceLineNo">672</span> return snapshot(new SnapshotDescription(snapshotName, tableName, type));<a name="line.672"></a> -<span class="sourceLineNo">673</span> }<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> * Take a snapshot and wait for the server to complete that snapshot asynchronously. Only a single<a name="line.676"></a> -<span class="sourceLineNo">677</span> * snapshot should be taken at a time for an instance of HBase, or results may be undefined (you<a name="line.677"></a> -<span class="sourceLineNo">678</span> * can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a<a name="line.678"></a> -<span class="sourceLineNo">679</span> * single cluster). Snapshots are considered unique based on <b>the name of the snapshot</b>.<a name="line.679"></a> -<span class="sourceLineNo">680</span> * Attempts to take a snapshot with the same name (even a different type or with different<a name="line.680"></a> -<span class="sourceLineNo">681</span> * parameters) will fail with a {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException}<a name="line.681"></a> -<span class="sourceLineNo">682</span> * indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in<a name="line.682"></a> -<span class="sourceLineNo">683</span> * HBase. See {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.683"></a> -<span class="sourceLineNo">684</span> * You should probably use {@link #snapshot(String, org.apache.hadoop.hbase.TableName)} unless you<a name="line.684"></a> -<span class="sourceLineNo">685</span> * are sure about the type of snapshot that you want to take.<a name="line.685"></a> -<span class="sourceLineNo">686</span> * @param snapshot snapshot to take<a name="line.686"></a> -<span class="sourceLineNo">687</span> */<a name="line.687"></a> -<span class="sourceLineNo">688</span> CompletableFuture<Void> snapshot(SnapshotDescription snapshot);<a name="line.688"></a> -<span class="sourceLineNo">689</span><a name="line.689"></a> -<span class="sourceLineNo">690</span> /**<a name="line.690"></a> -<span class="sourceLineNo">691</span> * Check the current state of the passed snapshot. There are three possible states:<a name="line.691"></a> -<span class="sourceLineNo">692</span> * <ol><a name="line.692"></a> -<span class="sourceLineNo">693</span> * <li>running - returns <tt>false</tt></li><a name="line.693"></a> -<span class="sourceLineNo">694</span> * <li>finished - returns <tt>true</tt></li><a name="line.694"></a> -<span class="sourceLineNo">695</span> * <li>finished with error - throws the exception that caused the snapshot to fail</li><a name="line.695"></a> -<span class="sourceLineNo">696</span> * </ol><a name="line.696"></a> -<span class="sourceLineNo">697</span> * The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been<a name="line.697"></a> -<span class="sourceLineNo">698</span> * run/started since the snapshot you are checking, you will receive an<a name="line.698"></a> -<span class="sourceLineNo">699</span> * {@link org.apache.hadoop.hbase.snapshot.UnknownSnapshotException}.<a name="line.699"></a> -<span class="sourceLineNo">700</span> * @param snapshot description of the snapshot to check<a name="line.700"></a> -<span class="sourceLineNo">701</span> * @return <tt>true</tt> if the snapshot is completed, <tt>false</tt> if the snapshot is still<a name="line.701"></a> -<span class="sourceLineNo">702</span> * running<a name="line.702"></a> -<span class="sourceLineNo">703</span> */<a name="line.703"></a> -<span class="sourceLineNo">704</span> CompletableFuture<Boolean> isSnapshotFinished(SnapshotDescription snapshot);<a name="line.704"></a> -<span class="sourceLineNo">705</span><a name="line.705"></a> -<span class="sourceLineNo">706</span> /**<a name="line.706"></a> -<span class="sourceLineNo">707</span> * Restore the specified snapshot on the original table. (The table must be disabled) If the<a name="line.707"></a> -<span class="sourceLineNo">708</span> * "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a<a name="line.708"></a> -<span class="sourceLineNo">709</span> * snapshot of the current table is taken before executing the restore operation. In case of<a name="line.709"></a> -<span class="sourceLineNo">710</span> * restore failure, the failsafe snapshot will be restored. If the restore completes without<a name="line.710"></a> -<span class="sourceLineNo">711</span> * problem the failsafe snapshot is deleted.<a name="line.711"></a> -<span class="sourceLineNo">712</span> * @param snapshotName name of the snapshot to restore<a name="line.712"></a> -<span class="sourceLineNo">713</span> */<a name="line.713"></a> -<span class="sourceLineNo">714</span> CompletableFuture<Void> restoreSnapshot(String snapshotName);<a name="line.714"></a> -<span class="sourceLineNo">715</span><a name="line.715"></a> -<span class="sourceLineNo">716</span> /**<a name="line.716"></a> -<span class="sourceLineNo">717</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.717"></a> -<span class="sourceLineNo">718</span> * 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before<a name="line.718"></a> -<span class="sourceLineNo">719</span> * executing the restore operation. In case of restore failure, the failsafe snapshot will be<a name="line.719"></a> -<span class="sourceLineNo">720</span> * restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.720"></a> -<span class="sourceLineNo">721</span> * failsafe snapshot name is configurable by using the property<a name="line.721"></a> -<span class="sourceLineNo">722</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.722"></a> -<span class="sourceLineNo">723</span> * @param snapshotName name of the snapshot to restore<a name="line.723"></a> -<span class="sourceLineNo">724</span> * @param takeFailSafeSnapshot true if the failsafe snapshot should be taken<a name="line.724"></a> -<span class="sourceLineNo">725</span> */<a name="line.725"></a> -<span class="sourceLineNo">726</span> CompletableFuture<Void> restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot);<a name="line.726"></a> -<span class="sourceLineNo">727</span><a name="line.727"></a> -<span class="sourceLineNo">728</span> /**<a name="line.728"></a> -<span class="sourceLineNo">729</span> * Create a new table by cloning the snapshot content.<a name="line.729"></a> -<span class="sourceLineNo">730</span> * @param snapshotName name of the snapshot to be cloned<a name="line.730"></a> -<span class="sourceLineNo">731</span> * @param tableName name of the table where the snapshot will be restored<a name="line.731"></a> -<span class="sourceLineNo">732</span> */<a name="line.732"></a> -<span class="sourceLineNo">733</span> CompletableFuture<Void> cloneSnapshot(String snapshotName, TableName tableName);<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> * List completed snapshots.<a name="line.736"></a> -<span class="sourceLineNo">737</span> * @return a list of snapshot descriptors for completed snapshots wrapped by a<a name="line.737"></a> -<span class="sourceLineNo">738</span> * {@link CompletableFuture}<a name="line.738"></a> -<span class="sourceLineNo">739</span> */<a name="line.739"></a> -<span class="sourceLineNo">740</span> CompletableFuture<List<SnapshotDescription>> listSnapshots();<a name="line.740"></a> -<span class="sourceLineNo">741</span><a name="line.741"></a> -<span class="sourceLineNo">742</span> /**<a name="line.742"></a> -<span class="sourceLineNo">743</span> * List all the completed snapshots matching the given pattern.<a name="line.743"></a> -<span class="sourceLineNo">744</span> * @param pattern The compiled regular expression to match against<a name="line.744"></a> -<span class="sourceLineNo">745</span> * @return - returns a List of SnapshotDescription wrapped by a {@link CompletableFuture}<a name="line.745"></a> -<span class="sourceLineNo">746</span> */<a name="line.746"></a> -<span class="sourceLineNo">747</span> CompletableFuture<List<SnapshotDescription>> listSnapshots(Pattern pattern);<a name="line.747"></a> -<span class="sourceLineNo">748</span><a name="line.748"></a> -<span class="sourceLineNo">749</span> /**<a name="line.749"></a> -<span class="sourceLineNo">750</span> * List all the completed snapshots matching the given table name pattern.<a name="line.750"></a> -<span class="sourceLineNo">751</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.751"></a> -<span class="sourceLineNo">752</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.752"></a> -<span class="sourceLineNo">753</span> * {@link CompletableFuture}<a name="line.753"></a> -<span class="sourceLineNo">754</span> */<a name="line.754"></a> -<span class="sourceLineNo">755</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern);<a name="line.755"></a> -<span class="sourceLineNo">756</span><a name="line.756"></a> -<span class="sourceLineNo">757</span> /**<a name="line.757"></a> -<span class="sourceLineNo">758</span> * List all the completed snapshots matching the given table name regular expression and snapshot<a name="line.758"></a> -<span class="sourceLineNo">759</span> * name regular expression.<a name="line.759"></a> -<span class="sourceLineNo">760</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.760"></a> -<span class="sourceLineNo">761</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.761"></a> -<span class="sourceLineNo">762</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.762"></a> -<span class="sourceLineNo">763</span> * {@link CompletableFuture}<a name="line.763"></a> -<span class="sourceLineNo">764</span> */<a name="line.764"></a> -<span class="sourceLineNo">765</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern,<a name="line.765"></a> -<span class="sourceLineNo">766</span> Pattern snapshotNamePattern);<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> * Delete an existing snapshot.<a name="line.769"></a> -<span class="sourceLineNo">770</span> * @param snapshotName name of the snapshot<a name="line.770"></a> -<span class="sourceLineNo">771</span> */<a name="line.771"></a> -<span class="sourceLineNo">772</span> CompletableFuture<Void> deleteSnapshot(String snapshotName);<a name="line.772"></a> -<span class="sourceLineNo">773</span><a name="line.773"></a> -<span class="sourceLineNo">774</span> /**<a name="line.774"></a> -<span class="sourceLineNo">775</span> * Delete all existing snapshots.<a name="line.775"></a> -<span class="sourceLineNo">776</span> */<a name="line.776"></a> -<span class="sourceLineNo">777</span> CompletableFuture<Void> deleteSnapshots();<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> * Delete existing snapshots whose names match the pattern passed.<a name="line.780"></a> -<span class="sourceLineNo">781</span> * @param pattern pattern for names of the snapshot to match<a name="line.781"></a> -<span class="sourceLineNo">782</span> */<a name="line.782"></a> -<span class="sourceLineNo">783</span> CompletableFuture<Void> deleteSnapshots(Pattern pattern);<a name="line.783"></a> -<span class="sourceLineNo">784</span><a name="line.784"></a> -<span class="sourceLineNo">785</span> /**<a name="line.785"></a> -<span class="sourceLineNo">786</span> * Delete all existing snapshots matching the given table name pattern.<a name="line.786"></a> -<span class="sourceLineNo">787</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.787"></a> -<span class="sourceLineNo">788</span> */<a name="line.788"></a> -<span class="sourceLineNo">789</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern);<a name="line.789"></a> -<span class="sourceLineNo">790</span><a name="line.790"></a> -<span class="sourceLineNo">791</span> /**<a name="line.791"></a> -<span class="sourceLineNo">792</span> * Delete all existing snapshots matching the given table name regular expression and snapshot<a name="line.792"></a> -<span class="sourceLineNo">793</span> * name regular expression.<a name="line.793"></a> -<span class="sourceLineNo">794</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.794"></a> -<span class="sourceLineNo">795</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.795"></a> -<span class="sourceLineNo">796</span> */<a name="line.796"></a> -<span class="sourceLineNo">797</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern,<a name="line.797"></a> -<span class="sourceLineNo">798</span> Pattern snapshotNamePattern);<a name="line.798"></a> -<span class="sourceLineNo">799</span><a name="line.799"></a> -<span class="sourceLineNo">800</span> /**<a name="line.800"></a> -<span class="sourceLineNo">801</span> * Execute a distributed procedure on a cluster.<a name="line.801"></a> -<span class="sourceLineNo">802</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.802"></a> -<span class="sourceLineNo">803</span> * root ZK node name of the procedure).<a name="line.803"></a> -<span class="sourceLineNo">804</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.804"></a> -<span class="sourceLineNo">805</span> * optional.<a name="line.805"></a> -<span class="sourceLineNo">806</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.806"></a> -<span class="sourceLineNo">807</span> */<a name="line.807"></a> -<span class="sourceLineNo">808</span> CompletableFuture<Void> execProcedure(String signature, String instance,<a name="line.808"></a> -<span class="sourceLineNo">809</span> Map<String, String> props);<a name="line.809"></a> -<span class="sourceLineNo">810</span><a name="line.810"></a> -<span class="sourceLineNo">811</span> /**<a name="line.811"></a> -<span class="sourceLineNo">812</span> * Execute a distributed procedure on a cluster.<a name="line.812"></a> -<span class="sourceLineNo">813</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.813"></a> -<span class="sourceLineNo">814</span> * root ZK node name of the procedure).<a name="line.814"></a> -<span class="sourceLineNo">815</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.815"></a> -<span class="sourceLineNo">816</span> * optional.<a name="line.816"></a> -<span class="sourceLineNo">817</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.817"></a> -<span class="sourceLineNo">818</span> * @return data returned after procedure execution. null if no return data.<a name="line.818"></a> -<span class="sourceLineNo">819</span> */<a name="line.819"></a> -<span class="sourceLineNo">820</span> CompletableFuture<byte[]> execProcedureWithReturn(String signature, String instance,<a name="line.820"></a> -<span class="sourceLineNo">821</span> Map<String, String> props);<a name="line.821"></a> -<span class="sourceLineNo">822</span><a name="line.822"></a> -<span class="sourceLineNo">823</span> /**<a name="line.823"></a> -<span class="sourceLineNo">824</span> * Check the current state of the specified procedure. There are three possible states:<a name="line.824"></a> -<span class="sourceLineNo">825</span> * <ol><a name="line.825"></a> -<span class="sourceLineNo">826</span> * <li>running - returns <tt>false</tt></li><a name="line.826"></a> -<span class="sourceLineNo">827</span> * <li>finished - returns <tt>true</tt></li><a name="line.827"></a> -<span class="sourceLineNo">828</span> * <li>finished with error - throws the exception that caused the procedure to fail</li><a name="line.828"></a> -<span class="sourceLineNo">829</span> * </ol><a name="line.829"></a> -<span class="sourceLineNo">830</span> * @param signature The signature that uniquely identifies a procedure<a name="line.830"></a> -<span class="sourceLineNo">831</span> * @param instance The instance name of the procedure<a name="line.831"></a> -<span class="sourceLineNo">832</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.832"></a> -<span class="sourceLineNo">833</span> * @return true if the specified procedure is finished successfully, false if it is still running.<a name="line.833"></a> -<span class="sourceLineNo">834</span> * The value is wrapped by {@link CompletableFuture}<a name="line.834"></a> -<span class="sourceLineNo">835</span> */<a name="line.835"></a> -<span class="sourceLineNo">836</span> CompletableFuture<Boolean> isProcedureFinished(String signature, String instance,<a name="line.836"></a> -<span class="sourceLineNo">837</span> Map<String, String> props);<a name="line.837"></a> -<span class="sourceLineNo">838</span><a name="line.838"></a> -<span class="sourceLineNo">839</span> /**<a name="line.839"></a> -<span class="sourceLineNo">840</span> * abort a procedure<a name="line.840"></a> -<span class="sourceLineNo">841</span> * @param procId ID of the procedure to abort<a name="line.841"></a> -<span class="sourceLineNo">842</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.842"></a> -<span class="sourceLineNo">843</span> * @return true if aborted, false if procedure already completed or does not exist. the value is<a name="line.843"></a> -<span class="sourceLineNo">844</span> * wrapped by {@link CompletableFuture}<a name="line.844"></a> -<span class="sourceLineNo">845</span> */<a name="line.845"></a> -<span class="sourceLineNo">846</span> CompletableFuture<Boolean> abortProcedure(long procId, boolean mayInterruptIfRunning);<a name="line.846"></a> -<span class="sourceLineNo">847</span><a name="line.847"></a> -<span class="sourceLineNo">848</span> /**<a name="line.848"></a> -<span class="sourceLineNo">849</span> * List procedures<a name="line.849"></a> -<span class="sourceLineNo">850</span> * @return procedure list JSON wrapped by {@link CompletableFuture}<a name="line.850"></a> -<span class="sourceLineNo">851</span> */<a name="line.851"></a> -<span class="sourceLineNo">852</span> CompletableFuture<String> getProcedures();<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> * List locks.<a name="line.855"></a> -<span class="sourceLineNo">856</span> * @return lock list JSON wrapped by {@link CompletableFuture}<a name="line.856"></a> -<span class="sourceLineNo">857</span> */<a name="line.857"></a> -<span class="sourceLineNo">858</span> CompletableFuture<String> getLocks();<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> * Mark region server(s) as decommissioned to prevent additional regions from getting<a name="line.861"></a> -<span class="sourceLineNo">862</span> * assigned to them. Optionally unload the regions on the servers. If there are multiple servers<a name="line.862"></a> -<span class="sourceLineNo">863</span> * to be decommissioned, decommissioning them at the same time can prevent wasteful region<a name="line.863"></a> -<span class="sourceLineNo">864</span> * movements. Region unloading is asynchronous.<a name="line.864"></a> -<span class="sourceLineNo">865</span> * @param servers The list of servers to decommission.<a name="line.865"></a> -<span class="sourceLineNo">866</span> * @param offload True to offload the regions from the decommissioned servers<a name="line.866"></a> -<span class="sourceLineNo">867</span> */<a name="line.867"></a> -<span class="sourceLineNo">868</span> CompletableFuture<Void> decommissionRegionServers(List<ServerName> servers, boolean offload);<a name="line.868"></a> -<span class="sourceLineNo">869</span><a name="line.869"></a> -<span class="sourceLineNo">870</span> /**<a name="line.870"></a> -<span class="sourceLineNo">871</span> * List region servers marked as decommissioned, which can not be assigned regions.<a name="line.871"></a> -<span class="sourceLineNo">872</span> * @return List of decommissioned region servers wrapped by {@link CompletableFuture}<a name="line.872"></a> -<span class="sourceLineNo">873</span> */<a name="line.873"></a> -<span class="sourceLineNo">874</span> CompletableFuture<List<ServerName>> listDecommissionedRegionServers();<a name="line.874"></a> -<span class="sourceLineNo">875</span><a name="line.875"></a> -<span class="sourceLineNo">876</span> /**<a name="line.876"></a> -<span class="sourceLineNo">877</span> * Remove decommission marker from a region server to allow regions assignments. Load regions onto<
<TRUNCATED>
