http://git-wip-us.apache.org/repos/asf/hbase-site/blob/eb5d2c62/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 27eb0b0..3f8c13d 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html @@ -27,1228 +27,1259 @@ <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><a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.EnumSet;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import java.util.Optional;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import java.util.Set;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import java.util.concurrent.CompletableFuture;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import java.util.function.Function;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import java.util.regex.Pattern;<a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.CacheEvictionStats;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.ClusterMetrics;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.ClusterMetrics.Option;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.RegionMetrics;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.ServerName;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.TableName;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.replication.TableCFs;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.42"></a> -<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.replication.ReplicationPeerConfig;<a name="line.43"></a> -<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.replication.ReplicationPeerDescription;<a name="line.44"></a> -<span class="sourceLineNo">045</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span>/**<a name="line.47"></a> -<span class="sourceLineNo">048</span> * The asynchronous administrative API for HBase.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * @since 2.0.0<a name="line.49"></a> -<span class="sourceLineNo">050</span> */<a name="line.50"></a> -<span class="sourceLineNo">051</span>@InterfaceAudience.Public<a name="line.51"></a> -<span class="sourceLineNo">052</span>public interface AsyncAdmin {<a name="line.52"></a> -<span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span> /**<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @param tableName Table to check.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @return True if table exists already. The return value will be wrapped by a<a name="line.56"></a> -<span class="sourceLineNo">057</span> * {@link CompletableFuture}.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> CompletableFuture<Boolean> tableExists(TableName tableName);<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> /**<a name="line.61"></a> -<span class="sourceLineNo">062</span> * List all the userspace tables.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.63"></a> -<span class="sourceLineNo">064</span> */<a name="line.64"></a> -<span class="sourceLineNo">065</span> default CompletableFuture<List<TableDescriptor>> listTableDescriptors() {<a name="line.65"></a> -<span class="sourceLineNo">066</span> return listTableDescriptors(false);<a name="line.66"></a> -<span class="sourceLineNo">067</span> }<a name="line.67"></a> -<span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> /**<a name="line.69"></a> -<span class="sourceLineNo">070</span> * List all the tables.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * @param includeSysTables False to match only against userspace tables<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.72"></a> -<span class="sourceLineNo">073</span> */<a name="line.73"></a> -<span class="sourceLineNo">074</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(boolean includeSysTables);<a name="line.74"></a> -<span class="sourceLineNo">075</span><a name="line.75"></a> -<span class="sourceLineNo">076</span> /**<a name="line.76"></a> -<span class="sourceLineNo">077</span> * List all the tables matching the given pattern.<a name="line.77"></a> -<span class="sourceLineNo">078</span> * @param pattern The compiled regular expression to match against<a name="line.78"></a> -<span class="sourceLineNo">079</span> * @param includeSysTables False to match only against userspace tables<a name="line.79"></a> -<span class="sourceLineNo">080</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.80"></a> -<span class="sourceLineNo">081</span> */<a name="line.81"></a> -<span class="sourceLineNo">082</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(Pattern pattern,<a name="line.82"></a> -<span class="sourceLineNo">083</span> boolean includeSysTables);<a name="line.83"></a> -<span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span> /**<a name="line.85"></a> -<span class="sourceLineNo">086</span> * Get list of table descriptors by namespace.<a name="line.86"></a> -<span class="sourceLineNo">087</span> * @param name namespace name<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @return returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> CompletableFuture<List<TableDescriptor>> listTableDescriptorsByNamespace(String name);<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> /**<a name="line.92"></a> -<span class="sourceLineNo">093</span> * List all of the names of userspace tables.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.94"></a> -<span class="sourceLineNo">095</span> * @see #listTableNames(Pattern, boolean)<a name="line.95"></a> -<span class="sourceLineNo">096</span> */<a name="line.96"></a> -<span class="sourceLineNo">097</span> default CompletableFuture<List<TableName>> listTableNames() {<a name="line.97"></a> -<span class="sourceLineNo">098</span> return listTableNames(false);<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<a name="line.99"></a> -<span class="sourceLineNo">100</span><a name="line.100"></a> -<span class="sourceLineNo">101</span> /**<a name="line.101"></a> -<span class="sourceLineNo">102</span> * List all of the names of tables.<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @param includeSysTables False to match only against userspace tables<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> CompletableFuture<List<TableName>> listTableNames(boolean includeSysTables);<a name="line.106"></a> -<span class="sourceLineNo">107</span><a name="line.107"></a> -<span class="sourceLineNo">108</span> /**<a name="line.108"></a> -<span class="sourceLineNo">109</span> * List all of the names of userspace tables.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @param pattern The regular expression to match against<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @param includeSysTables False to match only against userspace tables<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> CompletableFuture<List<TableName>> listTableNames(Pattern pattern, boolean includeSysTables);<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> -<span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * Get list of table names by namespace.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @param name namespace name<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @return The list of table names in the namespace wrapped by a {@link CompletableFuture}.<a name="line.119"></a> -<span class="sourceLineNo">120</span> */<a name="line.120"></a> -<span class="sourceLineNo">121</span> CompletableFuture<List<TableName>> listTableNamesByNamespace(String name);<a name="line.121"></a> -<span class="sourceLineNo">122</span><a name="line.122"></a> -<span class="sourceLineNo">123</span> /**<a name="line.123"></a> -<span class="sourceLineNo">124</span> * Method for getting the tableDescriptor<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @param tableName as a {@link TableName}<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @return the read-only tableDescriptor wrapped by a {@link CompletableFuture}.<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> CompletableFuture<TableDescriptor> getDescriptor(TableName tableName);<a name="line.128"></a> -<span class="sourceLineNo">129</span><a name="line.129"></a> -<span class="sourceLineNo">130</span> /**<a name="line.130"></a> -<span class="sourceLineNo">131</span> * Creates a new table.<a name="line.131"></a> -<span class="sourceLineNo">132</span> * @param desc table descriptor for table<a name="line.132"></a> -<span class="sourceLineNo">133</span> */<a name="line.133"></a> -<span class="sourceLineNo">134</span> CompletableFuture<Void> createTable(TableDescriptor desc);<a name="line.134"></a> -<span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> /**<a name="line.136"></a> -<span class="sourceLineNo">137</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.137"></a> -<span class="sourceLineNo">138</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.138"></a> -<span class="sourceLineNo">139</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.139"></a> -<span class="sourceLineNo">140</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.140"></a> -<span class="sourceLineNo">141</span> * segments to make the required number of total regions.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @param desc table descriptor for table<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @param startKey beginning of key range<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @param endKey end of key range<a name="line.144"></a> -<span class="sourceLineNo">145</span> * @param numRegions the total number of regions to create<a name="line.145"></a> -<span class="sourceLineNo">146</span> */<a name="line.146"></a> -<span class="sourceLineNo">147</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[] startKey, byte[] endKey,<a name="line.147"></a> -<span class="sourceLineNo">148</span> int numRegions);<a name="line.148"></a> -<span class="sourceLineNo">149</span><a name="line.149"></a> -<span class="sourceLineNo">150</span> /**<a name="line.150"></a> -<span class="sourceLineNo">151</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * The total number of regions created will be the number of split keys plus one.<a name="line.152"></a> -<span class="sourceLineNo">153</span> * Note : Avoid passing empty split key.<a name="line.153"></a> -<span class="sourceLineNo">154</span> * @param desc table descriptor for table<a name="line.154"></a> -<span class="sourceLineNo">155</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.155"></a> -<span class="sourceLineNo">156</span> */<a name="line.156"></a> -<span class="sourceLineNo">157</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[][] splitKeys);<a name="line.157"></a> -<span class="sourceLineNo">158</span><a name="line.158"></a> -<span class="sourceLineNo">159</span> /**<a name="line.159"></a> -<span class="sourceLineNo">160</span> * Modify an existing table, more IRB friendly version.<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @param desc modified description of the table<a name="line.161"></a> -<span class="sourceLineNo">162</span> */<a name="line.162"></a> -<span class="sourceLineNo">163</span> CompletableFuture<Void> modifyTable(TableDescriptor desc);<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> /**<a name="line.165"></a> -<span class="sourceLineNo">166</span> * Deletes a table.<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @param tableName name of table to delete<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> CompletableFuture<Void> deleteTable(TableName tableName);<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> /**<a name="line.171"></a> -<span class="sourceLineNo">172</span> * Truncate a table.<a name="line.172"></a> -<span class="sourceLineNo">173</span> * @param tableName name of table to truncate<a name="line.173"></a> -<span class="sourceLineNo">174</span> * @param preserveSplits True if the splits should be preserved<a name="line.174"></a> -<span class="sourceLineNo">175</span> */<a name="line.175"></a> -<span class="sourceLineNo">176</span> CompletableFuture<Void> truncateTable(TableName tableName, boolean preserveSplits);<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * Enable a table. The table has to be in disabled state for it to be enabled.<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @param tableName name of the table<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> CompletableFuture<Void> enableTable(TableName tableName);<a name="line.182"></a> -<span class="sourceLineNo">183</span><a name="line.183"></a> -<span class="sourceLineNo">184</span> /**<a name="line.184"></a> -<span class="sourceLineNo">185</span> * Disable a table. The table has to be in enabled state for it to be disabled.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @param tableName<a name="line.186"></a> -<span class="sourceLineNo">187</span> */<a name="line.187"></a> -<span class="sourceLineNo">188</span> CompletableFuture<Void> disableTable(TableName tableName);<a name="line.188"></a> -<span class="sourceLineNo">189</span><a name="line.189"></a> -<span class="sourceLineNo">190</span> /**<a name="line.190"></a> -<span class="sourceLineNo">191</span> * @param tableName name of table to check<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @return true if table is on-line. The return value will be wrapped by a<a name="line.192"></a> -<span class="sourceLineNo">193</span> * {@link CompletableFuture}.<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> CompletableFuture<Boolean> isTableEnabled(TableName tableName);<a name="line.195"></a> -<span class="sourceLineNo">196</span><a name="line.196"></a> -<span class="sourceLineNo">197</span> /**<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @param tableName name of table to check<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @return true if table is off-line. The return value will be wrapped by a<a name="line.199"></a> -<span class="sourceLineNo">200</span> * {@link CompletableFuture}.<a name="line.200"></a> -<span class="sourceLineNo">201</span> */<a name="line.201"></a> -<span class="sourceLineNo">202</span> CompletableFuture<Boolean> isTableDisabled(TableName tableName);<a name="line.202"></a> -<span class="sourceLineNo">203</span><a name="line.203"></a> -<span class="sourceLineNo">204</span> /**<a name="line.204"></a> -<span class="sourceLineNo">205</span> * @param tableName name of table to check<a name="line.205"></a> -<span class="sourceLineNo">206</span> * @return true if all regions of the table are available. The return value will be wrapped by a<a name="line.206"></a> -<span class="sourceLineNo">207</span> * {@link CompletableFuture}.<a name="line.207"></a> -<span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> CompletableFuture<Boolean> isTableAvailable(TableName tableName);<a name="line.209"></a> -<span class="sourceLineNo">210</span><a name="line.210"></a> -<span class="sourceLineNo">211</span> /**<a name="line.211"></a> -<span class="sourceLineNo">212</span> * Use this api to check if the table has been created with the specified number of splitkeys<a name="line.212"></a> -<span class="sourceLineNo">213</span> * which was used while creating the given table. Note : If this api is used after a table's<a name="line.213"></a> -<span class="sourceLineNo">214</span> * region gets splitted, the api may return false. The return value will be wrapped by a<a name="line.214"></a> -<span class="sourceLineNo">215</span> * {@link CompletableFuture}.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @param tableName name of table to check<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.217"></a> -<span class="sourceLineNo">218</span> */<a name="line.218"></a> -<span class="sourceLineNo">219</span> CompletableFuture<Boolean> isTableAvailable(TableName tableName, byte[][] splitKeys);<a name="line.219"></a> -<span class="sourceLineNo">220</span><a name="line.220"></a> -<span class="sourceLineNo">221</span> /**<a name="line.221"></a> -<span class="sourceLineNo">222</span> * Add a column family to an existing table.<a name="line.222"></a> -<span class="sourceLineNo">223</span> * @param tableName name of the table to add column family to<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @param columnFamily column family descriptor of column family to be added<a name="line.224"></a> -<span class="sourceLineNo">225</span> */<a name="line.225"></a> -<span class="sourceLineNo">226</span> CompletableFuture<Void> addColumnFamily(TableName tableName,<a name="line.226"></a> -<span class="sourceLineNo">227</span> ColumnFamilyDescriptor columnFamily);<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> /**<a name="line.229"></a> -<span class="sourceLineNo">230</span> * Delete a column family from a table.<a name="line.230"></a> -<span class="sourceLineNo">231</span> * @param tableName name of table<a name="line.231"></a> -<span class="sourceLineNo">232</span> * @param columnFamily name of column family to be deleted<a name="line.232"></a> -<span class="sourceLineNo">233</span> */<a name="line.233"></a> -<span class="sourceLineNo">234</span> CompletableFuture<Void> deleteColumnFamily(TableName tableName, byte[] columnFamily);<a name="line.234"></a> -<span class="sourceLineNo">235</span><a name="line.235"></a> -<span class="sourceLineNo">236</span> /**<a name="line.236"></a> -<span class="sourceLineNo">237</span> * Modify an existing column family on a table.<a name="line.237"></a> -<span class="sourceLineNo">238</span> * @param tableName name of table<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @param columnFamily new column family descriptor to use<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> CompletableFuture<Void> modifyColumnFamily(TableName tableName,<a name="line.241"></a> -<span class="sourceLineNo">242</span> ColumnFamilyDescriptor columnFamily);<a name="line.242"></a> -<span class="sourceLineNo">243</span><a name="line.243"></a> -<span class="sourceLineNo">244</span> /**<a name="line.244"></a> -<span class="sourceLineNo">245</span> * Create a new namespace.<a name="line.245"></a> -<span class="sourceLineNo">246</span> * @param descriptor descriptor which describes the new namespace<a name="line.246"></a> -<span class="sourceLineNo">247</span> */<a name="line.247"></a> -<span class="sourceLineNo">248</span> CompletableFuture<Void> createNamespace(NamespaceDescriptor descriptor);<a name="line.248"></a> -<span class="sourceLineNo">249</span><a name="line.249"></a> -<span class="sourceLineNo">250</span> /**<a name="line.250"></a> -<span class="sourceLineNo">251</span> * Modify an existing namespace.<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param descriptor descriptor which describes the new namespace<a name="line.252"></a> -<span class="sourceLineNo">253</span> */<a name="line.253"></a> -<span class="sourceLineNo">254</span> CompletableFuture<Void> modifyNamespace(NamespaceDescriptor descriptor);<a name="line.254"></a> -<span class="sourceLineNo">255</span><a name="line.255"></a> -<span class="sourceLineNo">256</span> /**<a name="line.256"></a> -<span class="sourceLineNo">257</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @param name namespace name<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> CompletableFuture<Void> deleteNamespace(String name);<a name="line.260"></a> -<span class="sourceLineNo">261</span><a name="line.261"></a> -<span class="sourceLineNo">262</span> /**<a name="line.262"></a> -<span class="sourceLineNo">263</span> * Get a namespace descriptor by name<a name="line.263"></a> -<span class="sourceLineNo">264</span> * @param name name of namespace descriptor<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @return A descriptor wrapped by a {@link CompletableFuture}.<a name="line.265"></a> -<span class="sourceLineNo">266</span> */<a name="line.266"></a> -<span class="sourceLineNo">267</span> CompletableFuture<NamespaceDescriptor> getNamespaceDescriptor(String name);<a name="line.267"></a> -<span class="sourceLineNo">268</span><a name="line.268"></a> -<span class="sourceLineNo">269</span> /**<a name="line.269"></a> -<span class="sourceLineNo">270</span> * List available namespace descriptors<a name="line.270"></a> -<span class="sourceLineNo">271</span> * @return List of descriptors wrapped by a {@link CompletableFuture}.<a name="line.271"></a> -<span class="sourceLineNo">272</span> */<a name="line.272"></a> -<span class="sourceLineNo">273</span> CompletableFuture<List<NamespaceDescriptor>> listNamespaceDescriptors();<a name="line.273"></a> -<span class="sourceLineNo">274</span><a name="line.274"></a> -<span class="sourceLineNo">275</span> /**<a name="line.275"></a> -<span class="sourceLineNo">276</span> * Get all the online regions on a region server.<a name="line.276"></a> -<span class="sourceLineNo">277</span> */<a name="line.277"></a> -<span class="sourceLineNo">278</span> CompletableFuture<List<RegionInfo>> getRegions(ServerName serverName);<a name="line.278"></a> -<span class="sourceLineNo">279</span><a name="line.279"></a> -<span class="sourceLineNo">280</span> /**<a name="line.280"></a> -<span class="sourceLineNo">281</span> * Get the regions of a given table.<a name="line.281"></a> -<span class="sourceLineNo">282</span> */<a name="line.282"></a> -<span class="sourceLineNo">283</span> CompletableFuture<List<RegionInfo>> getRegions(TableName tableName);<a name="line.283"></a> -<span class="sourceLineNo">284</span><a name="line.284"></a> -<span class="sourceLineNo">285</span> /**<a name="line.285"></a> -<span class="sourceLineNo">286</span> * Flush a table.<a name="line.286"></a> -<span class="sourceLineNo">287</span> * @param tableName table to flush<a name="line.287"></a> -<span class="sourceLineNo">288</span> */<a name="line.288"></a> -<span class="sourceLineNo">289</span> CompletableFuture<Void> flush(TableName tableName);<a name="line.289"></a> -<span class="sourceLineNo">290</span><a name="line.290"></a> -<span class="sourceLineNo">291</span> /**<a name="line.291"></a> -<span class="sourceLineNo">292</span> * Flush an individual region.<a name="line.292"></a> -<span class="sourceLineNo">293</span> * @param regionName region to flush<a name="line.293"></a> -<span class="sourceLineNo">294</span> */<a name="line.294"></a> -<span class="sourceLineNo">295</span> CompletableFuture<Void> flushRegion(byte[] regionName);<a name="line.295"></a> -<span class="sourceLineNo">296</span><a name="line.296"></a> -<span class="sourceLineNo">297</span> /**<a name="line.297"></a> -<span class="sourceLineNo">298</span> * Flush all region on the region server.<a name="line.298"></a> -<span class="sourceLineNo">299</span> * @param serverName server to flush<a name="line.299"></a> -<span class="sourceLineNo">300</span> */<a name="line.300"></a> -<span class="sourceLineNo">301</span> CompletableFuture<Void> flushRegionServer(ServerName serverName);<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 table. When the returned CompletableFuture is done, it only means the compact request<a name="line.304"></a> -<span class="sourceLineNo">305</span> * was sent to HBase and may need some time to finish the compact operation.<a name="line.305"></a> -<span class="sourceLineNo">306</span> * @param tableName table to compact<a name="line.306"></a> -<span class="sourceLineNo">307</span> */<a name="line.307"></a> -<span class="sourceLineNo">308</span> default CompletableFuture<Void> compact(TableName tableName) {<a name="line.308"></a> -<span class="sourceLineNo">309</span> return compact(tableName, CompactType.NORMAL);<a name="line.309"></a> -<span class="sourceLineNo">310</span> }<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> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.313"></a> -<span class="sourceLineNo">314</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.314"></a> -<span class="sourceLineNo">315</span> * operation.<a name="line.315"></a> -<span class="sourceLineNo">316</span> * @param tableName table to compact<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @param columnFamily column family within a table. If not present, compact the table's all<a name="line.317"></a> -<span class="sourceLineNo">318</span> * column families.<a name="line.318"></a> -<span class="sourceLineNo">319</span> */<a name="line.319"></a> -<span class="sourceLineNo">320</span> default CompletableFuture<Void> compact(TableName tableName, byte[] columnFamily) {<a name="line.320"></a> -<span class="sourceLineNo">321</span> return compact(tableName, columnFamily, CompactType.NORMAL);<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> /**<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> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.328"></a> -<span class="sourceLineNo">329</span> */<a name="line.329"></a> -<span class="sourceLineNo">330</span> CompletableFuture<Void> compact(TableName tableName, CompactType compactType);<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> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.333"></a> -<span class="sourceLineNo">334</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.334"></a> -<span class="sourceLineNo">335</span> * operation.<a name="line.335"></a> -<span class="sourceLineNo">336</span> * @param tableName table to compact<a name="line.336"></a> -<span class="sourceLineNo">337</span> * @param columnFamily column family within a table<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.338"></a> -<span class="sourceLineNo">339</span> */<a name="line.339"></a> -<span class="sourceLineNo">340</span> CompletableFuture<Void> compact(TableName tableName, byte[] columnFamily,<a name="line.340"></a> -<span class="sourceLineNo">341</span> CompactType compactType);<a name="line.341"></a> -<span class="sourceLineNo">342</span><a name="line.342"></a> -<span class="sourceLineNo">343</span> /**<a name="line.343"></a> -<span class="sourceLineNo">344</span> * Compact an individual region. When the returned CompletableFuture is done, it only means the<a name="line.344"></a> -<span class="sourceLineNo">345</span> * compact request was sent to HBase and may need some time to finish the compact operation.<a name="line.345"></a> -<span class="sourceLineNo">346</span> * @param regionName region to compact<a name="line.346"></a> -<span class="sourceLineNo">347</span> */<a name="line.347"></a> -<span class="sourceLineNo">348</span> CompletableFuture<Void> compactRegion(byte[] regionName);<a name="line.348"></a> -<span class="sourceLineNo">349</span><a name="line.349"></a> -<span class="sourceLineNo">350</span> /**<a name="line.350"></a> -<span class="sourceLineNo">351</span> * Compact a column family within a region. When the returned CompletableFuture is done, it only<a name="line.351"></a> -<span class="sourceLineNo">352</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.352"></a> -<span class="sourceLineNo">353</span> * operation.<a name="line.353"></a> -<span class="sourceLineNo">354</span> * @param regionName region to compact<a name="line.354"></a> -<span class="sourceLineNo">355</span> * @param columnFamily column family within a region. If not present, compact the region's all<a name="line.355"></a> -<span class="sourceLineNo">356</span> * column families.<a name="line.356"></a> -<span class="sourceLineNo">357</span> */<a name="line.357"></a> -<span class="sourceLineNo">358</span> CompletableFuture<Void> compactRegion(byte[] regionName, byte[] columnFamily);<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 table. When the returned CompletableFuture is done, it only means the compact<a name="line.361"></a> -<span class="sourceLineNo">362</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @param tableName table to major compact<a name="line.363"></a> -<span class="sourceLineNo">364</span> */<a name="line.364"></a> -<span class="sourceLineNo">365</span> default CompletableFuture<Void> majorCompact(TableName tableName) {<a name="line.365"></a> -<span class="sourceLineNo">366</span> return majorCompact(tableName, CompactType.NORMAL);<a name="line.366"></a> -<span class="sourceLineNo">367</span> }<a name="line.367"></a> -<span class="sourceLineNo">368</span><a name="line.368"></a> -<span class="sourceLineNo">369</span> /**<a name="line.369"></a> -<span class="sourceLineNo">370</span> * Major compact a column family within a table. When the returned CompletableFuture is done, it<a name="line.370"></a> -<span class="sourceLineNo">371</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.371"></a> -<span class="sourceLineNo">372</span> * operation.<a name="line.372"></a> -<span class="sourceLineNo">373</span> * @param tableName table to major compact<a name="line.373"></a> -<span class="sourceLineNo">374</span> * @param columnFamily column family within a table. If not present, major compact the table's all<a name="line.374"></a> -<span class="sourceLineNo">375</span> * column families.<a name="line.375"></a> -<span class="sourceLineNo">376</span> */<a name="line.376"></a> -<span class="sourceLineNo">377</span> default CompletableFuture<Void> majorCompact(TableName tableName, byte[] columnFamily) {<a name="line.377"></a> -<span class="sourceLineNo">378</span> return majorCompact(tableName, columnFamily, CompactType.NORMAL);<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> /**<a name="line.381"></a> -<span class="sourceLineNo">382</span> * Major compact a table. When the returned CompletableFuture is done, it only means the compact<a name="line.382"></a> -<span class="sourceLineNo">383</span> * request was sent to HBase and may need some time to finish the compact 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 compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.385"></a> -<span class="sourceLineNo">386</span> */<a name="line.386"></a> -<span class="sourceLineNo">387</span> CompletableFuture<Void> majorCompact(TableName tableName, CompactType compactType);<a name="line.387"></a> -<span class="sourceLineNo">388</span><a name="line.388"></a> -<span class="sourceLineNo">389</span> /**<a name="line.389"></a> -<span class="sourceLineNo">390</span> * Major compact a column family within a table. When the returned CompletableFuture is done, it<a name="line.390"></a> -<span class="sourceLineNo">391</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.391"></a> -<span class="sourceLineNo">392</span> * operation.<a name="line.392"></a> -<span class="sourceLineNo">393</span> * @param tableName table to major compact<a name="line.393"></a> -<span class="sourceLineNo">394</span> * @param columnFamily column family within a table. If not present, major compact the table's all<a name="line.394"></a> -<span class="sourceLineNo">395</span> * column families.<a name="line.395"></a> -<span class="sourceLineNo">396</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.396"></a> -<span class="sourceLineNo">397</span> */<a name="line.397"></a> -<span class="sourceLineNo">398</span> CompletableFuture<Void> majorCompact(TableName tableName, byte[] columnFamily,<a name="line.398"></a> -<span class="sourceLineNo">399</span> CompactType compactType);<a name="line.399"></a> -<span class="sourceLineNo">400</span><a name="line.400"></a> -<span class="sourceLineNo">401</span> /**<a name="line.401"></a> -<span class="sourceLineNo">402</span> * Major compact a region. When the returned CompletableFuture is done, it only means the compact<a name="line.402"></a> -<span class="sourceLineNo">403</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.403"></a> -<span class="sourceLineNo">404</span> * @param regionName region to major compact<a name="line.404"></a> -<span class="sourceLineNo">405</span> */<a name="line.405"></a> -<span class="sourceLineNo">406</span> CompletableFuture<Void> majorCompactRegion(byte[] regionName);<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> * Major compact a column family within region. When the returned CompletableFuture is done, it<a name="line.409"></a> -<span class="sourceLineNo">410</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.410"></a> -<span class="sourceLineNo">411</span> * operation.<a name="line.411"></a> -<span class="sourceLineNo">412</span> * @param regionName region to major compact<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @param columnFamily column family within a region. If not present, major compact the region's<a name="line.413"></a> -<span class="sourceLineNo">414</span> * all column families.<a name="line.414"></a> -<span class="sourceLineNo">415</span> */<a name="line.415"></a> -<span class="sourceLineNo">416</span> CompletableFuture<Void> majorCompactRegion(byte[] regionName, byte[] columnFamily);<a name="line.416"></a> -<span class="sourceLineNo">417</span><a name="line.417"></a> -<span class="sourceLineNo">418</span> /**<a name="line.418"></a> -<span class="sourceLineNo">419</span> * Compact all regions on the region server.<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @param serverName the region server name<a name="line.420"></a> -<span class="sourceLineNo">421</span> */<a name="line.421"></a> -<span class="sourceLineNo">422</span> CompletableFuture<Void> compactRegionServer(ServerName serverName);<a name="line.422"></a> -<span class="sourceLineNo">423</span><a name="line.423"></a> -<span class="sourceLineNo">424</span> /**<a name="line.424"></a> -<span class="sourceLineNo">425</span> * Compact all regions on the region server.<a name="line.425"></a> -<span class="sourceLineNo">426</span> * @param serverName the region server name<a name="line.426"></a> -<span class="sourceLineNo">427</span> */<a name="line.427"></a> -<span class="sourceLineNo">428</span> CompletableFuture<Void> majorCompactRegionServer(ServerName serverName);<a name="line.428"></a> -<span class="sourceLineNo">429</span><a name="line.429"></a> -<span class="sourceLineNo">430</span> /**<a name="line.430"></a> -<span class="sourceLineNo">431</span> * Turn the Merge switch on or off.<a name="line.431"></a> -<span class="sourceLineNo">432</span> * @param on<a name="line.432"></a> -<span class="sourceLineNo">433</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.433"></a> -<span class="sourceLineNo">434</span> */<a name="line.434"></a> -<span class="sourceLineNo">435</span> CompletableFuture<Boolean> mergeSwitch(boolean on);<a name="line.435"></a> -<span class="sourceLineNo">436</span><a name="line.436"></a> -<span class="sourceLineNo">437</span> /**<a name="line.437"></a> -<span class="sourceLineNo">438</span> * Query the current state of the Merge switch.<a name="line.438"></a> -<span class="sourceLineNo">439</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.439"></a> -<span class="sourceLineNo">440</span> * {@link CompletableFuture}<a name="line.440"></a> -<span class="sourceLineNo">441</span> */<a name="line.441"></a> -<span class="sourceLineNo">442</span> CompletableFuture<Boolean> isMergeEnabled();<a name="line.442"></a> -<span class="sourceLineNo">443</span><a name="line.443"></a> -<span class="sourceLineNo">444</span> /**<a name="line.444"></a> -<span class="sourceLineNo">445</span> * Turn the Split switch on or off.<a name="line.445"></a> -<span class="sourceLineNo">446</span> * @param on<a name="line.446"></a> -<span class="sourceLineNo">447</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.447"></a> -<span class="sourceLineNo">448</span> */<a name="line.448"></a> -<span class="sourceLineNo">449</span> CompletableFuture<Boolean> splitSwitch(boolean on);<a name="line.449"></a> -<span class="sourceLineNo">450</span><a name="line.450"></a> -<span class="sourceLineNo">451</span> /**<a name="line.451"></a> -<span class="sourceLineNo">452</span> * Query the current state of the Split switch.<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.453"></a> -<span class="sourceLineNo">454</span> * {@link CompletableFuture}<a name="line.454"></a> -<span class="sourceLineNo">455</span> */<a name="line.455"></a> -<span class="sourceLineNo">456</span> CompletableFuture<Boolean> isSplitEnabled();<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> * Merge two regions.<a name="line.459"></a> -<span class="sourceLineNo">460</span> * @param nameOfRegionA encoded or full name of region a<a name="line.460"></a> -<span class="sourceLineNo">461</span> * @param nameOfRegionB encoded or full name of region b<a name="line.461"></a> -<span class="sourceLineNo">462</span> * @param forcible true if do a compulsory merge, otherwise we will only merge two adjacent<a name="line.462"></a> -<span class="sourceLineNo">463</span> * regions<a name="line.463"></a> -<span class="sourceLineNo">464</span> */<a name="line.464"></a> -<span class="sourceLineNo">465</span> CompletableFuture<Void> mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB,<a name="line.465"></a> -<span class="sourceLineNo">466</span> boolean forcible);<a name="line.466"></a> -<span class="sourceLineNo">467</span><a name="line.467"></a> -<span class="sourceLineNo">468</span> /**<a name="line.468"></a> -<span class="sourceLineNo">469</span> * Split a table. The method will execute split action for each region in table.<a name="line.469"></a> -<span class="sourceLineNo">470</span> * @param tableName table to split<a name="line.470"></a> -<span class="sourceLineNo">471</span> */<a name="line.471"></a> -<span class="sourceLineNo">472</span> CompletableFuture<Void> split(TableName tableName);<a name="line.472"></a> -<span class="sourceLineNo">473</span><a name="line.473"></a> -<span class="sourceLineNo">474</span> /**<a name="line.474"></a> -<span class="sourceLineNo">475</span> * Split an individual region.<a name="line.475"></a> -<span class="sourceLineNo">476</span> * @param regionName region to split<a name="line.476"></a> -<span class="sourceLineNo">477</span> */<a name="line.477"></a> -<span class="sourceLineNo">478</span> CompletableFuture<Void> splitRegion(byte[] regionName);<a name="line.478"></a> -<span class="sourceLineNo">479</span><a name="line.479"></a> -<span class="sourceLineNo">480</span> /**<a name="line.480"></a> -<span class="sourceLineNo">481</span> * Split a table.<a name="line.481"></a> -<span class="sourceLineNo">482</span> * @param tableName table to split<a name="line.482"></a> -<span class="sourceLineNo">483</span> * @param splitPoint the explicit position to split on<a name="line.483"></a> -<span class="sourceLineNo">484</span> */<a name="line.484"></a> -<span class="sourceLineNo">485</span> CompletableFuture<Void> split(TableName tableName, byte[] splitPoint);<a name="line.485"></a> -<span class="sourceLineNo">486</span><a name="line.486"></a> -<span class="sourceLineNo">487</span> /**<a name="line.487"></a> -<span class="sourceLineNo">488</span> * Split an individual region.<a name="line.488"></a> -<span class="sourceLineNo">489</span> * @param regionName region to split<a name="line.489"></a> -<span class="sourceLineNo">490</span> * @param splitPoint the explicit position to split on. If not present, it will decide by region<a name="line.490"></a> -<span class="sourceLineNo">491</span> * server.<a name="line.491"></a> -<span class="sourceLineNo">492</span> */<a name="line.492"></a> -<span class="sourceLineNo">493</span> CompletableFuture<Void> splitRegion(byte[] regionName, byte[] splitPoint);<a name="line.493"></a> -<span class="sourceLineNo">494</span><a name="line.494"></a> -<span class="sourceLineNo">495</span> /**<a name="line.495"></a> -<span class="sourceLineNo">496</span> * @param regionName Encoded or full name of region to assign.<a name="line.496"></a> -<span class="sourceLineNo">497</span> */<a name="line.497"></a> -<span class="sourceLineNo">498</span> CompletableFuture<Void> assign(byte[] regionName);<a name="line.498"></a> -<span class="sourceLineNo">499</span><a name="line.499"></a> -<span class="sourceLineNo">500</span> /**<a name="line.500"></a> -<span class="sourceLineNo">501</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.501"></a> -<span class="sourceLineNo">502</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use<a name="line.502"></a> -<span class="sourceLineNo">503</span> * {@link #move(byte[], ServerName)} if you want to control the region movement.<a name="line.503"></a> -<span class="sourceLineNo">504</span> * @param regionName Encoded or full name of region to unassign. Will clear any existing<a name="line.504"></a> -<span class="sourceLineNo">505</span> * RegionPlan if one found.<a name="line.505"></a> -<span class="sourceLineNo">506</span> * @param forcible If true, force unassign (Will remove region from regions-in-transition too if<a name="line.506"></a> -<span class="sourceLineNo">507</span> * present. If results in double assignment use hbck -fix to resolve. To be used by<a name="line.507"></a> -<span class="sourceLineNo">508</span> * experts).<a name="line.508"></a> -<span class="sourceLineNo">509</span> */<a name="line.509"></a> -<span class="sourceLineNo">510</span> CompletableFuture<Void> unassign(byte[] regionName, boolean forcible);<a name="line.510"></a> -<span class="sourceLineNo">511</span><a name="line.511"></a> -<span class="sourceLineNo">512</span> /**<a name="line.512"></a> -<span class="sourceLineNo">513</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.513"></a> -<span class="sourceLineNo">514</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.514"></a> -<span class="sourceLineNo">515</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.515"></a> -<span class="sourceLineNo">516</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.516"></a> -<span class="sourceLineNo">517</span> * experts or hbck.<a name="line.517"></a> -<span class="sourceLineNo">518</span> * @param regionName Encoded or full name of region to offline<a name="line.518"></a> -<span class="sourceLineNo">519</span> */<a name="line.519"></a> -<span class="sourceLineNo">520</span> CompletableFuture<Void> offline(byte[] regionName);<a name="line.520"></a> -<span class="sourceLineNo">521</span><a name="line.521"></a> -<span class="sourceLineNo">522</span> /**<a name="line.522"></a> -<span class="sourceLineNo">523</span> * Move the region <code>r</code> to a random server.<a name="line.523"></a> -<span class="sourceLineNo">524</span> * @param regionName Encoded or full name of region to move.<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);<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> * Move the region <code>r</code> to <code>dest</code>.<a name="line.529"></a> -<span class="sourceLineNo">530</span> * @param regionName Encoded or full name of region to move.<a name="line.530"></a> -<span class="sourceLineNo">531</span> * @param destServerName The servername of the destination regionserver. If not present, we'll<a name="line.531"></a> -<span class="sourceLineNo">532</span> * assign to a random server. A server name is made of host, port and startcode. Here is<a name="line.532"></a> -<span class="sourceLineNo">533</span> * an example: <code> host187.example.com,60020,1289493121758</code><a name="line.533"></a> -<span class="sourceLineNo">534</span> */<a name="line.534"></a> -<span class="sourceLineNo">535</span> CompletableFuture<Void> move(byte[] regionName, ServerName destServerName);<a name="line.535"></a> -<span class="sourceLineNo">536</span><a name="line.536"></a> -<span class="sourceLineNo">537</span> /**<a name="line.537"></a> -<span class="sourceLineNo">538</span> * Apply the new quota settings.<a name="line.538"></a> -<span class="sourceLineNo">539</span> * @param quota the quota settings<a name="line.539"></a> -<span class="sourceLineNo">540</span> */<a name="line.540"></a> -<span class="sourceLineNo">541</span> CompletableFuture<Void> setQuota(QuotaSettings quota);<a name="line.541"></a> -<span class="sourceLineNo">542</span><a name="line.542"></a> -<span class="sourceLineNo">543</span> /**<a name="line.543"></a> -<span class="sourceLineNo">544</span> * List the quotas based on the filter.<a name="line.544"></a> -<span class="sourceLineNo">545</span> * @param filter the quota settings filter<a name="line.545"></a> -<span class="sourceLineNo">546</span> * @return the QuotaSetting list, which wrapped by a CompletableFuture.<a name="line.546"></a> -<span class="sourceLineNo">547</span> */<a name="line.547"></a> -<span class="sourceLineNo">548</span> CompletableFuture<List<QuotaSettings>> getQuota(QuotaFilter filter);<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> * Add a new replication peer for replicating data to slave cluster<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> * @param peerConfig configuration for the replication slave cluster<a name="line.553"></a> -<span class="sourceLineNo">554</span> */<a name="line.554"></a> -<span class="sourceLineNo">555</span> default CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.555"></a> -<span class="sourceLineNo">556</span> ReplicationPeerConfig peerConfig) {<a name="line.556"></a> -<span class="sourceLineNo">557</span> return addReplicationPeer(peerId, peerConfig, true);<a name="line.557"></a> -<span class="sourceLineNo">558</span> }<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> * Add a new replication peer for replicating data to slave cluster<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> * @param peerConfig configuration for the replication slave cluster<a name="line.563"></a> -<span class="sourceLineNo">564</span> * @param enabled peer state, true if ENABLED and false if DISABLED<a name="line.564"></a> -<span class="sourceLineNo">565</span> */<a name="line.565"></a> -<span class="sourceLineNo">566</span> CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.566"></a> -<span class="sourceLineNo">567</span> ReplicationPeerConfig peerConfig, boolean enabled);<a name="line.567"></a> -<span class="sourceLineNo">568</span><a name="line.568"></a> -<span class="sourceLineNo">569</span> /**<a name="line.569"></a> -<span class="sourceLineNo">570</span> * Remove a peer and stop the replication<a name="line.570"></a> -<span class="sourceLineNo">571</span> * @param peerId a short name that identifies the peer<a name="line.571"></a> -<span class="sourceLineNo">572</span> */<a name="line.572"></a> -<span class="sourceLineNo">573</span> CompletableFuture<Void> removeReplicationPeer(String peerId);<a name="line.573"></a> -<span class="sourceLineNo">574</span><a name="line.574"></a> -<span class="sourceLineNo">575</span> /**<a name="line.575"></a> -<span class="sourceLineNo">576</span> * Restart the replication stream to the specified peer<a name="line.576"></a> -<span class="sourceLineNo">577</span> * @param peerId a short name that identifies the peer<a name="line.577"></a> -<span class="sourceLineNo">578</span> */<a name="line.578"></a> -<span class="sourceLineNo">579</span> CompletableFuture<Void> enableReplicationPeer(String peerId);<a name="line.579"></a> -<span class="sourceLineNo">580</span><a name="line.580"></a> -<span class="sourceLineNo">581</span> /**<a name="line.581"></a> -<span class="sourceLineNo">582</span> * Stop the replication stream to the specified peer<a name="line.582"></a> -<span class="sourceLineNo">583</span> * @param peerId a short name that identifies the peer<a name="line.583"></a> -<span class="sourceLineNo">584</span> */<a name="line.584"></a> -<span class="sourceLineNo">585</span> CompletableFuture<Void> disableReplicationPeer(String peerId);<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> * Returns the configured ReplicationPeerConfig for the specified peer<a name="line.588"></a> -<span class="sourceLineNo">589</span> * @param peerId a short name that identifies the peer<a name="line.589"></a> -<span class="sourceLineNo">590</span> * @return ReplicationPeerConfig for the peer wrapped by a {@link CompletableFuture}.<a name="line.590"></a> -<span class="sourceLineNo">591</span> */<a name="line.591"></a> -<span class="sourceLineNo">592</span> CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId);<a name="line.592"></a> -<span class="sourceLineNo">593</span><a name="line.593"></a> -<span class="sourceLineNo">594</span> /**<a name="line.594"></a> -<span class="sourceLineNo">595</span> * Update the peerConfig for the specified peer<a name="line.595"></a> -<span class="sourceLineNo">596</span> * @param peerId a short name that identifies the peer<a name="line.596"></a> -<span class="sourceLineNo">597</span> * @param peerConfig new config for the peer<a name="line.597"></a> -<span class="sourceLineNo">598</span> */<a name="line.598"></a> -<span class="sourceLineNo">599</span> CompletableFuture<Void> updateReplicationPeerConfig(String peerId,<a name="line.599"></a> -<span class="sourceLineNo">600</span> ReplicationPeerConfig peerConfig);<a name="line.600"></a> -<span class="sourceLineNo">601</span><a name="line.601"></a> -<span class="sourceLineNo">602</span> /**<a name="line.602"></a> -<span class="sourceLineNo">603</span> * Append the replicable table-cf config of the specified peer<a name="line.603"></a> -<span class="sourceLineNo">604</span> * @param peerId a short that identifies the cluster<a name="line.604"></a> -<span class="sourceLineNo">605</span> * @param tableCfs A map from tableName to column family names<a name="line.605"></a> -<span class="sourceLineNo">606</span> */<a name="line.606"></a> -<span class="sourceLineNo">607</span> CompletableFuture<Void> appendReplicationPeerTableCFs(String peerId,<a name="line.607"></a> -<span class="sourceLineNo">608</span> Map<TableName, List<String>> tableCfs);<a name="line.608"></a> -<span class="sourceLineNo">609</span><a name="line.609"></a> -<span class="sourceLineNo">610</span> /**<a name="line.610"></a> -<span class="sourceLineNo">611</span> * Remove some table-cfs from config of the specified peer<a name="line.611"></a> -<span class="sourceLineNo">612</span> * @param peerId a short name that identifies the cluster<a name="line.612"></a> -<span class="sourceLineNo">613</span> * @param tableCfs A map from tableName to column family names<a name="line.613"></a> -<span class="sourceLineNo">614</span> */<a name="line.614"></a> -<span class="sourceLineNo">615</span> CompletableFuture<Void> removeReplicationPeerTableCFs(String peerId,<a name="line.615"></a> -<span class="sourceLineNo">616</span> Map<TableName, List<String>> tableCfs);<a name="line.616"></a> -<span class="sourceLineNo">617</span><a name="line.617"></a> -<span class="sourceLineNo">618</span> /**<a name="line.618"></a> -<span class="sourceLineNo">619</span> * Return a list of replication peers.<a name="line.619"></a> -<span class="sourceLineNo">620</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.620"></a> -<span class="sourceLineNo">621</span> * {@link CompletableFuture}.<a name="line.621"></a> -<span class="sourceLineNo">622</span> */<a name="line.622"></a> -<span class="sourceLineNo">623</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers();<a name="line.623"></a> -<span class="sourceLineNo">624</span><a name="line.624"></a> -<span class="sourceLineNo">625</span> /**<a name="line.625"></a> -<span class="sourceLineNo">626</span> * Return a list of replication peers.<a name="line.626"></a> -<span class="sourceLineNo">627</span> * @param pattern The compiled regular expression to match peer id<a name="line.627"></a> -<span class="sourceLineNo">628</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.628"></a> -<span class="sourceLineNo">629</span> * {@link CompletableFuture}.<a name="line.629"></a> -<span class="sourceLineNo">630</span> */<a name="line.630"></a> -<span class="sourceLineNo">631</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(Pattern pattern);<a name="line.631"></a> +<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.util.Collection;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.EnumSet;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.util.Map;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.Optional;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.util.Set;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import java.util.concurrent.CompletableFuture;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import java.util.function.Function;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import java.util.regex.Pattern;<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.CacheEvictionStats;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.ClusterMetrics;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.ClusterMetrics.Option;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.RegionMetrics;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.ServerName;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.TableName;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.replication.TableCFs;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.42"></a> +<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.43"></a> +<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.replication.ReplicationPeerConfig;<a name="line.44"></a> +<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.replication.ReplicationPeerDescription;<a name="line.45"></a> +<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.replication.SyncReplicationState;<a name="line.46"></a> +<span class="sourceLineNo">047</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.47"></a> +<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">049</span>/**<a name="line.49"></a> +<span class="sourceLineNo">050</span> * The asynchronous administrative API for HBase.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * @since 2.0.0<a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span>@InterfaceAudience.Public<a name="line.53"></a> +<span class="sourceLineNo">054</span>public interface AsyncAdmin {<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> /**<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param tableName Table to check.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @return True if table exists already. The return value will be wrapped by a<a name="line.58"></a> +<span class="sourceLineNo">059</span> * {@link CompletableFuture}.<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> CompletableFuture<Boolean> tableExists(TableName tableName);<a name="line.61"></a> +<span class="sourceLineNo">062</span><a name="line.62"></a> +<span class="sourceLineNo">063</span> /**<a name="line.63"></a> +<span class="sourceLineNo">064</span> * List all the userspace tables.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.65"></a> +<span class="sourceLineNo">066</span> */<a name="line.66"></a> +<span class="sourceLineNo">067</span> default CompletableFuture<List<TableDescriptor>> listTableDescriptors() {<a name="line.67"></a> +<span class="sourceLineNo">068</span> return listTableDescriptors(false);<a name="line.68"></a> +<span class="sourceLineNo">069</span> }<a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> /**<a name="line.71"></a> +<span class="sourceLineNo">072</span> * List all the tables.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param includeSysTables False to match only against userspace tables<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.74"></a> +<span class="sourceLineNo">075</span> */<a name="line.75"></a> +<span class="sourceLineNo">076</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(boolean includeSysTables);<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> /**<a name="line.78"></a> +<span class="sourceLineNo">079</span> * List all the tables matching the given pattern.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * @param pattern The compiled regular expression to match against<a name="line.80"></a> +<span class="sourceLineNo">081</span> * @param includeSysTables False to match only against userspace tables<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(Pattern pattern,<a name="line.84"></a> +<span class="sourceLineNo">085</span> boolean includeSysTables);<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * Get list of table descriptors by namespace.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @param name namespace name<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @return returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.90"></a> +<span class="sourceLineNo">091</span> */<a name="line.91"></a> +<span class="sourceLineNo">092</span> CompletableFuture<List<TableDescriptor>> listTableDescriptorsByNamespace(String name);<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span> /**<a name="line.94"></a> +<span class="sourceLineNo">095</span> * List all of the names of userspace tables.<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @see #listTableNames(Pattern, boolean)<a name="line.97"></a> +<span class="sourceLineNo">098</span> */<a name="line.98"></a> +<span class="sourceLineNo">099</span> default CompletableFuture<List<TableName>> listTableNames() {<a name="line.99"></a> +<span class="sourceLineNo">100</span> return listTableNames(false);<a name="line.100"></a> +<span class="sourceLineNo">101</span> }<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> /**<a name="line.103"></a> +<span class="sourceLineNo">104</span> * List all of the names of tables.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @param includeSysTables False to match only against userspace tables<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> CompletableFuture<List<TableName>> listTableNames(boolean includeSysTables);<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> /**<a name="line.110"></a> +<span class="sourceLineNo">111</span> * List all of the names of userspace tables.<a name="line.111"></a> +<span class="sourceLineNo">112</span> * @param pattern The regular expression to match against<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @param includeSysTables False to match only against userspace tables<a name="line.113"></a> +<span class="sourceLineNo">114</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.114"></a> +<span class="sourceLineNo">115</span> */<a name="line.115"></a> +<span class="sourceLineNo">116</span> CompletableFuture<List<TableName>> listTableNames(Pattern pattern, boolean includeSysTables);<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Get list of table names by namespace.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param name namespace name<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @return The list of table names in the namespace wrapped by a {@link CompletableFuture}.<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> CompletableFuture<List<TableName>> listTableNamesByNamespace(String name);<a name="line.123"></a> +<span class="sourceLineNo">124</span><a name="line.124"></a> +<span class="sourceLineNo">125</span> /**<a name="line.125"></a> +<span class="sourceLineNo">126</span> * Method for getting the tableDescriptor<a name="line.126"></a> +<span class="sourceLineNo">127</span> * @param tableName as a {@link TableName}<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @return the read-only tableDescriptor wrapped by a {@link CompletableFuture}.<a name="line.128"></a> +<span class="sourceLineNo">129</span> */<a name="line.129"></a> +<span class="sourceLineNo">130</span> CompletableFuture<TableDescriptor> getDescriptor(TableName tableName);<a name="line.130"></a> +<span class="sourceLineNo">131</span><a name="line.131"></a> +<span class="sourceLineNo">132</span> /**<a name="line.132"></a> +<span class="sourceLineNo">133</span> * Creates a new table.<a name="line.133"></a> +<span class="sourceLineNo">134</span> * @param desc table descriptor for table<a name="line.134"></a> +<span class="sourceLineNo">135</span> */<a name="line.135"></a> +<span class="sourceLineNo">136</span> CompletableFuture<Void> createTable(TableDescriptor desc);<a name="line.136"></a> +<span class="sourceLineNo">137</span><a name="line.137"></a> +<span class="sourceLineNo">138</span> /**<a name="line.138"></a> +<span class="sourceLineNo">139</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.139"></a> +<span class="sourceLineNo">140</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.140"></a> +<span class="sourceLineNo">141</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.141"></a> +<span class="sourceLineNo">142</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.142"></a> +<span class="sourceLineNo">143</span> * segments to make the required number of total regions.<a name="line.143"></a> +<span class="sourceLineNo">144</span> * @param desc table descriptor for table<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param startKey beginning of key range<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @param endKey end of key range<a name="line.146"></a> +<span class="sourceLineNo">147</span> * @param numRegions the total number of regions to create<a name="line.147"></a> +<span class="sourceLineNo">148</span> */<a name="line.148"></a> +<span class="sourceLineNo">149</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[] startKey, byte[] endKey,<a name="line.149"></a> +<span class="sourceLineNo">150</span> int numRegions);<a name="line.150"></a> +<span class="sourceLineNo">151</span><a name="line.151"></a> +<span class="sourceLineNo">152</span> /**<a name="line.152"></a> +<span class="sourceLineNo">153</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * The total number of regions created will be the number of split keys plus one.<a name="line.154"></a> +<span class="sourceLineNo">155</span> * Note : Avoid passing empty split key.<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @param desc table descriptor for table<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.157"></a> +<span class="sourceLineNo">158</span> */<a name="line.158"></a> +<span class="sourceLineNo">159</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[][] splitKeys);<a name="line.159"></a> +<span class="sourceLineNo">160</span><a name="line.160"></a> +<span class="sourceLineNo">161</span> /**<a name="line.161"></a> +<span class="sourceLineNo">162</span> * Modify an existing table, more IRB friendly version.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @param desc modified description of the table<a name="line.163"></a> +<span class="sourceLineNo">164</span> */<a name="line.164"></a> +<span class="sourceLineNo">165</span> CompletableFuture<Void> modifyTable(TableDescriptor desc);<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> /**<a name="line.167"></a> +<span class="sourceLineNo">168</span> * Deletes a table.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @param tableName name of table to delete<a name="line.169"></a> +<span class="sourceLineNo">170</span> */<a name="line.170"></a> +<span class="sourceLineNo">171</span> CompletableFuture<Void> deleteTable(TableName tableName);<a name="line.171"></a> +<span class="sourceLineNo">172</span><a name="line.172"></a> +<span class="sourceLineNo">173</span> /**<a name="line.173"></a> +<span class="sourceLineNo">174</span> * Truncate a table.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @param tableName name of table to truncate<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param preserveSplits True if the splits should be preserved<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> CompletableFuture<Void> truncateTable(TableName tableName, boolean preserveSplits);<a name="line.178"></a> +<span class="sourceLineNo">179</span><a name="line.179"></a> +<span class="sourceLineNo">180</span> /**<a name="line.180"></a> +<span class="sourceLineNo">181</span> * Enable a table. The table has to be in disabled state for it to be enabled.<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param tableName name of the table<a name="line.182"></a> +<span class="sourceLineNo">183</span> */<a name="line.183"></a> +<span class="sourceLineNo">184</span> CompletableFuture<Void> enableTable(TableName tableName);<a name="line.184"></a> +<span class="sourceLineNo">185</span><a name="line.185"></a> +<span class="sourceLineNo">186</span> /**<a name="line.186"></a> +<span class="sourceLineNo">187</span> * Disable a table. The table has to be in enabled state for it to be disabled.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param tableName<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> CompletableFuture<Void> disableTable(TableName tableName);<a name="line.190"></a> +<span class="sourceLineNo">191</span><a name="line.191"></a> +<span class="sourceLineNo">192</span> /**<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param tableName name of table to check<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @return true if table is on-line. The return value will be wrapped by a<a name="line.194"></a> +<span class="sourceLineNo">195</span> * {@link CompletableFuture}.<a name="line.195"></a> +<span class="sourceLineNo">196</span> */<a name="line.196"></a> +<span class="sourceLineNo">197</span> CompletableFuture<Boolean> isTableEnabled(TableName tableName);<a name="line.197"></a> +<span class="sourceLineNo">198</span><a name="line.198"></a> +<span class="sourceLineNo">199</span> /**<a name="line.199"></a> +<span class="sourceLineNo">200</span> * @param tableName name of table to check<a name="line.200"></a> +<span class="sourceLineNo">201</span> * @return true if table is off-line. The return value will be wrapped by a<a name="line.201"></a> +<span class="sourceLineNo">202</span> * {@link CompletableFuture}.<a name="line.202"></a> +<span class="sourceLineNo">203</span> */<a name="line.203"></a> +<span class="sourceLineNo">204</span> CompletableFuture<Boolean> isTableDisabled(TableName tableName);<a name="line.204"></a> +<span class="sourceLineNo">205</span><a name="line.205"></a> +<span class="sourceLineNo">206</span> /**<a name="line.206"></a> +<span class="sourceLineNo">207</span> * @param tableName name of table to check<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @return true if all regions of the table are available. The return value will be wrapped by a<a name="line.208"></a> +<span class="sourceLineNo">209</span> * {@link CompletableFuture}.<a name="line.209"></a> +<span class="sourceLineNo">210</span> */<a name="line.210"></a> +<span class="sourceLineNo">211</span> CompletableFuture<Boolean> isTableAvailable(TableName tableName);<a name="line.211"></a> +<span class="sourceLineNo">212</span><a name="line.212"></a> +<span class="sourceLineNo">213</span> /**<a name="line.213"></a> +<span class="sourceLineNo">214</span> * Use this api to check if the table has been created with the specified number of splitkeys<a name="line.214"></a> +<span class="sourceLineNo">215</span> * which was used while creating the given table. Note : If this api is used after a table's<a name="line.215"></a> +<span class="sourceLineNo">216</span> * region gets splitted, the api may return false. The return value will be wrapped by a<a name="line.216"></a> +<span class="sourceLineNo">217</span> * {@link CompletableFuture}.<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @param tableName name of table to check<a name="line.218"></a> +<span class="sourceLineNo">219</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.219"></a> +<span class="sourceLineNo">220</span> */<a name="line.220"></a> +<span class="sourceLineNo">221</span> CompletableFuture<Boolean> isTableAvailable(TableName tableName, byte[][] splitKeys);<a name="line.221"></a> +<span class="sourceLineNo">222</span><a name="line.222"></a> +<span class="sourceLineNo">223</span> /**<a name="line.223"></a> +<span class="sourceLineNo">224</span> * Add a column family to an existing table.<a name="line.224"></a> +<span class="sourceLineNo">225</span> * @param tableName name of the table to add column family to<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @param columnFamily column family descriptor of column family to be added<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> CompletableFuture<Void> addColumnFamily(TableName tableName,<a name="line.228"></a> +<span class="sourceLineNo">229</span> ColumnFamilyDescriptor columnFamily);<a name="line.229"></a> +<span class="sourceLineNo">230</span><a name="line.230"></a> +<span class="sourceLineNo">231</span> /**<a name="line.231"></a> +<span class="sourceLineNo">232</span> * Delete a column family from a table.<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param tableName name of table<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @param columnFamily name of column family to be deleted<a name="line.234"></a> +<span class="sourceLineNo">235</span> */<a name="line.235"></a> +<span class="sourceLineNo">236</span> CompletableFuture<Void> deleteColumnFamily(TableName tableName, byte[] columnFamily);<a name="line.236"></a> +<span class="sourceLineNo">237</span><a name="line.237"></a> +<span class="sourceLineNo">238</span> /**<a name="line.238"></a> +<span class="sourceLineNo">239</span> * Modify an existing column family on a table.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param tableName name of table<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @param columnFamily new column family descriptor to use<a name="line.241"></a> +<span class="sourceLineNo">242</span> */<a name="line.242"></a> +<span class="sourceLineNo">243</span> CompletableFuture<Void> modifyColumnFamily(TableName tableName,<a name="line.243"></a> +<span class="sourceLineNo">244</span> ColumnFamilyDescriptor columnFamily);<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> /**<a name="line.246"></a> +<span class="sourceLineNo">247</span> * Create a new namespace.<a name="line.247"></a> +<span class="sourceLineNo">248</span> * @param descriptor descriptor which describes the new namespace<a name="line.248"></a> +<span class="sourceLineNo">249</span> */<a name="line.249"></a> +<span class="sourceLineNo">250</span> CompletableFuture<Void> createNamespace(NamespaceDescriptor descriptor);<a name="line.250"></a> +<span class="sourceLineNo">251</span><a name="line.251"></a> +<span class="sourceLineNo">252</span> /**<a name="line.252"></a> +<span class="sourceLineNo">253</span> * Modify an existing namespace.<a name="line.253"></a> +<span class="sourceLineNo">254</span> * @param descriptor descriptor which describes the new namespace<a name="line.254"></a> +<span class="sourceLineNo">255</span> */<a name="line.255"></a> +<span class="sourceLineNo">256</span> CompletableFuture<Void> modifyNamespace(NamespaceDescriptor descriptor);<a name="line.256"></a> +<span class="sourceLineNo">257</span><a name="line.257"></a> +<span class="sourceLineNo">258</span> /**<a name="line.258"></a> +<span class="sourceLineNo">259</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.259"></a> +<span class="sourceLineNo">260</span> * @param name namespace name<a name="line.260"></a> +<span class="sourceLineNo">261</span> */<a name="line.261"></a> +<span class="sourceLineNo">262</span> CompletableFuture<Void> deleteNamespace(String name);<a name="line.262"></a> +<span class="sourceLineNo">263</span><a name="line.263"></a> +<span class="sourceLineNo">264</span> /**<a name="line.264"></a> +<span class="sourceLineNo">265</span> * Get a namespace descriptor by name<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @param name name of namespace descriptor<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @return A descriptor wrapped by a {@link CompletableFuture}.<a name="line.267"></a> +<span class="sourceLineNo">268</span> */<a name="line.268"></a> +<span class="sourceLineNo">269</span> CompletableFuture<NamespaceDescriptor> getNamespaceDescriptor(String name);<a name="line.269"></a> +<span class="sourceLineNo">270</span><a name="line.270"></a> +<span class="sourceLineNo">271</span> /**<a name="line.271"></a> +<span class="sourceLineNo">272</span> * List available namespace descriptors<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @return List of descriptors wrapped by a {@link CompletableFuture}.<a name="line.273"></a> +<span class="sourceLineNo">274</span> */<a name="line.274"></a> +<span class="sourceLineNo">275</span> CompletableFuture<List<NamespaceDescriptor>> listNamespaceDescriptors();<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 all the online regions on a region server.<a name="line.278"></a> +<span class="sourceLineNo">279</span> */<a name="line.279"></a> +<span class="sourceLineNo">280</span> CompletableFuture<List<RegionInfo>> getRegions(ServerName serverName);<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> * Get the regions of a given table.<a name="line.283"></a> +<span class="sourceLineNo">284</span> */<a name="line.284"></a> +<span class="sourceLineNo">285</span> CompletableFuture<List<RegionInfo>> getRegions(TableName tableName);<a name="line.285"></a> +<span class="sourceLineNo">286</span><a name="line.286"></a> +<span class="sourceLineNo">287</span> /**<a name="line.287"></a> +<span class="sourceLineNo">288</span> * Flush a table.<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @param tableName table to flush<a name="line.289"></a> +<span class="sourceLineNo">290</span> */<a name="line.290"></a> +<span class="sourceLineNo">291</span> CompletableFuture<Void> flush(TableName tableName);<a name="line.291"></a> +<span class="sourceLineNo">292</span><a name="line.292"></a> +<span class="sourceLineNo">293</span> /**<a name="line.293"></a> +<span class="sourceLineNo">294</span> * Flush an individual region.<a name="line.294"></a> +<span class="sourceLineNo">295</span> * @param regionName region to flush<a name="line.295"></a> +<span class="sourceLineNo">296</span> */<a name="line.296"></a> +<span class="sourceLineNo">297</span> CompletableFuture<Void> flushRegion(byte[] regionName);<a name="line.297"></a> +<span class="sourceLineNo">298</span><a name="line.298"></a> +<span class="sourceLineNo">299</span> /**<a name="line.299"></a> +<span class="sourceLineNo">300</span> * Flush all region on the region server.<a name="line.300"></a> +<span class="sourceLineNo">301</span> * @param serverName server to flush<a name="line.301"></a> +<span cla
<TRUNCATED>
