| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <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 static org.apache.hadoop.hbase.util.FutureUtils.addListener;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Arrays;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Collection;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.EnumSet;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.HashMap;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.Map;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Optional;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.Set;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.CompletableFuture;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.function.Function;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.regex.Pattern;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.stream.Collectors;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.CacheEvictionStats;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.ClusterMetrics;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.ClusterMetrics.Option;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.RegionMetrics;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.ServerName;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.TableName;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.replication.TableCFs;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.net.Address;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshotView;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.replication.ReplicationPeerConfig;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.replication.ReplicationPeerDescription;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.replication.SyncReplicationState;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.rsgroup.RSGroupInfo;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.security.access.GetUserPermissionsRequest;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.security.access.Permission;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.security.access.UserPermission;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span>import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableList;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel;<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> * The asynchronous administrative API for HBase.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @since 2.0.0<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span>@InterfaceAudience.Public<a name="line.65"></a> |
| <span class="sourceLineNo">066</span>public interface AsyncAdmin {<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> * Check if a table exists.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param tableName Table to check.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return True if table exists already. The return value will be wrapped by a<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * {@link CompletableFuture}.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> CompletableFuture<Boolean> tableExists(TableName tableName);<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 userspace tables.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> default CompletableFuture<List<TableDescriptor>> listTableDescriptors() {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return listTableDescriptors(false);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * List all the tables.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @param includeSysTables False to match only against userspace tables<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(boolean includeSysTables);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * List all the tables matching the given pattern.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param pattern The compiled regular expression to match against<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param includeSysTables False to match only against userspace tables<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(Pattern pattern,<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> boolean includeSysTables);<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> * List specific tables including system tables.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param tableNames the table list to match against<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return - returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> CompletableFuture<List<TableDescriptor>> listTableDescriptors(List<TableName> tableNames);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Get list of table descriptors by namespace.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param name namespace name<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @return returns a list of TableDescriptors wrapped by a {@link CompletableFuture}.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> CompletableFuture<List<TableDescriptor>> listTableDescriptorsByNamespace(String name);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * List all enabled or disabled table descriptors<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param isEnabled is true means return enabled table descriptors, false means return disabled<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * table descriptors<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> CompletableFuture<List<TableDescriptor>> listTableDescriptorsByState(boolean isEnabled);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> /**<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * List all of the names of userspace tables.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @see #listTableNames(Pattern, boolean)<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> default CompletableFuture<List<TableName>> listTableNames() {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> return listTableNames(false);<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> /**<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * List all of the names of tables.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param includeSysTables False to match only against userspace tables<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> CompletableFuture<List<TableName>> listTableNames(boolean includeSysTables);<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> * List all of the names of userspace tables.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @param pattern The regular expression to match against<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @param includeSysTables False to match only against userspace tables<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> CompletableFuture<List<TableName>> listTableNames(Pattern pattern, boolean includeSysTables);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> /**<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * List all enabled or disabled table names<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @param isEnabled is true means return enabled table names, false means return disabled table<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * names<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @return a list of table names wrapped by a {@link CompletableFuture}.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> */<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> CompletableFuture<List<TableName>> listTableNamesByState(boolean isEnabled);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> /**<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Get list of table names by namespace.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @param name namespace name<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @return The list of table names in the namespace wrapped by a {@link CompletableFuture}.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> */<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> CompletableFuture<List<TableName>> listTableNamesByNamespace(String name);<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> * Method for getting the tableDescriptor<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @param tableName as a {@link TableName}<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @return the read-only tableDescriptor wrapped by a {@link CompletableFuture}.<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> */<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> CompletableFuture<TableDescriptor> getDescriptor(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> * Creates a new table.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @param desc table descriptor for table<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> CompletableFuture<Void> createTable(TableDescriptor desc);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * segments to make the required number of total regions.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param desc table descriptor for table<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param startKey beginning of key range<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param endKey end of key range<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @param numRegions the total number of regions to create<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> */<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[] startKey, byte[] endKey,<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> int numRegions);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> /**<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * The total number of regions created will be the number of split keys plus one. Note : Avoid<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * passing empty split key.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @param desc table descriptor for table<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> CompletableFuture<Void> createTable(TableDescriptor desc, byte[][] splitKeys);<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> * Modify an existing table, more IRB friendly version.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * @param desc modified description of the table<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> */<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> default CompletableFuture<Void> modifyTable(TableDescriptor desc) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return modifyTable(desc, true);<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> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * Modify an existing table, more IRB friendly version.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * @param desc description of the table<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @param reopenRegions By default, 'modifyTable' reopens all regions, potentially causing a RIT<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * (Region In Transition) storm in large tables. If set to 'false', regions<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * will remain unaware of the modification until they are individually<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * reopened. Please note that this may temporarily result in configuration<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * inconsistencies among regions.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> */<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> CompletableFuture<Void> modifyTable(TableDescriptor desc, boolean reopenRegions);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span><a name="line.215"></a> |
| <span class="sourceLineNo">216</span> /**<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * Change the store file tracker of the given table.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * @param tableName the table you want to change<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * @param dstSFT the destination store file tracker<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> */<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> CompletableFuture<Void> modifyTableStoreFileTracker(TableName tableName, String dstSFT);<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> * Deletes a table.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * @param tableName name of table to delete<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> */<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> CompletableFuture<Void> deleteTable(TableName tableName);<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> * Truncate a table.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @param tableName name of table to truncate<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @param preserveSplits True if the splits should be preserved<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> */<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> CompletableFuture<Void> truncateTable(TableName tableName, boolean preserveSplits);<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> * Enable a table. The table has to be in disabled state for it to be enabled.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @param tableName name of the table<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> CompletableFuture<Void> enableTable(TableName tableName);<a name="line.240"></a> |
| <span class="sourceLineNo">241</span><a name="line.241"></a> |
| <span class="sourceLineNo">242</span> /**<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * Disable a table. The table has to be in enabled state for it to be disabled.<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> */<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> CompletableFuture<Void> disableTable(TableName tableName);<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> * Check if a table is enabled.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @param tableName name of table to check<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @return true if table is on-line. The return value will be wrapped by a<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * {@link CompletableFuture}.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> */<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> CompletableFuture<Boolean> isTableEnabled(TableName tableName);<a name="line.253"></a> |
| <span class="sourceLineNo">254</span><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> /**<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * Check if a table is disabled.<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @param tableName name of table to check<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @return true if table is off-line. The return value will be wrapped by a<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * {@link CompletableFuture}.<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> */<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> CompletableFuture<Boolean> isTableDisabled(TableName tableName);<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> /**<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Check if a table is available.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @param tableName name of table to check<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @return true if all regions of the table are available. The return value will be wrapped by a<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * {@link CompletableFuture}.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> */<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> CompletableFuture<Boolean> isTableAvailable(TableName tableName);<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> * Add a column family to an existing table.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * @param tableName name of the table to add column family to<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * @param columnFamily column family descriptor of column family to be added<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> */<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> CompletableFuture<Void> addColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> /**<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * Delete a column family from a table.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * @param tableName name of table<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * @param columnFamily name of column family to be deleted<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> */<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> CompletableFuture<Void> deleteColumnFamily(TableName tableName, byte[] columnFamily);<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> * Modify an existing column family on a table.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * @param tableName name of table<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * @param columnFamily new column family descriptor to use<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> */<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> CompletableFuture<Void> modifyColumnFamily(TableName tableName,<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> ColumnFamilyDescriptor columnFamily);<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> * Change the store file tracker of the given table's given family.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * @param tableName the table you want to change<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * @param family the family you want to change<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * @param dstSFT the destination store file tracker<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> */<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> CompletableFuture<Void> modifyColumnFamilyStoreFileTracker(TableName tableName, byte[] family,<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> String dstSFT);<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> * Create a new namespace.<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * @param descriptor descriptor which describes the new namespace<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> */<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> CompletableFuture<Void> createNamespace(NamespaceDescriptor descriptor);<a name="line.306"></a> |
| <span class="sourceLineNo">307</span><a name="line.307"></a> |
| <span class="sourceLineNo">308</span> /**<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * Modify an existing namespace.<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * @param descriptor descriptor which describes the new namespace<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> */<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> CompletableFuture<Void> modifyNamespace(NamespaceDescriptor descriptor);<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> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * @param name namespace name<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> */<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> CompletableFuture<Void> deleteNamespace(String name);<a name="line.318"></a> |
| <span class="sourceLineNo">319</span><a name="line.319"></a> |
| <span class="sourceLineNo">320</span> /**<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * Get a namespace descriptor by name<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * @param name name of namespace descriptor<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * @return A descriptor wrapped by a {@link CompletableFuture}.<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> */<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> CompletableFuture<NamespaceDescriptor> getNamespaceDescriptor(String name);<a name="line.325"></a> |
| <span class="sourceLineNo">326</span><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> /**<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * List available namespaces<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * @return List of namespaces wrapped by a {@link CompletableFuture}.<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> */<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> CompletableFuture<List<String>> listNamespaces();<a name="line.331"></a> |
| <span class="sourceLineNo">332</span><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> /**<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * List available namespace descriptors<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @return List of descriptors wrapped by a {@link CompletableFuture}.<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> */<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> CompletableFuture<List<NamespaceDescriptor>> listNamespaceDescriptors();<a name="line.337"></a> |
| <span class="sourceLineNo">338</span><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> /**<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * Get all the online regions on a region server.<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> */<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> CompletableFuture<List<RegionInfo>> getRegions(ServerName serverName);<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> /**<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * Get the regions of a given table.<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> */<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> CompletableFuture<List<RegionInfo>> getRegions(TableName tableName);<a name="line.347"></a> |
| <span class="sourceLineNo">348</span><a name="line.348"></a> |
| <span class="sourceLineNo">349</span> /**<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * Flush a table.<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * @param tableName table to flush<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> */<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> CompletableFuture<Void> flush(TableName tableName);<a name="line.353"></a> |
| <span class="sourceLineNo">354</span><a name="line.354"></a> |
| <span class="sourceLineNo">355</span> /**<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * Flush the specified column family stores on all regions of the passed table. This runs as a<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * synchronous operation.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * @param tableName table to flush<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * @param columnFamily column family within a table<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> */<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> CompletableFuture<Void> flush(TableName tableName, byte[] columnFamily);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> /**<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * Flush the specified column family stores on all regions of the passed table. This runs as a<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * synchronous operation.<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * @param tableName table to flush<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * @param columnFamilies column families within a table<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> */<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> CompletableFuture<Void> flush(TableName tableName, List<byte[]> columnFamilies);<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> * Flush an individual region.<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * @param regionName region to flush<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> */<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> CompletableFuture<Void> flushRegion(byte[] regionName);<a name="line.375"></a> |
| <span class="sourceLineNo">376</span><a name="line.376"></a> |
| <span class="sourceLineNo">377</span> /**<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * Flush a column family within a region.<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * @param regionName region to flush<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * @param columnFamily column family within a region. If not present, flush the region's all<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * column families.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> */<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> CompletableFuture<Void> flushRegion(byte[] regionName, byte[] columnFamily);<a name="line.383"></a> |
| <span class="sourceLineNo">384</span><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> /**<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * Flush all region on the region server.<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * @param serverName server to flush<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> */<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> CompletableFuture<Void> flushRegionServer(ServerName serverName);<a name="line.389"></a> |
| <span class="sourceLineNo">390</span><a name="line.390"></a> |
| <span class="sourceLineNo">391</span> /**<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * Compact a table. When the returned CompletableFuture is done, it only means the compact request<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * was sent to HBase and may need some time to finish the compact operation. Throws<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found.<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * @param tableName table to compact<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> */<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> default CompletableFuture<Void> compact(TableName tableName) {<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> return compact(tableName, CompactType.NORMAL);<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> }<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> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * operation. Throws {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found.<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * @param tableName table to compact<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> * @param columnFamily column family within a table. If not present, compact the table's all<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * column families.<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> */<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> default CompletableFuture<Void> compact(TableName tableName, byte[] columnFamily) {<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> return compact(tableName, columnFamily, CompactType.NORMAL);<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> }<a name="line.411"></a> |
| <span class="sourceLineNo">412</span><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> /**<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * Compact a table. When the returned CompletableFuture is done, it only means the compact request<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * was sent to HBase and may need some time to finish the compact operation. Throws<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found for normal compaction<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * type.<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * @param tableName table to compact<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> */<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> CompletableFuture<Void> compact(TableName tableName, CompactType compactType);<a name="line.421"></a> |
| <span class="sourceLineNo">422</span><a name="line.422"></a> |
| <span class="sourceLineNo">423</span> /**<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * Compact a column family within a table. When the returned CompletableFuture is done, it only<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * operation. Throws {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found for<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * normal compaction type.<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * @param tableName table to compact<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> * @param columnFamily column family within a table<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> */<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> CompletableFuture<Void> compact(TableName tableName, byte[] columnFamily,<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> CompactType compactType);<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> * Compact an individual region. When the returned CompletableFuture is done, it only means the<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * compact request was sent to HBase and may need some time to finish the compact operation.<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * @param regionName region to compact<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> */<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> CompletableFuture<Void> compactRegion(byte[] regionName);<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> * Compact a column family within a region. When the returned CompletableFuture is done, it only<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * means the compact request was sent to HBase and may need some time to finish the compact<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * operation.<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * @param regionName region to compact<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * @param columnFamily column family within a region. If not present, compact the region's all<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * column families.<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> */<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> CompletableFuture<Void> compactRegion(byte[] regionName, byte[] columnFamily);<a name="line.450"></a> |
| <span class="sourceLineNo">451</span><a name="line.451"></a> |
| <span class="sourceLineNo">452</span> /**<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> * Major compact a table. When the returned CompletableFuture is done, it only means the compact<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> * request was sent to HBase and may need some time to finish the compact operation. Throws<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> * {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found.<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> * @param tableName table to major compact<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> */<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> default CompletableFuture<Void> majorCompact(TableName tableName) {<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> return majorCompact(tableName, CompactType.NORMAL);<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> }<a name="line.460"></a> |
| <span class="sourceLineNo">461</span><a name="line.461"></a> |
| <span class="sourceLineNo">462</span> /**<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * Major compact a column family within a table. When the returned CompletableFuture is done, it<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> * operation. Throws {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found for<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * normal compaction. type.<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * @param tableName table to major compact<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> * @param columnFamily column family within a table. If not present, major compact the table's all<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> * column families.<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> */<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> default CompletableFuture<Void> majorCompact(TableName tableName, byte[] columnFamily) {<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> return majorCompact(tableName, columnFamily, CompactType.NORMAL);<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> /**<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> * Major compact a table. When the returned CompletableFuture is done, it only means the compact<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * request was sent to HBase and may need some time to finish the compact operation. Throws<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found for normal compaction<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * type.<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * @param tableName table to major compact<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> */<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> CompletableFuture<Void> majorCompact(TableName tableName, CompactType compactType);<a name="line.483"></a> |
| <span class="sourceLineNo">484</span><a name="line.484"></a> |
| <span class="sourceLineNo">485</span> /**<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> * Major compact a column family within a table. When the returned CompletableFuture is done, it<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * operation. Throws {@link org.apache.hadoop.hbase.TableNotFoundException} if table not found.<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * @param tableName table to major compact<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * @param columnFamily column family within a table. If not present, major compact the table's all<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> * column families.<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> */<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> CompletableFuture<Void> majorCompact(TableName tableName, byte[] columnFamily,<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> CompactType compactType);<a name="line.495"></a> |
| <span class="sourceLineNo">496</span><a name="line.496"></a> |
| <span class="sourceLineNo">497</span> /**<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * Major compact a region. When the returned CompletableFuture is done, it only means the compact<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * request was sent to HBase and may need some time to finish the compact operation.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> * @param regionName region to major compact<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> */<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> CompletableFuture<Void> majorCompactRegion(byte[] regionName);<a name="line.502"></a> |
| <span class="sourceLineNo">503</span><a name="line.503"></a> |
| <span class="sourceLineNo">504</span> /**<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> * Major compact a column family within region. When the returned CompletableFuture is done, it<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> * only means the compact request was sent to HBase and may need some time to finish the compact<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * operation.<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * @param regionName region to major compact<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> * @param columnFamily column family within a region. If not present, major compact the region's<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * all column families.<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> */<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> CompletableFuture<Void> majorCompactRegion(byte[] regionName, byte[] columnFamily);<a name="line.512"></a> |
| <span class="sourceLineNo">513</span><a name="line.513"></a> |
| <span class="sourceLineNo">514</span> /**<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> * Compact all regions on the region server.<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> * @param serverName the region server name<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> */<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> CompletableFuture<Void> compactRegionServer(ServerName serverName);<a name="line.518"></a> |
| <span class="sourceLineNo">519</span><a name="line.519"></a> |
| <span class="sourceLineNo">520</span> /**<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> * Compact all regions on the region server.<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> * @param serverName the region server name<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> */<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> CompletableFuture<Void> majorCompactRegionServer(ServerName serverName);<a name="line.524"></a> |
| <span class="sourceLineNo">525</span><a name="line.525"></a> |
| <span class="sourceLineNo">526</span> /**<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> * Turn the Merge switch on or off.<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> * @param enabled enabled or not<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> */<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> default CompletableFuture<Boolean> mergeSwitch(boolean enabled) {<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> return mergeSwitch(enabled, false);<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> /**<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> * Turn the Merge switch on or off.<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * <p/><a name="line.537"></a> |
| <span class="sourceLineNo">538</span> * Notice that, the method itself is always non-blocking, which means it will always return<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> * immediately. The {@code drainMerges} parameter only effects when will we complete the returned<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> * {@link CompletableFuture}.<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> * @param enabled enabled or not<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> * @param drainMerges If <code>true</code>, it waits until current merge() call, if outstanding,<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> * to return.<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> */<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> CompletableFuture<Boolean> mergeSwitch(boolean enabled, boolean drainMerges);<a name="line.546"></a> |
| <span class="sourceLineNo">547</span><a name="line.547"></a> |
| <span class="sourceLineNo">548</span> /**<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> * Query the current state of the Merge switch.<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> * {@link CompletableFuture}<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> */<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> CompletableFuture<Boolean> isMergeEnabled();<a name="line.553"></a> |
| <span class="sourceLineNo">554</span><a name="line.554"></a> |
| <span class="sourceLineNo">555</span> /**<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * Turn the Split switch on or off.<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> * @param enabled enabled or not<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> */<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> default CompletableFuture<Boolean> splitSwitch(boolean enabled) {<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> return splitSwitch(enabled, false);<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> }<a name="line.562"></a> |
| <span class="sourceLineNo">563</span><a name="line.563"></a> |
| <span class="sourceLineNo">564</span> /**<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> * Turn the Split switch on or off.<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> * <p/><a name="line.566"></a> |
| <span class="sourceLineNo">567</span> * Notice that, the method itself is always non-blocking, which means it will always return<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> * immediately. The {@code drainSplits} parameter only effects when will we complete the returned<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> * {@link CompletableFuture}.<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> * @param enabled enabled or not<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> * @param drainSplits If <code>true</code>, it waits until current split() call, if outstanding,<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> * to return.<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> * @return Previous switch value wrapped by a {@link CompletableFuture}<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> */<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> CompletableFuture<Boolean> splitSwitch(boolean enabled, boolean drainSplits);<a name="line.575"></a> |
| <span class="sourceLineNo">576</span><a name="line.576"></a> |
| <span class="sourceLineNo">577</span> /**<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> * Query the current state of the Split switch.<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> * @return true if the switch is on, false otherwise. The return value will be wrapped by a<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> * {@link CompletableFuture}<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> */<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> CompletableFuture<Boolean> isSplitEnabled();<a name="line.582"></a> |
| <span class="sourceLineNo">583</span><a name="line.583"></a> |
| <span class="sourceLineNo">584</span> /**<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> * Merge two regions.<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> * @param nameOfRegionA encoded or full name of region a<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * @param nameOfRegionB encoded or full name of region b<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> * @param forcible true if do a compulsory merge, otherwise we will only merge two adjacent<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> * regions<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> * @deprecated since 2.3.0 and will be removed in 4.0.0.Use {@link #mergeRegions(List, boolean)}<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> * instead.<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> */<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> @Deprecated<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> default CompletableFuture<Void> mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB,<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> boolean forcible) {<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> return mergeRegions(Arrays.asList(nameOfRegionA, nameOfRegionB), forcible);<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> }<a name="line.597"></a> |
| <span class="sourceLineNo">598</span><a name="line.598"></a> |
| <span class="sourceLineNo">599</span> /**<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> * Merge multiple regions (>=2).<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> * @param nameOfRegionsToMerge encoded or full name of daughter regions<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> * @param forcible true if do a compulsory merge, otherwise we will only merge two<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> * adjacent regions<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> */<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> CompletableFuture<Void> mergeRegions(List<byte[]> nameOfRegionsToMerge, boolean forcible);<a name="line.605"></a> |
| <span class="sourceLineNo">606</span><a name="line.606"></a> |
| <span class="sourceLineNo">607</span> /**<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> * Split a table. The method will execute split action for each region in table.<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> * @param tableName table to split<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> */<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> CompletableFuture<Void> split(TableName tableName);<a name="line.611"></a> |
| <span class="sourceLineNo">612</span><a name="line.612"></a> |
| <span class="sourceLineNo">613</span> /**<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> * Split an individual region.<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> * @param regionName region to split<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> */<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> CompletableFuture<Void> splitRegion(byte[] regionName);<a name="line.617"></a> |
| <span class="sourceLineNo">618</span><a name="line.618"></a> |
| <span class="sourceLineNo">619</span> /**<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> * Split a table.<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> * @param tableName table to split<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> * @param splitPoint the explicit position to split on<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> */<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> CompletableFuture<Void> split(TableName tableName, byte[] splitPoint);<a name="line.624"></a> |
| <span class="sourceLineNo">625</span><a name="line.625"></a> |
| <span class="sourceLineNo">626</span> /**<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> * Split an individual region.<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> * @param regionName region to split<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> * @param splitPoint the explicit position to split on. If not present, it will decide by region<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> * server.<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> */<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> CompletableFuture<Void> splitRegion(byte[] regionName, byte[] splitPoint);<a name="line.632"></a> |
| <span class="sourceLineNo">633</span><a name="line.633"></a> |
| <span class="sourceLineNo">634</span> /**<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * Truncate an individual region.<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> * @param regionName region to truncate<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> */<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> CompletableFuture<Void> truncateRegion(byte[] regionName);<a name="line.638"></a> |
| <span class="sourceLineNo">639</span><a name="line.639"></a> |
| <span class="sourceLineNo">640</span> /**<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> * Assign an individual region.<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> * @param regionName Encoded or full name of region to assign.<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> */<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> CompletableFuture<Void> assign(byte[] regionName);<a name="line.644"></a> |
| <span class="sourceLineNo">645</span><a name="line.645"></a> |
| <span class="sourceLineNo">646</span> /**<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> * {@link #move(byte[], ServerName)} if you want to control the region movement.<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> * @param regionName Encoded or full name of region to unassign.<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> */<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> CompletableFuture<Void> unassign(byte[] regionName);<a name="line.652"></a> |
| <span class="sourceLineNo">653</span><a name="line.653"></a> |
| <span class="sourceLineNo">654</span> /**<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> * {@link #move(byte[], ServerName)} if you want to control the region movement.<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> * @param regionName Encoded or full name of region to unassign. Will clear any existing<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> * RegionPlan if one found.<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> * @param forcible If true, force unassign (Will remove region from regions-in-transition too if<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> * present. If results in double assignment use hbck -fix to resolve. To be used<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> * by experts).<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> * @deprecated since 2.4.0 and will be removed in 4.0.0. Use {@link #unassign(byte[])} instead.<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-24875">HBASE-24875</a><a name="line.664"></a> |
| <span class="sourceLineNo">665</span> */<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> @Deprecated<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> default CompletableFuture<Void> unassign(byte[] regionName, boolean forcible) {<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> return unassign(regionName);<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> }<a name="line.669"></a> |
| <span class="sourceLineNo">670</span><a name="line.670"></a> |
| <span class="sourceLineNo">671</span> /**<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> * experts or hbck.<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> * @param regionName Encoded or full name of region to offline<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> */<a name="line.678"></a> |
| <span class="sourceLineNo">679</span> CompletableFuture<Void> offline(byte[] regionName);<a name="line.679"></a> |
| <span class="sourceLineNo">680</span><a name="line.680"></a> |
| <span class="sourceLineNo">681</span> /**<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> * Move the region <code>r</code> to a random server.<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> * @param regionName Encoded or full name of region to move.<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> */<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> CompletableFuture<Void> move(byte[] regionName);<a name="line.685"></a> |
| <span class="sourceLineNo">686</span><a name="line.686"></a> |
| <span class="sourceLineNo">687</span> /**<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> * Move the region <code>r</code> to <code>dest</code>.<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> * @param regionName Encoded or full name of region to move.<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> * @param destServerName The servername of the destination regionserver. If not present, we'll<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> * assign to a random server. A server name is made of host, port and<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> * startcode. Here is an example:<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * <code> host187.example.com,60020,1289493121758</code><a name="line.693"></a> |
| <span class="sourceLineNo">694</span> */<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> CompletableFuture<Void> move(byte[] regionName, ServerName destServerName);<a name="line.695"></a> |
| <span class="sourceLineNo">696</span><a name="line.696"></a> |
| <span class="sourceLineNo">697</span> /**<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> * Apply the new quota settings.<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> * @param quota the quota settings<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> */<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> CompletableFuture<Void> setQuota(QuotaSettings quota);<a name="line.701"></a> |
| <span class="sourceLineNo">702</span><a name="line.702"></a> |
| <span class="sourceLineNo">703</span> /**<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> * List the quotas based on the filter.<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> * @param filter the quota settings filter<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> * @return the QuotaSetting list, which wrapped by a CompletableFuture.<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> */<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> CompletableFuture<List<QuotaSettings>> getQuota(QuotaFilter filter);<a name="line.708"></a> |
| <span class="sourceLineNo">709</span><a name="line.709"></a> |
| <span class="sourceLineNo">710</span> /**<a name="line.710"></a> |
| <span class="sourceLineNo">711</span> * Add a new replication peer for replicating data to slave cluster<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> * @param peerId a short name that identifies the peer<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> * @param peerConfig configuration for the replication slave cluster<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> */<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> default CompletableFuture<Void> addReplicationPeer(String peerId,<a name="line.715"></a> |
| <span class="sourceLineNo">716</span> ReplicationPeerConfig peerConfig) {<a name="line.716"></a> |
| <span class="sourceLineNo">717</span> return addReplicationPeer(peerId, peerConfig, true);<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> }<a name="line.718"></a> |
| <span class="sourceLineNo">719</span><a name="line.719"></a> |
| <span class="sourceLineNo">720</span> /**<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> * Add a new replication peer for replicating data to slave cluster<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> * @param peerId a short name that identifies the peer<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> * @param peerConfig configuration for the replication slave cluster<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> * @param enabled peer state, true if ENABLED and false if DISABLED<a name="line.724"></a> |
| <span class="sourceLineNo">725</span> */<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> CompletableFuture<Void> addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig,<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> boolean enabled);<a name="line.727"></a> |
| <span class="sourceLineNo">728</span><a name="line.728"></a> |
| <span class="sourceLineNo">729</span> /**<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> * Remove a peer and stop the replication<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> * @param peerId a short name that identifies the peer<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> */<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> CompletableFuture<Void> removeReplicationPeer(String peerId);<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> * Restart the replication stream to the specified peer<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> * @param peerId a short name that identifies the peer<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> */<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> CompletableFuture<Void> enableReplicationPeer(String peerId);<a name="line.739"></a> |
| <span class="sourceLineNo">740</span><a name="line.740"></a> |
| <span class="sourceLineNo">741</span> /**<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> * Stop the replication stream to the specified peer<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> * @param peerId a short name that identifies the peer<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> */<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> CompletableFuture<Void> disableReplicationPeer(String peerId);<a name="line.745"></a> |
| <span class="sourceLineNo">746</span><a name="line.746"></a> |
| <span class="sourceLineNo">747</span> /**<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> * Returns the configured ReplicationPeerConfig for the specified peer<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> * @param peerId a short name that identifies the peer<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> * @return ReplicationPeerConfig for the peer wrapped by a {@link CompletableFuture}.<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> */<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId);<a name="line.752"></a> |
| <span class="sourceLineNo">753</span><a name="line.753"></a> |
| <span class="sourceLineNo">754</span> /**<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> * Update the peerConfig for the specified peer<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> * @param peerId a short name that identifies the peer<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> * @param peerConfig new config for the peer<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> */<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> CompletableFuture<Void> updateReplicationPeerConfig(String peerId,<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> ReplicationPeerConfig peerConfig);<a name="line.760"></a> |
| <span class="sourceLineNo">761</span><a name="line.761"></a> |
| <span class="sourceLineNo">762</span> /**<a name="line.762"></a> |
| <span class="sourceLineNo">763</span> * Transit current cluster to a new state in a synchronous replication peer.<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> * @param peerId a short name that identifies the peer<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> * @param state a new state of current cluster<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> */<a name="line.766"></a> |
| <span class="sourceLineNo">767</span> CompletableFuture<Void> transitReplicationPeerSyncReplicationState(String peerId,<a name="line.767"></a> |
| <span class="sourceLineNo">768</span> SyncReplicationState state);<a name="line.768"></a> |
| <span class="sourceLineNo">769</span><a name="line.769"></a> |
| <span class="sourceLineNo">770</span> /**<a name="line.770"></a> |
| <span class="sourceLineNo">771</span> * Get the current cluster state in a synchronous replication peer.<a name="line.771"></a> |
| <span class="sourceLineNo">772</span> * @param peerId a short name that identifies the peer<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> * @return the current cluster state wrapped by a {@link CompletableFuture}.<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> */<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> default CompletableFuture<SyncReplicationState><a name="line.775"></a> |
| <span class="sourceLineNo">776</span> getReplicationPeerSyncReplicationState(String peerId) {<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> CompletableFuture<SyncReplicationState> future = new CompletableFuture<>();<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> addListener(listReplicationPeers(Pattern.compile(peerId)), (peers, error) -> {<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> if (error != null) {<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> future.completeExceptionally(error);<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> } else if (peers.isEmpty() || !peers.get(0).getPeerId().equals(peerId)) {<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> future<a name="line.782"></a> |
| <span class="sourceLineNo">783</span> .completeExceptionally(new IOException("Replication peer " + peerId + " does not exist"));<a name="line.783"></a> |
| <span class="sourceLineNo">784</span> } else {<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> future.complete(peers.get(0).getSyncReplicationState());<a name="line.785"></a> |
| <span class="sourceLineNo">786</span> }<a name="line.786"></a> |
| <span class="sourceLineNo">787</span> });<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> return future;<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> }<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> * Append the replicable table-cf config of the specified peer<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> * @param peerId a short that identifies the cluster<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> * @param tableCfs A map from tableName to column family names<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> */<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> CompletableFuture<Void> appendReplicationPeerTableCFs(String peerId,<a name="line.796"></a> |
| <span class="sourceLineNo">797</span> Map<TableName, List<String>> tableCfs);<a name="line.797"></a> |
| <span class="sourceLineNo">798</span><a name="line.798"></a> |
| <span class="sourceLineNo">799</span> /**<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> * Remove some table-cfs from config of the specified peer<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> * @param peerId a short name that identifies the cluster<a name="line.801"></a> |
| <span class="sourceLineNo">802</span> * @param tableCfs A map from tableName to column family names<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> */<a name="line.803"></a> |
| <span class="sourceLineNo">804</span> CompletableFuture<Void> removeReplicationPeerTableCFs(String peerId,<a name="line.804"></a> |
| <span class="sourceLineNo">805</span> Map<TableName, List<String>> tableCfs);<a name="line.805"></a> |
| <span class="sourceLineNo">806</span><a name="line.806"></a> |
| <span class="sourceLineNo">807</span> /**<a name="line.807"></a> |
| <span class="sourceLineNo">808</span> * Return a list of replication peers.<a name="line.808"></a> |
| <span class="sourceLineNo">809</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> * {@link CompletableFuture}.<a name="line.810"></a> |
| <span class="sourceLineNo">811</span> */<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers();<a name="line.812"></a> |
| <span class="sourceLineNo">813</span><a name="line.813"></a> |
| <span class="sourceLineNo">814</span> /**<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> * Return a list of replication peers.<a name="line.815"></a> |
| <span class="sourceLineNo">816</span> * @param pattern The compiled regular expression to match peer id<a name="line.816"></a> |
| <span class="sourceLineNo">817</span> * @return a list of replication peers description. The return value will be wrapped by a<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> * {@link CompletableFuture}.<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> */<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(Pattern pattern);<a name="line.820"></a> |
| <span class="sourceLineNo">821</span><a name="line.821"></a> |
| <span class="sourceLineNo">822</span> /**<a name="line.822"></a> |
| <span class="sourceLineNo">823</span> * Find all table and column families that are replicated from this cluster<a name="line.823"></a> |
| <span class="sourceLineNo">824</span> * @return the replicated table-cfs list of this cluster. The return value will be wrapped by a<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> * {@link CompletableFuture}.<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> */<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> CompletableFuture<List<TableCFs>> listReplicatedTableCFs();<a name="line.827"></a> |
| <span class="sourceLineNo">828</span><a name="line.828"></a> |
| <span class="sourceLineNo">829</span> /**<a name="line.829"></a> |
| <span class="sourceLineNo">830</span> * Enable a table's replication switch.<a name="line.830"></a> |
| <span class="sourceLineNo">831</span> * @param tableName name of the table<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> */<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> CompletableFuture<Void> enableTableReplication(TableName tableName);<a name="line.833"></a> |
| <span class="sourceLineNo">834</span><a name="line.834"></a> |
| <span class="sourceLineNo">835</span> /**<a name="line.835"></a> |
| <span class="sourceLineNo">836</span> * Disable a table's replication switch.<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> * @param tableName name of the table<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> */<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> CompletableFuture<Void> disableTableReplication(TableName tableName);<a name="line.839"></a> |
| <span class="sourceLineNo">840</span><a name="line.840"></a> |
| <span class="sourceLineNo">841</span> /**<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> * Check if a replication peer is enabled.<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> * @param peerId id of replication peer to check<a name="line.843"></a> |
| <span class="sourceLineNo">844</span> * @return true if replication peer is enabled. The return value will be wrapped by a<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> * {@link CompletableFuture}<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> */<a name="line.846"></a> |
| <span class="sourceLineNo">847</span> CompletableFuture<Boolean> isReplicationPeerEnabled(String peerId);<a name="line.847"></a> |
| <span class="sourceLineNo">848</span><a name="line.848"></a> |
| <span class="sourceLineNo">849</span> /**<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> * Enable or disable replication peer modification.<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> * <p/><a name="line.851"></a> |
| <span class="sourceLineNo">852</span> * This is especially useful when you want to change the replication peer storage.<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> * @param on {@code true} means enable, otherwise disable<a name="line.853"></a> |
| <span class="sourceLineNo">854</span> * @return the previous enable/disable state wrapped by a {@link CompletableFuture}<a name="line.854"></a> |
| <span class="sourceLineNo">855</span> */<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> default CompletableFuture<Boolean> replicationPeerModificationSwitch(boolean on) {<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> return replicationPeerModificationSwitch(on, false);<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> }<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> * Enable or disable replication peer modification.<a name="line.861"></a> |
| <span class="sourceLineNo">862</span> * <p/><a name="line.862"></a> |
| <span class="sourceLineNo">863</span> * This is especially useful when you want to change the replication peer storage.<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> * @param on {@code true} means enable, otherwise disable<a name="line.864"></a> |
| <span class="sourceLineNo">865</span> * @param drainProcedures if {@code true}, will wait until all the running replication peer<a name="line.865"></a> |
| <span class="sourceLineNo">866</span> * modification procedures finish<a name="line.866"></a> |
| <span class="sourceLineNo">867</span> * @return the previous enable/disable state wrapped by a {@link CompletableFuture}<a name="line.867"></a> |
| <span class="sourceLineNo">868</span> */<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> CompletableFuture<Boolean> replicationPeerModificationSwitch(boolean on, boolean drainProcedures);<a name="line.869"></a> |
| <span class="sourceLineNo">870</span><a name="line.870"></a> |
| <span class="sourceLineNo">871</span> /**<a name="line.871"></a> |
| <span class="sourceLineNo">872</span> * Check whether replication peer modification is enabled.<a name="line.872"></a> |
| <span class="sourceLineNo">873</span> * @return {@code true} if modification is enabled, otherwise {@code false}, wrapped by a<a name="line.873"></a> |
| <span class="sourceLineNo">874</span> * {@link CompletableFuture}<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> */<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> CompletableFuture<Boolean> isReplicationPeerModificationEnabled();<a name="line.876"></a> |
| <span class="sourceLineNo">877</span><a name="line.877"></a> |
| <span class="sourceLineNo">878</span> /**<a name="line.878"></a> |
| <span class="sourceLineNo">879</span> * Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be<a name="line.879"></a> |
| <span class="sourceLineNo">880</span> * taken. If the table is disabled, an offline snapshot is taken. Snapshots are taken sequentially<a name="line.880"></a> |
| <span class="sourceLineNo">881</span> * even when requested concurrently, across all tables. Snapshots are considered unique based on<a name="line.881"></a> |
| <span class="sourceLineNo">882</span> * <b>the name of the snapshot</b>. Attempts to take a snapshot with the same name (even a<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> * different type or with different parameters) will fail with a<a name="line.883"></a> |
| <span class="sourceLineNo">884</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.884"></a> |
| <span class="sourceLineNo">885</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> * @param snapshotName name of the snapshot to be created<a name="line.887"></a> |
| <span class="sourceLineNo">888</span> * @param tableName name of the table for which snapshot is created<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> */<a name="line.889"></a> |
| <span class="sourceLineNo">890</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName) {<a name="line.890"></a> |
| <span class="sourceLineNo">891</span> return snapshot(snapshotName, tableName, SnapshotType.FLUSH);<a name="line.891"></a> |
| <span class="sourceLineNo">892</span> }<a name="line.892"></a> |
| <span class="sourceLineNo">893</span><a name="line.893"></a> |
| <span class="sourceLineNo">894</span> /**<a name="line.894"></a> |
| <span class="sourceLineNo">895</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.895"></a> |
| <span class="sourceLineNo">896</span> * snapshot</b>. Snapshots are taken sequentially even when requested concurrently, across all<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> * tables. Attempts to take a snapshot with the same name (even a different type or with different<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> * parameters) will fail with a {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException}<a name="line.898"></a> |
| <span class="sourceLineNo">899</span> * indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in<a name="line.899"></a> |
| <span class="sourceLineNo">900</span> * HBase. See {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.900"></a> |
| <span class="sourceLineNo">901</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.901"></a> |
| <span class="sourceLineNo">902</span> * snapshots stored on the cluster<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> * @param tableName name of the table to snapshot<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> * @param type type of snapshot to take<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> */<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> default CompletableFuture<Void> snapshot(String snapshotName, TableName tableName,<a name="line.906"></a> |
| <span class="sourceLineNo">907</span> SnapshotType type) {<a name="line.907"></a> |
| <span class="sourceLineNo">908</span> return snapshot(new SnapshotDescription(snapshotName, tableName, type));<a name="line.908"></a> |
| <span class="sourceLineNo">909</span> }<a name="line.909"></a> |
| <span class="sourceLineNo">910</span><a name="line.910"></a> |
| <span class="sourceLineNo">911</span> /**<a name="line.911"></a> |
| <span class="sourceLineNo">912</span> * Take a snapshot and wait for the server to complete that snapshot asynchronously. Snapshots are<a name="line.912"></a> |
| <span class="sourceLineNo">913</span> * taken sequentially even when requested concurrently, across all tables. Snapshots are<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> * considered unique based on <b>the name of the snapshot</b>. Attempts to take a snapshot with<a name="line.914"></a> |
| <span class="sourceLineNo">915</span> * the same name (even a different type or with different parameters) will fail with a<a name="line.915"></a> |
| <span class="sourceLineNo">916</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.916"></a> |
| <span class="sourceLineNo">917</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.917"></a> |
| <span class="sourceLineNo">918</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}. You should<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> * probably use {@link #snapshot(String, org.apache.hadoop.hbase.TableName)} unless you are sure<a name="line.919"></a> |
| <span class="sourceLineNo">920</span> * about the type of snapshot that you want to take.<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> * @param snapshot snapshot to take<a name="line.921"></a> |
| <span class="sourceLineNo">922</span> */<a name="line.922"></a> |
| <span class="sourceLineNo">923</span> CompletableFuture<Void> snapshot(SnapshotDescription snapshot);<a name="line.923"></a> |
| <span class="sourceLineNo">924</span><a name="line.924"></a> |
| <span class="sourceLineNo">925</span> /**<a name="line.925"></a> |
| <span class="sourceLineNo">926</span> * Check the current state of the passed snapshot. There are three possible states:<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> * <ol><a name="line.927"></a> |
| <span class="sourceLineNo">928</span> * <li>running - returns <tt>false</tt></li><a name="line.928"></a> |
| <span class="sourceLineNo">929</span> * <li>finished - returns <tt>true</tt></li><a name="line.929"></a> |
| <span class="sourceLineNo">930</span> * <li>finished with error - throws the exception that caused the snapshot to fail</li><a name="line.930"></a> |
| <span class="sourceLineNo">931</span> * </ol><a name="line.931"></a> |
| <span class="sourceLineNo">932</span> * The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> * run/started since the snapshot you are checking, you will receive an<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> * {@link org.apache.hadoop.hbase.snapshot.UnknownSnapshotException}.<a name="line.934"></a> |
| <span class="sourceLineNo">935</span> * @param snapshot description of the snapshot to check<a name="line.935"></a> |
| <span class="sourceLineNo">936</span> * @return <tt>true</tt> if the snapshot is completed, <tt>false</tt> if the snapshot is still<a name="line.936"></a> |
| <span class="sourceLineNo">937</span> * running<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> */<a name="line.938"></a> |
| <span class="sourceLineNo">939</span> CompletableFuture<Boolean> isSnapshotFinished(SnapshotDescription snapshot);<a name="line.939"></a> |
| <span class="sourceLineNo">940</span><a name="line.940"></a> |
| <span class="sourceLineNo">941</span> /**<a name="line.941"></a> |
| <span class="sourceLineNo">942</span> * Restore the specified snapshot on the original table. (The table must be disabled) If the<a name="line.942"></a> |
| <span class="sourceLineNo">943</span> * "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a<a name="line.943"></a> |
| <span class="sourceLineNo">944</span> * snapshot of the current table is taken before executing the restore operation. In case of<a name="line.944"></a> |
| <span class="sourceLineNo">945</span> * restore failure, the failsafe snapshot will be restored. If the restore completes without<a name="line.945"></a> |
| <span class="sourceLineNo">946</span> * problem the failsafe snapshot is deleted.<a name="line.946"></a> |
| <span class="sourceLineNo">947</span> * @param snapshotName name of the snapshot to restore<a name="line.947"></a> |
| <span class="sourceLineNo">948</span> */<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> CompletableFuture<Void> restoreSnapshot(String snapshotName);<a name="line.949"></a> |
| <span class="sourceLineNo">950</span><a name="line.950"></a> |
| <span class="sourceLineNo">951</span> /**<a name="line.951"></a> |
| <span class="sourceLineNo">952</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.952"></a> |
| <span class="sourceLineNo">953</span> * 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before<a name="line.953"></a> |
| <span class="sourceLineNo">954</span> * executing the restore operation. In case of restore failure, the failsafe snapshot will be<a name="line.954"></a> |
| <span class="sourceLineNo">955</span> * restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.955"></a> |
| <span class="sourceLineNo">956</span> * failsafe snapshot name is configurable by using the property<a name="line.956"></a> |
| <span class="sourceLineNo">957</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.957"></a> |
| <span class="sourceLineNo">958</span> * @param snapshotName name of the snapshot to restore<a name="line.958"></a> |
| <span class="sourceLineNo">959</span> * @param takeFailSafeSnapshot true if the failsafe snapshot should be taken<a name="line.959"></a> |
| <span class="sourceLineNo">960</span> */<a name="line.960"></a> |
| <span class="sourceLineNo">961</span> default CompletableFuture<Void> restoreSnapshot(String snapshotName,<a name="line.961"></a> |
| <span class="sourceLineNo">962</span> boolean takeFailSafeSnapshot) {<a name="line.962"></a> |
| <span class="sourceLineNo">963</span> return restoreSnapshot(snapshotName, takeFailSafeSnapshot, false);<a name="line.963"></a> |
| <span class="sourceLineNo">964</span> }<a name="line.964"></a> |
| <span class="sourceLineNo">965</span><a name="line.965"></a> |
| <span class="sourceLineNo">966</span> /**<a name="line.966"></a> |
| <span class="sourceLineNo">967</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.967"></a> |
| <span class="sourceLineNo">968</span> * 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before<a name="line.968"></a> |
| <span class="sourceLineNo">969</span> * executing the restore operation. In case of restore failure, the failsafe snapshot will be<a name="line.969"></a> |
| <span class="sourceLineNo">970</span> * restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.970"></a> |
| <span class="sourceLineNo">971</span> * failsafe snapshot name is configurable by using the property<a name="line.971"></a> |
| <span class="sourceLineNo">972</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.972"></a> |
| <span class="sourceLineNo">973</span> * @param snapshotName name of the snapshot to restore<a name="line.973"></a> |
| <span class="sourceLineNo">974</span> * @param takeFailSafeSnapshot true if the failsafe snapshot should be taken<a name="line.974"></a> |
| <span class="sourceLineNo">975</span> * @param restoreAcl <code>true</code> to restore acl of snapshot<a name="line.975"></a> |
| <span class="sourceLineNo">976</span> */<a name="line.976"></a> |
| <span class="sourceLineNo">977</span> CompletableFuture<Void> restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot,<a name="line.977"></a> |
| <span class="sourceLineNo">978</span> boolean restoreAcl);<a name="line.978"></a> |
| <span class="sourceLineNo">979</span><a name="line.979"></a> |
| <span class="sourceLineNo">980</span> /**<a name="line.980"></a> |
| <span class="sourceLineNo">981</span> * Create a new table by cloning the snapshot content.<a name="line.981"></a> |
| <span class="sourceLineNo">982</span> * @param snapshotName name of the snapshot to be cloned<a name="line.982"></a> |
| <span class="sourceLineNo">983</span> * @param tableName name of the table where the snapshot will be restored<a name="line.983"></a> |
| <span class="sourceLineNo">984</span> */<a name="line.984"></a> |
| <span class="sourceLineNo">985</span> default CompletableFuture<Void> cloneSnapshot(String snapshotName, TableName tableName) {<a name="line.985"></a> |
| <span class="sourceLineNo">986</span> return cloneSnapshot(snapshotName, tableName, false);<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> }<a name="line.987"></a> |
| <span class="sourceLineNo">988</span><a name="line.988"></a> |
| <span class="sourceLineNo">989</span> /**<a name="line.989"></a> |
| <span class="sourceLineNo">990</span> * Create a new table by cloning the snapshot content.<a name="line.990"></a> |
| <span class="sourceLineNo">991</span> * @param snapshotName name of the snapshot to be cloned<a name="line.991"></a> |
| <span class="sourceLineNo">992</span> * @param tableName name of the table where the snapshot will be restored<a name="line.992"></a> |
| <span class="sourceLineNo">993</span> * @param restoreAcl <code>true</code> to restore acl of snapshot<a name="line.993"></a> |
| <span class="sourceLineNo">994</span> */<a name="line.994"></a> |
| <span class="sourceLineNo">995</span> default CompletableFuture<Void> cloneSnapshot(String snapshotName, TableName tableName,<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> boolean restoreAcl) {<a name="line.996"></a> |
| <span class="sourceLineNo">997</span> return cloneSnapshot(snapshotName, tableName, restoreAcl, null);<a name="line.997"></a> |
| <span class="sourceLineNo">998</span> }<a name="line.998"></a> |
| <span class="sourceLineNo">999</span><a name="line.999"></a> |
| <span class="sourceLineNo">1000</span> /**<a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span> * Create a new table by cloning the snapshot content.<a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> * @param snapshotName name of the snapshot to be cloned<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span> * @param tableName name of the table where the snapshot will be restored<a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span> * @param restoreAcl <code>true</code> to restore acl of snapshot<a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span> * @param customSFT specify the StroreFileTracker used for the table<a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> */<a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span> CompletableFuture<Void> cloneSnapshot(String snapshotName, TableName tableName,<a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> boolean restoreAcl, String customSFT);<a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span><a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> /**<a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> * List completed snapshots.<a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> * @return a list of snapshot descriptors for completed snapshots wrapped by a<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span> * {@link CompletableFuture}<a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> */<a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span> CompletableFuture<List<SnapshotDescription>> listSnapshots();<a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span><a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> /**<a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> * List all the completed snapshots matching the given pattern.<a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> * @param pattern The compiled regular expression to match against<a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> * @return - returns a List of SnapshotDescription wrapped by a {@link CompletableFuture}<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span> */<a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> CompletableFuture<List<SnapshotDescription>> listSnapshots(Pattern pattern);<a name="line.1022"></a> |
| <span class="sourceLineNo">1023</span><a name="line.1023"></a> |
| <span class="sourceLineNo">1024</span> /**<a name="line.1024"></a> |
| <span class="sourceLineNo">1025</span> * List all the completed snapshots matching the given table name pattern.<a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> * {@link CompletableFuture}<a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> */<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern);<a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span><a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> /**<a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> * List all the completed snapshots matching the given table name regular expression and snapshot<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> * name regular expression.<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.1036"></a> |
| <span class="sourceLineNo">1037</span> * @return - returns a List of completed SnapshotDescription wrapped by a<a name="line.1037"></a> |
| <span class="sourceLineNo">1038</span> * {@link CompletableFuture}<a name="line.1038"></a> |
| <span class="sourceLineNo">1039</span> */<a name="line.1039"></a> |
| <span class="sourceLineNo">1040</span> CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern,<a name="line.1040"></a> |
| <span class="sourceLineNo">1041</span> Pattern snapshotNamePattern);<a name="line.1041"></a> |
| <span class="sourceLineNo">1042</span><a name="line.1042"></a> |
| <span class="sourceLineNo">1043</span> /**<a name="line.1043"></a> |
| <span class="sourceLineNo">1044</span> * Delete an existing snapshot.<a name="line.1044"></a> |
| <span class="sourceLineNo">1045</span> * @param snapshotName name of the snapshot<a name="line.1045"></a> |
| <span class="sourceLineNo">1046</span> */<a name="line.1046"></a> |
| <span class="sourceLineNo">1047</span> CompletableFuture<Void> deleteSnapshot(String snapshotName);<a name="line.1047"></a> |
| <span class="sourceLineNo">1048</span><a name="line.1048"></a> |
| <span class="sourceLineNo">1049</span> /**<a name="line.1049"></a> |
| <span class="sourceLineNo">1050</span> * Delete all existing snapshots.<a name="line.1050"></a> |
| <span class="sourceLineNo">1051</span> */<a name="line.1051"></a> |
| <span class="sourceLineNo">1052</span> CompletableFuture<Void> deleteSnapshots();<a name="line.1052"></a> |
| <span class="sourceLineNo">1053</span><a name="line.1053"></a> |
| <span class="sourceLineNo">1054</span> /**<a name="line.1054"></a> |
| <span class="sourceLineNo">1055</span> * Delete existing snapshots whose names match the pattern passed.<a name="line.1055"></a> |
| <span class="sourceLineNo">1056</span> * @param pattern pattern for names of the snapshot to match<a name="line.1056"></a> |
| <span class="sourceLineNo">1057</span> */<a name="line.1057"></a> |
| <span class="sourceLineNo">1058</span> CompletableFuture<Void> deleteSnapshots(Pattern pattern);<a name="line.1058"></a> |
| <span class="sourceLineNo">1059</span><a name="line.1059"></a> |
| <span class="sourceLineNo">1060</span> /**<a name="line.1060"></a> |
| <span class="sourceLineNo">1061</span> * Delete all existing snapshots matching the given table name pattern.<a name="line.1061"></a> |
| <span class="sourceLineNo">1062</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.1062"></a> |
| <span class="sourceLineNo">1063</span> */<a name="line.1063"></a> |
| <span class="sourceLineNo">1064</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern);<a name="line.1064"></a> |
| <span class="sourceLineNo">1065</span><a name="line.1065"></a> |
| <span class="sourceLineNo">1066</span> /**<a name="line.1066"></a> |
| <span class="sourceLineNo">1067</span> * Delete all existing snapshots matching the given table name regular expression and snapshot<a name="line.1067"></a> |
| <span class="sourceLineNo">1068</span> * name regular expression.<a name="line.1068"></a> |
| <span class="sourceLineNo">1069</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.1069"></a> |
| <span class="sourceLineNo">1070</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.1070"></a> |
| <span class="sourceLineNo">1071</span> */<a name="line.1071"></a> |
| <span class="sourceLineNo">1072</span> CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern,<a name="line.1072"></a> |
| <span class="sourceLineNo">1073</span> Pattern snapshotNamePattern);<a name="line.1073"></a> |
| <span class="sourceLineNo">1074</span><a name="line.1074"></a> |
| <span class="sourceLineNo">1075</span> /**<a name="line.1075"></a> |
| <span class="sourceLineNo">1076</span> * Execute a distributed procedure on a cluster.<a name="line.1076"></a> |
| <span class="sourceLineNo">1077</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.1077"></a> |
| <span class="sourceLineNo">1078</span> * root ZK node name of the procedure).<a name="line.1078"></a> |
| <span class="sourceLineNo">1079</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.1079"></a> |
| <span class="sourceLineNo">1080</span> * optional.<a name="line.1080"></a> |
| <span class="sourceLineNo">1081</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.1081"></a> |
| <span class="sourceLineNo">1082</span> */<a name="line.1082"></a> |
| <span class="sourceLineNo">1083</span> CompletableFuture<Void> execProcedure(String signature, String instance,<a name="line.1083"></a> |
| <span class="sourceLineNo">1084</span> Map<String, String> props);<a name="line.1084"></a> |
| <span class="sourceLineNo">1085</span><a name="line.1085"></a> |
| <span class="sourceLineNo">1086</span> /**<a name="line.1086"></a> |
| <span class="sourceLineNo">1087</span> * Execute a distributed procedure on a cluster.<a name="line.1087"></a> |
| <span class="sourceLineNo">1088</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.1088"></a> |
| <span class="sourceLineNo">1089</span> * root ZK node name of the procedure).<a name="line.1089"></a> |
| <span class="sourceLineNo">1090</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.1090"></a> |
| <span class="sourceLineNo">1091</span> * optional.<a name="line.1091"></a> |
| <span class="sourceLineNo">1092</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.1092"></a> |
| <span class="sourceLineNo">1093</span> * @return data returned after procedure execution. null if no return data.<a name="line.1093"></a> |
| <span class="sourceLineNo">1094</span> */<a name="line.1094"></a> |
| <span class="sourceLineNo">1095</span> CompletableFuture<byte[]> execProcedureWithReturn(String signature, String instance,<a name="line.1095"></a> |
| <span class="sourceLineNo">1096</span> Map<String, String> props);<a name="line.1096"></a> |
| <span class="sourceLineNo">1097</span><a name="line.1097"></a> |
| <span class="sourceLineNo">1098</span> /**<a name="line.1098"></a> |
| <span class="sourceLineNo">1099</span> * Check the current state of the specified procedure. There are three possible states:<a name="line.1099"></a> |
| <span class="sourceLineNo">1100</span> * <ol><a name="line.1100"></a> |
| <span class="sourceLineNo">1101</span> * <li>running - returns <tt>false</tt></li><a name="line.1101"></a> |
| <span class="sourceLineNo">1102</span> * <li>finished - returns <tt>true</tt></li><a name="line.1102"></a> |
| <span class="sourceLineNo">1103</span> * <li>finished with error - throws the exception that caused the procedure to fail</li><a name="line.1103"></a> |
| <span class="sourceLineNo">1104</span> * </ol><a name="line.1104"></a> |
| <span class="sourceLineNo">1105</span> * @param signature The signature that uniquely identifies a procedure<a name="line.1105"></a> |
| <span class="sourceLineNo">1106</span> * @param instance The instance name of the procedure<a name="line.1106"></a> |
| <span class="sourceLineNo">1107</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.1107"></a> |
| <span class="sourceLineNo">1108</span> * @return true if the specified procedure is finished successfully, false if it is still running.<a name="line.1108"></a> |
| <span class="sourceLineNo">1109</span> * The value is wrapped by {@link CompletableFuture}<a name="line.1109"></a> |
| <span class="sourceLineNo">1110</span> */<a name="line.1110"></a> |
| <span class="sourceLineNo">1111</span> CompletableFuture<Boolean> isProcedureFinished(String signature, String instance,<a name="line.1111"></a> |
| <span class="sourceLineNo">1112</span> Map<String, String> props);<a name="line.1112"></a> |
| <span class="sourceLineNo">1113</span><a name="line.1113"></a> |
| <span class="sourceLineNo">1114</span> /**<a name="line.1114"></a> |
| <span class="sourceLineNo">1115</span> * Abort a procedure Do not use. Usually it is ignored but if not, it can do more damage than<a name="line.1115"></a> |
| <span class="sourceLineNo">1116</span> * good. See hbck2.<a name="line.1116"></a> |
| <span class="sourceLineNo">1117</span> * @param procId ID of the procedure to abort<a name="line.1117"></a> |
| <span class="sourceLineNo">1118</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1118"></a> |
| <span class="sourceLineNo">1119</span> * @return true if aborted, false if procedure already completed or does not exist. the value is<a name="line.1119"></a> |
| <span class="sourceLineNo">1120</span> * wrapped by {@link CompletableFuture}<a name="line.1120"></a> |
| <span class="sourceLineNo">1121</span> * @deprecated since 2.1.1 and will be removed in 4.0.0.<a name="line.1121"></a> |
| <span class="sourceLineNo">1122</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-21223">HBASE-21223</a><a name="line.1122"></a> |
| <span class="sourceLineNo">1123</span> */<a name="line.1123"></a> |
| <span class="sourceLineNo">1124</span> @Deprecated<a name="line.1124"></a> |
| <span class="sourceLineNo">1125</span> CompletableFuture<Boolean> abortProcedure(long procId, boolean mayInterruptIfRunning);<a name="line.1125"></a> |
| <span class="sourceLineNo">1126</span><a name="line.1126"></a> |
| <span class="sourceLineNo">1127</span> /**<a name="line.1127"></a> |
| <span class="sourceLineNo">1128</span> * List procedures<a name="line.1128"></a> |
| <span class="sourceLineNo">1129</span> * @return procedure list JSON wrapped by {@link CompletableFuture}<a name="line.1129"></a> |
| <span class="sourceLineNo">1130</span> */<a name="line.1130"></a> |
| <span class="sourceLineNo">1131</span> CompletableFuture<String> getProcedures();<a name="line.1131"></a> |
| <span class="sourceLineNo">1132</span><a name="line.1132"></a> |
| <span class="sourceLineNo">1133</span> /**<a name="line.1133"></a> |
| <span class="sourceLineNo">1134</span> * List locks.<a name="line.1134"></a> |
| <span class="sourceLineNo">1135</span> * @return lock list JSON wrapped by {@link CompletableFuture}<a name="line.1135"></a> |
| <span class="sourceLineNo">1136</span> */<a name="line.1136"></a> |
| <span class="sourceLineNo">1137</span> CompletableFuture<String> getLocks();<a name="line.1137"></a> |
| <span class="sourceLineNo">1138</span><a name="line.1138"></a> |
| <span class="sourceLineNo">1139</span> /**<a name="line.1139"></a> |
| <span class="sourceLineNo">1140</span> * Mark region server(s) as decommissioned to prevent additional regions from getting assigned to<a name="line.1140"></a> |
| <span class="sourceLineNo">1141</span> * them. Optionally unload the regions on the servers. If there are multiple servers to be<a name="line.1141"></a> |
| <span class="sourceLineNo">1142</span> * decommissioned, decommissioning them at the same time can prevent wasteful region movements.<a name="line.1142"></a> |
| <span class="sourceLineNo">1143</span> * Region unloading is asynchronous.<a name="line.1143"></a> |
| <span class="sourceLineNo">1144</span> * @param servers The list of servers to decommission.<a name="line.1144"></a> |
| <span class="sourceLineNo">1145</span> * @param offload True to offload the regions from the decommissioned servers<a name="line.1145"></a> |
| <span class="sourceLineNo">1146</span> */<a name="line.1146"></a> |
| <span class="sourceLineNo">1147</span> CompletableFuture<Void> decommissionRegionServers(List<ServerName> servers, boolean offload);<a name="line.1147"></a> |
| <span class="sourceLineNo">1148</span><a name="line.1148"></a> |
| <span class="sourceLineNo">1149</span> /**<a name="line.1149"></a> |
| <span class="sourceLineNo">1150</span> * List region servers marked as decommissioned, which can not be assigned regions.<a name="line.1150"></a> |
| <span class="sourceLineNo">1151</span> * @return List of decommissioned region servers wrapped by {@link CompletableFuture}<a name="line.1151"></a> |
| <span class="sourceLineNo">1152</span> */<a name="line.1152"></a> |
| <span class="sourceLineNo">1153</span> CompletableFuture<List<ServerName>> listDecommissionedRegionServers();<a name="line.1153"></a> |
| <span class="sourceLineNo">1154</span><a name="line.1154"></a> |
| <span class="sourceLineNo">1155</span> /**<a name="line.1155"></a> |
| <span class="sourceLineNo">1156</span> * Remove decommission marker from a region server to allow regions assignments. Load regions onto<a name="line.1156"></a> |
| <span class="sourceLineNo">1157</span> * the server if a list of regions is given. Region loading is asynchronous.<a name="line.1157"></a> |
| <span class="sourceLineNo">1158</span> * @param server The server to recommission.<a name="line.1158"></a> |
| <span class="sourceLineNo">1159</span> * @param encodedRegionNames Regions to load onto the server.<a name="line.1159"></a> |
| <span class="sourceLineNo">1160</span> */<a name="line.1160"></a> |
| <span class="sourceLineNo">1161</span> CompletableFuture<Void> recommissionRegionServer(ServerName server,<a name="line.1161"></a> |
| <span class="sourceLineNo">1162</span> List<byte[]> encodedRegionNames);<a name="line.1162"></a> |
| <span class="sourceLineNo">1163</span><a name="line.1163"></a> |
| <span class="sourceLineNo">1164</span> /** Returns cluster status wrapped by {@link CompletableFuture} */<a name="line.1164"></a> |
| <span class="sourceLineNo">1165</span> CompletableFuture<ClusterMetrics> getClusterMetrics();<a name="line.1165"></a> |
| <span class="sourceLineNo">1166</span><a name="line.1166"></a> |
| <span class="sourceLineNo">1167</span> /** Returns cluster status wrapped by {@link CompletableFuture} */<a name="line.1167"></a> |
| <span class="sourceLineNo">1168</span> CompletableFuture<ClusterMetrics> getClusterMetrics(EnumSet<Option> options);<a name="line.1168"></a> |
| <span class="sourceLineNo">1169</span><a name="line.1169"></a> |
| <span class="sourceLineNo">1170</span> /** Returns current master server name wrapped by {@link CompletableFuture} */<a name="line.1170"></a> |
| <span class="sourceLineNo">1171</span> default CompletableFuture<ServerName> getMaster() {<a name="line.1171"></a> |
| <span class="sourceLineNo">1172</span> return getClusterMetrics(EnumSet.of(Option.MASTER)).thenApply(ClusterMetrics::getMasterName);<a name="line.1172"></a> |
| <span class="sourceLineNo">1173</span> }<a name="line.1173"></a> |
| <span class="sourceLineNo">1174</span><a name="line.1174"></a> |
| <span class="sourceLineNo">1175</span> /** Returns current backup master list wrapped by {@link CompletableFuture} */<a name="line.1175"></a> |
| <span class="sourceLineNo">1176</span> default CompletableFuture<Collection<ServerName>> getBackupMasters() {<a name="line.1176"></a> |
| <span class="sourceLineNo">1177</span> return getClusterMetrics(EnumSet.of(Option.BACKUP_MASTERS))<a name="line.1177"></a> |
| <span class="sourceLineNo">1178</span> .thenApply(ClusterMetrics::getBackupMasterNames);<a name="line.1178"></a> |
| <span class="sourceLineNo">1179</span> }<a name="line.1179"></a> |
| <span class="sourceLineNo">1180</span><a name="line.1180"></a> |
| <span class="sourceLineNo">1181</span> /** Returns current live region servers list wrapped by {@link CompletableFuture} */<a name="line.1181"></a> |
| <span class="sourceLineNo">1182</span> default CompletableFuture<Collection<ServerName>> getRegionServers() {<a name="line.1182"></a> |
| <span class="sourceLineNo">1183</span> return getClusterMetrics(EnumSet.of(Option.SERVERS_NAME))<a name="line.1183"></a> |
| <span class="sourceLineNo">1184</span> .thenApply(ClusterMetrics::getServersName);<a name="line.1184"></a> |
| <span class="sourceLineNo">1185</span> }<a name="line.1185"></a> |
| <span class="sourceLineNo">1186</span><a name="line.1186"></a> |
| <span class="sourceLineNo">1187</span> default CompletableFuture<Collection<ServerName>><a name="line.1187"></a> |
| <span class="sourceLineNo">1188</span> getRegionServers(boolean excludeDecommissionedRS) {<a name="line.1188"></a> |
| <span class="sourceLineNo">1189</span> CompletableFuture<Collection<ServerName>> future = new CompletableFuture<>();<a name="line.1189"></a> |
| <span class="sourceLineNo">1190</span> addListener(<a name="line.1190"></a> |
| <span class="sourceLineNo">1191</span> getClusterMetrics(EnumSet.of(Option.SERVERS_NAME)).thenApply(ClusterMetrics::getServersName),<a name="line.1191"></a> |
| <span class="sourceLineNo">1192</span> (allServers, err) -> {<a name="line.1192"></a> |
| <span class="sourceLineNo">1193</span> if (err != null) {<a name="line.1193"></a> |
| <span class="sourceLineNo">1194</span> future.completeExceptionally(err);<a name="line.1194"></a> |
| <span class="sourceLineNo">1195</span> } else {<a name="line.1195"></a> |
| <span class="sourceLineNo">1196</span> if (!excludeDecommissionedRS) {<a name="line.1196"></a> |
| <span class="sourceLineNo">1197</span> future.complete(allServers);<a name="line.1197"></a> |
| <span class="sourceLineNo">1198</span> } else {<a name="line.1198"></a> |
| <span class="sourceLineNo">1199</span> addListener(listDecommissionedRegionServers(), (decomServers, decomErr) -> {<a name="line.1199"></a> |
| <span class="sourceLineNo">1200</span> if (decomErr != null) {<a name="line.1200"></a> |
| <span class="sourceLineNo">1201</span> future.completeExceptionally(decomErr);<a name="line.1201"></a> |
| <span class="sourceLineNo">1202</span> } else {<a name="line.1202"></a> |
| <span class="sourceLineNo">1203</span> future.complete(allServers.stream().filter(s -> !decomServers.contains(s))<a name="line.1203"></a> |
| <span class="sourceLineNo">1204</span> .collect(ImmutableList.toImmutableList()));<a name="line.1204"></a> |
| <span class="sourceLineNo">1205</span> }<a name="line.1205"></a> |
| <span class="sourceLineNo">1206</span> });<a name="line.1206"></a> |
| <span class="sourceLineNo">1207</span> }<a name="line.1207"></a> |
| <span class="sourceLineNo">1208</span> }<a name="line.1208"></a> |
| <span class="sourceLineNo">1209</span> });<a name="line.1209"></a> |
| <span class="sourceLineNo">1210</span> return future;<a name="line.1210"></a> |
| <span class="sourceLineNo">1211</span> }<a name="line.1211"></a> |
| <span class="sourceLineNo">1212</span><a name="line.1212"></a> |
| <span class="sourceLineNo">1213</span> /** Returns a list of master coprocessors wrapped by {@link CompletableFuture} */<a name="line.1213"></a> |
| <span class="sourceLineNo">1214</span> default CompletableFuture<List<String>> getMasterCoprocessorNames() {<a name="line.1214"></a> |
| <span class="sourceLineNo">1215</span> return getClusterMetrics(EnumSet.of(Option.MASTER_COPROCESSORS))<a name="line.1215"></a> |
| <span class="sourceLineNo">1216</span> .thenApply(ClusterMetrics::getMasterCoprocessorNames);<a name="line.1216"></a> |
| <span class="sourceLineNo">1217</span> }<a name="line.1217"></a> |
| <span class="sourceLineNo">1218</span><a name="line.1218"></a> |
| <span class="sourceLineNo">1219</span> /**<a name="line.1219"></a> |
| <span class="sourceLineNo">1220</span> * Get the info port of the current master if one is available.<a name="line.1220"></a> |
| <span class="sourceLineNo">1221</span> * @return master info port<a name="line.1221"></a> |
| <span class="sourceLineNo">1222</span> */<a name="line.1222"></a> |
| <span class="sourceLineNo">1223</span> default CompletableFuture<Integer> getMasterInfoPort() {<a name="line.1223"></a> |
| <span class="sourceLineNo">1224</span> return getClusterMetrics(EnumSet.of(Option.MASTER_INFO_PORT))<a name="line.1224"></a> |
| <span class="sourceLineNo">1225</span> .thenApply(ClusterMetrics::getMasterInfoPort);<a name="line.1225"></a> |
| <span class="sourceLineNo">1226</span> }<a name="line.1226"></a> |
| <span class="sourceLineNo">1227</span><a name="line.1227"></a> |
| <span class="sourceLineNo">1228</span> /**<a name="line.1228"></a> |
| <span class="sourceLineNo">1229</span> * Shuts down the HBase cluster.<a name="line.1229"></a> |
| <span class="sourceLineNo">1230</span> */<a name="line.1230"></a> |
| <span class="sourceLineNo">1231</span> CompletableFuture<Void> shutdown();<a name="line.1231"></a> |
| <span class="sourceLineNo">1232</span><a name="line.1232"></a> |
| <span class="sourceLineNo">1233</span> /**<a name="line.1233"></a> |
| <span class="sourceLineNo">1234</span> * Shuts down the current HBase master only.<a name="line.1234"></a> |
| <span class="sourceLineNo">1235</span> */<a name="line.1235"></a> |
| <span class="sourceLineNo">1236</span> CompletableFuture<Void> stopMaster();<a name="line.1236"></a> |
| <span class="sourceLineNo">1237</span><a name="line.1237"></a> |
| <span class="sourceLineNo">1238</span> /**<a name="line.1238"></a> |
| <span class="sourceLineNo">1239</span> * Stop the designated regionserver.<a name="line.1239"></a> |
| <span class="sourceLineNo">1240</span> */<a name="line.1240"></a> |
| <span class="sourceLineNo">1241</span> CompletableFuture<Void> stopRegionServer(ServerName serverName);<a name="line.1241"></a> |
| <span class="sourceLineNo">1242</span><a name="line.1242"></a> |
| <span class="sourceLineNo">1243</span> /**<a name="line.1243"></a> |
| <span class="sourceLineNo">1244</span> * Update the configuration and trigger an online config change on the regionserver.<a name="line.1244"></a> |
| <span class="sourceLineNo">1245</span> * @param serverName : The server whose config needs to be updated.<a name="line.1245"></a> |
| <span class="sourceLineNo">1246</span> */<a name="line.1246"></a> |
| <span class="sourceLineNo">1247</span> CompletableFuture<Void> updateConfiguration(ServerName serverName);<a name="line.1247"></a> |
| <span class="sourceLineNo">1248</span><a name="line.1248"></a> |
| <span class="sourceLineNo">1249</span> /**<a name="line.1249"></a> |
| <span class="sourceLineNo">1250</span> * Update the configuration and trigger an online config change on all the masters and<a name="line.1250"></a> |
| <span class="sourceLineNo">1251</span> * regionservers.<a name="line.1251"></a> |
| <span class="sourceLineNo">1252</span> */<a name="line.1252"></a> |
| <span class="sourceLineNo">1253</span> CompletableFuture<Void> updateConfiguration();<a name="line.1253"></a> |
| <span class="sourceLineNo">1254</span><a name="line.1254"></a> |
| <span class="sourceLineNo">1255</span> /**<a name="line.1255"></a> |
| <span class="sourceLineNo">1256</span> * Update the configuration and trigger an online config change on all the regionservers in the<a name="line.1256"></a> |
| <span class="sourceLineNo">1257</span> * RSGroup.<a name="line.1257"></a> |
| <span class="sourceLineNo">1258</span> * @param groupName the group name<a name="line.1258"></a> |
| <span class="sourceLineNo">1259</span> */<a name="line.1259"></a> |
| <span class="sourceLineNo">1260</span> CompletableFuture<Void> updateConfiguration(String groupName);<a name="line.1260"></a> |
| <span class="sourceLineNo">1261</span><a name="line.1261"></a> |
| <span class="sourceLineNo">1262</span> /**<a name="line.1262"></a> |
| <span class="sourceLineNo">1263</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.1263"></a> |
| <span class="sourceLineNo">1264</span> * <p><a name="line.1264"></a> |
| <span class="sourceLineNo">1265</span> * When the returned CompletableFuture is done, it only means the rollWALWriter request was sent<a name="line.1265"></a> |
| <span class="sourceLineNo">1266</span> * to the region server and may need some time to finish the rollWALWriter operation. As a side<a name="line.1266"></a> |
| <span class="sourceLineNo">1267</span> * effect of this call, the named region server may schedule store flushes at the request of the<a name="line.1267"></a> |
| <span class="sourceLineNo">1268</span> * wal.<a name="line.1268"></a> |
| <span class="sourceLineNo">1269</span> * @param serverName The servername of the region server.<a name="line.1269"></a> |
| <span class="sourceLineNo">1270</span> */<a name="line.1270"></a> |
| <span class="sourceLineNo">1271</span> CompletableFuture<Void> rollWALWriter(ServerName serverName);<a name="line.1271"></a> |
| <span class="sourceLineNo">1272</span><a name="line.1272"></a> |
| <span class="sourceLineNo">1273</span> /**<a name="line.1273"></a> |
| <span class="sourceLineNo">1274</span> * Clear compacting queues on a region server.<a name="line.1274"></a> |
| <span class="sourceLineNo">1275</span> * @param serverName The servername of the region server.<a name="line.1275"></a> |
| <span class="sourceLineNo">1276</span> * @param queues the set of queue name<a name="line.1276"></a> |
| <span class="sourceLineNo">1277</span> */<a name="line.1277"></a> |
| <span class="sourceLineNo">1278</span> CompletableFuture<Void> clearCompactionQueues(ServerName serverName, Set<String> queues);<a name="line.1278"></a> |
| <span class="sourceLineNo">1279</span><a name="line.1279"></a> |
| <span class="sourceLineNo">1280</span> /**<a name="line.1280"></a> |
| <span class="sourceLineNo">1281</span> * Get a list of {@link RegionMetrics} of all regions hosted on a region server.<a name="line.1281"></a> |
| <span class="sourceLineNo">1282</span> * @return list of {@link RegionMetrics} wrapped by {@link CompletableFuture}<a name="line.1282"></a> |
| <span class="sourceLineNo">1283</span> */<a name="line.1283"></a> |
| <span class="sourceLineNo">1284</span> CompletableFuture<List<RegionMetrics>> getRegionMetrics(ServerName serverName);<a name="line.1284"></a> |
| <span class="sourceLineNo">1285</span><a name="line.1285"></a> |
| <span class="sourceLineNo">1286</span> /**<a name="line.1286"></a> |
| <span class="sourceLineNo">1287</span> * Get a list of {@link RegionMetrics} of all regions hosted on a region server for a table.<a name="line.1287"></a> |
| <span class="sourceLineNo">1288</span> * @return a list of {@link RegionMetrics} wrapped by {@link CompletableFuture}<a name="line.1288"></a> |
| <span class="sourceLineNo">1289</span> */<a name="line.1289"></a> |
| <span class="sourceLineNo">1290</span> CompletableFuture<List<RegionMetrics>> getRegionMetrics(ServerName serverName,<a name="line.1290"></a> |
| <span class="sourceLineNo">1291</span> TableName tableName);<a name="line.1291"></a> |
| <span class="sourceLineNo">1292</span><a name="line.1292"></a> |
| <span class="sourceLineNo">1293</span> /**<a name="line.1293"></a> |
| <span class="sourceLineNo">1294</span> * Check whether master is in maintenance mode<a name="line.1294"></a> |
| <span class="sourceLineNo">1295</span> * @return true if master is in maintenance mode, false otherwise. The return value will be<a name="line.1295"></a> |
| <span class="sourceLineNo">1296</span> * wrapped by a {@link CompletableFuture}<a name="line.1296"></a> |
| <span class="sourceLineNo">1297</span> */<a name="line.1297"></a> |
| <span class="sourceLineNo">1298</span> CompletableFuture<Boolean> isMasterInMaintenanceMode();<a name="line.1298"></a> |
| <span class="sourceLineNo">1299</span><a name="line.1299"></a> |
| <span class="sourceLineNo">1300</span> /**<a name="line.1300"></a> |
| <span class="sourceLineNo">1301</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1301"></a> |
| <span class="sourceLineNo">1302</span> * compaction, both, or none.<a name="line.1302"></a> |
| <span class="sourceLineNo">1303</span> * @param tableName table to examine<a name="line.1303"></a> |
| <span class="sourceLineNo">1304</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1304"></a> |
| <span class="sourceLineNo">1305</span> */<a name="line.1305"></a> |
| <span class="sourceLineNo">1306</span> default CompletableFuture<CompactionState> getCompactionState(TableName tableName) {<a name="line.1306"></a> |
| <span class="sourceLineNo">1307</span> return getCompactionState(tableName, CompactType.NORMAL);<a name="line.1307"></a> |
| <span class="sourceLineNo">1308</span> }<a name="line.1308"></a> |
| <span class="sourceLineNo">1309</span><a name="line.1309"></a> |
| <span class="sourceLineNo">1310</span> /**<a name="line.1310"></a> |
| <span class="sourceLineNo">1311</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1311"></a> |
| <span class="sourceLineNo">1312</span> * compaction, both, or none.<a name="line.1312"></a> |
| <span class="sourceLineNo">1313</span> * @param tableName table to examine<a name="line.1313"></a> |
| <span class="sourceLineNo">1314</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.1314"></a> |
| <span class="sourceLineNo">1315</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1315"></a> |
| <span class="sourceLineNo">1316</span> */<a name="line.1316"></a> |
| <span class="sourceLineNo">1317</span> CompletableFuture<CompactionState> getCompactionState(TableName tableName,<a name="line.1317"></a> |
| <span class="sourceLineNo">1318</span> CompactType compactType);<a name="line.1318"></a> |
| <span class="sourceLineNo">1319</span><a name="line.1319"></a> |
| <span class="sourceLineNo">1320</span> /**<a name="line.1320"></a> |
| <span class="sourceLineNo">1321</span> * Get the current compaction state of region. It could be in a major compaction, a minor<a name="line.1321"></a> |
| <span class="sourceLineNo">1322</span> * compaction, both, or none.<a name="line.1322"></a> |
| <span class="sourceLineNo">1323</span> * @param regionName region to examine<a name="line.1323"></a> |
| <span class="sourceLineNo">1324</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1324"></a> |
| <span class="sourceLineNo">1325</span> */<a name="line.1325"></a> |
| <span class="sourceLineNo">1326</span> CompletableFuture<CompactionState> getCompactionStateForRegion(byte[] regionName);<a name="line.1326"></a> |
| <span class="sourceLineNo">1327</span><a name="line.1327"></a> |
| <span class="sourceLineNo">1328</span> /**<a name="line.1328"></a> |
| <span class="sourceLineNo">1329</span> * Get the timestamp of the last major compaction for the passed table.<a name="line.1329"></a> |
| <span class="sourceLineNo">1330</span> * <p><a name="line.1330"></a> |
| <span class="sourceLineNo">1331</span> * The timestamp of the oldest HFile resulting from a major compaction of that table, or not<a name="line.1331"></a> |
| <span class="sourceLineNo">1332</span> * present if no such HFile could be found.<a name="line.1332"></a> |
| <span class="sourceLineNo">1333</span> * @param tableName table to examine<a name="line.1333"></a> |
| <span class="sourceLineNo">1334</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.1334"></a> |
| <span class="sourceLineNo">1335</span> */<a name="line.1335"></a> |
| <span class="sourceLineNo">1336</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestamp(TableName tableName);<a name="line.1336"></a> |
| <span class="sourceLineNo">1337</span><a name="line.1337"></a> |
| <span class="sourceLineNo">1338</span> /**<a name="line.1338"></a> |
| <span class="sourceLineNo">1339</span> * Get the timestamp of the last major compaction for the passed region.<a name="line.1339"></a> |
| <span class="sourceLineNo">1340</span> * <p><a name="line.1340"></a> |
| <span class="sourceLineNo">1341</span> * The timestamp of the oldest HFile resulting from a major compaction of that region, or not<a name="line.1341"></a> |
| <span class="sourceLineNo">1342</span> * present if no such HFile could be found.<a name="line.1342"></a> |
| <span class="sourceLineNo">1343</span> * @param regionName region to examine<a name="line.1343"></a> |
| <span class="sourceLineNo">1344</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.1344"></a> |
| <span class="sourceLineNo">1345</span> */<a name="line.1345"></a> |
| <span class="sourceLineNo">1346</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestampForRegion(byte[] regionName);<a name="line.1346"></a> |
| <span class="sourceLineNo">1347</span><a name="line.1347"></a> |
| <span class="sourceLineNo">1348</span> /**<a name="line.1348"></a> |
| <span class="sourceLineNo">1349</span> * Returns the list of supported security capabilities. The return value will be wrapped by a<a name="line.1349"></a> |
| <span class="sourceLineNo">1350</span> * {@link CompletableFuture}.<a name="line.1350"></a> |
| <span class="sourceLineNo">1351</span> */<a name="line.1351"></a> |
| <span class="sourceLineNo">1352</span> CompletableFuture<List<SecurityCapability>> getSecurityCapabilities();<a name="line.1352"></a> |
| <span class="sourceLineNo">1353</span><a name="line.1353"></a> |
| <span class="sourceLineNo">1354</span> /**<a name="line.1354"></a> |
| <span class="sourceLineNo">1355</span> * Turn the load balancer on or off.<a name="line.1355"></a> |
| <span class="sourceLineNo">1356</span> * @param on Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1356"></a> |
| <span class="sourceLineNo">1357</span> * @return Previous balancer value wrapped by a {@link CompletableFuture}.<a name="line.1357"></a> |
| <span class="sourceLineNo">1358</span> */<a name="line.1358"></a> |
| <span class="sourceLineNo">1359</span> default CompletableFuture<Boolean> balancerSwitch(boolean on) {<a name="line.1359"></a> |
| <span class="sourceLineNo">1360</span> return balancerSwitch(on, false);<a name="line.1360"></a> |
| <span class="sourceLineNo">1361</span> }<a name="line.1361"></a> |
| <span class="sourceLineNo">1362</span><a name="line.1362"></a> |
| <span class="sourceLineNo">1363</span> /**<a name="line.1363"></a> |
| <span class="sourceLineNo">1364</span> * Turn the load balancer on or off.<a name="line.1364"></a> |
| <span class="sourceLineNo">1365</span> * <p/><a name="line.1365"></a> |
| <span class="sourceLineNo">1366</span> * Notice that, the method itself is always non-blocking, which means it will always return<a name="line.1366"></a> |
| <span class="sourceLineNo">1367</span> * immediately. The {@code drainRITs} parameter only effects when will we complete the returned<a name="line.1367"></a> |
| <span class="sourceLineNo">1368</span> * {@link CompletableFuture}.<a name="line.1368"></a> |
| <span class="sourceLineNo">1369</span> * @param on Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1369"></a> |
| <span class="sourceLineNo">1370</span> * @param drainRITs If <code>true</code>, it waits until current balance() call, if outstanding,<a name="line.1370"></a> |
| <span class="sourceLineNo">1371</span> * to return.<a name="line.1371"></a> |
| <span class="sourceLineNo">1372</span> * @return Previous balancer value wrapped by a {@link CompletableFuture}.<a name="line.1372"></a> |
| <span class="sourceLineNo">1373</span> */<a name="line.1373"></a> |
| <span class="sourceLineNo">1374</span> CompletableFuture<Boolean> balancerSwitch(boolean on, boolean drainRITs);<a name="line.1374"></a> |
| <span class="sourceLineNo">1375</span><a name="line.1375"></a> |
| <span class="sourceLineNo">1376</span> /**<a name="line.1376"></a> |
| <span class="sourceLineNo">1377</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1377"></a> |
| <span class="sourceLineNo">1378</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.1378"></a> |
| <span class="sourceLineNo">1379</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.1379"></a> |
| <span class="sourceLineNo">1380</span> * {@link CompletableFuture}.<a name="line.1380"></a> |
| <span class="sourceLineNo">1381</span> */<a name="line.1381"></a> |
| <span class="sourceLineNo">1382</span> default CompletableFuture<Boolean> balance() {<a name="line.1382"></a> |
| <span class="sourceLineNo">1383</span> return balance(BalanceRequest.defaultInstance()).thenApply(BalanceResponse::isBalancerRan);<a name="line.1383"></a> |
| <span class="sourceLineNo">1384</span> }<a name="line.1384"></a> |
| <span class="sourceLineNo">1385</span><a name="line.1385"></a> |
| <span class="sourceLineNo">1386</span> /**<a name="line.1386"></a> |
| <span class="sourceLineNo">1387</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1387"></a> |
| <span class="sourceLineNo">1388</span> * reassignments. If there is region in transition, force parameter of true would still run<a name="line.1388"></a> |
| <span class="sourceLineNo">1389</span> * balancer. Can *not* run for other reasons. Check logs.<a name="line.1389"></a> |
| <span class="sourceLineNo">1390</span> * @param forcible whether we should force balance even if there is region in transition.<a name="line.1390"></a> |
| <span class="sourceLineNo">1391</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.1391"></a> |
| <span class="sourceLineNo">1392</span> * {@link CompletableFuture}.<a name="line.1392"></a> |
| <span class="sourceLineNo">1393</span> * @deprecated Since 2.5.0. Will be removed in 4.0.0. Use {@link #balance(BalanceRequest)}<a name="line.1393"></a> |
| <span class="sourceLineNo">1394</span> * instead.<a name="line.1394"></a> |
| <span class="sourceLineNo">1395</span> */<a name="line.1395"></a> |
| <span class="sourceLineNo">1396</span> default CompletableFuture<Boolean> balance(boolean forcible) {<a name="line.1396"></a> |
| <span class="sourceLineNo">1397</span> return balance(BalanceRequest.newBuilder().setIgnoreRegionsInTransition(forcible).build())<a name="line.1397"></a> |
| <span class="sourceLineNo">1398</span> .thenApply(BalanceResponse::isBalancerRan);<a name="line.1398"></a> |
| <span class="sourceLineNo">1399</span> }<a name="line.1399"></a> |
| <span class="sourceLineNo">1400</span><a name="line.1400"></a> |
| <span class="sourceLineNo">1401</span> /**<a name="line.1401"></a> |
| <span class="sourceLineNo">1402</span> * Invoke the balancer with the given balance request. The BalanceRequest defines how the balancer<a name="line.1402"></a> |
| <span class="sourceLineNo">1403</span> * will run. See {@link BalanceRequest} for more details.<a name="line.1403"></a> |
| <span class="sourceLineNo">1404</span> * @param request defines how the balancer should run<a name="line.1404"></a> |
| <span class="sourceLineNo">1405</span> * @return {@link BalanceResponse} with details about the results of the invocation.<a name="line.1405"></a> |
| <span class="sourceLineNo">1406</span> */<a name="line.1406"></a> |
| <span class="sourceLineNo">1407</span> CompletableFuture<BalanceResponse> balance(BalanceRequest request);<a name="line.1407"></a> |
| <span class="sourceLineNo">1408</span><a name="line.1408"></a> |
| <span class="sourceLineNo">1409</span> /**<a name="line.1409"></a> |
| <span class="sourceLineNo">1410</span> * Query the current state of the balancer.<a name="line.1410"></a> |
| <span class="sourceLineNo">1411</span> * @return true if the balance switch is on, false otherwise. The return value will be wrapped by<a name="line.1411"></a> |
| <span class="sourceLineNo">1412</span> * a {@link CompletableFuture}.<a name="line.1412"></a> |
| <span class="sourceLineNo">1413</span> */<a name="line.1413"></a> |
| <span class="sourceLineNo">1414</span> CompletableFuture<Boolean> isBalancerEnabled();<a name="line.1414"></a> |
| <span class="sourceLineNo">1415</span><a name="line.1415"></a> |
| <span class="sourceLineNo">1416</span> /**<a name="line.1416"></a> |
| <span class="sourceLineNo">1417</span> * Set region normalizer on/off.<a name="line.1417"></a> |
| <span class="sourceLineNo">1418</span> * @param on whether normalizer should be on or off<a name="line.1418"></a> |
| <span class="sourceLineNo">1419</span> * @return Previous normalizer value wrapped by a {@link CompletableFuture}<a name="line.1419"></a> |
| <span class="sourceLineNo">1420</span> */<a name="line.1420"></a> |
| <span class="sourceLineNo">1421</span> CompletableFuture<Boolean> normalizerSwitch(boolean on);<a name="line.1421"></a> |
| <span class="sourceLineNo">1422</span><a name="line.1422"></a> |
| <span class="sourceLineNo">1423</span> /**<a name="line.1423"></a> |
| <span class="sourceLineNo">1424</span> * Query the current state of the region normalizer<a name="line.1424"></a> |
| <span class="sourceLineNo">1425</span> * @return true if region normalizer is on, false otherwise. The return value will be wrapped by a<a name="line.1425"></a> |
| <span class="sourceLineNo">1426</span> * {@link CompletableFuture}<a name="line.1426"></a> |
| <span class="sourceLineNo">1427</span> */<a name="line.1427"></a> |
| <span class="sourceLineNo">1428</span> CompletableFuture<Boolean> isNormalizerEnabled();<a name="line.1428"></a> |
| <span class="sourceLineNo">1429</span><a name="line.1429"></a> |
| <span class="sourceLineNo">1430</span> /**<a name="line.1430"></a> |
| <span class="sourceLineNo">1431</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.1431"></a> |
| <span class="sourceLineNo">1432</span> * @return true if region normalizer ran, false otherwise. The return value will be wrapped by a<a name="line.1432"></a> |
| <span class="sourceLineNo">1433</span> * {@link CompletableFuture}<a name="line.1433"></a> |
| <span class="sourceLineNo">1434</span> */<a name="line.1434"></a> |
| <span class="sourceLineNo">1435</span> default CompletableFuture<Boolean> normalize() {<a name="line.1435"></a> |
| <span class="sourceLineNo">1436</span> return normalize(new NormalizeTableFilterParams.Builder().build());<a name="line.1436"></a> |
| <span class="sourceLineNo">1437</span> }<a name="line.1437"></a> |
| <span class="sourceLineNo">1438</span><a name="line.1438"></a> |
| <span class="sourceLineNo">1439</span> /**<a name="line.1439"></a> |
| <span class="sourceLineNo">1440</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.1440"></a> |
| <span class="sourceLineNo">1441</span> * @param ntfp limit to tables matching the specified filter.<a name="line.1441"></a> |
| <span class="sourceLineNo">1442</span> * @return true if region normalizer ran, false otherwise. The return value will be wrapped by a<a name="line.1442"></a> |
| <span class="sourceLineNo">1443</span> * {@link CompletableFuture}<a name="line.1443"></a> |
| <span class="sourceLineNo">1444</span> */<a name="line.1444"></a> |
| <span class="sourceLineNo">1445</span> CompletableFuture<Boolean> normalize(NormalizeTableFilterParams ntfp);<a name="line.1445"></a> |
| <span class="sourceLineNo">1446</span><a name="line.1446"></a> |
| <span class="sourceLineNo">1447</span> /**<a name="line.1447"></a> |
| <span class="sourceLineNo">1448</span> * Turn the cleaner chore on/off.<a name="line.1448"></a> |
| <span class="sourceLineNo">1449</span> * @return Previous cleaner state wrapped by a {@link CompletableFuture}<a name="line.1449"></a> |
| <span class="sourceLineNo">1450</span> */<a name="line.1450"></a> |
| <span class="sourceLineNo">1451</span> CompletableFuture<Boolean> cleanerChoreSwitch(boolean on);<a name="line.1451"></a> |
| <span class="sourceLineNo">1452</span><a name="line.1452"></a> |
| <span class="sourceLineNo">1453</span> /**<a name="line.1453"></a> |
| <span class="sourceLineNo">1454</span> * Query the current state of the cleaner chore.<a name="line.1454"></a> |
| <span class="sourceLineNo">1455</span> * @return true if cleaner chore is on, false otherwise. The return value will be wrapped by a<a name="line.1455"></a> |
| <span class="sourceLineNo">1456</span> * {@link CompletableFuture}<a name="line.1456"></a> |
| <span class="sourceLineNo">1457</span> */<a name="line.1457"></a> |
| <span class="sourceLineNo">1458</span> CompletableFuture<Boolean> isCleanerChoreEnabled();<a name="line.1458"></a> |
| <span class="sourceLineNo">1459</span><a name="line.1459"></a> |
| <span class="sourceLineNo">1460</span> /**<a name="line.1460"></a> |
| <span class="sourceLineNo">1461</span> * Ask for cleaner chore to run.<a name="line.1461"></a> |
| <span class="sourceLineNo">1462</span> * @return true if cleaner chore ran, false otherwise. The return value will be wrapped by a<a name="line.1462"></a> |
| <span class="sourceLineNo">1463</span> * {@link CompletableFuture}<a name="line.1463"></a> |
| <span class="sourceLineNo">1464</span> */<a name="line.1464"></a> |
| <span class="sourceLineNo">1465</span> CompletableFuture<Boolean> runCleanerChore();<a name="line.1465"></a> |
| <span class="sourceLineNo">1466</span><a name="line.1466"></a> |
| <span class="sourceLineNo">1467</span> /**<a name="line.1467"></a> |
| <span class="sourceLineNo">1468</span> * Turn the catalog janitor on/off.<a name="line.1468"></a> |
| <span class="sourceLineNo">1469</span> * @return the previous state wrapped by a {@link CompletableFuture}<a name="line.1469"></a> |
| <span class="sourceLineNo">1470</span> */<a name="line.1470"></a> |
| <span class="sourceLineNo">1471</span> CompletableFuture<Boolean> catalogJanitorSwitch(boolean on);<a name="line.1471"></a> |
| <span class="sourceLineNo">1472</span><a name="line.1472"></a> |
| <span class="sourceLineNo">1473</span> /**<a name="line.1473"></a> |
| <span class="sourceLineNo">1474</span> * Query on the catalog janitor state.<a name="line.1474"></a> |
| <span class="sourceLineNo">1475</span> * @return true if the catalog janitor is on, false otherwise. The return value will be wrapped by<a name="line.1475"></a> |
| <span class="sourceLineNo">1476</span> * a {@link CompletableFuture}<a name="line.1476"></a> |
| <span class="sourceLineNo">1477</span> */<a name="line.1477"></a> |
| <span class="sourceLineNo">1478</span> CompletableFuture<Boolean> isCatalogJanitorEnabled();<a name="line.1478"></a> |
| <span class="sourceLineNo">1479</span><a name="line.1479"></a> |
| <span class="sourceLineNo">1480</span> /**<a name="line.1480"></a> |
| <span class="sourceLineNo">1481</span> * Ask for a scan of the catalog table.<a name="line.1481"></a> |
| <span class="sourceLineNo">1482</span> * @return the number of entries cleaned. The return value will be wrapped by a<a name="line.1482"></a> |
| <span class="sourceLineNo">1483</span> * {@link CompletableFuture}<a name="line.1483"></a> |
| <span class="sourceLineNo">1484</span> */<a name="line.1484"></a> |
| <span class="sourceLineNo">1485</span> CompletableFuture<Integer> runCatalogJanitor();<a name="line.1485"></a> |
| <span class="sourceLineNo">1486</span><a name="line.1486"></a> |
| <span class="sourceLineNo">1487</span> /**<a name="line.1487"></a> |
| <span class="sourceLineNo">1488</span> * Execute the given coprocessor call on the master.<a name="line.1488"></a> |
| <span class="sourceLineNo">1489</span> * <p><a name="line.1489"></a> |
| <span class="sourceLineNo">1490</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1490"></a> |
| <span class="sourceLineNo">1491</span> * one line lambda expression, like:<a name="line.1491"></a> |
| <span class="sourceLineNo">1492</span> *<a name="line.1492"></a> |
| <span class="sourceLineNo">1493</span> * <pre><a name="line.1493"></a> |
| <span class="sourceLineNo">1494</span> * channel -&gt; xxxService.newStub(channel)<a name="line.1494"></a> |
| <span class="sourceLineNo">1495</span> * </pre><a name="line.1495"></a> |
| <span class="sourceLineNo">1496</span> *<a name="line.1496"></a> |
| <span class="sourceLineNo">1497</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1497"></a> |
| <span class="sourceLineNo">1498</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1498"></a> |
| <span class="sourceLineNo">1499</span> * {@link ServiceCaller} for more details.<a name="line.1499"></a> |
| <span class="sourceLineNo">1500</span> * @param <S> the type of the asynchronous stub<a name="line.1500"></a> |
| <span class="sourceLineNo">1501</span> * @param <R> the type of the return value<a name="line.1501"></a> |
| <span class="sourceLineNo">1502</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1502"></a> |
| <span class="sourceLineNo">1503</span> * @see ServiceCaller<a name="line.1503"></a> |
| <span class="sourceLineNo">1504</span> */<a name="line.1504"></a> |
| <span class="sourceLineNo">1505</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1505"></a> |
| <span class="sourceLineNo">1506</span> ServiceCaller<S, R> callable);<a name="line.1506"></a> |
| <span class="sourceLineNo">1507</span><a name="line.1507"></a> |
| <span class="sourceLineNo">1508</span> /**<a name="line.1508"></a> |
| <span class="sourceLineNo">1509</span> * Execute the given coprocessor call on the given region server.<a name="line.1509"></a> |
| <span class="sourceLineNo">1510</span> * <p><a name="line.1510"></a> |
| <span class="sourceLineNo">1511</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1511"></a> |
| <span class="sourceLineNo">1512</span> * one line lambda expression, like:<a name="line.1512"></a> |
| <span class="sourceLineNo">1513</span> *<a name="line.1513"></a> |
| <span class="sourceLineNo">1514</span> * <pre><a name="line.1514"></a> |
| <span class="sourceLineNo">1515</span> * channel -&gt; xxxService.newStub(channel)<a name="line.1515"></a> |
| <span class="sourceLineNo">1516</span> * </pre><a name="line.1516"></a> |
| <span class="sourceLineNo">1517</span> *<a name="line.1517"></a> |
| <span class="sourceLineNo">1518</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1518"></a> |
| <span class="sourceLineNo">1519</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1519"></a> |
| <span class="sourceLineNo">1520</span> * {@link ServiceCaller} for more details.<a name="line.1520"></a> |
| <span class="sourceLineNo">1521</span> * @param serverName the given region server<a name="line.1521"></a> |
| <span class="sourceLineNo">1522</span> * @param <S> the type of the asynchronous stub<a name="line.1522"></a> |
| <span class="sourceLineNo">1523</span> * @param <R> the type of the return value<a name="line.1523"></a> |
| <span class="sourceLineNo">1524</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1524"></a> |
| <span class="sourceLineNo">1525</span> * @see ServiceCaller<a name="line.1525"></a> |
| <span class="sourceLineNo">1526</span> */<a name="line.1526"></a> |
| <span class="sourceLineNo">1527</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1527"></a> |
| <span class="sourceLineNo">1528</span> ServiceCaller<S, R> callable, ServerName serverName);<a name="line.1528"></a> |
| <span class="sourceLineNo">1529</span><a name="line.1529"></a> |
| <span class="sourceLineNo">1530</span> /**<a name="line.1530"></a> |
| <span class="sourceLineNo">1531</span> * List all the dead region servers.<a name="line.1531"></a> |
| <span class="sourceLineNo">1532</span> */<a name="line.1532"></a> |
| <span class="sourceLineNo">1533</span> default CompletableFuture<List<ServerName>> listDeadServers() {<a name="line.1533"></a> |
| <span class="sourceLineNo">1534</span> return this.getClusterMetrics(EnumSet.of(Option.DEAD_SERVERS))<a name="line.1534"></a> |
| <span class="sourceLineNo">1535</span> .thenApply(ClusterMetrics::getDeadServerNames);<a name="line.1535"></a> |
| <span class="sourceLineNo">1536</span> }<a name="line.1536"></a> |
| <span class="sourceLineNo">1537</span><a name="line.1537"></a> |
| <span class="sourceLineNo">1538</span> /**<a name="line.1538"></a> |
| <span class="sourceLineNo">1539</span> * List all the unknown region servers.<a name="line.1539"></a> |
| <span class="sourceLineNo">1540</span> */<a name="line.1540"></a> |
| <span class="sourceLineNo">1541</span> default CompletableFuture<List<ServerName>> listUnknownServers() {<a name="line.1541"></a> |
| <span class="sourceLineNo">1542</span> return this.getClusterMetrics(EnumSet.of(Option.UNKNOWN_SERVERS))<a name="line.1542"></a> |
| <span class="sourceLineNo">1543</span> .thenApply(ClusterMetrics::getUnknownServerNames);<a name="line.1543"></a> |
| <span class="sourceLineNo">1544</span> }<a name="line.1544"></a> |
| <span class="sourceLineNo">1545</span><a name="line.1545"></a> |
| <span class="sourceLineNo">1546</span> /**<a name="line.1546"></a> |
| <span class="sourceLineNo">1547</span> * Clear dead region servers from master.<a name="line.1547"></a> |
| <span class="sourceLineNo">1548</span> * @param servers list of dead region servers.<a name="line.1548"></a> |
| <span class="sourceLineNo">1549</span> * @return - returns a list of servers that not cleared wrapped by a {@link CompletableFuture}.<a name="line.1549"></a> |
| <span class="sourceLineNo">1550</span> */<a name="line.1550"></a> |
| <span class="sourceLineNo">1551</span> CompletableFuture<List<ServerName>> clearDeadServers(final List<ServerName> servers);<a name="line.1551"></a> |
| <span class="sourceLineNo">1552</span><a name="line.1552"></a> |
| <span class="sourceLineNo">1553</span> /**<a name="line.1553"></a> |
| <span class="sourceLineNo">1554</span> * Clear all the blocks corresponding to this table from BlockCache. For expert-admins. Calling<a name="line.1554"></a> |
| <span class="sourceLineNo">1555</span> * this API will drop all the cached blocks specific to a table from BlockCache. This can<a name="line.1555"></a> |
| <span class="sourceLineNo">1556</span> * significantly impact the query performance as the subsequent queries will have to retrieve the<a name="line.1556"></a> |
| <span class="sourceLineNo">1557</span> * blocks from underlying filesystem.<a name="line.1557"></a> |
| <span class="sourceLineNo">1558</span> * @param tableName table to clear block cache<a name="line.1558"></a> |
| <span class="sourceLineNo">1559</span> * @return CacheEvictionStats related to the eviction wrapped by a {@link CompletableFuture}.<a name="line.1559"></a> |
| <span class="sourceLineNo">1560</span> */<a name="line.1560"></a> |
| <span class="sourceLineNo">1561</span> CompletableFuture<CacheEvictionStats> clearBlockCache(final TableName tableName);<a name="line.1561"></a> |
| <span class="sourceLineNo">1562</span><a name="line.1562"></a> |
| <span class="sourceLineNo">1563</span> /**<a name="line.1563"></a> |
| <span class="sourceLineNo">1564</span> * Create a new table by cloning the existent table schema.<a name="line.1564"></a> |
| <span class="sourceLineNo">1565</span> * @param tableName name of the table to be cloned<a name="line.1565"></a> |
| <span class="sourceLineNo">1566</span> * @param newTableName name of the new table where the table will be created<a name="line.1566"></a> |
| <span class="sourceLineNo">1567</span> * @param preserveSplits True if the splits should be preserved<a name="line.1567"></a> |
| <span class="sourceLineNo">1568</span> */<a name="line.1568"></a> |
| <span class="sourceLineNo">1569</span> CompletableFuture<Void> cloneTableSchema(final TableName tableName, final TableName newTableName,<a name="line.1569"></a> |
| <span class="sourceLineNo">1570</span> final boolean preserveSplits);<a name="line.1570"></a> |
| <span class="sourceLineNo">1571</span><a name="line.1571"></a> |
| <span class="sourceLineNo">1572</span> /**<a name="line.1572"></a> |
| <span class="sourceLineNo">1573</span> * Turn the compaction on or off. Disabling compactions will also interrupt any currently ongoing<a name="line.1573"></a> |
| <span class="sourceLineNo">1574</span> * compactions. This state is ephemeral. The setting will be lost on restart. Compaction can also<a name="line.1574"></a> |
| <span class="sourceLineNo">1575</span> * be enabled/disabled by modifying configuration hbase.regionserver.compaction.enabled in<a name="line.1575"></a> |
| <span class="sourceLineNo">1576</span> * hbase-site.xml.<a name="line.1576"></a> |
| <span class="sourceLineNo">1577</span> * @param switchState Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1577"></a> |
| <span class="sourceLineNo">1578</span> * @param serverNamesList list of region servers.<a name="line.1578"></a> |
| <span class="sourceLineNo">1579</span> * @return Previous compaction states for region servers<a name="line.1579"></a> |
| <span class="sourceLineNo">1580</span> */<a name="line.1580"></a> |
| <span class="sourceLineNo">1581</span> CompletableFuture<Map<ServerName, Boolean>> compactionSwitch(boolean switchState,<a name="line.1581"></a> |
| <span class="sourceLineNo">1582</span> List<String> serverNamesList);<a name="line.1582"></a> |
| <span class="sourceLineNo">1583</span><a name="line.1583"></a> |
| <span class="sourceLineNo">1584</span> /**<a name="line.1584"></a> |
| <span class="sourceLineNo">1585</span> * Switch the rpc throttle enabled state.<a name="line.1585"></a> |
| <span class="sourceLineNo">1586</span> * @param enable Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1586"></a> |
| <span class="sourceLineNo">1587</span> * @return Previous rpc throttle enabled value<a name="line.1587"></a> |
| <span class="sourceLineNo">1588</span> */<a name="line.1588"></a> |
| <span class="sourceLineNo">1589</span> CompletableFuture<Boolean> switchRpcThrottle(boolean enable);<a name="line.1589"></a> |
| <span class="sourceLineNo">1590</span><a name="line.1590"></a> |
| <span class="sourceLineNo">1591</span> /**<a name="line.1591"></a> |
| <span class="sourceLineNo">1592</span> * Get if the rpc throttle is enabled.<a name="line.1592"></a> |
| <span class="sourceLineNo">1593</span> * @return True if rpc throttle is enabled<a name="line.1593"></a> |
| <span class="sourceLineNo">1594</span> */<a name="line.1594"></a> |
| <span class="sourceLineNo">1595</span> CompletableFuture<Boolean> isRpcThrottleEnabled();<a name="line.1595"></a> |
| <span class="sourceLineNo">1596</span><a name="line.1596"></a> |
| <span class="sourceLineNo">1597</span> /**<a name="line.1597"></a> |
| <span class="sourceLineNo">1598</span> * Switch the exceed throttle quota. If enabled, user/table/namespace throttle quota can be<a name="line.1598"></a> |
| <span class="sourceLineNo">1599</span> * exceeded if region server has availble quota.<a name="line.1599"></a> |
| <span class="sourceLineNo">1600</span> * @param enable Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1600"></a> |
| <span class="sourceLineNo">1601</span> * @return Previous exceed throttle enabled value<a name="line.1601"></a> |
| <span class="sourceLineNo">1602</span> */<a name="line.1602"></a> |
| <span class="sourceLineNo">1603</span> CompletableFuture<Boolean> exceedThrottleQuotaSwitch(boolean enable);<a name="line.1603"></a> |
| <span class="sourceLineNo">1604</span><a name="line.1604"></a> |
| <span class="sourceLineNo">1605</span> /**<a name="line.1605"></a> |
| <span class="sourceLineNo">1606</span> * Fetches the table sizes on the filesystem as tracked by the HBase Master.<a name="line.1606"></a> |
| <span class="sourceLineNo">1607</span> */<a name="line.1607"></a> |
| <span class="sourceLineNo">1608</span> CompletableFuture<Map<TableName, Long>> getSpaceQuotaTableSizes();<a name="line.1608"></a> |
| <span class="sourceLineNo">1609</span><a name="line.1609"></a> |
| <span class="sourceLineNo">1610</span> /**<a name="line.1610"></a> |
| <span class="sourceLineNo">1611</span> * Fetches the observed {@link SpaceQuotaSnapshotView}s observed by a RegionServer.<a name="line.1611"></a> |
| <span class="sourceLineNo">1612</span> */<a name="line.1612"></a> |
| <span class="sourceLineNo">1613</span> CompletableFuture<? extends Map<TableName, ? extends SpaceQuotaSnapshotView>><a name="line.1613"></a> |
| <span class="sourceLineNo">1614</span> getRegionServerSpaceQuotaSnapshots(ServerName serverName);<a name="line.1614"></a> |
| <span class="sourceLineNo">1615</span><a name="line.1615"></a> |
| <span class="sourceLineNo">1616</span> /**<a name="line.1616"></a> |
| <span class="sourceLineNo">1617</span> * Returns the Master's view of a quota on the given {@code namespace} or null if the Master has<a name="line.1617"></a> |
| <span class="sourceLineNo">1618</span> * no quota information on that namespace.<a name="line.1618"></a> |
| <span class="sourceLineNo">1619</span> */<a name="line.1619"></a> |
| <span class="sourceLineNo">1620</span> CompletableFuture<? extends SpaceQuotaSnapshotView><a name="line.1620"></a> |
| <span class="sourceLineNo">1621</span> getCurrentSpaceQuotaSnapshot(String namespace);<a name="line.1621"></a> |
| <span class="sourceLineNo">1622</span><a name="line.1622"></a> |
| <span class="sourceLineNo">1623</span> /**<a name="line.1623"></a> |
| <span class="sourceLineNo">1624</span> * Returns the Master's view of a quota on the given {@code tableName} or null if the Master has<a name="line.1624"></a> |
| <span class="sourceLineNo">1625</span> * no quota information on that table.<a name="line.1625"></a> |
| <span class="sourceLineNo">1626</span> */<a name="line.1626"></a> |
| <span class="sourceLineNo">1627</span> CompletableFuture<? extends SpaceQuotaSnapshotView><a name="line.1627"></a> |
| <span class="sourceLineNo">1628</span> getCurrentSpaceQuotaSnapshot(TableName tableName);<a name="line.1628"></a> |
| <span class="sourceLineNo">1629</span><a name="line.1629"></a> |
| <span class="sourceLineNo">1630</span> /**<a name="line.1630"></a> |
| <span class="sourceLineNo">1631</span> * Grants user specific permissions<a name="line.1631"></a> |
| <span class="sourceLineNo">1632</span> * @param userPermission user name and the specific permission<a name="line.1632"></a> |
| <span class="sourceLineNo">1633</span> * @param mergeExistingPermissions If set to false, later granted permissions will override<a name="line.1633"></a> |
| <span class="sourceLineNo">1634</span> * previous granted permissions. otherwise, it'll merge with<a name="line.1634"></a> |
| <span class="sourceLineNo">1635</span> * previous granted permissions.<a name="line.1635"></a> |
| <span class="sourceLineNo">1636</span> */<a name="line.1636"></a> |
| <span class="sourceLineNo">1637</span> CompletableFuture<Void> grant(UserPermission userPermission, boolean mergeExistingPermissions);<a name="line.1637"></a> |
| <span class="sourceLineNo">1638</span><a name="line.1638"></a> |
| <span class="sourceLineNo">1639</span> /**<a name="line.1639"></a> |
| <span class="sourceLineNo">1640</span> * Revokes user specific permissions<a name="line.1640"></a> |
| <span class="sourceLineNo">1641</span> * @param userPermission user name and the specific permission<a name="line.1641"></a> |
| <span class="sourceLineNo">1642</span> */<a name="line.1642"></a> |
| <span class="sourceLineNo">1643</span> CompletableFuture<Void> revoke(UserPermission userPermission);<a name="line.1643"></a> |
| <span class="sourceLineNo">1644</span><a name="line.1644"></a> |
| <span class="sourceLineNo">1645</span> /**<a name="line.1645"></a> |
| <span class="sourceLineNo">1646</span> * Get the global/namespace/table permissions for user<a name="line.1646"></a> |
| <span class="sourceLineNo">1647</span> * @param getUserPermissionsRequest A request contains which user, global, namespace or table<a name="line.1647"></a> |
| <span class="sourceLineNo">1648</span> * permissions needed<a name="line.1648"></a> |
| <span class="sourceLineNo">1649</span> * @return The user and permission list<a name="line.1649"></a> |
| <span class="sourceLineNo">1650</span> */<a name="line.1650"></a> |
| <span class="sourceLineNo">1651</span> CompletableFuture<List<UserPermission>><a name="line.1651"></a> |
| <span class="sourceLineNo">1652</span> getUserPermissions(GetUserPermissionsRequest getUserPermissionsRequest);<a name="line.1652"></a> |
| <span class="sourceLineNo">1653</span><a name="line.1653"></a> |
| <span class="sourceLineNo">1654</span> /**<a name="line.1654"></a> |
| <span class="sourceLineNo">1655</span> * Check if the user has specific permissions<a name="line.1655"></a> |
| <span class="sourceLineNo">1656</span> * @param userName the user name<a name="line.1656"></a> |
| <span class="sourceLineNo">1657</span> * @param permissions the specific permission list<a name="line.1657"></a> |
| <span class="sourceLineNo">1658</span> * @return True if user has the specific permissions<a name="line.1658"></a> |
| <span class="sourceLineNo">1659</span> */<a name="line.1659"></a> |
| <span class="sourceLineNo">1660</span> CompletableFuture<List<Boolean>> hasUserPermissions(String userName,<a name="line.1660"></a> |
| <span class="sourceLineNo">1661</span> List<Permission> permissions);<a name="line.1661"></a> |
| <span class="sourceLineNo">1662</span><a name="line.1662"></a> |
| <span class="sourceLineNo">1663</span> /**<a name="line.1663"></a> |
| <span class="sourceLineNo">1664</span> * Check if call user has specific permissions<a name="line.1664"></a> |
| <span class="sourceLineNo">1665</span> * @param permissions the specific permission list<a name="line.1665"></a> |
| <span class="sourceLineNo">1666</span> * @return True if user has the specific permissions<a name="line.1666"></a> |
| <span class="sourceLineNo">1667</span> */<a name="line.1667"></a> |
| <span class="sourceLineNo">1668</span> default CompletableFuture<List<Boolean>> hasUserPermissions(List<Permission> permissions) {<a name="line.1668"></a> |
| <span class="sourceLineNo">1669</span> return hasUserPermissions(null, permissions);<a name="line.1669"></a> |
| <span class="sourceLineNo">1670</span> }<a name="line.1670"></a> |
| <span class="sourceLineNo">1671</span><a name="line.1671"></a> |
| <span class="sourceLineNo">1672</span> /**<a name="line.1672"></a> |
| <span class="sourceLineNo">1673</span> * Turn on or off the auto snapshot cleanup based on TTL.<a name="line.1673"></a> |
| <span class="sourceLineNo">1674</span> * <p/><a name="line.1674"></a> |
| <span class="sourceLineNo">1675</span> * Notice that, the method itself is always non-blocking, which means it will always return<a name="line.1675"></a> |
| <span class="sourceLineNo">1676</span> * immediately. The {@code sync} parameter only effects when will we complete the returned<a name="line.1676"></a> |
| <span class="sourceLineNo">1677</span> * {@link CompletableFuture}.<a name="line.1677"></a> |
| <span class="sourceLineNo">1678</span> * @param on Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1678"></a> |
| <span class="sourceLineNo">1679</span> * @param sync If <code>true</code>, it waits until current snapshot cleanup is completed, if<a name="line.1679"></a> |
| <span class="sourceLineNo">1680</span> * outstanding.<a name="line.1680"></a> |
| <span class="sourceLineNo">1681</span> * @return Previous auto snapshot cleanup value wrapped by a {@link CompletableFuture}.<a name="line.1681"></a> |
| <span class="sourceLineNo">1682</span> */<a name="line.1682"></a> |
| <span class="sourceLineNo">1683</span> CompletableFuture<Boolean> snapshotCleanupSwitch(boolean on, boolean sync);<a name="line.1683"></a> |
| <span class="sourceLineNo">1684</span><a name="line.1684"></a> |
| <span class="sourceLineNo">1685</span> /**<a name="line.1685"></a> |
| <span class="sourceLineNo">1686</span> * Query the current state of the auto snapshot cleanup based on TTL.<a name="line.1686"></a> |
| <span class="sourceLineNo">1687</span> * @return true if the auto snapshot cleanup is enabled, false otherwise. The return value will be<a name="line.1687"></a> |
| <span class="sourceLineNo">1688</span> * wrapped by a {@link CompletableFuture}.<a name="line.1688"></a> |
| <span class="sourceLineNo">1689</span> */<a name="line.1689"></a> |
| <span class="sourceLineNo">1690</span> CompletableFuture<Boolean> isSnapshotCleanupEnabled();<a name="line.1690"></a> |
| <span class="sourceLineNo">1691</span><a name="line.1691"></a> |
| <span class="sourceLineNo">1692</span> /**<a name="line.1692"></a> |
| <span class="sourceLineNo">1693</span> * Retrieves online slow RPC logs from the provided list of RegionServers<a name="line.1693"></a> |
| <span class="sourceLineNo">1694</span> * @param serverNames Server names to get slowlog responses from<a name="line.1694"></a> |
| <span class="sourceLineNo">1695</span> * @param logQueryFilter filter to be used if provided<a name="line.1695"></a> |
| <span class="sourceLineNo">1696</span> * @return Online slowlog response list. The return value wrapped by a {@link CompletableFuture}<a name="line.1696"></a> |
| <span class="sourceLineNo">1697</span> * @deprecated since 2.4.0 and will be removed in 4.0.0. Use<a name="line.1697"></a> |
| <span class="sourceLineNo">1698</span> * {@link #getLogEntries(Set, String, ServerType, int, Map)} instead.<a name="line.1698"></a> |
| <span class="sourceLineNo">1699</span> */<a name="line.1699"></a> |
| <span class="sourceLineNo">1700</span> @Deprecated<a name="line.1700"></a> |
| <span class="sourceLineNo">1701</span> default CompletableFuture<List<OnlineLogRecord>><a name="line.1701"></a> |
| <span class="sourceLineNo">1702</span> getSlowLogResponses(final Set<ServerName> serverNames, final LogQueryFilter logQueryFilter) {<a name="line.1702"></a> |
| <span class="sourceLineNo">1703</span> String logType;<a name="line.1703"></a> |
| <span class="sourceLineNo">1704</span> if (LogQueryFilter.Type.LARGE_LOG.equals(logQueryFilter.getType())) {<a name="line.1704"></a> |
| <span class="sourceLineNo">1705</span> logType = "LARGE_LOG";<a name="line.1705"></a> |
| <span class="sourceLineNo">1706</span> } else {<a name="line.1706"></a> |
| <span class="sourceLineNo">1707</span> logType = "SLOW_LOG";<a name="line.1707"></a> |
| <span class="sourceLineNo">1708</span> }<a name="line.1708"></a> |
| <span class="sourceLineNo">1709</span> Map<String, Object> filterParams = new HashMap<>();<a name="line.1709"></a> |
| <span class="sourceLineNo">1710</span> filterParams.put("regionName", logQueryFilter.getRegionName());<a name="line.1710"></a> |
| <span class="sourceLineNo">1711</span> filterParams.put("clientAddress", logQueryFilter.getClientAddress());<a name="line.1711"></a> |
| <span class="sourceLineNo">1712</span> filterParams.put("tableName", logQueryFilter.getTableName());<a name="line.1712"></a> |
| <span class="sourceLineNo">1713</span> filterParams.put("userName", logQueryFilter.getUserName());<a name="line.1713"></a> |
| <span class="sourceLineNo">1714</span> filterParams.put("filterByOperator", logQueryFilter.getFilterByOperator().toString());<a name="line.1714"></a> |
| <span class="sourceLineNo">1715</span> CompletableFuture<List<LogEntry>> logEntries = getLogEntries(serverNames, logType,<a name="line.1715"></a> |
| <span class="sourceLineNo">1716</span> ServerType.REGION_SERVER, logQueryFilter.getLimit(), filterParams);<a name="line.1716"></a> |
| <span class="sourceLineNo">1717</span> return logEntries.thenApply(logEntryList -> logEntryList.stream()<a name="line.1717"></a> |
| <span class="sourceLineNo">1718</span> .map(logEntry -> (OnlineLogRecord) logEntry).collect(Collectors.toList()));<a name="line.1718"></a> |
| <span class="sourceLineNo">1719</span> }<a name="line.1719"></a> |
| <span class="sourceLineNo">1720</span><a name="line.1720"></a> |
| <span class="sourceLineNo">1721</span> /**<a name="line.1721"></a> |
| <span class="sourceLineNo">1722</span> * Clears online slow RPC logs from the provided list of RegionServers<a name="line.1722"></a> |
| <span class="sourceLineNo">1723</span> * @param serverNames Set of Server names to clean slowlog responses from<a name="line.1723"></a> |
| <span class="sourceLineNo">1724</span> * @return List of booleans representing if online slowlog response buffer is cleaned from each<a name="line.1724"></a> |
| <span class="sourceLineNo">1725</span> * RegionServer. The return value wrapped by a {@link CompletableFuture}<a name="line.1725"></a> |
| <span class="sourceLineNo">1726</span> */<a name="line.1726"></a> |
| <span class="sourceLineNo">1727</span> CompletableFuture<List<Boolean>> clearSlowLogResponses(final Set<ServerName> serverNames);<a name="line.1727"></a> |
| <span class="sourceLineNo">1728</span><a name="line.1728"></a> |
| <span class="sourceLineNo">1729</span> /**<a name="line.1729"></a> |
| <span class="sourceLineNo">1730</span> * Creates a new RegionServer group with the given name<a name="line.1730"></a> |
| <span class="sourceLineNo">1731</span> * @param groupName the name of the group<a name="line.1731"></a> |
| <span class="sourceLineNo">1732</span> */<a name="line.1732"></a> |
| <span class="sourceLineNo">1733</span> CompletableFuture<Void> addRSGroup(String groupName);<a name="line.1733"></a> |
| <span class="sourceLineNo">1734</span><a name="line.1734"></a> |
| <span class="sourceLineNo">1735</span> /**<a name="line.1735"></a> |
| <span class="sourceLineNo">1736</span> * Get group info for the given group name<a name="line.1736"></a> |
| <span class="sourceLineNo">1737</span> * @param groupName the group name<a name="line.1737"></a> |
| <span class="sourceLineNo">1738</span> * @return group info<a name="line.1738"></a> |
| <span class="sourceLineNo">1739</span> */<a name="line.1739"></a> |
| <span class="sourceLineNo">1740</span> CompletableFuture<RSGroupInfo> getRSGroup(String groupName);<a name="line.1740"></a> |
| <span class="sourceLineNo">1741</span><a name="line.1741"></a> |
| <span class="sourceLineNo">1742</span> /**<a name="line.1742"></a> |
| <span class="sourceLineNo">1743</span> * Get group info for the given hostPort<a name="line.1743"></a> |
| <span class="sourceLineNo">1744</span> * @param hostPort HostPort to get RSGroupInfo for<a name="line.1744"></a> |
| <span class="sourceLineNo">1745</span> */<a name="line.1745"></a> |
| <span class="sourceLineNo">1746</span> CompletableFuture<RSGroupInfo> getRSGroup(Address hostPort);<a name="line.1746"></a> |
| <span class="sourceLineNo">1747</span><a name="line.1747"></a> |
| <span class="sourceLineNo">1748</span> /**<a name="line.1748"></a> |
| <span class="sourceLineNo">1749</span> * Get group info for the given table<a name="line.1749"></a> |
| <span class="sourceLineNo">1750</span> * @param tableName table name to get RSGroupInfo for<a name="line.1750"></a> |
| <span class="sourceLineNo">1751</span> */<a name="line.1751"></a> |
| <span class="sourceLineNo">1752</span> CompletableFuture<RSGroupInfo> getRSGroup(TableName tableName);<a name="line.1752"></a> |
| <span class="sourceLineNo">1753</span><a name="line.1753"></a> |
| <span class="sourceLineNo">1754</span> /**<a name="line.1754"></a> |
| <span class="sourceLineNo">1755</span> * Lists current set of RegionServer groups<a name="line.1755"></a> |
| <span class="sourceLineNo">1756</span> */<a name="line.1756"></a> |
| <span class="sourceLineNo">1757</span> CompletableFuture<List<RSGroupInfo>> listRSGroups();<a name="line.1757"></a> |
| <span class="sourceLineNo">1758</span><a name="line.1758"></a> |
| <span class="sourceLineNo">1759</span> /**<a name="line.1759"></a> |
| <span class="sourceLineNo">1760</span> * Get all tables in this RegionServer group.<a name="line.1760"></a> |
| <span class="sourceLineNo">1761</span> * @param groupName the group name<a name="line.1761"></a> |
| <span class="sourceLineNo">1762</span> * @see #getConfiguredNamespacesAndTablesInRSGroup(String)<a name="line.1762"></a> |
| <span class="sourceLineNo">1763</span> */<a name="line.1763"></a> |
| <span class="sourceLineNo">1764</span> CompletableFuture<List<TableName>> listTablesInRSGroup(String groupName);<a name="line.1764"></a> |
| <span class="sourceLineNo">1765</span><a name="line.1765"></a> |
| <span class="sourceLineNo">1766</span> /**<a name="line.1766"></a> |
| <span class="sourceLineNo">1767</span> * Get the namespaces and tables which have this RegionServer group in descriptor.<a name="line.1767"></a> |
| <span class="sourceLineNo">1768</span> * <p/><a name="line.1768"></a> |
| <span class="sourceLineNo">1769</span> * The difference between this method and {@link #listTablesInRSGroup(String)} is that, this<a name="line.1769"></a> |
| <span class="sourceLineNo">1770</span> * method will not include the table which is actually in this RegionServr group but without the<a name="line.1770"></a> |
| <span class="sourceLineNo">1771</span> * RegionServer group configuration in its {@link TableDescriptor}. For example, we have a group<a name="line.1771"></a> |
| <span class="sourceLineNo">1772</span> * 'A', and we make namespace 'nsA' in this group, then all the tables under this namespace will<a name="line.1772"></a> |
| <span class="sourceLineNo">1773</span> * in the group 'A', but this method will not return these tables but only the namespace 'nsA',<a name="line.1773"></a> |
| <span class="sourceLineNo">1774</span> * while the {@link #listTablesInRSGroup(String)} will return all these tables.<a name="line.1774"></a> |
| <span class="sourceLineNo">1775</span> * @param groupName the group name<a name="line.1775"></a> |
| <span class="sourceLineNo">1776</span> * @see #listTablesInRSGroup(String)<a name="line.1776"></a> |
| <span class="sourceLineNo">1777</span> */<a name="line.1777"></a> |
| <span class="sourceLineNo">1778</span> CompletableFuture<Pair<List<String>, List<TableName>>><a name="line.1778"></a> |
| <span class="sourceLineNo">1779</span> getConfiguredNamespacesAndTablesInRSGroup(String groupName);<a name="line.1779"></a> |
| <span class="sourceLineNo">1780</span><a name="line.1780"></a> |
| <span class="sourceLineNo">1781</span> /**<a name="line.1781"></a> |
| <span class="sourceLineNo">1782</span> * Remove RegionServer group associated with the given name<a name="line.1782"></a> |
| <span class="sourceLineNo">1783</span> * @param groupName the group name<a name="line.1783"></a> |
| <span class="sourceLineNo">1784</span> */<a name="line.1784"></a> |
| <span class="sourceLineNo">1785</span> CompletableFuture<Void> removeRSGroup(String groupName);<a name="line.1785"></a> |
| <span class="sourceLineNo">1786</span><a name="line.1786"></a> |
| <span class="sourceLineNo">1787</span> /**<a name="line.1787"></a> |
| <span class="sourceLineNo">1788</span> * Remove decommissioned servers from group 1. Sometimes we may find the server aborted due to<a name="line.1788"></a> |
| <span class="sourceLineNo">1789</span> * some hardware failure and we must offline the server for repairing. Or we need to move some<a name="line.1789"></a> |
| <span class="sourceLineNo">1790</span> * servers to join other clusters. So we need to remove these servers from the group. 2.<a name="line.1790"></a> |
| <span class="sourceLineNo">1791</span> * Dead/recovering/live servers will be disallowed.<a name="line.1791"></a> |
| <span class="sourceLineNo">1792</span> * @param servers set of servers to remove<a name="line.1792"></a> |
| <span class="sourceLineNo">1793</span> */<a name="line.1793"></a> |
| <span class="sourceLineNo">1794</span> CompletableFuture<Void> removeServersFromRSGroup(Set<Address> servers);<a name="line.1794"></a> |
| <span class="sourceLineNo">1795</span><a name="line.1795"></a> |
| <span class="sourceLineNo">1796</span> /**<a name="line.1796"></a> |
| <span class="sourceLineNo">1797</span> * Move given set of servers to the specified target RegionServer group<a name="line.1797"></a> |
| <span class="sourceLineNo">1798</span> * @param servers set of servers to move<a name="line.1798"></a> |
| <span class="sourceLineNo">1799</span> * @param groupName the group to move servers to<a name="line.1799"></a> |
| <span class="sourceLineNo">1800</span> */<a name="line.1800"></a> |
| <span class="sourceLineNo">1801</span> CompletableFuture<Void> moveServersToRSGroup(Set<Address> servers, String groupName);<a name="line.1801"></a> |
| <span class="sourceLineNo">1802</span><a name="line.1802"></a> |
| <span class="sourceLineNo">1803</span> /**<a name="line.1803"></a> |
| <span class="sourceLineNo">1804</span> * Set the RegionServer group for tables<a name="line.1804"></a> |
| <span class="sourceLineNo">1805</span> * @param tables tables to set group for<a name="line.1805"></a> |
| <span class="sourceLineNo">1806</span> * @param groupName group name for tables<a name="line.1806"></a> |
| <span class="sourceLineNo">1807</span> */<a name="line.1807"></a> |
| <span class="sourceLineNo">1808</span> CompletableFuture<Void> setRSGroup(Set<TableName> tables, String groupName);<a name="line.1808"></a> |
| <span class="sourceLineNo">1809</span><a name="line.1809"></a> |
| <span class="sourceLineNo">1810</span> /**<a name="line.1810"></a> |
| <span class="sourceLineNo">1811</span> * Balance regions in the given RegionServer group<a name="line.1811"></a> |
| <span class="sourceLineNo">1812</span> * @param groupName the group name<a name="line.1812"></a> |
| <span class="sourceLineNo">1813</span> * @return BalanceResponse details about the balancer run<a name="line.1813"></a> |
| <span class="sourceLineNo">1814</span> */<a name="line.1814"></a> |
| <span class="sourceLineNo">1815</span> default CompletableFuture<BalanceResponse> balanceRSGroup(String groupName) {<a name="line.1815"></a> |
| <span class="sourceLineNo">1816</span> return balanceRSGroup(groupName, BalanceRequest.defaultInstance());<a name="line.1816"></a> |
| <span class="sourceLineNo">1817</span> }<a name="line.1817"></a> |
| <span class="sourceLineNo">1818</span><a name="line.1818"></a> |
| <span class="sourceLineNo">1819</span> /**<a name="line.1819"></a> |
| <span class="sourceLineNo">1820</span> * Balance regions in the given RegionServer group<a name="line.1820"></a> |
| <span class="sourceLineNo">1821</span> * @param groupName the group name<a name="line.1821"></a> |
| <span class="sourceLineNo">1822</span> * @param request options to define how the balancer should run<a name="line.1822"></a> |
| <span class="sourceLineNo">1823</span> * @return BalanceResponse details about the balancer run<a name="line.1823"></a> |
| <span class="sourceLineNo">1824</span> */<a name="line.1824"></a> |
| <span class="sourceLineNo">1825</span> CompletableFuture<BalanceResponse> balanceRSGroup(String groupName, BalanceRequest request);<a name="line.1825"></a> |
| <span class="sourceLineNo">1826</span><a name="line.1826"></a> |
| <span class="sourceLineNo">1827</span> /**<a name="line.1827"></a> |
| <span class="sourceLineNo">1828</span> * Rename rsgroup<a name="line.1828"></a> |
| <span class="sourceLineNo">1829</span> * @param oldName old rsgroup name<a name="line.1829"></a> |
| <span class="sourceLineNo">1830</span> * @param newName new rsgroup name<a name="line.1830"></a> |
| <span class="sourceLineNo">1831</span> */<a name="line.1831"></a> |
| <span class="sourceLineNo">1832</span> CompletableFuture<Void> renameRSGroup(String oldName, String newName);<a name="line.1832"></a> |
| <span class="sourceLineNo">1833</span><a name="line.1833"></a> |
| <span class="sourceLineNo">1834</span> /**<a name="line.1834"></a> |
| <span class="sourceLineNo">1835</span> * Update RSGroup configuration<a name="line.1835"></a> |
| <span class="sourceLineNo">1836</span> * @param groupName the group name<a name="line.1836"></a> |
| <span class="sourceLineNo">1837</span> * @param configuration new configuration of the group name to be set<a name="line.1837"></a> |
| <span class="sourceLineNo">1838</span> */<a name="line.1838"></a> |
| <span class="sourceLineNo">1839</span> CompletableFuture<Void> updateRSGroupConfig(String groupName, Map<String, String> configuration);<a name="line.1839"></a> |
| <span class="sourceLineNo">1840</span><a name="line.1840"></a> |
| <span class="sourceLineNo">1841</span> /**<a name="line.1841"></a> |
| <span class="sourceLineNo">1842</span> * Retrieve recent online records from HMaster / RegionServers. Examples include slow/large RPC<a name="line.1842"></a> |
| <span class="sourceLineNo">1843</span> * logs, balancer decisions by master.<a name="line.1843"></a> |
| <span class="sourceLineNo">1844</span> * @param serverNames servers to retrieve records from, useful in case of records maintained by<a name="line.1844"></a> |
| <span class="sourceLineNo">1845</span> * RegionServer as we can select specific server. In case of<a name="line.1845"></a> |
| <span class="sourceLineNo">1846</span> * servertype=MASTER, logs will only come from the currently active master.<a name="line.1846"></a> |
| <span class="sourceLineNo">1847</span> * @param logType string representing type of log records<a name="line.1847"></a> |
| <span class="sourceLineNo">1848</span> * @param serverType enum for server type: HMaster or RegionServer<a name="line.1848"></a> |
| <span class="sourceLineNo">1849</span> * @param limit put a limit to list of records that server should send in response<a name="line.1849"></a> |
| <span class="sourceLineNo">1850</span> * @param filterParams additional filter params<a name="line.1850"></a> |
| <span class="sourceLineNo">1851</span> */<a name="line.1851"></a> |
| <span class="sourceLineNo">1852</span> CompletableFuture<List<LogEntry>> getLogEntries(Set<ServerName> serverNames, String logType,<a name="line.1852"></a> |
| <span class="sourceLineNo">1853</span> ServerType serverType, int limit, Map<String, Object> filterParams);<a name="line.1853"></a> |
| <span class="sourceLineNo">1854</span><a name="line.1854"></a> |
| <span class="sourceLineNo">1855</span> /**<a name="line.1855"></a> |
| <span class="sourceLineNo">1856</span> * Flush master local region<a name="line.1856"></a> |
| <span class="sourceLineNo">1857</span> */<a name="line.1857"></a> |
| <span class="sourceLineNo">1858</span> CompletableFuture<Void> flushMasterStore();<a name="line.1858"></a> |
| <span class="sourceLineNo">1859</span><a name="line.1859"></a> |
| <span class="sourceLineNo">1860</span> /**<a name="line.1860"></a> |
| <span class="sourceLineNo">1861</span> * Get the list of cached files<a name="line.1861"></a> |
| <span class="sourceLineNo">1862</span> */<a name="line.1862"></a> |
| <span class="sourceLineNo">1863</span> CompletableFuture<List<String>> getCachedFilesList(ServerName serverName);<a name="line.1863"></a> |
| <span class="sourceLineNo">1864</span>}<a name="line.1864"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
