| <!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.get;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.Closeable;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.IOException;<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.Set;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.concurrent.Future;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.TimeUnit;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.regex.Pattern;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.stream.Collectors;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.conf.Configuration;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.Abortable;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.CacheEvictionStats;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.ClusterMetrics;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.ClusterMetrics.Option;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.NamespaceNotFoundException;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.RegionMetrics;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.ServerName;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.TableExistsException;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.TableName;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.TableNotFoundException;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.client.replication.ReplicationPeerConfigUtil;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.client.replication.TableCFs;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.net.Address;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshotView;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.replication.ReplicationException;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.replication.ReplicationPeerConfig;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.replication.ReplicationPeerDescription;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.replication.SyncReplicationState;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.rsgroup.RSGroupInfo;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>import org.apache.hadoop.hbase.security.access.GetUserPermissionsRequest;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>import org.apache.hadoop.hbase.security.access.Permission;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>import org.apache.hadoop.hbase.security.access.UserPermission;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>import org.apache.hadoop.hbase.snapshot.HBaseSnapshotException;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span>import org.apache.hadoop.hbase.snapshot.RestoreSnapshotException;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span>import org.apache.hadoop.hbase.snapshot.SnapshotCreationException;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span>import org.apache.hadoop.hbase.snapshot.UnknownSnapshotException;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span>import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableList;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span>/**<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * The administrative API for HBase. Obtain an instance from {@link Connection#getAdmin()} and<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * call {@link #close()} when done.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <p>Admin can be used to create, drop, list, enable and disable and otherwise modify tables,<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * as well as perform other administrative operations.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @see ConnectionFactory<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @see Connection<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @see Table<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @since 0.99.0<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span>@InterfaceAudience.Public<a name="line.84"></a> |
| <span class="sourceLineNo">085</span>public interface Admin extends Abortable, Closeable {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Return the operation timeout for a rpc call.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @see #getSyncWaitTimeout()<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> int getOperationTimeout();<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Return the blocking wait time for an asynchronous operation. Can be configured by<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * {@code hbase.client.sync.wait.timeout.msec}.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * <p/><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * For several operations, such as createTable, deleteTable, etc, the rpc call will finish right<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * after we schedule a procedure at master side, so the timeout will not be controlled by the<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * above {@link #getOperationTimeout()}. And timeout value here tells you how much time we will<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * wait until the procedure at master side is finished.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <p/><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * In general, you can consider that the implementation for XXXX method is just a<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * XXXXAsync().get(getSyncWaitTimeout(), TimeUnit.MILLISECONDS).<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @see #getOperationTimeout()<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> int getSyncWaitTimeout();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> @Override<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> void abort(String why, Throwable e);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> @Override<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> boolean isAborted();<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> * @return Connection used by this object.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> Connection getConnection();<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> /**<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @param tableName Table to check.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @return <code>true</code> if table exists already.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @throws IOException if a remote or network exception occurs<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> boolean tableExists(TableName tableName) throws IOException;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> /**<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * List all the userspace tables.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> *<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @return a list of TableDescriptors<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @throws IOException if a remote or network exception occurs<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> */<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> List<TableDescriptor> listTableDescriptors() throws IOException;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> /**<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * List all userspace tables and whether or not include system tables.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> *<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @return a list of TableDescriptors<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @throws IOException if a remote or network exception occurs<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> List<TableDescriptor> listTableDescriptors(boolean includeSysTables) throws IOException;<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> /**<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * List all the userspace tables that match the given pattern.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> *<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @param pattern The compiled regular expression to match against<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @return a list of TableDescriptors<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @throws IOException if a remote or network exception occurs<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @see #listTableDescriptors()<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> */<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> default List<TableDescriptor> listTableDescriptors(Pattern pattern) throws IOException {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return listTableDescriptors(pattern, false);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<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> * List all the tables matching the given pattern.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @param pattern The compiled regular expression to match against<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @param includeSysTables <code>false</code> to match only against userspace tables<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @return a list of TableDescriptors<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @throws IOException if a remote or network exception occurs<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @see #listTableDescriptors()<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> */<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> List<TableDescriptor> listTableDescriptors(Pattern pattern, boolean includeSysTables)<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> throws IOException;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> /**<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * List all of the names of userspace tables.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> *<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return TableName[] table names<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @throws IOException if a remote or network exception occurs<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> TableName[] listTableNames() throws IOException;<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> * List all of the names of userspace tables.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @param pattern The regular expression to match against<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @return array of table names<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @throws IOException if a remote or network exception occurs<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> default TableName[] listTableNames(Pattern pattern) throws IOException {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return listTableNames(pattern, false);<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> /**<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * List all of the names of userspace tables.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @param pattern The regular expression to match against<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @param includeSysTables <code>false</code> to match only against userspace tables<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @return TableName[] table names<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @throws IOException if a remote or network exception occurs<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> TableName[] listTableNames(Pattern pattern, boolean includeSysTables)<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> throws IOException;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> /**<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * Get a table descriptor.<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> *<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * @param tableName as a {@link TableName}<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * @return the tableDescriptor<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * @throws org.apache.hadoop.hbase.TableNotFoundException<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @throws IOException if a remote or network exception occurs<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> */<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> TableDescriptor getDescriptor(TableName tableName)<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> throws TableNotFoundException, IOException;<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> * Creates a new table. Synchronous operation.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> *<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @param desc table descriptor for table<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @throws IOException if a remote or network exception occurs<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> */<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> default void createTable(TableDescriptor desc) throws IOException {<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> get(createTableAsync(desc), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> /**<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * segments to make the required number of total regions. Synchronous operation.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> *<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @param desc table descriptor for table<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * @param startKey beginning of key range<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * @param endKey end of key range<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * @param numRegions the total number of regions to create<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * @throws IOException if a remote or network exception occurs<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> */<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> void createTable(TableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> throws IOException;<a name="line.237"></a> |
| <span class="sourceLineNo">238</span><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> /**<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * The total number of regions created will be the number of split keys plus one. Synchronous<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * operation. Note : Avoid passing empty split key.<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> *<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @param desc table descriptor for table<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @throws IllegalArgumentException if the table name is reserved, if the split keys are repeated<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * and if the split key has empty byte array.<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * @throws IOException if a remote or network exception occurs<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> */<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> default void createTable(TableDescriptor desc, byte[][] splitKeys) throws IOException {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> get(createTableAsync(desc, splitKeys), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> }<a name="line.255"></a> |
| <span class="sourceLineNo">256</span><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> /**<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * Creates a new table but does not block and wait for it to come online. You can use<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * <p/><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * Throws IllegalArgumentException Bad table name, if the split keys are repeated and if the split<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * key has empty byte array.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @param desc table descriptor for table<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @throws IOException if a remote or network exception occurs<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @return the result of the async creation. You can use Future.get(long, TimeUnit) to wait on the<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * operation to complete.<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> */<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> Future<Void> createTableAsync(TableDescriptor desc) throws IOException;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> /**<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * Creates a new table but does not block and wait for it to come online.<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * operation to complete.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * Throws IllegalArgumentException Bad table name, if the split keys<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * are repeated and if the split key has empty byte array.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> *<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * @param desc table descriptor for table<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @throws IOException if a remote or network exception occurs<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * @return the result of the async creation. You can use Future.get(long, TimeUnit) to wait on the<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * operation to complete.<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> */<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> Future<Void> createTableAsync(TableDescriptor desc, byte[][] splitKeys) throws IOException;<a name="line.287"></a> |
| <span class="sourceLineNo">288</span><a name="line.288"></a> |
| <span class="sourceLineNo">289</span> /**<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * Deletes a table. Synchronous operation.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * @param tableName name of table to delete<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * @throws IOException if a remote or network exception occurs<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> */<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> default void deleteTable(TableName tableName) throws IOException {<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> get(deleteTableAsync(tableName), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> }<a name="line.296"></a> |
| <span class="sourceLineNo">297</span><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> /**<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * Deletes the table but does not block and wait for it to be completely removed.<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * operation to complete.<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> *<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * @param tableName name of table to delete<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * @throws IOException if a remote or network exception occurs<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * @return the result of the async delete. You can use Future.get(long, TimeUnit)<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * to wait on the operation to complete.<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> */<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> Future<Void> deleteTableAsync(TableName tableName) throws IOException;<a name="line.310"></a> |
| <span class="sourceLineNo">311</span><a name="line.311"></a> |
| <span class="sourceLineNo">312</span> /**<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * Truncate a table. Synchronous operation.<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * @param tableName name of table to truncate<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * @param preserveSplits <code>true</code> if the splits should be preserved<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * @throws IOException if a remote or network exception occurs<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> */<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> default void truncateTable(TableName tableName, boolean preserveSplits) throws IOException {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> get(truncateTableAsync(tableName, preserveSplits), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> }<a name="line.320"></a> |
| <span class="sourceLineNo">321</span><a name="line.321"></a> |
| <span class="sourceLineNo">322</span> /**<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * Truncate the table but does not block and wait for it to be completely enabled. You can use<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * @param tableName name of table to delete<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * @param preserveSplits <code>true</code> if the splits should be preserved<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * @throws IOException if a remote or network exception occurs<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * @return the result of the async truncate. You can use Future.get(long, TimeUnit) to wait on the<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * operation to complete.<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> */<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> Future<Void> truncateTableAsync(TableName tableName, boolean preserveSplits)<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> throws IOException;<a name="line.334"></a> |
| <span class="sourceLineNo">335</span><a name="line.335"></a> |
| <span class="sourceLineNo">336</span> /**<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * Enable a table. May timeout. Use {@link #enableTableAsync(org.apache.hadoop.hbase.TableName)}<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * and {@link #isTableEnabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * disabled state for it to be enabled.<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @param tableName name of the table<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * @throws IOException There could be couple types of<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * IOException TableNotFoundException means the table doesn't exist.<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * TableNotDisabledException means the table isn't in disabled state.<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * @see #isTableEnabled(org.apache.hadoop.hbase.TableName)<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * @see #disableTable(org.apache.hadoop.hbase.TableName)<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * @see #enableTableAsync(org.apache.hadoop.hbase.TableName)<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> */<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> default void enableTable(TableName tableName) throws IOException {<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> get(enableTableAsync(tableName), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> }<a name="line.350"></a> |
| <span class="sourceLineNo">351</span><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> /**<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * Enable the table but does not block and wait for it to be completely enabled.<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * operation to complete.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> *<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * @param tableName name of table to delete<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * @throws IOException if a remote or network exception occurs<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * @return the result of the async enable. You can use Future.get(long, TimeUnit)<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * to wait on the operation to complete.<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> */<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> Future<Void> enableTableAsync(TableName tableName) throws IOException;<a name="line.364"></a> |
| <span class="sourceLineNo">365</span><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> /**<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * Disable the table but does not block and wait for it to be completely disabled.<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * operation to complete.<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> *<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * @param tableName name of table to delete<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * @throws IOException if a remote or network exception occurs<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * @return the result of the async disable. You can use Future.get(long, TimeUnit)<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * to wait on the operation to complete.<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> */<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> Future<Void> disableTableAsync(TableName tableName) throws IOException;<a name="line.378"></a> |
| <span class="sourceLineNo">379</span><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> /**<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * Disable table and wait on completion. May timeout eventually. Use<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * {@link #disableTableAsync(org.apache.hadoop.hbase.TableName)} and<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * {@link #isTableDisabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * enabled state for it to be disabled.<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * @param tableName<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * @throws IOException There could be couple types of IOException TableNotFoundException means the<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * table doesn't exist. TableNotEnabledException means the table isn't in enabled state.<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> */<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> default void disableTable(TableName tableName) throws IOException {<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> get(disableTableAsync(tableName), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> }<a name="line.391"></a> |
| <span class="sourceLineNo">392</span><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> /**<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * @param tableName name of table to check<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * @return <code>true</code> if table is on-line<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * @throws IOException if a remote or network exception occurs<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> */<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> boolean isTableEnabled(TableName tableName) throws IOException;<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> * @param tableName name of table to check<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * @return <code>true</code> if table is off-line<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> * @throws IOException if a remote or network exception occurs<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> */<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> boolean isTableDisabled(TableName tableName) throws IOException;<a name="line.405"></a> |
| <span class="sourceLineNo">406</span><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> /**<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * @param tableName name of table to check<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * @return <code>true</code> if all regions of the table are available<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @throws IOException if a remote or network exception occurs<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> */<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> boolean isTableAvailable(TableName tableName) throws IOException;<a name="line.412"></a> |
| <span class="sourceLineNo">413</span><a name="line.413"></a> |
| <span class="sourceLineNo">414</span> /**<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * Add a column family to an existing table. Synchronous operation. Use<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * {@link #addColumnFamilyAsync(TableName, ColumnFamilyDescriptor)} instead because it returns a<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * {@link Future} from which you can learn whether success or failure.<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * @param tableName name of the table to add column family to<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * @param columnFamily column family descriptor of column family to be added<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * @throws IOException if a remote or network exception occurs<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> */<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> default void addColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily)<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> throws IOException {<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> get(addColumnFamilyAsync(tableName, columnFamily), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> }<a name="line.425"></a> |
| <span class="sourceLineNo">426</span><a name="line.426"></a> |
| <span class="sourceLineNo">427</span> /**<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * Add a column family to an existing table. Asynchronous operation.<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * operation to complete.<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> *<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> * @param tableName name of the table to add column family to<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * @param columnFamily column family descriptor of column family to be added<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> * @throws IOException if a remote or network exception occurs<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * @return the result of the async add column family. You can use Future.get(long, TimeUnit) to<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * wait on the operation to complete.<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> */<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> Future<Void> addColumnFamilyAsync(TableName tableName, ColumnFamilyDescriptor columnFamily)<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> throws IOException;<a name="line.441"></a> |
| <span class="sourceLineNo">442</span><a name="line.442"></a> |
| <span class="sourceLineNo">443</span> /**<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * Delete a column family from a table. Synchronous operation. Use<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * {@link #deleteColumnFamily(TableName, byte[])} instead because it returns a {@link Future} from<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * which you can learn whether success or failure.<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * @param tableName name of table<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * @param columnFamily name of column family to be deleted<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * @throws IOException if a remote or network exception occurs<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> */<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> default void deleteColumnFamily(TableName tableName, byte[] columnFamily) throws IOException {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> get(deleteColumnFamilyAsync(tableName, columnFamily), getSyncWaitTimeout(),<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> TimeUnit.MILLISECONDS);<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> }<a name="line.454"></a> |
| <span class="sourceLineNo">455</span><a name="line.455"></a> |
| <span class="sourceLineNo">456</span> /**<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> * Delete a column family from a table. Asynchronous operation.<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * operation to complete.<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> *<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * @param tableName name of table<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * @param columnFamily name of column family to be deleted<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> * @throws IOException if a remote or network exception occurs<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * @return the result of the async delete column family. You can use Future.get(long, TimeUnit) to<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * wait on the operation to complete.<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> */<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> Future<Void> deleteColumnFamilyAsync(TableName tableName, byte[] columnFamily)<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> throws IOException;<a name="line.470"></a> |
| <span class="sourceLineNo">471</span><a name="line.471"></a> |
| <span class="sourceLineNo">472</span> /**<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> * Modify an existing column family on a table. Synchronous operation. Use<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> * {@link #modifyColumnFamilyAsync(TableName, ColumnFamilyDescriptor)} instead because it returns<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> * a {@link Future} from which you can learn whether success or failure.<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> * @param tableName name of table<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * @param columnFamily new column family descriptor to use<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * @throws IOException if a remote or network exception occurs<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> */<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> default void modifyColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily)<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> throws IOException {<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> get(modifyColumnFamilyAsync(tableName, columnFamily), getSyncWaitTimeout(),<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> TimeUnit.MILLISECONDS);<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> /**<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * Modify an existing column family on a table. Asynchronous operation.<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> * operation to complete.<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> *<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> * @param tableName name of table<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> * @param columnFamily new column family descriptor to use<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> * @throws IOException if a remote or network exception occurs<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * @return the result of the async modify column family. You can use Future.get(long, TimeUnit) to<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * wait on the operation to complete.<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> */<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> Future<Void> modifyColumnFamilyAsync(TableName tableName, ColumnFamilyDescriptor columnFamily)<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> throws IOException;<a name="line.500"></a> |
| <span class="sourceLineNo">501</span><a name="line.501"></a> |
| <span class="sourceLineNo">502</span> /**<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> * Get all the online regions on a region server.<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> *<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> * @return List of {@link RegionInfo}<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> * @throws IOException if a remote or network exception occurs<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> */<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> List<RegionInfo> getRegions(ServerName serverName) throws IOException;<a name="line.508"></a> |
| <span class="sourceLineNo">509</span><a name="line.509"></a> |
| <span class="sourceLineNo">510</span> /**<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * Flush a table. Synchronous operation.<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> *<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * @param tableName table to flush<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> * @throws IOException if a remote or network exception occurs<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> */<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> void flush(TableName tableName) throws IOException;<a name="line.516"></a> |
| <span class="sourceLineNo">517</span><a name="line.517"></a> |
| <span class="sourceLineNo">518</span> /**<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> * Flush the specified column family stores on all regions of the passed table.<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> * This runs as a synchronous operation.<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> *<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> * @param tableName table to flush<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> * @param columnFamily column family within a table<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> * @throws IOException if a remote or network exception occurs<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> */<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> void flush(TableName tableName, byte[] columnFamily) throws IOException;<a name="line.526"></a> |
| <span class="sourceLineNo">527</span><a name="line.527"></a> |
| <span class="sourceLineNo">528</span> /**<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * Flush an individual region. Synchronous operation.<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> *<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * @param regionName region to flush<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> * @throws IOException if a remote or network exception occurs<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> */<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> void flushRegion(byte[] regionName) throws IOException;<a name="line.534"></a> |
| <span class="sourceLineNo">535</span><a name="line.535"></a> |
| <span class="sourceLineNo">536</span> /**<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * Flush a column family within a region. Synchronous operation.<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> *<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> * @param regionName region to flush<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> * @param columnFamily column family within a region<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> * @throws IOException if a remote or network exception occurs<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> */<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> void flushRegion(byte[] regionName, byte[] columnFamily) throws IOException;<a name="line.543"></a> |
| <span class="sourceLineNo">544</span><a name="line.544"></a> |
| <span class="sourceLineNo">545</span> /**<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> * Flush all regions on the region server. Synchronous operation.<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> * @param serverName the region server name to flush<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> * @throws IOException if a remote or network exception occurs<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> */<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> void flushRegionServer(ServerName serverName) throws IOException;<a name="line.550"></a> |
| <span class="sourceLineNo">551</span><a name="line.551"></a> |
| <span class="sourceLineNo">552</span> /**<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> * Compact a table. Asynchronous operation in that this method requests that a<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> * (it can take a while).<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> *<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> * @param tableName table to compact<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> * @throws IOException if a remote or network exception occurs<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> */<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> void compact(TableName tableName) throws IOException;<a name="line.560"></a> |
| <span class="sourceLineNo">561</span><a name="line.561"></a> |
| <span class="sourceLineNo">562</span> /**<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> * Compact an individual region. Asynchronous operation in that this method requests that a<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> * (it can take a while).<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> *<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> * @param regionName region to compact<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> * @throws IOException if a remote or network exception occurs<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> */<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> void compactRegion(byte[] regionName) throws IOException;<a name="line.570"></a> |
| <span class="sourceLineNo">571</span><a name="line.571"></a> |
| <span class="sourceLineNo">572</span> /**<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> * Compact a column family within a table. Asynchronous operation in that this method requests<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> * (it can take a while).<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> *<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> * @param tableName table to compact<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> * @param columnFamily column family within a table<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> * @throws IOException if a remote or network exception occurs<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> */<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> void compact(TableName tableName, byte[] columnFamily)<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> throws IOException;<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> * Compact a column family within a region. Asynchronous operation in that this method requests<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * (it can take a while).<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> *<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> * @param regionName region to compact<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> * @param columnFamily column family within a region<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> * @throws IOException if a remote or network exception occurs<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> */<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> void compactRegion(byte[] regionName, byte[] columnFamily)<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> throws IOException;<a name="line.594"></a> |
| <span class="sourceLineNo">595</span><a name="line.595"></a> |
| <span class="sourceLineNo">596</span> /**<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> * Compact a table. Asynchronous operation in that this method requests that a<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> * (it can take a while).<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> *<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> * @param tableName table to compact<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> * @throws IOException if a remote or network exception occurs<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> * @throws InterruptedException<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> */<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> void compact(TableName tableName, CompactType compactType)<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> throws IOException, InterruptedException;<a name="line.607"></a> |
| <span class="sourceLineNo">608</span><a name="line.608"></a> |
| <span class="sourceLineNo">609</span> /**<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> * Compact a column family within a table. Asynchronous operation in that this method<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> * requests that a Compaction run and then it returns. It does not wait on the<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> * completion of Compaction (it can take a while).<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> *<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> * @param tableName table to compact<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> * @param columnFamily column family within a table<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> * @throws IOException if not a mob column family or if a remote or network exception occurs<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> * @throws InterruptedException<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> */<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> void compact(TableName tableName, byte[] columnFamily, CompactType compactType)<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> throws IOException, InterruptedException;<a name="line.621"></a> |
| <span class="sourceLineNo">622</span><a name="line.622"></a> |
| <span class="sourceLineNo">623</span> /**<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> * Major compact a table. Asynchronous operation in that this method requests<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> * (it can take a while).<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> *<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> * @param tableName table to major compact<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> * @throws IOException if a remote or network exception occurs<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> */<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> void majorCompact(TableName tableName) throws IOException;<a name="line.631"></a> |
| <span class="sourceLineNo">632</span><a name="line.632"></a> |
| <span class="sourceLineNo">633</span> /**<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> * Major compact a table or an individual region. Asynchronous operation in that this method requests<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> * (it can take a while).<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> *<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * @param regionName region to major compact<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> * @throws IOException if a remote or network exception occurs<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> */<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> void majorCompactRegion(byte[] regionName) throws IOException;<a name="line.641"></a> |
| <span class="sourceLineNo">642</span><a name="line.642"></a> |
| <span class="sourceLineNo">643</span> /**<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> * Major compact a column family within a table. Asynchronous operation in that this method requests<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> * (it can take a while).<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> *<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> * @param tableName table to major compact<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> * @param columnFamily column family within a table<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> * @throws IOException if a remote or network exception occurs<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> */<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> void majorCompact(TableName tableName, byte[] columnFamily)<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> throws IOException;<a name="line.653"></a> |
| <span class="sourceLineNo">654</span><a name="line.654"></a> |
| <span class="sourceLineNo">655</span> /**<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> * Major compact a column family within region. Asynchronous operation in that this method requests<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> * (it can take a while).<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> *<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> * @param regionName egion to major compact<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> * @param columnFamily column family within a region<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> * @throws IOException if a remote or network exception occurs<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> */<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> void majorCompactRegion(byte[] regionName, byte[] columnFamily)<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> throws IOException;<a name="line.665"></a> |
| <span class="sourceLineNo">666</span><a name="line.666"></a> |
| <span class="sourceLineNo">667</span> /**<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> * Major compact a table. Asynchronous operation in that this method requests that a<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> * (it can take a while).<a name="line.670"></a> |
| <span class="sourceLineNo">671</span> *<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * @param tableName table to compact<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> * @throws IOException if a remote or network exception occurs<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> * @throws InterruptedException<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> */<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> void majorCompact(TableName tableName, CompactType compactType)<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> throws IOException, InterruptedException;<a name="line.678"></a> |
| <span class="sourceLineNo">679</span><a name="line.679"></a> |
| <span class="sourceLineNo">680</span> /**<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> * Major compact a column family within a table. Asynchronous operation in that this method requests that a<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> * (it can take a while).<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> *<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> * @param tableName table to compact<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> * @param columnFamily column family within a table<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> * @throws IOException if not a mob column family or if a remote or network exception occurs<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> * @throws InterruptedException<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> */<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> void majorCompact(TableName tableName, byte[] columnFamily, CompactType compactType)<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> throws IOException, InterruptedException;<a name="line.692"></a> |
| <span class="sourceLineNo">693</span><a name="line.693"></a> |
| <span class="sourceLineNo">694</span> /**<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> * Turn the compaction on or off. Disabling compactions will also interrupt any currently ongoing<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> * compactions. This state is ephemeral. The setting will be lost on restart. Compaction<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> * can also be enabled/disabled by modifying configuration hbase.regionserver.compaction.enabled<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> * in hbase-site.xml.<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> *<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> * @param switchState Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> * @param serverNamesList list of region servers.<a name="line.701"></a> |
| <span class="sourceLineNo">702</span> * @return Previous compaction states for region servers<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> * @throws IOException if a remote or network exception occurs<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> */<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> Map<ServerName, Boolean> compactionSwitch(boolean switchState, List<String> serverNamesList)<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> throws IOException;<a name="line.706"></a> |
| <span class="sourceLineNo">707</span><a name="line.707"></a> |
| <span class="sourceLineNo">708</span> /**<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> * Compact all regions on the region server. Asynchronous operation in that this method requests<a name="line.709"></a> |
| <span class="sourceLineNo">710</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction (it<a name="line.710"></a> |
| <span class="sourceLineNo">711</span> * can take a while).<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> * @param serverName the region server name<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> * @throws IOException if a remote or network exception occurs<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> */<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> void compactRegionServer(ServerName serverName) throws IOException;<a name="line.715"></a> |
| <span class="sourceLineNo">716</span><a name="line.716"></a> |
| <span class="sourceLineNo">717</span> /**<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> * Major compact all regions on the region server. Asynchronous operation in that this method<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> * requests that a Compaction run and then it returns. It does not wait on the completion of<a name="line.719"></a> |
| <span class="sourceLineNo">720</span> * Compaction (it can take a while).<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> * @param serverName the region server name<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> * @throws IOException if a remote or network exception occurs<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> */<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> void majorCompactRegionServer(ServerName serverName) throws IOException;<a name="line.724"></a> |
| <span class="sourceLineNo">725</span><a name="line.725"></a> |
| <span class="sourceLineNo">726</span> /**<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> * Move the region <code>encodedRegionName</code> to a random server.<a name="line.727"></a> |
| <span class="sourceLineNo">728</span> * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name<a name="line.728"></a> |
| <span class="sourceLineNo">729</span> * suffix: e.g. if regionname is<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>,<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>.<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> * @throws IOException if we can't find a region named <code>encodedRegionName</code><a name="line.732"></a> |
| <span class="sourceLineNo">733</span> */<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> void move(byte[] encodedRegionName) throws IOException;<a name="line.734"></a> |
| <span class="sourceLineNo">735</span><a name="line.735"></a> |
| <span class="sourceLineNo">736</span> /**<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> * Move the region <code>rencodedRegionName</code> to <code>destServerName</code>.<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> * suffix: e.g. if regionname is<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>,<a name="line.740"></a> |
| <span class="sourceLineNo">741</span> * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>.<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> * @param destServerName The servername of the destination regionserver. If passed the empty byte<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> * array we'll assign to a random server. A server name is made of host, port and<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> * startcode. Here is an example: <code> host187.example.com,60020,1289493121758</code><a name="line.744"></a> |
| <span class="sourceLineNo">745</span> * @throws IOException if we can't find a region named <code>encodedRegionName</code><a name="line.745"></a> |
| <span class="sourceLineNo">746</span> * @deprecated since 2.2.0 and will be removed in 4.0.0. Use {@link #move(byte[], ServerName)}<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> * instead. And if you want to move the region to a random server, please use<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> * {@link #move(byte[])}.<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-22108">HBASE-22108</a><a name="line.749"></a> |
| <span class="sourceLineNo">750</span> */<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> @Deprecated<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> default void move(byte[] encodedRegionName, byte[] destServerName) throws IOException {<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> if (destServerName == null || destServerName.length == 0) {<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> move(encodedRegionName);<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> } else {<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> move(encodedRegionName, ServerName.valueOf(Bytes.toString(destServerName)));<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> }<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> }<a name="line.758"></a> |
| <span class="sourceLineNo">759</span><a name="line.759"></a> |
| <span class="sourceLineNo">760</span> /**<a name="line.760"></a> |
| <span class="sourceLineNo">761</span> * Move the region <code>encodedRegionName</code> to <code>destServerName</code>.<a name="line.761"></a> |
| <span class="sourceLineNo">762</span> * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name<a name="line.762"></a> |
| <span class="sourceLineNo">763</span> * suffix: e.g. if regionname is<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>,<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>.<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> * @param destServerName The servername of the destination regionserver. A server name is made of<a name="line.766"></a> |
| <span class="sourceLineNo">767</span> * host, port and startcode. Here is an example:<a name="line.767"></a> |
| <span class="sourceLineNo">768</span> * <code> host187.example.com,60020,1289493121758</code><a name="line.768"></a> |
| <span class="sourceLineNo">769</span> * @throws IOException if we can't find a region named <code>encodedRegionName</code><a name="line.769"></a> |
| <span class="sourceLineNo">770</span> */<a name="line.770"></a> |
| <span class="sourceLineNo">771</span> void move(byte[] encodedRegionName, ServerName destServerName) throws IOException;<a name="line.771"></a> |
| <span class="sourceLineNo">772</span><a name="line.772"></a> |
| <span class="sourceLineNo">773</span> /**<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> * Assign a Region.<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> * @param regionName Region name to assign.<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> * @throws IOException if a remote or network exception occurs<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> */<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> void assign(byte[] regionName) throws IOException;<a name="line.778"></a> |
| <span class="sourceLineNo">779</span><a name="line.779"></a> |
| <span class="sourceLineNo">780</span> /**<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> * Unassign a Region.<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> * @param regionName Region name to assign.<a name="line.782"></a> |
| <span class="sourceLineNo">783</span> * @throws IOException if a remote or network exception occurs<a name="line.783"></a> |
| <span class="sourceLineNo">784</span> */<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> void unassign(byte[] regionName) throws IOException;<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> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use {@link<a name="line.789"></a> |
| <span class="sourceLineNo">790</span> * #move(byte[], ServerName)} if you want to control the region movement.<a name="line.790"></a> |
| <span class="sourceLineNo">791</span> *<a name="line.791"></a> |
| <span class="sourceLineNo">792</span> * @param regionName Region to unassign. Will clear any existing RegionPlan if one found.<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> * @param force If <code>true</code>, force unassign (Will remove region from regions-in-transition too if<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> * present. If results in double assignment use hbck -fix to resolve. To be used by experts).<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> * @throws IOException if a remote or network exception occurs<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> * @deprecated since 2.4.0 and will be removed in 4.0.0. Use {@link #unassign(byte[])}<a name="line.796"></a> |
| <span class="sourceLineNo">797</span> * instead.<a name="line.797"></a> |
| <span class="sourceLineNo">798</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-24875">HBASE-24875</a><a name="line.798"></a> |
| <span class="sourceLineNo">799</span> */<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> @Deprecated<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> default void unassign(byte[] regionName, boolean force) throws IOException {<a name="line.801"></a> |
| <span class="sourceLineNo">802</span> unassign(regionName);<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> }<a name="line.803"></a> |
| <span class="sourceLineNo">804</span><a name="line.804"></a> |
| <span class="sourceLineNo">805</span> /**<a name="line.805"></a> |
| <span class="sourceLineNo">806</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.806"></a> |
| <span class="sourceLineNo">807</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.807"></a> |
| <span class="sourceLineNo">808</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.808"></a> |
| <span class="sourceLineNo">809</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> * experts or hbck.<a name="line.810"></a> |
| <span class="sourceLineNo">811</span> *<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> * @param regionName Region to offline.<a name="line.812"></a> |
| <span class="sourceLineNo">813</span> * @throws IOException if a remote or network exception occurs<a name="line.813"></a> |
| <span class="sourceLineNo">814</span> */<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> void offline(byte[] regionName) throws IOException;<a name="line.815"></a> |
| <span class="sourceLineNo">816</span><a name="line.816"></a> |
| <span class="sourceLineNo">817</span> /**<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> * Turn the load balancer on or off.<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> * @param onOrOff Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> * @param synchronous If <code>true</code>, it waits until current balance() call, if outstanding,<a name="line.820"></a> |
| <span class="sourceLineNo">821</span> * to return.<a name="line.821"></a> |
| <span class="sourceLineNo">822</span> * @return Previous balancer value<a name="line.822"></a> |
| <span class="sourceLineNo">823</span> * @throws IOException if a remote or network exception occurs<a name="line.823"></a> |
| <span class="sourceLineNo">824</span> */<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> boolean balancerSwitch(boolean onOrOff, boolean synchronous) throws IOException;<a name="line.825"></a> |
| <span class="sourceLineNo">826</span><a name="line.826"></a> |
| <span class="sourceLineNo">827</span> /**<a name="line.827"></a> |
| <span class="sourceLineNo">828</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.828"></a> |
| <span class="sourceLineNo">829</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.829"></a> |
| <span class="sourceLineNo">830</span> *<a name="line.830"></a> |
| <span class="sourceLineNo">831</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> * @throws IOException if a remote or network exception occurs<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> */<a name="line.833"></a> |
| <span class="sourceLineNo">834</span> boolean balance() throws IOException;<a name="line.834"></a> |
| <span class="sourceLineNo">835</span><a name="line.835"></a> |
| <span class="sourceLineNo">836</span> /**<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> * Invoke the balancer. Will run the balancer and if regions to move, it will<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> * go ahead and do the reassignments. If there is region in transition, force parameter of true<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> * would still run balancer. Can *not* run for other reasons. Check<a name="line.839"></a> |
| <span class="sourceLineNo">840</span> * logs.<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> * @param force whether we should force balance even if there is region in transition<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> * @throws IOException if a remote or network exception occurs<a name="line.843"></a> |
| <span class="sourceLineNo">844</span> */<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> boolean balance(boolean force) throws IOException;<a name="line.845"></a> |
| <span class="sourceLineNo">846</span><a name="line.846"></a> |
| <span class="sourceLineNo">847</span> /**<a name="line.847"></a> |
| <span class="sourceLineNo">848</span> * Query the current state of the balancer.<a name="line.848"></a> |
| <span class="sourceLineNo">849</span> *<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> * @return <code>true</code> if the balancer is enabled, <code>false</code> otherwise.<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> * @throws IOException if a remote or network exception occurs<a name="line.851"></a> |
| <span class="sourceLineNo">852</span> */<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> boolean isBalancerEnabled() throws IOException;<a name="line.853"></a> |
| <span class="sourceLineNo">854</span><a name="line.854"></a> |
| <span class="sourceLineNo">855</span> /**<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> * Clear all the blocks corresponding to this table from BlockCache. For expert-admins.<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> * Calling this API will drop all the cached blocks specific to a table from BlockCache.<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> * This can significantly impact the query performance as the subsequent queries will<a name="line.858"></a> |
| <span class="sourceLineNo">859</span> * have to retrieve the blocks from underlying filesystem.<a name="line.859"></a> |
| <span class="sourceLineNo">860</span> *<a name="line.860"></a> |
| <span class="sourceLineNo">861</span> * @param tableName table to clear block cache<a name="line.861"></a> |
| <span class="sourceLineNo">862</span> * @return CacheEvictionStats related to the eviction<a name="line.862"></a> |
| <span class="sourceLineNo">863</span> * @throws IOException if a remote or network exception occurs<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> */<a name="line.864"></a> |
| <span class="sourceLineNo">865</span> CacheEvictionStats clearBlockCache(final TableName tableName) throws IOException;<a name="line.865"></a> |
| <span class="sourceLineNo">866</span><a name="line.866"></a> |
| <span class="sourceLineNo">867</span> /**<a name="line.867"></a> |
| <span class="sourceLineNo">868</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> * This is a non-blocking invocation to region normalizer. If return value is true, it means<a name="line.869"></a> |
| <span class="sourceLineNo">870</span> * the request was submitted successfully. We need to check logs for the details of which regions<a name="line.870"></a> |
| <span class="sourceLineNo">871</span> * were split/merged.<a name="line.871"></a> |
| <span class="sourceLineNo">872</span> *<a name="line.872"></a> |
| <span class="sourceLineNo">873</span> * @return {@code true} if region normalizer ran, {@code false} otherwise.<a name="line.873"></a> |
| <span class="sourceLineNo">874</span> * @throws IOException if a remote or network exception occurs<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> */<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> default boolean normalize() throws IOException {<a name="line.876"></a> |
| <span class="sourceLineNo">877</span> return normalize(new NormalizeTableFilterParams.Builder().build());<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> }<a name="line.878"></a> |
| <span class="sourceLineNo">879</span><a name="line.879"></a> |
| <span class="sourceLineNo">880</span> /**<a name="line.880"></a> |
| <span class="sourceLineNo">881</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.881"></a> |
| <span class="sourceLineNo">882</span> * This is a non-blocking invocation to region normalizer. If return value is true, it means<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> * the request was submitted successfully. We need to check logs for the details of which regions<a name="line.883"></a> |
| <span class="sourceLineNo">884</span> * were split/merged.<a name="line.884"></a> |
| <span class="sourceLineNo">885</span> *<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> * @param ntfp limit to tables matching the specified filter.<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> * @return {@code true} if region normalizer ran, {@code false} otherwise.<a name="line.887"></a> |
| <span class="sourceLineNo">888</span> * @throws IOException if a remote or network exception occurs<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> */<a name="line.889"></a> |
| <span class="sourceLineNo">890</span> boolean normalize(NormalizeTableFilterParams ntfp) throws IOException;<a name="line.890"></a> |
| <span class="sourceLineNo">891</span><a name="line.891"></a> |
| <span class="sourceLineNo">892</span> /**<a name="line.892"></a> |
| <span class="sourceLineNo">893</span> * Query the current state of the region normalizer.<a name="line.893"></a> |
| <span class="sourceLineNo">894</span> *<a name="line.894"></a> |
| <span class="sourceLineNo">895</span> * @return <code>true</code> if region normalizer is enabled, <code>false</code> otherwise.<a name="line.895"></a> |
| <span class="sourceLineNo">896</span> * @throws IOException if a remote or network exception occurs<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> */<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> boolean isNormalizerEnabled() throws IOException;<a name="line.898"></a> |
| <span class="sourceLineNo">899</span><a name="line.899"></a> |
| <span class="sourceLineNo">900</span> /**<a name="line.900"></a> |
| <span class="sourceLineNo">901</span> * Turn region normalizer on or off.<a name="line.901"></a> |
| <span class="sourceLineNo">902</span> *<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> * @return Previous normalizer value<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> * @throws IOException if a remote or network exception occurs<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> */<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> boolean normalizerSwitch(boolean on) throws IOException;<a name="line.906"></a> |
| <span class="sourceLineNo">907</span><a name="line.907"></a> |
| <span class="sourceLineNo">908</span> /**<a name="line.908"></a> |
| <span class="sourceLineNo">909</span> * Enable/Disable the catalog janitor/<a name="line.909"></a> |
| <span class="sourceLineNo">910</span> *<a name="line.910"></a> |
| <span class="sourceLineNo">911</span> * @param onOrOff if <code>true</code> enables the catalog janitor<a name="line.911"></a> |
| <span class="sourceLineNo">912</span> * @return the previous state<a name="line.912"></a> |
| <span class="sourceLineNo">913</span> * @throws IOException if a remote or network exception occurs<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> */<a name="line.914"></a> |
| <span class="sourceLineNo">915</span> boolean catalogJanitorSwitch(boolean onOrOff) throws IOException;<a name="line.915"></a> |
| <span class="sourceLineNo">916</span><a name="line.916"></a> |
| <span class="sourceLineNo">917</span> /**<a name="line.917"></a> |
| <span class="sourceLineNo">918</span> * Ask for a scan of the catalog table.<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> *<a name="line.919"></a> |
| <span class="sourceLineNo">920</span> * @return the number of entries cleaned. Returns -1 if previous run is in progress.<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> * @throws IOException if a remote or network exception occurs<a name="line.921"></a> |
| <span class="sourceLineNo">922</span> */<a name="line.922"></a> |
| <span class="sourceLineNo">923</span> int runCatalogJanitor() throws IOException;<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> * Query on the catalog janitor state (Enabled/Disabled?).<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> *<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> * @throws IOException if a remote or network exception occurs<a name="line.928"></a> |
| <span class="sourceLineNo">929</span> */<a name="line.929"></a> |
| <span class="sourceLineNo">930</span> boolean isCatalogJanitorEnabled() throws IOException;<a name="line.930"></a> |
| <span class="sourceLineNo">931</span><a name="line.931"></a> |
| <span class="sourceLineNo">932</span> /**<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> * Enable/Disable the cleaner chore.<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> *<a name="line.934"></a> |
| <span class="sourceLineNo">935</span> * @param onOrOff if <code>true</code> enables the cleaner chore<a name="line.935"></a> |
| <span class="sourceLineNo">936</span> * @return the previous state<a name="line.936"></a> |
| <span class="sourceLineNo">937</span> * @throws IOException if a remote or network exception occurs<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> */<a name="line.938"></a> |
| <span class="sourceLineNo">939</span> boolean cleanerChoreSwitch(boolean onOrOff) throws IOException;<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> * Ask for cleaner chore to run.<a name="line.942"></a> |
| <span class="sourceLineNo">943</span> *<a name="line.943"></a> |
| <span class="sourceLineNo">944</span> * @return <code>true</code> if cleaner chore ran, <code>false</code> otherwise<a name="line.944"></a> |
| <span class="sourceLineNo">945</span> * @throws IOException if a remote or network exception occurs<a name="line.945"></a> |
| <span class="sourceLineNo">946</span> */<a name="line.946"></a> |
| <span class="sourceLineNo">947</span> boolean runCleanerChore() throws IOException;<a name="line.947"></a> |
| <span class="sourceLineNo">948</span><a name="line.948"></a> |
| <span class="sourceLineNo">949</span> /**<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> * Query on the cleaner chore state (Enabled/Disabled?).<a name="line.950"></a> |
| <span class="sourceLineNo">951</span> *<a name="line.951"></a> |
| <span class="sourceLineNo">952</span> * @throws IOException if a remote or network exception occurs<a name="line.952"></a> |
| <span class="sourceLineNo">953</span> */<a name="line.953"></a> |
| <span class="sourceLineNo">954</span> boolean isCleanerChoreEnabled() throws IOException;<a name="line.954"></a> |
| <span class="sourceLineNo">955</span><a name="line.955"></a> |
| <span class="sourceLineNo">956</span><a name="line.956"></a> |
| <span class="sourceLineNo">957</span> /**<a name="line.957"></a> |
| <span class="sourceLineNo">958</span> * Merge two regions. Asynchronous operation.<a name="line.958"></a> |
| <span class="sourceLineNo">959</span> * @param nameOfRegionA encoded or full name of region a<a name="line.959"></a> |
| <span class="sourceLineNo">960</span> * @param nameOfRegionB encoded or full name of region b<a name="line.960"></a> |
| <span class="sourceLineNo">961</span> * @param forcible <code>true</code> if do a compulsory merge, otherwise we will only merge two<a name="line.961"></a> |
| <span class="sourceLineNo">962</span> * adjacent regions<a name="line.962"></a> |
| <span class="sourceLineNo">963</span> * @throws IOException if a remote or network exception occurs<a name="line.963"></a> |
| <span class="sourceLineNo">964</span> * @deprecated since 2.3.0 and will be removed in 4.0.0. Multi-region merge feature is now<a name="line.964"></a> |
| <span class="sourceLineNo">965</span> * supported. Use {@link #mergeRegionsAsync(byte[][], boolean)} instead.<a name="line.965"></a> |
| <span class="sourceLineNo">966</span> */<a name="line.966"></a> |
| <span class="sourceLineNo">967</span> @Deprecated<a name="line.967"></a> |
| <span class="sourceLineNo">968</span> default Future<Void> mergeRegionsAsync(byte[] nameOfRegionA, byte[] nameOfRegionB,<a name="line.968"></a> |
| <span class="sourceLineNo">969</span> boolean forcible) throws IOException {<a name="line.969"></a> |
| <span class="sourceLineNo">970</span> byte[][] nameofRegionsToMerge = new byte[2][];<a name="line.970"></a> |
| <span class="sourceLineNo">971</span> nameofRegionsToMerge[0] = nameOfRegionA;<a name="line.971"></a> |
| <span class="sourceLineNo">972</span> nameofRegionsToMerge[1] = nameOfRegionB;<a name="line.972"></a> |
| <span class="sourceLineNo">973</span> return mergeRegionsAsync(nameofRegionsToMerge, forcible);<a name="line.973"></a> |
| <span class="sourceLineNo">974</span> }<a name="line.974"></a> |
| <span class="sourceLineNo">975</span><a name="line.975"></a> |
| <span class="sourceLineNo">976</span> /**<a name="line.976"></a> |
| <span class="sourceLineNo">977</span> * Merge multiple regions (>=2). Asynchronous operation.<a name="line.977"></a> |
| <span class="sourceLineNo">978</span> * @param nameofRegionsToMerge encoded or full name of daughter regions<a name="line.978"></a> |
| <span class="sourceLineNo">979</span> * @param forcible <code>true</code> if do a compulsory merge, otherwise we will only merge<a name="line.979"></a> |
| <span class="sourceLineNo">980</span> * adjacent regions<a name="line.980"></a> |
| <span class="sourceLineNo">981</span> * @throws IOException if a remote or network exception occurs<a name="line.981"></a> |
| <span class="sourceLineNo">982</span> */<a name="line.982"></a> |
| <span class="sourceLineNo">983</span> Future<Void> mergeRegionsAsync(byte[][] nameofRegionsToMerge, boolean forcible)<a name="line.983"></a> |
| <span class="sourceLineNo">984</span> throws IOException;<a name="line.984"></a> |
| <span class="sourceLineNo">985</span><a name="line.985"></a> |
| <span class="sourceLineNo">986</span> /**<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> * Split a table. The method will execute split action for each region in table.<a name="line.987"></a> |
| <span class="sourceLineNo">988</span> * @param tableName table to split<a name="line.988"></a> |
| <span class="sourceLineNo">989</span> * @throws IOException if a remote or network exception occurs<a name="line.989"></a> |
| <span class="sourceLineNo">990</span> */<a name="line.990"></a> |
| <span class="sourceLineNo">991</span> void split(TableName tableName) throws IOException;<a name="line.991"></a> |
| <span class="sourceLineNo">992</span><a name="line.992"></a> |
| <span class="sourceLineNo">993</span> /**<a name="line.993"></a> |
| <span class="sourceLineNo">994</span> * Split a table.<a name="line.994"></a> |
| <span class="sourceLineNo">995</span> * @param tableName table to split<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> * @param splitPoint the explicit position to split on<a name="line.996"></a> |
| <span class="sourceLineNo">997</span> * @throws IOException if a remote or network exception occurs<a name="line.997"></a> |
| <span class="sourceLineNo">998</span> */<a name="line.998"></a> |
| <span class="sourceLineNo">999</span> void split(TableName tableName, byte[] splitPoint) throws IOException;<a name="line.999"></a> |
| <span class="sourceLineNo">1000</span><a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span> /**<a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> * Split an individual region. Asynchronous operation.<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span> * @param regionName region to split<a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span> * @throws IOException if a remote or network exception occurs<a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span> */<a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> Future<Void> splitRegionAsync(byte[] regionName) throws IOException;<a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span><a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> /**<a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span> * Split an individual region. Asynchronous operation.<a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> * @param regionName region to split<a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> * @param splitPoint the explicit position to split on<a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> * @throws IOException if a remote or network exception occurs<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span> */<a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> Future<Void> splitRegionAsync(byte[] regionName, byte[] splitPoint) throws IOException;<a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span><a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span> /**<a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> * Modify an existing table, more IRB friendly version.<a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> * @param td modified description of the table<a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> * @throws IOException if a remote or network exception occurs<a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> */<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span> default void modifyTable(TableDescriptor td) throws IOException {<a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> get(modifyTableAsync(td), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<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> /**<a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> * Modify an existing table, more IRB (ruby) friendly version. Asynchronous operation. This means<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> * that it may be a while before your schema change is updated across all of the table. You can<a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> * use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span> * @param td description of the table<a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> * @throws IOException if a remote or network exception occurs<a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> * @return the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> * operation to complete<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span> */<a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span> Future<Void> modifyTableAsync(TableDescriptor td) throws IOException;<a name="line.1036"></a> |
| <span class="sourceLineNo">1037</span><a name="line.1037"></a> |
| <span class="sourceLineNo">1038</span> /**<a name="line.1038"></a> |
| <span class="sourceLineNo">1039</span> * Shuts down the HBase cluster.<a name="line.1039"></a> |
| <span class="sourceLineNo">1040</span> * <p/><a name="line.1040"></a> |
| <span class="sourceLineNo">1041</span> * Notice that, a success shutdown call may ends with an error since the remote server has already<a name="line.1041"></a> |
| <span class="sourceLineNo">1042</span> * been shutdown.<a name="line.1042"></a> |
| <span class="sourceLineNo">1043</span> * @throws IOException if a remote or network exception occurs<a name="line.1043"></a> |
| <span class="sourceLineNo">1044</span> */<a name="line.1044"></a> |
| <span class="sourceLineNo">1045</span> void shutdown() throws IOException;<a name="line.1045"></a> |
| <span class="sourceLineNo">1046</span><a name="line.1046"></a> |
| <span class="sourceLineNo">1047</span> /**<a name="line.1047"></a> |
| <span class="sourceLineNo">1048</span> * Shuts down the current HBase master only. Does not shutdown the cluster.<a name="line.1048"></a> |
| <span class="sourceLineNo">1049</span> * <p/><a name="line.1049"></a> |
| <span class="sourceLineNo">1050</span> * Notice that, a success stopMaster call may ends with an error since the remote server has<a name="line.1050"></a> |
| <span class="sourceLineNo">1051</span> * already been shutdown.<a name="line.1051"></a> |
| <span class="sourceLineNo">1052</span> * @throws IOException if a remote or network exception occurs<a name="line.1052"></a> |
| <span class="sourceLineNo">1053</span> * @see #shutdown()<a name="line.1053"></a> |
| <span class="sourceLineNo">1054</span> */<a name="line.1054"></a> |
| <span class="sourceLineNo">1055</span> void stopMaster() throws IOException;<a name="line.1055"></a> |
| <span class="sourceLineNo">1056</span><a name="line.1056"></a> |
| <span class="sourceLineNo">1057</span> /**<a name="line.1057"></a> |
| <span class="sourceLineNo">1058</span> * Check whether Master is in maintenance mode.<a name="line.1058"></a> |
| <span class="sourceLineNo">1059</span> *<a name="line.1059"></a> |
| <span class="sourceLineNo">1060</span> * @throws IOException if a remote or network exception occurs<a name="line.1060"></a> |
| <span class="sourceLineNo">1061</span> */<a name="line.1061"></a> |
| <span class="sourceLineNo">1062</span> boolean isMasterInMaintenanceMode() throws IOException;<a name="line.1062"></a> |
| <span class="sourceLineNo">1063</span><a name="line.1063"></a> |
| <span class="sourceLineNo">1064</span> /**<a name="line.1064"></a> |
| <span class="sourceLineNo">1065</span> * Stop the designated regionserver.<a name="line.1065"></a> |
| <span class="sourceLineNo">1066</span> *<a name="line.1066"></a> |
| <span class="sourceLineNo">1067</span> * @param hostnamePort Hostname and port delimited by a <code>:</code> as in<a name="line.1067"></a> |
| <span class="sourceLineNo">1068</span> * <code>example.org:1234</code><a name="line.1068"></a> |
| <span class="sourceLineNo">1069</span> * @throws IOException if a remote or network exception occurs<a name="line.1069"></a> |
| <span class="sourceLineNo">1070</span> */<a name="line.1070"></a> |
| <span class="sourceLineNo">1071</span> void stopRegionServer(String hostnamePort) throws IOException;<a name="line.1071"></a> |
| <span class="sourceLineNo">1072</span><a name="line.1072"></a> |
| <span class="sourceLineNo">1073</span> /**<a name="line.1073"></a> |
| <span class="sourceLineNo">1074</span> * Get whole cluster metrics, containing status about:<a name="line.1074"></a> |
| <span class="sourceLineNo">1075</span> * <pre><a name="line.1075"></a> |
| <span class="sourceLineNo">1076</span> * hbase version<a name="line.1076"></a> |
| <span class="sourceLineNo">1077</span> * cluster id<a name="line.1077"></a> |
| <span class="sourceLineNo">1078</span> * primary/backup master(s)<a name="line.1078"></a> |
| <span class="sourceLineNo">1079</span> * master's coprocessors<a name="line.1079"></a> |
| <span class="sourceLineNo">1080</span> * live/dead regionservers<a name="line.1080"></a> |
| <span class="sourceLineNo">1081</span> * balancer<a name="line.1081"></a> |
| <span class="sourceLineNo">1082</span> * regions in transition<a name="line.1082"></a> |
| <span class="sourceLineNo">1083</span> * </pre><a name="line.1083"></a> |
| <span class="sourceLineNo">1084</span> * @return cluster metrics<a name="line.1084"></a> |
| <span class="sourceLineNo">1085</span> * @throws IOException if a remote or network exception occurs<a name="line.1085"></a> |
| <span class="sourceLineNo">1086</span> */<a name="line.1086"></a> |
| <span class="sourceLineNo">1087</span> default ClusterMetrics getClusterMetrics() throws IOException {<a name="line.1087"></a> |
| <span class="sourceLineNo">1088</span> return getClusterMetrics(EnumSet.allOf(ClusterMetrics.Option.class));<a name="line.1088"></a> |
| <span class="sourceLineNo">1089</span> }<a name="line.1089"></a> |
| <span class="sourceLineNo">1090</span><a name="line.1090"></a> |
| <span class="sourceLineNo">1091</span> /**<a name="line.1091"></a> |
| <span class="sourceLineNo">1092</span> * Get cluster status with a set of {@link Option} to get desired status.<a name="line.1092"></a> |
| <span class="sourceLineNo">1093</span> * @return cluster status<a name="line.1093"></a> |
| <span class="sourceLineNo">1094</span> * @throws IOException if a remote or network exception occurs<a name="line.1094"></a> |
| <span class="sourceLineNo">1095</span> */<a name="line.1095"></a> |
| <span class="sourceLineNo">1096</span> ClusterMetrics getClusterMetrics(EnumSet<Option> options) throws IOException;<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> * @return current master server name<a name="line.1099"></a> |
| <span class="sourceLineNo">1100</span> * @throws IOException if a remote or network exception occurs<a name="line.1100"></a> |
| <span class="sourceLineNo">1101</span> */<a name="line.1101"></a> |
| <span class="sourceLineNo">1102</span> default ServerName getMaster() throws IOException {<a name="line.1102"></a> |
| <span class="sourceLineNo">1103</span> return getClusterMetrics(EnumSet.of(Option.MASTER)).getMasterName();<a name="line.1103"></a> |
| <span class="sourceLineNo">1104</span> }<a name="line.1104"></a> |
| <span class="sourceLineNo">1105</span><a name="line.1105"></a> |
| <span class="sourceLineNo">1106</span> /**<a name="line.1106"></a> |
| <span class="sourceLineNo">1107</span> * @return current backup master list<a name="line.1107"></a> |
| <span class="sourceLineNo">1108</span> * @throws IOException if a remote or network exception occurs<a name="line.1108"></a> |
| <span class="sourceLineNo">1109</span> */<a name="line.1109"></a> |
| <span class="sourceLineNo">1110</span> default Collection<ServerName> getBackupMasters() throws IOException {<a name="line.1110"></a> |
| <span class="sourceLineNo">1111</span> return getClusterMetrics(EnumSet.of(Option.BACKUP_MASTERS)).getBackupMasterNames();<a name="line.1111"></a> |
| <span class="sourceLineNo">1112</span> }<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> * @return current live region servers list<a name="line.1115"></a> |
| <span class="sourceLineNo">1116</span> * @throws IOException if a remote or network exception occurs<a name="line.1116"></a> |
| <span class="sourceLineNo">1117</span> */<a name="line.1117"></a> |
| <span class="sourceLineNo">1118</span> default Collection<ServerName> getRegionServers() throws IOException {<a name="line.1118"></a> |
| <span class="sourceLineNo">1119</span> return getRegionServers(false);<a name="line.1119"></a> |
| <span class="sourceLineNo">1120</span> }<a name="line.1120"></a> |
| <span class="sourceLineNo">1121</span><a name="line.1121"></a> |
| <span class="sourceLineNo">1122</span> /**<a name="line.1122"></a> |
| <span class="sourceLineNo">1123</span> * Retrieve all current live region servers including decommissioned<a name="line.1123"></a> |
| <span class="sourceLineNo">1124</span> * if excludeDecommissionedRS is false, else non-decommissioned ones only<a name="line.1124"></a> |
| <span class="sourceLineNo">1125</span> *<a name="line.1125"></a> |
| <span class="sourceLineNo">1126</span> * @param excludeDecommissionedRS should we exclude decommissioned RS nodes<a name="line.1126"></a> |
| <span class="sourceLineNo">1127</span> * @return all current live region servers including/excluding decommissioned hosts<a name="line.1127"></a> |
| <span class="sourceLineNo">1128</span> * @throws IOException if a remote or network exception occurs<a name="line.1128"></a> |
| <span class="sourceLineNo">1129</span> */<a name="line.1129"></a> |
| <span class="sourceLineNo">1130</span> default Collection<ServerName> getRegionServers(boolean excludeDecommissionedRS)<a name="line.1130"></a> |
| <span class="sourceLineNo">1131</span> throws IOException {<a name="line.1131"></a> |
| <span class="sourceLineNo">1132</span> List<ServerName> allServers =<a name="line.1132"></a> |
| <span class="sourceLineNo">1133</span> getClusterMetrics(EnumSet.of(Option.SERVERS_NAME)).getServersName();<a name="line.1133"></a> |
| <span class="sourceLineNo">1134</span> if (!excludeDecommissionedRS) {<a name="line.1134"></a> |
| <span class="sourceLineNo">1135</span> return allServers;<a name="line.1135"></a> |
| <span class="sourceLineNo">1136</span> }<a name="line.1136"></a> |
| <span class="sourceLineNo">1137</span> List<ServerName> decommissionedRegionServers = listDecommissionedRegionServers();<a name="line.1137"></a> |
| <span class="sourceLineNo">1138</span> return allServers.stream()<a name="line.1138"></a> |
| <span class="sourceLineNo">1139</span> .filter(s -> !decommissionedRegionServers.contains(s))<a name="line.1139"></a> |
| <span class="sourceLineNo">1140</span> .collect(ImmutableList.toImmutableList());<a name="line.1140"></a> |
| <span class="sourceLineNo">1141</span> }<a name="line.1141"></a> |
| <span class="sourceLineNo">1142</span><a name="line.1142"></a> |
| <span class="sourceLineNo">1143</span> /**<a name="line.1143"></a> |
| <span class="sourceLineNo">1144</span> * Get {@link RegionMetrics} of all regions hosted on a regionserver.<a name="line.1144"></a> |
| <span class="sourceLineNo">1145</span> *<a name="line.1145"></a> |
| <span class="sourceLineNo">1146</span> * @param serverName region server from which {@link RegionMetrics} is required.<a name="line.1146"></a> |
| <span class="sourceLineNo">1147</span> * @return a {@link RegionMetrics} list of all regions hosted on a region server<a name="line.1147"></a> |
| <span class="sourceLineNo">1148</span> * @throws IOException if a remote or network exception occurs<a name="line.1148"></a> |
| <span class="sourceLineNo">1149</span> */<a name="line.1149"></a> |
| <span class="sourceLineNo">1150</span> List<RegionMetrics> getRegionMetrics(ServerName serverName) throws IOException;<a name="line.1150"></a> |
| <span class="sourceLineNo">1151</span><a name="line.1151"></a> |
| <span class="sourceLineNo">1152</span> /**<a name="line.1152"></a> |
| <span class="sourceLineNo">1153</span> * Get {@link RegionMetrics} of all regions hosted on a regionserver for a table.<a name="line.1153"></a> |
| <span class="sourceLineNo">1154</span> *<a name="line.1154"></a> |
| <span class="sourceLineNo">1155</span> * @param serverName region server from which {@link RegionMetrics} is required.<a name="line.1155"></a> |
| <span class="sourceLineNo">1156</span> * @param tableName get {@link RegionMetrics} of regions belonging to the table<a name="line.1156"></a> |
| <span class="sourceLineNo">1157</span> * @return region metrics map of all regions of a table hosted on a region server<a name="line.1157"></a> |
| <span class="sourceLineNo">1158</span> * @throws IOException if a remote or network exception occurs<a name="line.1158"></a> |
| <span class="sourceLineNo">1159</span> */<a name="line.1159"></a> |
| <span class="sourceLineNo">1160</span> List<RegionMetrics> getRegionMetrics(ServerName serverName,<a name="line.1160"></a> |
| <span class="sourceLineNo">1161</span> TableName tableName) throws IOException;<a name="line.1161"></a> |
| <span class="sourceLineNo">1162</span><a name="line.1162"></a> |
| <span class="sourceLineNo">1163</span> /**<a name="line.1163"></a> |
| <span class="sourceLineNo">1164</span> * @return Configuration used by the instance.<a name="line.1164"></a> |
| <span class="sourceLineNo">1165</span> */<a name="line.1165"></a> |
| <span class="sourceLineNo">1166</span> Configuration getConfiguration();<a name="line.1166"></a> |
| <span class="sourceLineNo">1167</span><a name="line.1167"></a> |
| <span class="sourceLineNo">1168</span> /**<a name="line.1168"></a> |
| <span class="sourceLineNo">1169</span> * Create a new namespace. Blocks until namespace has been successfully created or an exception is<a name="line.1169"></a> |
| <span class="sourceLineNo">1170</span> * thrown.<a name="line.1170"></a> |
| <span class="sourceLineNo">1171</span> * @param descriptor descriptor which describes the new namespace.<a name="line.1171"></a> |
| <span class="sourceLineNo">1172</span> * @throws IOException if a remote or network exception occurs<a name="line.1172"></a> |
| <span class="sourceLineNo">1173</span> */<a name="line.1173"></a> |
| <span class="sourceLineNo">1174</span> default void createNamespace(NamespaceDescriptor descriptor) throws IOException {<a name="line.1174"></a> |
| <span class="sourceLineNo">1175</span> get(createNamespaceAsync(descriptor), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.1175"></a> |
| <span class="sourceLineNo">1176</span> }<a name="line.1176"></a> |
| <span class="sourceLineNo">1177</span><a name="line.1177"></a> |
| <span class="sourceLineNo">1178</span> /**<a name="line.1178"></a> |
| <span class="sourceLineNo">1179</span> * Create a new namespace.<a name="line.1179"></a> |
| <span class="sourceLineNo">1180</span> * @param descriptor descriptor which describes the new namespace<a name="line.1180"></a> |
| <span class="sourceLineNo">1181</span> * @return the result of the async create namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1181"></a> |
| <span class="sourceLineNo">1182</span> * wait on the operation to complete.<a name="line.1182"></a> |
| <span class="sourceLineNo">1183</span> * @throws IOException if a remote or network exception occurs<a name="line.1183"></a> |
| <span class="sourceLineNo">1184</span> */<a name="line.1184"></a> |
| <span class="sourceLineNo">1185</span> Future<Void> createNamespaceAsync(NamespaceDescriptor descriptor) throws IOException;<a name="line.1185"></a> |
| <span class="sourceLineNo">1186</span><a name="line.1186"></a> |
| <span class="sourceLineNo">1187</span> /**<a name="line.1187"></a> |
| <span class="sourceLineNo">1188</span> * Modify an existing namespace. Blocks until namespace has been successfully modified or an<a name="line.1188"></a> |
| <span class="sourceLineNo">1189</span> * exception is thrown.<a name="line.1189"></a> |
| <span class="sourceLineNo">1190</span> * @param descriptor descriptor which describes the new namespace<a name="line.1190"></a> |
| <span class="sourceLineNo">1191</span> * @throws IOException if a remote or network exception occurs<a name="line.1191"></a> |
| <span class="sourceLineNo">1192</span> */<a name="line.1192"></a> |
| <span class="sourceLineNo">1193</span> default void modifyNamespace(NamespaceDescriptor descriptor) throws IOException {<a name="line.1193"></a> |
| <span class="sourceLineNo">1194</span> get(modifyNamespaceAsync(descriptor), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.1194"></a> |
| <span class="sourceLineNo">1195</span> }<a name="line.1195"></a> |
| <span class="sourceLineNo">1196</span><a name="line.1196"></a> |
| <span class="sourceLineNo">1197</span> /**<a name="line.1197"></a> |
| <span class="sourceLineNo">1198</span> * Modify an existing namespace.<a name="line.1198"></a> |
| <span class="sourceLineNo">1199</span> * @param descriptor descriptor which describes the new namespace<a name="line.1199"></a> |
| <span class="sourceLineNo">1200</span> * @return the result of the async modify namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1200"></a> |
| <span class="sourceLineNo">1201</span> * wait on the operation to complete.<a name="line.1201"></a> |
| <span class="sourceLineNo">1202</span> * @throws IOException if a remote or network exception occurs<a name="line.1202"></a> |
| <span class="sourceLineNo">1203</span> */<a name="line.1203"></a> |
| <span class="sourceLineNo">1204</span> Future<Void> modifyNamespaceAsync(NamespaceDescriptor descriptor) throws IOException;<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> * Delete an existing namespace. Only empty namespaces (no tables) can be removed. Blocks until<a name="line.1207"></a> |
| <span class="sourceLineNo">1208</span> * namespace has been successfully deleted or an exception is thrown.<a name="line.1208"></a> |
| <span class="sourceLineNo">1209</span> * @param name namespace name<a name="line.1209"></a> |
| <span class="sourceLineNo">1210</span> * @throws IOException if a remote or network exception occurs<a name="line.1210"></a> |
| <span class="sourceLineNo">1211</span> */<a name="line.1211"></a> |
| <span class="sourceLineNo">1212</span> default void deleteNamespace(String name) throws IOException {<a name="line.1212"></a> |
| <span class="sourceLineNo">1213</span> get(deleteNamespaceAsync(name), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.1213"></a> |
| <span class="sourceLineNo">1214</span> }<a name="line.1214"></a> |
| <span class="sourceLineNo">1215</span><a name="line.1215"></a> |
| <span class="sourceLineNo">1216</span> /**<a name="line.1216"></a> |
| <span class="sourceLineNo">1217</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.1217"></a> |
| <span class="sourceLineNo">1218</span> * @param name namespace name<a name="line.1218"></a> |
| <span class="sourceLineNo">1219</span> * @return the result of the async delete namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1219"></a> |
| <span class="sourceLineNo">1220</span> * wait on the operation to complete.<a name="line.1220"></a> |
| <span class="sourceLineNo">1221</span> * @throws IOException if a remote or network exception occurs<a name="line.1221"></a> |
| <span class="sourceLineNo">1222</span> */<a name="line.1222"></a> |
| <span class="sourceLineNo">1223</span> Future<Void> deleteNamespaceAsync(String name) throws IOException;<a name="line.1223"></a> |
| <span class="sourceLineNo">1224</span><a name="line.1224"></a> |
| <span class="sourceLineNo">1225</span> /**<a name="line.1225"></a> |
| <span class="sourceLineNo">1226</span> * Get a namespace descriptor by name.<a name="line.1226"></a> |
| <span class="sourceLineNo">1227</span> * @param name name of namespace descriptor<a name="line.1227"></a> |
| <span class="sourceLineNo">1228</span> * @return A descriptor<a name="line.1228"></a> |
| <span class="sourceLineNo">1229</span> * @throws org.apache.hadoop.hbase.NamespaceNotFoundException<a name="line.1229"></a> |
| <span class="sourceLineNo">1230</span> * @throws IOException if a remote or network exception occurs<a name="line.1230"></a> |
| <span class="sourceLineNo">1231</span> */<a name="line.1231"></a> |
| <span class="sourceLineNo">1232</span> NamespaceDescriptor getNamespaceDescriptor(String name)<a name="line.1232"></a> |
| <span class="sourceLineNo">1233</span> throws NamespaceNotFoundException, IOException;<a name="line.1233"></a> |
| <span class="sourceLineNo">1234</span><a name="line.1234"></a> |
| <span class="sourceLineNo">1235</span> /**<a name="line.1235"></a> |
| <span class="sourceLineNo">1236</span> * List available namespaces<a name="line.1236"></a> |
| <span class="sourceLineNo">1237</span> *<a name="line.1237"></a> |
| <span class="sourceLineNo">1238</span> * @return List of namespace names<a name="line.1238"></a> |
| <span class="sourceLineNo">1239</span> * @throws IOException if a remote or network exception occurs<a name="line.1239"></a> |
| <span class="sourceLineNo">1240</span> */<a name="line.1240"></a> |
| <span class="sourceLineNo">1241</span> String[] listNamespaces() throws IOException;<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> * List available namespace descriptors<a name="line.1244"></a> |
| <span class="sourceLineNo">1245</span> *<a name="line.1245"></a> |
| <span class="sourceLineNo">1246</span> * @return List of descriptors<a name="line.1246"></a> |
| <span class="sourceLineNo">1247</span> * @throws IOException if a remote or network exception occurs<a name="line.1247"></a> |
| <span class="sourceLineNo">1248</span> */<a name="line.1248"></a> |
| <span class="sourceLineNo">1249</span> NamespaceDescriptor[] listNamespaceDescriptors() throws IOException;<a name="line.1249"></a> |
| <span class="sourceLineNo">1250</span><a name="line.1250"></a> |
| <span class="sourceLineNo">1251</span> /**<a name="line.1251"></a> |
| <span class="sourceLineNo">1252</span> * Get list of table descriptors by namespace.<a name="line.1252"></a> |
| <span class="sourceLineNo">1253</span> * @param name namespace name<a name="line.1253"></a> |
| <span class="sourceLineNo">1254</span> * @return returns a list of TableDescriptors<a name="line.1254"></a> |
| <span class="sourceLineNo">1255</span> * @throws IOException if a remote or network exception occurs<a name="line.1255"></a> |
| <span class="sourceLineNo">1256</span> */<a name="line.1256"></a> |
| <span class="sourceLineNo">1257</span> List<TableDescriptor> listTableDescriptorsByNamespace(byte[] name) throws IOException;<a name="line.1257"></a> |
| <span class="sourceLineNo">1258</span><a name="line.1258"></a> |
| <span class="sourceLineNo">1259</span> /**<a name="line.1259"></a> |
| <span class="sourceLineNo">1260</span> * Get list of table names by namespace.<a name="line.1260"></a> |
| <span class="sourceLineNo">1261</span> * @param name namespace name<a name="line.1261"></a> |
| <span class="sourceLineNo">1262</span> * @return The list of table names in the namespace<a name="line.1262"></a> |
| <span class="sourceLineNo">1263</span> * @throws IOException if a remote or network exception occurs<a name="line.1263"></a> |
| <span class="sourceLineNo">1264</span> */<a name="line.1264"></a> |
| <span class="sourceLineNo">1265</span> TableName[] listTableNamesByNamespace(String name) throws IOException;<a name="line.1265"></a> |
| <span class="sourceLineNo">1266</span><a name="line.1266"></a> |
| <span class="sourceLineNo">1267</span> /**<a name="line.1267"></a> |
| <span class="sourceLineNo">1268</span> * Get the regions of a given table.<a name="line.1268"></a> |
| <span class="sourceLineNo">1269</span> *<a name="line.1269"></a> |
| <span class="sourceLineNo">1270</span> * @param tableName the name of the table<a name="line.1270"></a> |
| <span class="sourceLineNo">1271</span> * @return List of {@link RegionInfo}.<a name="line.1271"></a> |
| <span class="sourceLineNo">1272</span> * @throws IOException if a remote or network exception occurs<a name="line.1272"></a> |
| <span class="sourceLineNo">1273</span> */<a name="line.1273"></a> |
| <span class="sourceLineNo">1274</span> List<RegionInfo> getRegions(TableName tableName) throws IOException;<a name="line.1274"></a> |
| <span class="sourceLineNo">1275</span><a name="line.1275"></a> |
| <span class="sourceLineNo">1276</span> @Override<a name="line.1276"></a> |
| <span class="sourceLineNo">1277</span> void close();<a name="line.1277"></a> |
| <span class="sourceLineNo">1278</span><a name="line.1278"></a> |
| <span class="sourceLineNo">1279</span> /**<a name="line.1279"></a> |
| <span class="sourceLineNo">1280</span> * Get tableDescriptors.<a name="line.1280"></a> |
| <span class="sourceLineNo">1281</span> *<a name="line.1281"></a> |
| <span class="sourceLineNo">1282</span> * @param tableNames List of table names<a name="line.1282"></a> |
| <span class="sourceLineNo">1283</span> * @return returns a list of TableDescriptors<a name="line.1283"></a> |
| <span class="sourceLineNo">1284</span> * @throws IOException if a remote or network exception occurs<a name="line.1284"></a> |
| <span class="sourceLineNo">1285</span> */<a name="line.1285"></a> |
| <span class="sourceLineNo">1286</span> List<TableDescriptor> listTableDescriptors(List<TableName> tableNames)<a name="line.1286"></a> |
| <span class="sourceLineNo">1287</span> throws IOException;<a name="line.1287"></a> |
| <span class="sourceLineNo">1288</span><a name="line.1288"></a> |
| <span class="sourceLineNo">1289</span> /**<a name="line.1289"></a> |
| <span class="sourceLineNo">1290</span> * Abort a procedure.<a name="line.1290"></a> |
| <span class="sourceLineNo">1291</span> * <p/><a name="line.1291"></a> |
| <span class="sourceLineNo">1292</span> * Do not use. Usually it is ignored but if not, it can do more damage than good. See hbck2.<a name="line.1292"></a> |
| <span class="sourceLineNo">1293</span> * @param procId ID of the procedure to abort<a name="line.1293"></a> |
| <span class="sourceLineNo">1294</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1294"></a> |
| <span class="sourceLineNo">1295</span> * @return <code>true</code> if aborted, <code>false</code> if procedure already completed or does<a name="line.1295"></a> |
| <span class="sourceLineNo">1296</span> * not exist<a name="line.1296"></a> |
| <span class="sourceLineNo">1297</span> * @throws IOException if a remote or network exception occurs<a name="line.1297"></a> |
| <span class="sourceLineNo">1298</span> * @deprecated since 2.1.1 and will be removed in 4.0.0.<a name="line.1298"></a> |
| <span class="sourceLineNo">1299</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-21223">HBASE-21223</a><a name="line.1299"></a> |
| <span class="sourceLineNo">1300</span> */<a name="line.1300"></a> |
| <span class="sourceLineNo">1301</span> @Deprecated<a name="line.1301"></a> |
| <span class="sourceLineNo">1302</span> default boolean abortProcedure(long procId, boolean mayInterruptIfRunning) throws IOException {<a name="line.1302"></a> |
| <span class="sourceLineNo">1303</span> return get(abortProcedureAsync(procId, mayInterruptIfRunning), getSyncWaitTimeout(),<a name="line.1303"></a> |
| <span class="sourceLineNo">1304</span> TimeUnit.MILLISECONDS);<a name="line.1304"></a> |
| <span class="sourceLineNo">1305</span> }<a name="line.1305"></a> |
| <span class="sourceLineNo">1306</span><a name="line.1306"></a> |
| <span class="sourceLineNo">1307</span> /**<a name="line.1307"></a> |
| <span class="sourceLineNo">1308</span> * Abort a procedure but does not block and wait for completion.<a name="line.1308"></a> |
| <span class="sourceLineNo">1309</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1309"></a> |
| <span class="sourceLineNo">1310</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.1310"></a> |
| <span class="sourceLineNo">1311</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.1311"></a> |
| <span class="sourceLineNo">1312</span> * operation to complete.<a name="line.1312"></a> |
| <span class="sourceLineNo">1313</span> * Do not use. Usually it is ignored but if not, it can do more damage than good. See hbck2.<a name="line.1313"></a> |
| <span class="sourceLineNo">1314</span> *<a name="line.1314"></a> |
| <span class="sourceLineNo">1315</span> * @param procId ID of the procedure to abort<a name="line.1315"></a> |
| <span class="sourceLineNo">1316</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1316"></a> |
| <span class="sourceLineNo">1317</span> * @return <code>true</code> if aborted, <code>false</code> if procedure already completed or does not exist<a name="line.1317"></a> |
| <span class="sourceLineNo">1318</span> * @throws IOException if a remote or network exception occurs<a name="line.1318"></a> |
| <span class="sourceLineNo">1319</span> * @deprecated since 2.1.1 and will be removed in 4.0.0.<a name="line.1319"></a> |
| <span class="sourceLineNo">1320</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-21223">HBASE-21223</a><a name="line.1320"></a> |
| <span class="sourceLineNo">1321</span> */<a name="line.1321"></a> |
| <span class="sourceLineNo">1322</span> @Deprecated<a name="line.1322"></a> |
| <span class="sourceLineNo">1323</span> Future<Boolean> abortProcedureAsync(long procId, boolean mayInterruptIfRunning)<a name="line.1323"></a> |
| <span class="sourceLineNo">1324</span> throws IOException;<a name="line.1324"></a> |
| <span class="sourceLineNo">1325</span><a name="line.1325"></a> |
| <span class="sourceLineNo">1326</span> /**<a name="line.1326"></a> |
| <span class="sourceLineNo">1327</span> * Get procedures.<a name="line.1327"></a> |
| <span class="sourceLineNo">1328</span> * @return procedure list in JSON<a name="line.1328"></a> |
| <span class="sourceLineNo">1329</span> * @throws IOException if a remote or network exception occurs<a name="line.1329"></a> |
| <span class="sourceLineNo">1330</span> */<a name="line.1330"></a> |
| <span class="sourceLineNo">1331</span> String getProcedures() throws IOException;<a name="line.1331"></a> |
| <span class="sourceLineNo">1332</span><a name="line.1332"></a> |
| <span class="sourceLineNo">1333</span> /**<a name="line.1333"></a> |
| <span class="sourceLineNo">1334</span> * Get locks.<a name="line.1334"></a> |
| <span class="sourceLineNo">1335</span> * @return lock list in JSON<a name="line.1335"></a> |
| <span class="sourceLineNo">1336</span> * @throws IOException if a remote or network exception occurs<a name="line.1336"></a> |
| <span class="sourceLineNo">1337</span> */<a name="line.1337"></a> |
| <span class="sourceLineNo">1338</span> String getLocks() throws IOException;<a name="line.1338"></a> |
| <span class="sourceLineNo">1339</span><a name="line.1339"></a> |
| <span class="sourceLineNo">1340</span> /**<a name="line.1340"></a> |
| <span class="sourceLineNo">1341</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.1341"></a> |
| <span class="sourceLineNo">1342</span> *<a name="line.1342"></a> |
| <span class="sourceLineNo">1343</span> * Note that the actual rolling of the log writer is asynchronous and may not be complete when<a name="line.1343"></a> |
| <span class="sourceLineNo">1344</span> * this method returns. As a side effect of this call, the named region server may schedule<a name="line.1344"></a> |
| <span class="sourceLineNo">1345</span> * store flushes at the request of the wal.<a name="line.1345"></a> |
| <span class="sourceLineNo">1346</span> *<a name="line.1346"></a> |
| <span class="sourceLineNo">1347</span> * @param serverName The servername of the regionserver.<a name="line.1347"></a> |
| <span class="sourceLineNo">1348</span> * @throws IOException if a remote or network exception occurs<a name="line.1348"></a> |
| <span class="sourceLineNo">1349</span> * @throws org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException<a name="line.1349"></a> |
| <span class="sourceLineNo">1350</span> */<a name="line.1350"></a> |
| <span class="sourceLineNo">1351</span> void rollWALWriter(ServerName serverName) throws IOException, FailedLogCloseException;<a name="line.1351"></a> |
| <span class="sourceLineNo">1352</span><a name="line.1352"></a> |
| <span class="sourceLineNo">1353</span> /**<a name="line.1353"></a> |
| <span class="sourceLineNo">1354</span> * Helper that delegates to getClusterMetrics().getMasterCoprocessorNames().<a name="line.1354"></a> |
| <span class="sourceLineNo">1355</span> * @return an array of master coprocessors<a name="line.1355"></a> |
| <span class="sourceLineNo">1356</span> * @see org.apache.hadoop.hbase.ClusterMetrics#getMasterCoprocessorNames()<a name="line.1356"></a> |
| <span class="sourceLineNo">1357</span> */<a name="line.1357"></a> |
| <span class="sourceLineNo">1358</span> default List<String> getMasterCoprocessorNames() throws IOException {<a name="line.1358"></a> |
| <span class="sourceLineNo">1359</span> return getClusterMetrics(EnumSet.of(Option.MASTER_COPROCESSORS))<a name="line.1359"></a> |
| <span class="sourceLineNo">1360</span> .getMasterCoprocessorNames();<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> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1364"></a> |
| <span class="sourceLineNo">1365</span> * compaction, both, or none.<a name="line.1365"></a> |
| <span class="sourceLineNo">1366</span> *<a name="line.1366"></a> |
| <span class="sourceLineNo">1367</span> * @param tableName table to examine<a name="line.1367"></a> |
| <span class="sourceLineNo">1368</span> * @return the current compaction state<a name="line.1368"></a> |
| <span class="sourceLineNo">1369</span> * @throws IOException if a remote or network exception occurs<a name="line.1369"></a> |
| <span class="sourceLineNo">1370</span> */<a name="line.1370"></a> |
| <span class="sourceLineNo">1371</span> CompactionState getCompactionState(TableName tableName) throws IOException;<a name="line.1371"></a> |
| <span class="sourceLineNo">1372</span><a name="line.1372"></a> |
| <span class="sourceLineNo">1373</span> /**<a name="line.1373"></a> |
| <span class="sourceLineNo">1374</span> * Get the current compaction state of a table. It could be in a compaction, or none.<a name="line.1374"></a> |
| <span class="sourceLineNo">1375</span> *<a name="line.1375"></a> |
| <span class="sourceLineNo">1376</span> * @param tableName table to examine<a name="line.1376"></a> |
| <span class="sourceLineNo">1377</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.1377"></a> |
| <span class="sourceLineNo">1378</span> * @return the current compaction state<a name="line.1378"></a> |
| <span class="sourceLineNo">1379</span> * @throws IOException if a remote or network exception occurs<a name="line.1379"></a> |
| <span class="sourceLineNo">1380</span> */<a name="line.1380"></a> |
| <span class="sourceLineNo">1381</span> CompactionState getCompactionState(TableName tableName,<a name="line.1381"></a> |
| <span class="sourceLineNo">1382</span> CompactType compactType) throws IOException;<a name="line.1382"></a> |
| <span class="sourceLineNo">1383</span><a name="line.1383"></a> |
| <span class="sourceLineNo">1384</span> /**<a name="line.1384"></a> |
| <span class="sourceLineNo">1385</span> * Get the current compaction state of region. It could be in a major compaction, a minor<a name="line.1385"></a> |
| <span class="sourceLineNo">1386</span> * compaction, both, or none.<a name="line.1386"></a> |
| <span class="sourceLineNo">1387</span> *<a name="line.1387"></a> |
| <span class="sourceLineNo">1388</span> * @param regionName region to examine<a name="line.1388"></a> |
| <span class="sourceLineNo">1389</span> * @return the current compaction state<a name="line.1389"></a> |
| <span class="sourceLineNo">1390</span> * @throws IOException if a remote or network exception occurs<a name="line.1390"></a> |
| <span class="sourceLineNo">1391</span> */<a name="line.1391"></a> |
| <span class="sourceLineNo">1392</span> CompactionState getCompactionStateForRegion(byte[] regionName) throws IOException;<a name="line.1392"></a> |
| <span class="sourceLineNo">1393</span><a name="line.1393"></a> |
| <span class="sourceLineNo">1394</span> /**<a name="line.1394"></a> |
| <span class="sourceLineNo">1395</span> * Get the timestamp of the last major compaction for the passed table<a name="line.1395"></a> |
| <span class="sourceLineNo">1396</span> *<a name="line.1396"></a> |
| <span class="sourceLineNo">1397</span> * The timestamp of the oldest HFile resulting from a major compaction of that table,<a name="line.1397"></a> |
| <span class="sourceLineNo">1398</span> * or 0 if no such HFile could be found.<a name="line.1398"></a> |
| <span class="sourceLineNo">1399</span> *<a name="line.1399"></a> |
| <span class="sourceLineNo">1400</span> * @param tableName table to examine<a name="line.1400"></a> |
| <span class="sourceLineNo">1401</span> * @return the last major compaction timestamp or 0<a name="line.1401"></a> |
| <span class="sourceLineNo">1402</span> * @throws IOException if a remote or network exception occurs<a name="line.1402"></a> |
| <span class="sourceLineNo">1403</span> */<a name="line.1403"></a> |
| <span class="sourceLineNo">1404</span> long getLastMajorCompactionTimestamp(TableName tableName) throws IOException;<a name="line.1404"></a> |
| <span class="sourceLineNo">1405</span><a name="line.1405"></a> |
| <span class="sourceLineNo">1406</span> /**<a name="line.1406"></a> |
| <span class="sourceLineNo">1407</span> * Get the timestamp of the last major compaction for the passed region.<a name="line.1407"></a> |
| <span class="sourceLineNo">1408</span> *<a name="line.1408"></a> |
| <span class="sourceLineNo">1409</span> * The timestamp of the oldest HFile resulting from a major compaction of that region,<a name="line.1409"></a> |
| <span class="sourceLineNo">1410</span> * or 0 if no such HFile could be found.<a name="line.1410"></a> |
| <span class="sourceLineNo">1411</span> *<a name="line.1411"></a> |
| <span class="sourceLineNo">1412</span> * @param regionName region to examine<a name="line.1412"></a> |
| <span class="sourceLineNo">1413</span> * @return the last major compaction timestamp or 0<a name="line.1413"></a> |
| <span class="sourceLineNo">1414</span> * @throws IOException if a remote or network exception occurs<a name="line.1414"></a> |
| <span class="sourceLineNo">1415</span> */<a name="line.1415"></a> |
| <span class="sourceLineNo">1416</span> long getLastMajorCompactionTimestampForRegion(byte[] regionName) throws IOException;<a name="line.1416"></a> |
| <span class="sourceLineNo">1417</span><a name="line.1417"></a> |
| <span class="sourceLineNo">1418</span> /**<a name="line.1418"></a> |
| <span class="sourceLineNo">1419</span> * Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be<a name="line.1419"></a> |
| <span class="sourceLineNo">1420</span> * taken. If the table is disabled, an offline snapshot is taken. Snapshots are taken<a name="line.1420"></a> |
| <span class="sourceLineNo">1421</span> * sequentially even when requested concurrently, across all tables. Snapshots are considered<a name="line.1421"></a> |
| <span class="sourceLineNo">1422</span> * unique based on <b>the name of the snapshot</b>. Attempts to take a snapshot with the same<a name="line.1422"></a> |
| <span class="sourceLineNo">1423</span> * name (even a different type or with different parameters) will fail with a<a name="line.1423"></a> |
| <span class="sourceLineNo">1424</span> * {@link org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate<a name="line.1424"></a> |
| <span class="sourceLineNo">1425</span> * naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.1425"></a> |
| <span class="sourceLineNo">1426</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.1426"></a> |
| <span class="sourceLineNo">1427</span> * @param snapshotName name of the snapshot to be created<a name="line.1427"></a> |
| <span class="sourceLineNo">1428</span> * @param tableName name of the table for which snapshot is created<a name="line.1428"></a> |
| <span class="sourceLineNo">1429</span> * @throws IOException if a remote or network exception occurs<a name="line.1429"></a> |
| <span class="sourceLineNo">1430</span> * @throws org.apache.hadoop.hbase.snapshot.SnapshotCreationException if snapshot creation failed<a name="line.1430"></a> |
| <span class="sourceLineNo">1431</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1431"></a> |
| <span class="sourceLineNo">1432</span> */<a name="line.1432"></a> |
| <span class="sourceLineNo">1433</span> default void snapshot(String snapshotName, TableName tableName)<a name="line.1433"></a> |
| <span class="sourceLineNo">1434</span> throws IOException, SnapshotCreationException, IllegalArgumentException {<a name="line.1434"></a> |
| <span class="sourceLineNo">1435</span> snapshot(snapshotName, tableName, SnapshotType.FLUSH);<a name="line.1435"></a> |
| <span class="sourceLineNo">1436</span> }<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> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.1439"></a> |
| <span class="sourceLineNo">1440</span> * snapshot</b>. Snapshots are taken sequentially even when requested concurrently, across<a name="line.1440"></a> |
| <span class="sourceLineNo">1441</span> * all tables. Attempts to take a snapshot with the same name (even a different type or with<a name="line.1441"></a> |
| <span class="sourceLineNo">1442</span> * different parameters) will fail with a {@link SnapshotCreationException} indicating the<a name="line.1442"></a> |
| <span class="sourceLineNo">1443</span> * duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.1443"></a> |
| <span class="sourceLineNo">1444</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.1444"></a> |
| <span class="sourceLineNo">1445</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.1445"></a> |
| <span class="sourceLineNo">1446</span> * snapshots stored on the cluster<a name="line.1446"></a> |
| <span class="sourceLineNo">1447</span> * @param tableName name of the table to snapshot<a name="line.1447"></a> |
| <span class="sourceLineNo">1448</span> * @param type type of snapshot to take<a name="line.1448"></a> |
| <span class="sourceLineNo">1449</span> * @throws IOException we fail to reach the master<a name="line.1449"></a> |
| <span class="sourceLineNo">1450</span> * @throws SnapshotCreationException if snapshot creation failed<a name="line.1450"></a> |
| <span class="sourceLineNo">1451</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1451"></a> |
| <span class="sourceLineNo">1452</span> */<a name="line.1452"></a> |
| <span class="sourceLineNo">1453</span> default void snapshot(String snapshotName, TableName tableName, SnapshotType type)<a name="line.1453"></a> |
| <span class="sourceLineNo">1454</span> throws IOException, SnapshotCreationException, IllegalArgumentException {<a name="line.1454"></a> |
| <span class="sourceLineNo">1455</span> snapshot(new SnapshotDescription(snapshotName, tableName, type));<a name="line.1455"></a> |
| <span class="sourceLineNo">1456</span> }<a name="line.1456"></a> |
| <span class="sourceLineNo">1457</span><a name="line.1457"></a> |
| <span class="sourceLineNo">1458</span> /**<a name="line.1458"></a> |
| <span class="sourceLineNo">1459</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.1459"></a> |
| <span class="sourceLineNo">1460</span> * snapshot</b>. Snapshots are taken sequentially even when requested concurrently, across<a name="line.1460"></a> |
| <span class="sourceLineNo">1461</span> * all tables. Attempts to take a snapshot with the same name (even a different type or with<a name="line.1461"></a> |
| <span class="sourceLineNo">1462</span> * different parameters) will fail with a {@link SnapshotCreationException} indicating the<a name="line.1462"></a> |
| <span class="sourceLineNo">1463</span> * duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.1463"></a> |
| <span class="sourceLineNo">1464</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.1464"></a> |
| <span class="sourceLineNo">1465</span> * Snapshot can live with ttl seconds.<a name="line.1465"></a> |
| <span class="sourceLineNo">1466</span> *<a name="line.1466"></a> |
| <span class="sourceLineNo">1467</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.1467"></a> |
| <span class="sourceLineNo">1468</span> * snapshots stored on the cluster<a name="line.1468"></a> |
| <span class="sourceLineNo">1469</span> * @param tableName name of the table to snapshot<a name="line.1469"></a> |
| <span class="sourceLineNo">1470</span> * @param type type of snapshot to take<a name="line.1470"></a> |
| <span class="sourceLineNo">1471</span> * @param snapshotProps snapshot additional properties e.g. TTL<a name="line.1471"></a> |
| <span class="sourceLineNo">1472</span> * @throws IOException we fail to reach the master<a name="line.1472"></a> |
| <span class="sourceLineNo">1473</span> * @throws SnapshotCreationException if snapshot creation failed<a name="line.1473"></a> |
| <span class="sourceLineNo">1474</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1474"></a> |
| <span class="sourceLineNo">1475</span> */<a name="line.1475"></a> |
| <span class="sourceLineNo">1476</span> default void snapshot(String snapshotName, TableName tableName, SnapshotType type,<a name="line.1476"></a> |
| <span class="sourceLineNo">1477</span> Map<String, Object> snapshotProps) throws IOException,<a name="line.1477"></a> |
| <span class="sourceLineNo">1478</span> SnapshotCreationException, IllegalArgumentException {<a name="line.1478"></a> |
| <span class="sourceLineNo">1479</span> snapshot(new SnapshotDescription(snapshotName, tableName, type, snapshotProps));<a name="line.1479"></a> |
| <span class="sourceLineNo">1480</span> }<a name="line.1480"></a> |
| <span class="sourceLineNo">1481</span><a name="line.1481"></a> |
| <span class="sourceLineNo">1482</span> /**<a name="line.1482"></a> |
| <span class="sourceLineNo">1483</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.1483"></a> |
| <span class="sourceLineNo">1484</span> * snapshot</b>. Snapshots are taken sequentially even when requested concurrently, across<a name="line.1484"></a> |
| <span class="sourceLineNo">1485</span> * all tables. Attempts to take a snapshot with the same name (even a different type or with<a name="line.1485"></a> |
| <span class="sourceLineNo">1486</span> * different parameters) will fail with a {@link SnapshotCreationException} indicating the<a name="line.1486"></a> |
| <span class="sourceLineNo">1487</span> * duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.1487"></a> |
| <span class="sourceLineNo">1488</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.1488"></a> |
| <span class="sourceLineNo">1489</span> * Snapshot can live with ttl seconds.<a name="line.1489"></a> |
| <span class="sourceLineNo">1490</span> *<a name="line.1490"></a> |
| <span class="sourceLineNo">1491</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.1491"></a> |
| <span class="sourceLineNo">1492</span> * snapshots stored on the cluster<a name="line.1492"></a> |
| <span class="sourceLineNo">1493</span> * @param tableName name of the table to snapshot<a name="line.1493"></a> |
| <span class="sourceLineNo">1494</span> * @param snapshotProps snapshot additional properties e.g. TTL<a name="line.1494"></a> |
| <span class="sourceLineNo">1495</span> * @throws IOException we fail to reach the master<a name="line.1495"></a> |
| <span class="sourceLineNo">1496</span> * @throws SnapshotCreationException if snapshot creation failed<a name="line.1496"></a> |
| <span class="sourceLineNo">1497</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1497"></a> |
| <span class="sourceLineNo">1498</span> */<a name="line.1498"></a> |
| <span class="sourceLineNo">1499</span> default void snapshot(String snapshotName, TableName tableName,<a name="line.1499"></a> |
| <span class="sourceLineNo">1500</span> Map<String, Object> snapshotProps) throws IOException,<a name="line.1500"></a> |
| <span class="sourceLineNo">1501</span> SnapshotCreationException, IllegalArgumentException {<a name="line.1501"></a> |
| <span class="sourceLineNo">1502</span> snapshot(new SnapshotDescription(snapshotName, tableName, SnapshotType.FLUSH, snapshotProps));<a name="line.1502"></a> |
| <span class="sourceLineNo">1503</span> }<a name="line.1503"></a> |
| <span class="sourceLineNo">1504</span><a name="line.1504"></a> |
| <span class="sourceLineNo">1505</span> /**<a name="line.1505"></a> |
| <span class="sourceLineNo">1506</span> * Take a snapshot and wait for the server to complete that snapshot (blocking). Snapshots are<a name="line.1506"></a> |
| <span class="sourceLineNo">1507</span> * considered unique based on <b>the name of the snapshot</b>. Snapshots are taken sequentially<a name="line.1507"></a> |
| <span class="sourceLineNo">1508</span> * even when requested concurrently, across all tables. Attempts to take a snapshot with the same<a name="line.1508"></a> |
| <span class="sourceLineNo">1509</span> * name (even a different type or with different parameters) will fail with a<a name="line.1509"></a> |
| <span class="sourceLineNo">1510</span> * {@link SnapshotCreationException} indicating the duplicate naming. Snapshot names follow the<a name="line.1510"></a> |
| <span class="sourceLineNo">1511</span> * same naming constraints as tables in HBase. See<a name="line.1511"></a> |
| <span class="sourceLineNo">1512</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}. You should<a name="line.1512"></a> |
| <span class="sourceLineNo">1513</span> * probably use {@link #snapshot(String, org.apache.hadoop.hbase.TableName)} unless you are sure<a name="line.1513"></a> |
| <span class="sourceLineNo">1514</span> * about the type of snapshot that you want to take.<a name="line.1514"></a> |
| <span class="sourceLineNo">1515</span> * @param snapshot snapshot to take<a name="line.1515"></a> |
| <span class="sourceLineNo">1516</span> * @throws IOException or we lose contact with the master.<a name="line.1516"></a> |
| <span class="sourceLineNo">1517</span> * @throws SnapshotCreationException if snapshot failed to be taken<a name="line.1517"></a> |
| <span class="sourceLineNo">1518</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1518"></a> |
| <span class="sourceLineNo">1519</span> */<a name="line.1519"></a> |
| <span class="sourceLineNo">1520</span> void snapshot(SnapshotDescription snapshot)<a name="line.1520"></a> |
| <span class="sourceLineNo">1521</span> throws IOException, SnapshotCreationException, IllegalArgumentException;<a name="line.1521"></a> |
| <span class="sourceLineNo">1522</span><a name="line.1522"></a> |
| <span class="sourceLineNo">1523</span> /**<a name="line.1523"></a> |
| <span class="sourceLineNo">1524</span> * Take a snapshot without waiting for the server to complete that snapshot (asynchronous).<a name="line.1524"></a> |
| <span class="sourceLineNo">1525</span> * Snapshots are considered unique based on <b>the name of the snapshot</b>. Snapshots are taken<a name="line.1525"></a> |
| <span class="sourceLineNo">1526</span> * sequentially even when requested concurrently, across all tables.<a name="line.1526"></a> |
| <span class="sourceLineNo">1527</span> *<a name="line.1527"></a> |
| <span class="sourceLineNo">1528</span> * @param snapshot snapshot to take<a name="line.1528"></a> |
| <span class="sourceLineNo">1529</span> * @throws IOException if the snapshot did not succeed or we lose contact with the master.<a name="line.1529"></a> |
| <span class="sourceLineNo">1530</span> * @throws SnapshotCreationException if snapshot creation failed<a name="line.1530"></a> |
| <span class="sourceLineNo">1531</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1531"></a> |
| <span class="sourceLineNo">1532</span> */<a name="line.1532"></a> |
| <span class="sourceLineNo">1533</span> Future<Void> snapshotAsync(SnapshotDescription snapshot)<a name="line.1533"></a> |
| <span class="sourceLineNo">1534</span> throws IOException, SnapshotCreationException;<a name="line.1534"></a> |
| <span class="sourceLineNo">1535</span><a name="line.1535"></a> |
| <span class="sourceLineNo">1536</span> /**<a name="line.1536"></a> |
| <span class="sourceLineNo">1537</span> * Check the current state of the passed snapshot. There are three possible states: <ol><a name="line.1537"></a> |
| <span class="sourceLineNo">1538</span> * <li>running - returns <tt>false</tt></li> <li>finished - returns <tt>true</tt></li><a name="line.1538"></a> |
| <span class="sourceLineNo">1539</span> * <li>finished with error - throws the exception that caused the snapshot to fail</li> </ol> The<a name="line.1539"></a> |
| <span class="sourceLineNo">1540</span> * cluster only knows about the most recent snapshot. Therefore, if another snapshot has been<a name="line.1540"></a> |
| <span class="sourceLineNo">1541</span> * run/started since the snapshot you are checking, you will receive an {@link<a name="line.1541"></a> |
| <span class="sourceLineNo">1542</span> * org.apache.hadoop.hbase.snapshot.UnknownSnapshotException}.<a name="line.1542"></a> |
| <span class="sourceLineNo">1543</span> *<a name="line.1543"></a> |
| <span class="sourceLineNo">1544</span> * @param snapshot description of the snapshot to check<a name="line.1544"></a> |
| <span class="sourceLineNo">1545</span> * @return <tt>true</tt> if the snapshot is completed, <tt>false</tt> if the snapshot is still<a name="line.1545"></a> |
| <span class="sourceLineNo">1546</span> * running<a name="line.1546"></a> |
| <span class="sourceLineNo">1547</span> * @throws IOException if we have a network issue<a name="line.1547"></a> |
| <span class="sourceLineNo">1548</span> * @throws org.apache.hadoop.hbase.snapshot.HBaseSnapshotException if the snapshot failed<a name="line.1548"></a> |
| <span class="sourceLineNo">1549</span> * @throws org.apache.hadoop.hbase.snapshot.UnknownSnapshotException if the requested snapshot is<a name="line.1549"></a> |
| <span class="sourceLineNo">1550</span> * unknown<a name="line.1550"></a> |
| <span class="sourceLineNo">1551</span> */<a name="line.1551"></a> |
| <span class="sourceLineNo">1552</span> boolean isSnapshotFinished(SnapshotDescription snapshot)<a name="line.1552"></a> |
| <span class="sourceLineNo">1553</span> throws IOException, HBaseSnapshotException, UnknownSnapshotException;<a name="line.1553"></a> |
| <span class="sourceLineNo">1554</span><a name="line.1554"></a> |
| <span class="sourceLineNo">1555</span> /**<a name="line.1555"></a> |
| <span class="sourceLineNo">1556</span> * Restore the specified snapshot on the original table. (The table must be disabled) If the<a name="line.1556"></a> |
| <span class="sourceLineNo">1557</span> * "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to<a name="line.1557"></a> |
| <span class="sourceLineNo">1558</span> * <code>true</code>, a snapshot of the current table is taken before executing the restore<a name="line.1558"></a> |
| <span class="sourceLineNo">1559</span> * operation. In case of restore failure, the failsafe snapshot will be restored. If the restore<a name="line.1559"></a> |
| <span class="sourceLineNo">1560</span> * completes without problem the failsafe snapshot is deleted.<a name="line.1560"></a> |
| <span class="sourceLineNo">1561</span> * @param snapshotName name of the snapshot to restore<a name="line.1561"></a> |
| <span class="sourceLineNo">1562</span> * @throws IOException if a remote or network exception occurs<a name="line.1562"></a> |
| <span class="sourceLineNo">1563</span> * @throws RestoreSnapshotException if snapshot failed to be restored<a name="line.1563"></a> |
| <span class="sourceLineNo">1564</span> * @throws IllegalArgumentException if the restore request is formatted incorrectly<a name="line.1564"></a> |
| <span class="sourceLineNo">1565</span> */<a name="line.1565"></a> |
| <span class="sourceLineNo">1566</span> void restoreSnapshot(String snapshotName) throws IOException, RestoreSnapshotException;<a name="line.1566"></a> |
| <span class="sourceLineNo">1567</span><a name="line.1567"></a> |
| <span class="sourceLineNo">1568</span> /**<a name="line.1568"></a> |
| <span class="sourceLineNo">1569</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.1569"></a> |
| <span class="sourceLineNo">1570</span> * 'takeFailSafeSnapshot' is set to <code>true</code>, a snapshot of the current table is taken<a name="line.1570"></a> |
| <span class="sourceLineNo">1571</span> * before executing the restore operation. In case of restore failure, the failsafe snapshot will<a name="line.1571"></a> |
| <span class="sourceLineNo">1572</span> * be restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.1572"></a> |
| <span class="sourceLineNo">1573</span> * failsafe snapshot name is configurable by using the property<a name="line.1573"></a> |
| <span class="sourceLineNo">1574</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.1574"></a> |
| <span class="sourceLineNo">1575</span> * @param snapshotName name of the snapshot to restore<a name="line.1575"></a> |
| <span class="sourceLineNo">1576</span> * @param takeFailSafeSnapshot <code>true</code> if the failsafe snapshot should be taken<a name="line.1576"></a> |
| <span class="sourceLineNo">1577</span> * @throws IOException if a remote or network exception occurs<a name="line.1577"></a> |
| <span class="sourceLineNo">1578</span> * @throws RestoreSnapshotException if snapshot failed to be restored<a name="line.1578"></a> |
| <span class="sourceLineNo">1579</span> * @throws IllegalArgumentException if the restore request is formatted incorrectly<a name="line.1579"></a> |
| <span class="sourceLineNo">1580</span> */<a name="line.1580"></a> |
| <span class="sourceLineNo">1581</span> default void restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot)<a name="line.1581"></a> |
| <span class="sourceLineNo">1582</span> throws IOException, RestoreSnapshotException {<a name="line.1582"></a> |
| <span class="sourceLineNo">1583</span> restoreSnapshot(snapshotName, takeFailSafeSnapshot, false);<a name="line.1583"></a> |
| <span class="sourceLineNo">1584</span> }<a name="line.1584"></a> |
| <span class="sourceLineNo">1585</span><a name="line.1585"></a> |
| <span class="sourceLineNo">1586</span> /**<a name="line.1586"></a> |
| <span class="sourceLineNo">1587</span> * Restore the specified snapshot on the original table. (The table must be disabled) If<a name="line.1587"></a> |
| <span class="sourceLineNo">1588</span> * 'takeFailSafeSnapshot' is set to <code>true</code>, a snapshot of the current table is taken<a name="line.1588"></a> |
| <span class="sourceLineNo">1589</span> * before executing the restore operation. In case of restore failure, the failsafe snapshot will<a name="line.1589"></a> |
| <span class="sourceLineNo">1590</span> * be restored. If the restore completes without problem the failsafe snapshot is deleted. The<a name="line.1590"></a> |
| <span class="sourceLineNo">1591</span> * failsafe snapshot name is configurable by using the property<a name="line.1591"></a> |
| <span class="sourceLineNo">1592</span> * "hbase.snapshot.restore.failsafe.name".<a name="line.1592"></a> |
| <span class="sourceLineNo">1593</span> * @param snapshotName name of the snapshot to restore<a name="line.1593"></a> |
| <span class="sourceLineNo">1594</span> * @param takeFailSafeSnapshot <code>true</code> if the failsafe snapshot should be taken<a name="line.1594"></a> |
| <span class="sourceLineNo">1595</span> * @param restoreAcl <code>true</code> to restore acl of snapshot<a name="line.1595"></a> |
| <span class="sourceLineNo">1596</span> * @throws IOException if a remote or network exception occurs<a name="line.1596"></a> |
| <span class="sourceLineNo">1597</span> * @throws RestoreSnapshotException if snapshot failed to be restored<a name="line.1597"></a> |
| <span class="sourceLineNo">1598</span> * @throws IllegalArgumentException if the restore request is formatted incorrectly<a name="line.1598"></a> |
| <span class="sourceLineNo">1599</span> */<a name="line.1599"></a> |
| <span class="sourceLineNo">1600</span> void restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot, boolean restoreAcl)<a name="line.1600"></a> |
| <span class="sourceLineNo">1601</span> throws IOException, RestoreSnapshotException;<a name="line.1601"></a> |
| <span class="sourceLineNo">1602</span><a name="line.1602"></a> |
| <span class="sourceLineNo">1603</span> /**<a name="line.1603"></a> |
| <span class="sourceLineNo">1604</span> * Create a new table by cloning the snapshot content.<a name="line.1604"></a> |
| <span class="sourceLineNo">1605</span> * @param snapshotName name of the snapshot to be cloned<a name="line.1605"></a> |
| <span class="sourceLineNo">1606</span> * @param tableName name of the table where the snapshot will be restored<a name="line.1606"></a> |
| <span class="sourceLineNo">1607</span> * @throws IOException if a remote or network exception occurs<a name="line.1607"></a> |
| <span class="sourceLineNo">1608</span> * @throws TableExistsException if table to be created already exists<a name="line.1608"></a> |
| <span class="sourceLineNo">1609</span> * @throws RestoreSnapshotException if snapshot failed to be cloned<a name="line.1609"></a> |
| <span class="sourceLineNo">1610</span> * @throws IllegalArgumentException if the specified table has not a valid name<a name="line.1610"></a> |
| <span class="sourceLineNo">1611</span> */<a name="line.1611"></a> |
| <span class="sourceLineNo">1612</span> default void cloneSnapshot(String snapshotName, TableName tableName)<a name="line.1612"></a> |
| <span class="sourceLineNo">1613</span> throws IOException, TableExistsException, RestoreSnapshotException {<a name="line.1613"></a> |
| <span class="sourceLineNo">1614</span> cloneSnapshot(snapshotName, tableName, false);<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> /**<a name="line.1617"></a> |
| <span class="sourceLineNo">1618</span> * Create a new table by cloning the snapshot content.<a name="line.1618"></a> |
| <span class="sourceLineNo">1619</span> * @param snapshotName name of the snapshot to be cloned<a name="line.1619"></a> |
| <span class="sourceLineNo">1620</span> * @param tableName name of the table where the snapshot will be restored<a name="line.1620"></a> |
| <span class="sourceLineNo">1621</span> * @param restoreAcl <code>true</code> to clone acl into newly created table<a name="line.1621"></a> |
| <span class="sourceLineNo">1622</span> * @throws IOException if a remote or network exception occurs<a name="line.1622"></a> |
| <span class="sourceLineNo">1623</span> * @throws TableExistsException if table to be created already exists<a name="line.1623"></a> |
| <span class="sourceLineNo">1624</span> * @throws RestoreSnapshotException if snapshot failed to be cloned<a name="line.1624"></a> |
| <span class="sourceLineNo">1625</span> * @throws IllegalArgumentException if the specified table has not a valid name<a name="line.1625"></a> |
| <span class="sourceLineNo">1626</span> */<a name="line.1626"></a> |
| <span class="sourceLineNo">1627</span> default void cloneSnapshot(String snapshotName, TableName tableName, boolean restoreAcl)<a name="line.1627"></a> |
| <span class="sourceLineNo">1628</span> throws IOException, TableExistsException, RestoreSnapshotException {<a name="line.1628"></a> |
| <span class="sourceLineNo">1629</span> get(cloneSnapshotAsync(snapshotName, tableName, restoreAcl), getSyncWaitTimeout(),<a name="line.1629"></a> |
| <span class="sourceLineNo">1630</span> TimeUnit.MILLISECONDS);<a name="line.1630"></a> |
| <span class="sourceLineNo">1631</span> }<a name="line.1631"></a> |
| <span class="sourceLineNo">1632</span><a name="line.1632"></a> |
| <span class="sourceLineNo">1633</span> /**<a name="line.1633"></a> |
| <span class="sourceLineNo">1634</span> * Create a new table by cloning the snapshot content, but does not block and wait for it to be<a name="line.1634"></a> |
| <span class="sourceLineNo">1635</span> * completely cloned. You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1635"></a> |
| <span class="sourceLineNo">1636</span> * It may throw ExecutionException if there was an error while executing the operation or<a name="line.1636"></a> |
| <span class="sourceLineNo">1637</span> * TimeoutException in case the wait timeout was not long enough to allow the operation to<a name="line.1637"></a> |
| <span class="sourceLineNo">1638</span> * complete.<a name="line.1638"></a> |
| <span class="sourceLineNo">1639</span> * @param snapshotName name of the snapshot to be cloned<a name="line.1639"></a> |
| <span class="sourceLineNo">1640</span> * @param tableName name of the table where the snapshot will be restored<a name="line.1640"></a> |
| <span class="sourceLineNo">1641</span> * @throws IOException if a remote or network exception occurs<a name="line.1641"></a> |
| <span class="sourceLineNo">1642</span> * @throws TableExistsException if table to be cloned already exists<a name="line.1642"></a> |
| <span class="sourceLineNo">1643</span> * @return the result of the async clone snapshot. You can use Future.get(long, TimeUnit) to wait<a name="line.1643"></a> |
| <span class="sourceLineNo">1644</span> * on the operation to complete.<a name="line.1644"></a> |
| <span class="sourceLineNo">1645</span> */<a name="line.1645"></a> |
| <span class="sourceLineNo">1646</span> default Future<Void> cloneSnapshotAsync(String snapshotName, TableName tableName)<a name="line.1646"></a> |
| <span class="sourceLineNo">1647</span> throws IOException, TableExistsException {<a name="line.1647"></a> |
| <span class="sourceLineNo">1648</span> return cloneSnapshotAsync(snapshotName, tableName, false);<a name="line.1648"></a> |
| <span class="sourceLineNo">1649</span> }<a name="line.1649"></a> |
| <span class="sourceLineNo">1650</span><a name="line.1650"></a> |
| <span class="sourceLineNo">1651</span> /**<a name="line.1651"></a> |
| <span class="sourceLineNo">1652</span> * Create a new table by cloning the snapshot content.<a name="line.1652"></a> |
| <span class="sourceLineNo">1653</span> * @param snapshotName name of the snapshot to be cloned<a name="line.1653"></a> |
| <span class="sourceLineNo">1654</span> * @param tableName name of the table where the snapshot will be restored<a name="line.1654"></a> |
| <span class="sourceLineNo">1655</span> * @param restoreAcl <code>true</code> to clone acl into newly created table<a name="line.1655"></a> |
| <span class="sourceLineNo">1656</span> * @throws IOException if a remote or network exception occurs<a name="line.1656"></a> |
| <span class="sourceLineNo">1657</span> * @throws TableExistsException if table to be created already exists<a name="line.1657"></a> |
| <span class="sourceLineNo">1658</span> * @throws RestoreSnapshotException if snapshot failed to be cloned<a name="line.1658"></a> |
| <span class="sourceLineNo">1659</span> * @throws IllegalArgumentException if the specified table has not a valid name<a name="line.1659"></a> |
| <span class="sourceLineNo">1660</span> */<a name="line.1660"></a> |
| <span class="sourceLineNo">1661</span> Future<Void> cloneSnapshotAsync(String snapshotName, TableName tableName, boolean restoreAcl)<a name="line.1661"></a> |
| <span class="sourceLineNo">1662</span> throws IOException, TableExistsException, RestoreSnapshotException;<a name="line.1662"></a> |
| <span class="sourceLineNo">1663</span><a name="line.1663"></a> |
| <span class="sourceLineNo">1664</span> /**<a name="line.1664"></a> |
| <span class="sourceLineNo">1665</span> * Execute a distributed procedure on a cluster.<a name="line.1665"></a> |
| <span class="sourceLineNo">1666</span> *<a name="line.1666"></a> |
| <span class="sourceLineNo">1667</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.1667"></a> |
| <span class="sourceLineNo">1668</span> * root ZK node name of the procedure).<a name="line.1668"></a> |
| <span class="sourceLineNo">1669</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.1669"></a> |
| <span class="sourceLineNo">1670</span> * optional.<a name="line.1670"></a> |
| <span class="sourceLineNo">1671</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.1671"></a> |
| <span class="sourceLineNo">1672</span> * @throws IOException if a remote or network exception occurs<a name="line.1672"></a> |
| <span class="sourceLineNo">1673</span> */<a name="line.1673"></a> |
| <span class="sourceLineNo">1674</span> void execProcedure(String signature, String instance, Map<String, String> props)<a name="line.1674"></a> |
| <span class="sourceLineNo">1675</span> throws IOException;<a name="line.1675"></a> |
| <span class="sourceLineNo">1676</span><a name="line.1676"></a> |
| <span class="sourceLineNo">1677</span> /**<a name="line.1677"></a> |
| <span class="sourceLineNo">1678</span> * Execute a distributed procedure on a cluster.<a name="line.1678"></a> |
| <span class="sourceLineNo">1679</span> *<a name="line.1679"></a> |
| <span class="sourceLineNo">1680</span> * @param signature A distributed procedure is uniquely identified by its signature (default the<a name="line.1680"></a> |
| <span class="sourceLineNo">1681</span> * root ZK node name of the procedure).<a name="line.1681"></a> |
| <span class="sourceLineNo">1682</span> * @param instance The instance name of the procedure. For some procedures, this parameter is<a name="line.1682"></a> |
| <span class="sourceLineNo">1683</span> * optional.<a name="line.1683"></a> |
| <span class="sourceLineNo">1684</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.1684"></a> |
| <span class="sourceLineNo">1685</span> * @return data returned after procedure execution. null if no return data.<a name="line.1685"></a> |
| <span class="sourceLineNo">1686</span> * @throws IOException if a remote or network exception occurs<a name="line.1686"></a> |
| <span class="sourceLineNo">1687</span> */<a name="line.1687"></a> |
| <span class="sourceLineNo">1688</span> byte[] execProcedureWithReturn(String signature, String instance, Map<String, String> props)<a name="line.1688"></a> |
| <span class="sourceLineNo">1689</span> throws IOException;<a name="line.1689"></a> |
| <span class="sourceLineNo">1690</span><a name="line.1690"></a> |
| <span class="sourceLineNo">1691</span> /**<a name="line.1691"></a> |
| <span class="sourceLineNo">1692</span> * Check the current state of the specified procedure. There are three possible states: <ol><a name="line.1692"></a> |
| <span class="sourceLineNo">1693</span> * <li>running - returns <tt>false</tt></li> <li>finished - returns <tt>true</tt></li><a name="line.1693"></a> |
| <span class="sourceLineNo">1694</span> * <li>finished with error - throws the exception that caused the procedure to fail</li> </ol><a name="line.1694"></a> |
| <span class="sourceLineNo">1695</span> *<a name="line.1695"></a> |
| <span class="sourceLineNo">1696</span> * @param signature The signature that uniquely identifies a procedure<a name="line.1696"></a> |
| <span class="sourceLineNo">1697</span> * @param instance The instance name of the procedure<a name="line.1697"></a> |
| <span class="sourceLineNo">1698</span> * @param props Property/Value pairs of properties passing to the procedure<a name="line.1698"></a> |
| <span class="sourceLineNo">1699</span> * @return <code>true</code> if the specified procedure is finished successfully, <code>false</code> if it is still running<a name="line.1699"></a> |
| <span class="sourceLineNo">1700</span> * @throws IOException if the specified procedure finished with error<a name="line.1700"></a> |
| <span class="sourceLineNo">1701</span> */<a name="line.1701"></a> |
| <span class="sourceLineNo">1702</span> boolean isProcedureFinished(String signature, String instance, Map<String, String> props)<a name="line.1702"></a> |
| <span class="sourceLineNo">1703</span> throws IOException;<a name="line.1703"></a> |
| <span class="sourceLineNo">1704</span><a name="line.1704"></a> |
| <span class="sourceLineNo">1705</span> /**<a name="line.1705"></a> |
| <span class="sourceLineNo">1706</span> * List completed snapshots.<a name="line.1706"></a> |
| <span class="sourceLineNo">1707</span> *<a name="line.1707"></a> |
| <span class="sourceLineNo">1708</span> * @return a list of snapshot descriptors for completed snapshots<a name="line.1708"></a> |
| <span class="sourceLineNo">1709</span> * @throws IOException if a network error occurs<a name="line.1709"></a> |
| <span class="sourceLineNo">1710</span> */<a name="line.1710"></a> |
| <span class="sourceLineNo">1711</span> List<SnapshotDescription> listSnapshots() throws IOException;<a name="line.1711"></a> |
| <span class="sourceLineNo">1712</span><a name="line.1712"></a> |
| <span class="sourceLineNo">1713</span> /**<a name="line.1713"></a> |
| <span class="sourceLineNo">1714</span> * List all the completed snapshots matching the given pattern.<a name="line.1714"></a> |
| <span class="sourceLineNo">1715</span> *<a name="line.1715"></a> |
| <span class="sourceLineNo">1716</span> * @param pattern The compiled regular expression to match against<a name="line.1716"></a> |
| <span class="sourceLineNo">1717</span> * @return list of SnapshotDescription<a name="line.1717"></a> |
| <span class="sourceLineNo">1718</span> * @throws IOException if a remote or network exception occurs<a name="line.1718"></a> |
| <span class="sourceLineNo">1719</span> */<a name="line.1719"></a> |
| <span class="sourceLineNo">1720</span> List<SnapshotDescription> listSnapshots(Pattern pattern) throws IOException;<a name="line.1720"></a> |
| <span class="sourceLineNo">1721</span><a name="line.1721"></a> |
| <span class="sourceLineNo">1722</span> /**<a name="line.1722"></a> |
| <span class="sourceLineNo">1723</span> * List all the completed snapshots matching the given table name regular expression and snapshot<a name="line.1723"></a> |
| <span class="sourceLineNo">1724</span> * name regular expression.<a name="line.1724"></a> |
| <span class="sourceLineNo">1725</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.1725"></a> |
| <span class="sourceLineNo">1726</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.1726"></a> |
| <span class="sourceLineNo">1727</span> * @return list of completed SnapshotDescription<a name="line.1727"></a> |
| <span class="sourceLineNo">1728</span> * @throws IOException if a remote or network exception occurs<a name="line.1728"></a> |
| <span class="sourceLineNo">1729</span> */<a name="line.1729"></a> |
| <span class="sourceLineNo">1730</span> List<SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,<a name="line.1730"></a> |
| <span class="sourceLineNo">1731</span> Pattern snapshotNamePattern) throws IOException;<a name="line.1731"></a> |
| <span class="sourceLineNo">1732</span><a name="line.1732"></a> |
| <span class="sourceLineNo">1733</span> /**<a name="line.1733"></a> |
| <span class="sourceLineNo">1734</span> * Delete an existing snapshot.<a name="line.1734"></a> |
| <span class="sourceLineNo">1735</span> *<a name="line.1735"></a> |
| <span class="sourceLineNo">1736</span> * @param snapshotName name of the snapshot<a name="line.1736"></a> |
| <span class="sourceLineNo">1737</span> * @throws IOException if a remote or network exception occurs<a name="line.1737"></a> |
| <span class="sourceLineNo">1738</span> */<a name="line.1738"></a> |
| <span class="sourceLineNo">1739</span> void deleteSnapshot(String snapshotName) throws IOException;<a name="line.1739"></a> |
| <span class="sourceLineNo">1740</span><a name="line.1740"></a> |
| <span class="sourceLineNo">1741</span> /**<a name="line.1741"></a> |
| <span class="sourceLineNo">1742</span> * Delete existing snapshots whose names match the pattern passed.<a name="line.1742"></a> |
| <span class="sourceLineNo">1743</span> *<a name="line.1743"></a> |
| <span class="sourceLineNo">1744</span> * @param pattern pattern for names of the snapshot to match<a name="line.1744"></a> |
| <span class="sourceLineNo">1745</span> * @throws IOException if a remote or network exception occurs<a name="line.1745"></a> |
| <span class="sourceLineNo">1746</span> */<a name="line.1746"></a> |
| <span class="sourceLineNo">1747</span> void deleteSnapshots(Pattern pattern) throws IOException;<a name="line.1747"></a> |
| <span class="sourceLineNo">1748</span><a name="line.1748"></a> |
| <span class="sourceLineNo">1749</span> /**<a name="line.1749"></a> |
| <span class="sourceLineNo">1750</span> * Delete all existing snapshots matching the given table name regular expression and snapshot<a name="line.1750"></a> |
| <span class="sourceLineNo">1751</span> * name regular expression.<a name="line.1751"></a> |
| <span class="sourceLineNo">1752</span> * @param tableNamePattern The compiled table name regular expression to match against<a name="line.1752"></a> |
| <span class="sourceLineNo">1753</span> * @param snapshotNamePattern The compiled snapshot name regular expression to match against<a name="line.1753"></a> |
| <span class="sourceLineNo">1754</span> * @throws IOException if a remote or network exception occurs<a name="line.1754"></a> |
| <span class="sourceLineNo">1755</span> */<a name="line.1755"></a> |
| <span class="sourceLineNo">1756</span> void deleteTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)<a name="line.1756"></a> |
| <span class="sourceLineNo">1757</span> throws IOException;<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> * Apply the new quota settings.<a name="line.1760"></a> |
| <span class="sourceLineNo">1761</span> *<a name="line.1761"></a> |
| <span class="sourceLineNo">1762</span> * @param quota the quota settings<a name="line.1762"></a> |
| <span class="sourceLineNo">1763</span> * @throws IOException if a remote or network exception occurs<a name="line.1763"></a> |
| <span class="sourceLineNo">1764</span> */<a name="line.1764"></a> |
| <span class="sourceLineNo">1765</span> void setQuota(QuotaSettings quota) throws IOException;<a name="line.1765"></a> |
| <span class="sourceLineNo">1766</span><a name="line.1766"></a> |
| <span class="sourceLineNo">1767</span> /**<a name="line.1767"></a> |
| <span class="sourceLineNo">1768</span> * List the quotas based on the filter.<a name="line.1768"></a> |
| <span class="sourceLineNo">1769</span> * @param filter the quota settings filter<a name="line.1769"></a> |
| <span class="sourceLineNo">1770</span> * @return the QuotaSetting list<a name="line.1770"></a> |
| <span class="sourceLineNo">1771</span> * @throws IOException if a remote or network exception occurs<a name="line.1771"></a> |
| <span class="sourceLineNo">1772</span> */<a name="line.1772"></a> |
| <span class="sourceLineNo">1773</span> List<QuotaSettings> getQuota(QuotaFilter filter) throws IOException;<a name="line.1773"></a> |
| <span class="sourceLineNo">1774</span><a name="line.1774"></a> |
| <span class="sourceLineNo">1775</span> /**<a name="line.1775"></a> |
| <span class="sourceLineNo">1776</span> * Creates and returns a {@link org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel}<a name="line.1776"></a> |
| <span class="sourceLineNo">1777</span> * instance connected to the active master.<a name="line.1777"></a> |
| <span class="sourceLineNo">1778</span> * <p/><a name="line.1778"></a> |
| <span class="sourceLineNo">1779</span> * The obtained {@link org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel} instance can be<a name="line.1779"></a> |
| <span class="sourceLineNo">1780</span> * used to access a published coprocessor<a name="line.1780"></a> |
| <span class="sourceLineNo">1781</span> * {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} using standard protobuf service<a name="line.1781"></a> |
| <span class="sourceLineNo">1782</span> * invocations:<a name="line.1782"></a> |
| <span class="sourceLineNo">1783</span> * <p/><a name="line.1783"></a> |
| <span class="sourceLineNo">1784</span> * <div style="background-color: #cccccc; padding: 2px"><a name="line.1784"></a> |
| <span class="sourceLineNo">1785</span> * <blockquote><a name="line.1785"></a> |
| <span class="sourceLineNo">1786</span> * <pre><a name="line.1786"></a> |
| <span class="sourceLineNo">1787</span> * CoprocessorRpcChannel channel = myAdmin.coprocessorService();<a name="line.1787"></a> |
| <span class="sourceLineNo">1788</span> * MyService.BlockingInterface service = MyService.newBlockingStub(channel);<a name="line.1788"></a> |
| <span class="sourceLineNo">1789</span> * MyCallRequest request = MyCallRequest.newBuilder()<a name="line.1789"></a> |
| <span class="sourceLineNo">1790</span> * ...<a name="line.1790"></a> |
| <span class="sourceLineNo">1791</span> * .build();<a name="line.1791"></a> |
| <span class="sourceLineNo">1792</span> * MyCallResponse response = service.myCall(null, request);<a name="line.1792"></a> |
| <span class="sourceLineNo">1793</span> * </pre><a name="line.1793"></a> |
| <span class="sourceLineNo">1794</span> * </blockquote><a name="line.1794"></a> |
| <span class="sourceLineNo">1795</span> * </div><a name="line.1795"></a> |
| <span class="sourceLineNo">1796</span> * @return A MasterCoprocessorRpcChannel instance<a name="line.1796"></a> |
| <span class="sourceLineNo">1797</span> * @deprecated since 3.0.0, will removed in 4.0.0. This is too low level, please stop using it any<a name="line.1797"></a> |
| <span class="sourceLineNo">1798</span> * more. Use the coprocessorService methods in {@link AsyncAdmin} instead.<a name="line.1798"></a> |
| <span class="sourceLineNo">1799</span> */<a name="line.1799"></a> |
| <span class="sourceLineNo">1800</span> @Deprecated<a name="line.1800"></a> |
| <span class="sourceLineNo">1801</span> CoprocessorRpcChannel coprocessorService();<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> /**<a name="line.1804"></a> |
| <span class="sourceLineNo">1805</span> * Creates and returns a {@link org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel}<a name="line.1805"></a> |
| <span class="sourceLineNo">1806</span> * instance connected to the passed region server.<a name="line.1806"></a> |
| <span class="sourceLineNo">1807</span> * <p/><a name="line.1807"></a> |
| <span class="sourceLineNo">1808</span> * The obtained {@link org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel} instance can be<a name="line.1808"></a> |
| <span class="sourceLineNo">1809</span> * used to access a published coprocessor<a name="line.1809"></a> |
| <span class="sourceLineNo">1810</span> * {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} using standard protobuf service<a name="line.1810"></a> |
| <span class="sourceLineNo">1811</span> * invocations:<a name="line.1811"></a> |
| <span class="sourceLineNo">1812</span> * <p/><a name="line.1812"></a> |
| <span class="sourceLineNo">1813</span> * <div style="background-color: #cccccc; padding: 2px"> <blockquote><a name="line.1813"></a> |
| <span class="sourceLineNo">1814</span> * <pre><a name="line.1814"></a> |
| <span class="sourceLineNo">1815</span> * CoprocessorRpcChannel channel = myAdmin.coprocessorService(serverName);<a name="line.1815"></a> |
| <span class="sourceLineNo">1816</span> * MyService.BlockingInterface service = MyService.newBlockingStub(channel);<a name="line.1816"></a> |
| <span class="sourceLineNo">1817</span> * MyCallRequest request = MyCallRequest.newBuilder()<a name="line.1817"></a> |
| <span class="sourceLineNo">1818</span> * ...<a name="line.1818"></a> |
| <span class="sourceLineNo">1819</span> * .build();<a name="line.1819"></a> |
| <span class="sourceLineNo">1820</span> * MyCallResponse response = service.myCall(null, request);<a name="line.1820"></a> |
| <span class="sourceLineNo">1821</span> * </pre><a name="line.1821"></a> |
| <span class="sourceLineNo">1822</span> * </blockquote><a name="line.1822"></a> |
| <span class="sourceLineNo">1823</span> * </div><a name="line.1823"></a> |
| <span class="sourceLineNo">1824</span> * @param serverName the server name to which the endpoint call is made<a name="line.1824"></a> |
| <span class="sourceLineNo">1825</span> * @return A RegionServerCoprocessorRpcChannel instance<a name="line.1825"></a> |
| <span class="sourceLineNo">1826</span> * @deprecated since 3.0.0, will removed in 4.0.0. This is too low level, please stop using it any<a name="line.1826"></a> |
| <span class="sourceLineNo">1827</span> * more. Use the coprocessorService methods in {@link AsyncAdmin} instead.<a name="line.1827"></a> |
| <span class="sourceLineNo">1828</span> */<a name="line.1828"></a> |
| <span class="sourceLineNo">1829</span> @Deprecated<a name="line.1829"></a> |
| <span class="sourceLineNo">1830</span> CoprocessorRpcChannel coprocessorService(ServerName serverName);<a name="line.1830"></a> |
| <span class="sourceLineNo">1831</span><a name="line.1831"></a> |
| <span class="sourceLineNo">1832</span><a name="line.1832"></a> |
| <span class="sourceLineNo">1833</span> /**<a name="line.1833"></a> |
| <span class="sourceLineNo">1834</span> * Update the configuration and trigger an online config change<a name="line.1834"></a> |
| <span class="sourceLineNo">1835</span> * on the regionserver.<a name="line.1835"></a> |
| <span class="sourceLineNo">1836</span> * @param server : The server whose config needs to be updated.<a name="line.1836"></a> |
| <span class="sourceLineNo">1837</span> * @throws IOException if a remote or network exception occurs<a name="line.1837"></a> |
| <span class="sourceLineNo">1838</span> */<a name="line.1838"></a> |
| <span class="sourceLineNo">1839</span> void updateConfiguration(ServerName server) throws IOException;<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> * Update the configuration and trigger an online config change<a name="line.1842"></a> |
| <span class="sourceLineNo">1843</span> * on all the regionservers.<a name="line.1843"></a> |
| <span class="sourceLineNo">1844</span> * @throws IOException if a remote or network exception occurs<a name="line.1844"></a> |
| <span class="sourceLineNo">1845</span> */<a name="line.1845"></a> |
| <span class="sourceLineNo">1846</span> void updateConfiguration() throws IOException;<a name="line.1846"></a> |
| <span class="sourceLineNo">1847</span><a name="line.1847"></a> |
| <span class="sourceLineNo">1848</span> /**<a name="line.1848"></a> |
| <span class="sourceLineNo">1849</span> * Update the configuration and trigger an online config change<a name="line.1849"></a> |
| <span class="sourceLineNo">1850</span> * on all the regionservers in the RSGroup.<a name="line.1850"></a> |
| <span class="sourceLineNo">1851</span> * @param groupName the group name<a name="line.1851"></a> |
| <span class="sourceLineNo">1852</span> * @throws IOException if a remote or network exception occurs<a name="line.1852"></a> |
| <span class="sourceLineNo">1853</span> */<a name="line.1853"></a> |
| <span class="sourceLineNo">1854</span> void updateConfiguration(String groupName) throws IOException;<a name="line.1854"></a> |
| <span class="sourceLineNo">1855</span><a name="line.1855"></a> |
| <span class="sourceLineNo">1856</span> /**<a name="line.1856"></a> |
| <span class="sourceLineNo">1857</span> * Get the info port of the current master if one is available.<a name="line.1857"></a> |
| <span class="sourceLineNo">1858</span> * @return master info port<a name="line.1858"></a> |
| <span class="sourceLineNo">1859</span> * @throws IOException if a remote or network exception occurs<a name="line.1859"></a> |
| <span class="sourceLineNo">1860</span> */<a name="line.1860"></a> |
| <span class="sourceLineNo">1861</span> default int getMasterInfoPort() throws IOException {<a name="line.1861"></a> |
| <span class="sourceLineNo">1862</span> return getClusterMetrics(EnumSet.of(Option.MASTER_INFO_PORT)).getMasterInfoPort();<a name="line.1862"></a> |
| <span class="sourceLineNo">1863</span> }<a name="line.1863"></a> |
| <span class="sourceLineNo">1864</span><a name="line.1864"></a> |
| <span class="sourceLineNo">1865</span> /**<a name="line.1865"></a> |
| <span class="sourceLineNo">1866</span> * Return the set of supported security capabilities.<a name="line.1866"></a> |
| <span class="sourceLineNo">1867</span> * @throws IOException if a remote or network exception occurs<a name="line.1867"></a> |
| <span class="sourceLineNo">1868</span> * @throws UnsupportedOperationException<a name="line.1868"></a> |
| <span class="sourceLineNo">1869</span> */<a name="line.1869"></a> |
| <span class="sourceLineNo">1870</span> List<SecurityCapability> getSecurityCapabilities() throws IOException;<a name="line.1870"></a> |
| <span class="sourceLineNo">1871</span><a name="line.1871"></a> |
| <span class="sourceLineNo">1872</span> /**<a name="line.1872"></a> |
| <span class="sourceLineNo">1873</span> * Turn the split switch on or off.<a name="line.1873"></a> |
| <span class="sourceLineNo">1874</span> * @param enabled enabled or not<a name="line.1874"></a> |
| <span class="sourceLineNo">1875</span> * @param synchronous If <code>true</code>, it waits until current split() call, if outstanding,<a name="line.1875"></a> |
| <span class="sourceLineNo">1876</span> * to return.<a name="line.1876"></a> |
| <span class="sourceLineNo">1877</span> * @return Previous switch value<a name="line.1877"></a> |
| <span class="sourceLineNo">1878</span> * @throws IOException if a remote or network exception occurs<a name="line.1878"></a> |
| <span class="sourceLineNo">1879</span> */<a name="line.1879"></a> |
| <span class="sourceLineNo">1880</span> boolean splitSwitch(boolean enabled, boolean synchronous) throws IOException;<a name="line.1880"></a> |
| <span class="sourceLineNo">1881</span><a name="line.1881"></a> |
| <span class="sourceLineNo">1882</span> /**<a name="line.1882"></a> |
| <span class="sourceLineNo">1883</span> * Turn the merge switch on or off.<a name="line.1883"></a> |
| <span class="sourceLineNo">1884</span> * @param enabled enabled or not<a name="line.1884"></a> |
| <span class="sourceLineNo">1885</span> * @param synchronous If <code>true</code>, it waits until current merge() call, if outstanding,<a name="line.1885"></a> |
| <span class="sourceLineNo">1886</span> * to return.<a name="line.1886"></a> |
| <span class="sourceLineNo">1887</span> * @return Previous switch value<a name="line.1887"></a> |
| <span class="sourceLineNo">1888</span> * @throws IOException if a remote or network exception occurs<a name="line.1888"></a> |
| <span class="sourceLineNo">1889</span> */<a name="line.1889"></a> |
| <span class="sourceLineNo">1890</span> boolean mergeSwitch(boolean enabled, boolean synchronous) throws IOException;<a name="line.1890"></a> |
| <span class="sourceLineNo">1891</span><a name="line.1891"></a> |
| <span class="sourceLineNo">1892</span> /**<a name="line.1892"></a> |
| <span class="sourceLineNo">1893</span> * Query the current state of the split switch.<a name="line.1893"></a> |
| <span class="sourceLineNo">1894</span> * @return <code>true</code> if the switch is enabled, <code>false</code> otherwise.<a name="line.1894"></a> |
| <span class="sourceLineNo">1895</span> * @throws IOException if a remote or network exception occurs<a name="line.1895"></a> |
| <span class="sourceLineNo">1896</span> */<a name="line.1896"></a> |
| <span class="sourceLineNo">1897</span> boolean isSplitEnabled() throws IOException;<a name="line.1897"></a> |
| <span class="sourceLineNo">1898</span><a name="line.1898"></a> |
| <span class="sourceLineNo">1899</span> /**<a name="line.1899"></a> |
| <span class="sourceLineNo">1900</span> * Query the current state of the merge switch.<a name="line.1900"></a> |
| <span class="sourceLineNo">1901</span> * @return <code>true</code> if the switch is enabled, <code>false</code> otherwise.<a name="line.1901"></a> |
| <span class="sourceLineNo">1902</span> * @throws IOException if a remote or network exception occurs<a name="line.1902"></a> |
| <span class="sourceLineNo">1903</span> */<a name="line.1903"></a> |
| <span class="sourceLineNo">1904</span> boolean isMergeEnabled() throws IOException;<a name="line.1904"></a> |
| <span class="sourceLineNo">1905</span><a name="line.1905"></a> |
| <span class="sourceLineNo">1906</span> /**<a name="line.1906"></a> |
| <span class="sourceLineNo">1907</span> * Add a new replication peer for replicating data to slave cluster.<a name="line.1907"></a> |
| <span class="sourceLineNo">1908</span> * @param peerId a short name that identifies the peer<a name="line.1908"></a> |
| <span class="sourceLineNo">1909</span> * @param peerConfig configuration for the replication peer<a name="line.1909"></a> |
| <span class="sourceLineNo">1910</span> * @throws IOException if a remote or network exception occurs<a name="line.1910"></a> |
| <span class="sourceLineNo">1911</span> */<a name="line.1911"></a> |
| <span class="sourceLineNo">1912</span> default void addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig)<a name="line.1912"></a> |
| <span class="sourceLineNo">1913</span> throws IOException {<a name="line.1913"></a> |
| <span class="sourceLineNo">1914</span> addReplicationPeer(peerId, peerConfig, true);<a name="line.1914"></a> |
| <span class="sourceLineNo">1915</span> }<a name="line.1915"></a> |
| <span class="sourceLineNo">1916</span><a name="line.1916"></a> |
| <span class="sourceLineNo">1917</span> /**<a name="line.1917"></a> |
| <span class="sourceLineNo">1918</span> * Add a new replication peer for replicating data to slave cluster.<a name="line.1918"></a> |
| <span class="sourceLineNo">1919</span> * @param peerId a short name that identifies the peer<a name="line.1919"></a> |
| <span class="sourceLineNo">1920</span> * @param peerConfig configuration for the replication peer<a name="line.1920"></a> |
| <span class="sourceLineNo">1921</span> * @param enabled peer state, true if ENABLED and false if DISABLED<a name="line.1921"></a> |
| <span class="sourceLineNo">1922</span> * @throws IOException if a remote or network exception occurs<a name="line.1922"></a> |
| <span class="sourceLineNo">1923</span> */<a name="line.1923"></a> |
| <span class="sourceLineNo">1924</span> default void addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig, boolean enabled)<a name="line.1924"></a> |
| <span class="sourceLineNo">1925</span> throws IOException {<a name="line.1925"></a> |
| <span class="sourceLineNo">1926</span> get(addReplicationPeerAsync(peerId, peerConfig, enabled), getSyncWaitTimeout(),<a name="line.1926"></a> |
| <span class="sourceLineNo">1927</span> TimeUnit.MILLISECONDS);<a name="line.1927"></a> |
| <span class="sourceLineNo">1928</span> }<a name="line.1928"></a> |
| <span class="sourceLineNo">1929</span><a name="line.1929"></a> |
| <span class="sourceLineNo">1930</span> /**<a name="line.1930"></a> |
| <span class="sourceLineNo">1931</span> * Add a new replication peer but does not block and wait for it.<a name="line.1931"></a> |
| <span class="sourceLineNo">1932</span> * <p/><a name="line.1932"></a> |
| <span class="sourceLineNo">1933</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.1933"></a> |
| <span class="sourceLineNo">1934</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.1934"></a> |
| <span class="sourceLineNo">1935</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.1935"></a> |
| <span class="sourceLineNo">1936</span> * @param peerId a short name that identifies the peer<a name="line.1936"></a> |
| <span class="sourceLineNo">1937</span> * @param peerConfig configuration for the replication peer<a name="line.1937"></a> |
| <span class="sourceLineNo">1938</span> * @return the result of the async operation<a name="line.1938"></a> |
| <span class="sourceLineNo">1939</span> * @throws IOException IOException if a remote or network exception occurs<a name="line.1939"></a> |
| <span class="sourceLineNo">1940</span> */<a name="line.1940"></a> |
| <span class="sourceLineNo">1941</span> default Future<Void> addReplicationPeerAsync(String peerId, ReplicationPeerConfig peerConfig)<a name="line.1941"></a> |
| <span class="sourceLineNo">1942</span> throws IOException {<a name="line.1942"></a> |
| <span class="sourceLineNo">1943</span> return addReplicationPeerAsync(peerId, peerConfig, true);<a name="line.1943"></a> |
| <span class="sourceLineNo">1944</span> }<a name="line.1944"></a> |
| <span class="sourceLineNo">1945</span><a name="line.1945"></a> |
| <span class="sourceLineNo">1946</span> /**<a name="line.1946"></a> |
| <span class="sourceLineNo">1947</span> * Add a new replication peer but does not block and wait for it.<a name="line.1947"></a> |
| <span class="sourceLineNo">1948</span> * <p><a name="line.1948"></a> |
| <span class="sourceLineNo">1949</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.1949"></a> |
| <span class="sourceLineNo">1950</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.1950"></a> |
| <span class="sourceLineNo">1951</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.1951"></a> |
| <span class="sourceLineNo">1952</span> * @param peerId a short name that identifies the peer<a name="line.1952"></a> |
| <span class="sourceLineNo">1953</span> * @param peerConfig configuration for the replication peer<a name="line.1953"></a> |
| <span class="sourceLineNo">1954</span> * @param enabled peer state, true if ENABLED and false if DISABLED<a name="line.1954"></a> |
| <span class="sourceLineNo">1955</span> * @return the result of the async operation<a name="line.1955"></a> |
| <span class="sourceLineNo">1956</span> * @throws IOException IOException if a remote or network exception occurs<a name="line.1956"></a> |
| <span class="sourceLineNo">1957</span> */<a name="line.1957"></a> |
| <span class="sourceLineNo">1958</span> Future<Void> addReplicationPeerAsync(String peerId, ReplicationPeerConfig peerConfig,<a name="line.1958"></a> |
| <span class="sourceLineNo">1959</span> boolean enabled) throws IOException;<a name="line.1959"></a> |
| <span class="sourceLineNo">1960</span><a name="line.1960"></a> |
| <span class="sourceLineNo">1961</span> /**<a name="line.1961"></a> |
| <span class="sourceLineNo">1962</span> * Remove a peer and stop the replication.<a name="line.1962"></a> |
| <span class="sourceLineNo">1963</span> * @param peerId a short name that identifies the peer<a name="line.1963"></a> |
| <span class="sourceLineNo">1964</span> * @throws IOException if a remote or network exception occurs<a name="line.1964"></a> |
| <span class="sourceLineNo">1965</span> */<a name="line.1965"></a> |
| <span class="sourceLineNo">1966</span> default void removeReplicationPeer(String peerId) throws IOException {<a name="line.1966"></a> |
| <span class="sourceLineNo">1967</span> get(removeReplicationPeerAsync(peerId), getSyncWaitTimeout(),<a name="line.1967"></a> |
| <span class="sourceLineNo">1968</span> TimeUnit.MILLISECONDS);<a name="line.1968"></a> |
| <span class="sourceLineNo">1969</span> }<a name="line.1969"></a> |
| <span class="sourceLineNo">1970</span><a name="line.1970"></a> |
| <span class="sourceLineNo">1971</span> /**<a name="line.1971"></a> |
| <span class="sourceLineNo">1972</span> * Remove a replication peer but does not block and wait for it.<a name="line.1972"></a> |
| <span class="sourceLineNo">1973</span> * <p><a name="line.1973"></a> |
| <span class="sourceLineNo">1974</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.1974"></a> |
| <span class="sourceLineNo">1975</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.1975"></a> |
| <span class="sourceLineNo">1976</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.1976"></a> |
| <span class="sourceLineNo">1977</span> * @param peerId a short name that identifies the peer<a name="line.1977"></a> |
| <span class="sourceLineNo">1978</span> * @return the result of the async operation<a name="line.1978"></a> |
| <span class="sourceLineNo">1979</span> * @throws IOException IOException if a remote or network exception occurs<a name="line.1979"></a> |
| <span class="sourceLineNo">1980</span> */<a name="line.1980"></a> |
| <span class="sourceLineNo">1981</span> Future<Void> removeReplicationPeerAsync(String peerId) throws IOException;<a name="line.1981"></a> |
| <span class="sourceLineNo">1982</span><a name="line.1982"></a> |
| <span class="sourceLineNo">1983</span> /**<a name="line.1983"></a> |
| <span class="sourceLineNo">1984</span> * Restart the replication stream to the specified peer.<a name="line.1984"></a> |
| <span class="sourceLineNo">1985</span> * @param peerId a short name that identifies the peer<a name="line.1985"></a> |
| <span class="sourceLineNo">1986</span> * @throws IOException if a remote or network exception occurs<a name="line.1986"></a> |
| <span class="sourceLineNo">1987</span> */<a name="line.1987"></a> |
| <span class="sourceLineNo">1988</span> default void enableReplicationPeer(String peerId) throws IOException {<a name="line.1988"></a> |
| <span class="sourceLineNo">1989</span> get(enableReplicationPeerAsync(peerId), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.1989"></a> |
| <span class="sourceLineNo">1990</span> }<a name="line.1990"></a> |
| <span class="sourceLineNo">1991</span><a name="line.1991"></a> |
| <span class="sourceLineNo">1992</span> /**<a name="line.1992"></a> |
| <span class="sourceLineNo">1993</span> * Enable a replication peer but does not block and wait for it.<a name="line.1993"></a> |
| <span class="sourceLineNo">1994</span> * <p><a name="line.1994"></a> |
| <span class="sourceLineNo">1995</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.1995"></a> |
| <span class="sourceLineNo">1996</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.1996"></a> |
| <span class="sourceLineNo">1997</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.1997"></a> |
| <span class="sourceLineNo">1998</span> * @param peerId a short name that identifies the peer<a name="line.1998"></a> |
| <span class="sourceLineNo">1999</span> * @return the result of the async operation<a name="line.1999"></a> |
| <span class="sourceLineNo">2000</span> * @throws IOException IOException if a remote or network exception occurs<a name="line.2000"></a> |
| <span class="sourceLineNo">2001</span> */<a name="line.2001"></a> |
| <span class="sourceLineNo">2002</span> Future<Void> enableReplicationPeerAsync(String peerId) throws IOException;<a name="line.2002"></a> |
| <span class="sourceLineNo">2003</span><a name="line.2003"></a> |
| <span class="sourceLineNo">2004</span> /**<a name="line.2004"></a> |
| <span class="sourceLineNo">2005</span> * Stop the replication stream to the specified peer.<a name="line.2005"></a> |
| <span class="sourceLineNo">2006</span> * @param peerId a short name that identifies the peer<a name="line.2006"></a> |
| <span class="sourceLineNo">2007</span> * @throws IOException if a remote or network exception occurs<a name="line.2007"></a> |
| <span class="sourceLineNo">2008</span> */<a name="line.2008"></a> |
| <span class="sourceLineNo">2009</span> default void disableReplicationPeer(String peerId) throws IOException {<a name="line.2009"></a> |
| <span class="sourceLineNo">2010</span> get(disableReplicationPeerAsync(peerId), getSyncWaitTimeout(), TimeUnit.MILLISECONDS);<a name="line.2010"></a> |
| <span class="sourceLineNo">2011</span> }<a name="line.2011"></a> |
| <span class="sourceLineNo">2012</span><a name="line.2012"></a> |
| <span class="sourceLineNo">2013</span> /**<a name="line.2013"></a> |
| <span class="sourceLineNo">2014</span> * Disable a replication peer but does not block and wait for it.<a name="line.2014"></a> |
| <span class="sourceLineNo">2015</span> * <p/><a name="line.2015"></a> |
| <span class="sourceLineNo">2016</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.2016"></a> |
| <span class="sourceLineNo">2017</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.2017"></a> |
| <span class="sourceLineNo">2018</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.2018"></a> |
| <span class="sourceLineNo">2019</span> * @param peerId a short name that identifies the peer<a name="line.2019"></a> |
| <span class="sourceLineNo">2020</span> * @return the result of the async operation<a name="line.2020"></a> |
| <span class="sourceLineNo">2021</span> * @throws IOException IOException if a remote or network exception occurs<a name="line.2021"></a> |
| <span class="sourceLineNo">2022</span> */<a name="line.2022"></a> |
| <span class="sourceLineNo">2023</span> Future<Void> disableReplicationPeerAsync(String peerId) throws IOException;<a name="line.2023"></a> |
| <span class="sourceLineNo">2024</span><a name="line.2024"></a> |
| <span class="sourceLineNo">2025</span> /**<a name="line.2025"></a> |
| <span class="sourceLineNo">2026</span> * Returns the configured ReplicationPeerConfig for the specified peer.<a name="line.2026"></a> |
| <span class="sourceLineNo">2027</span> * @param peerId a short name that identifies the peer<a name="line.2027"></a> |
| <span class="sourceLineNo">2028</span> * @return ReplicationPeerConfig for the peer<a name="line.2028"></a> |
| <span class="sourceLineNo">2029</span> * @throws IOException if a remote or network exception occurs<a name="line.2029"></a> |
| <span class="sourceLineNo">2030</span> */<a name="line.2030"></a> |
| <span class="sourceLineNo">2031</span> ReplicationPeerConfig getReplicationPeerConfig(String peerId) throws IOException;<a name="line.2031"></a> |
| <span class="sourceLineNo">2032</span><a name="line.2032"></a> |
| <span class="sourceLineNo">2033</span> /**<a name="line.2033"></a> |
| <span class="sourceLineNo">2034</span> * Update the peerConfig for the specified peer.<a name="line.2034"></a> |
| <span class="sourceLineNo">2035</span> * @param peerId a short name that identifies the peer<a name="line.2035"></a> |
| <span class="sourceLineNo">2036</span> * @param peerConfig new config for the replication peer<a name="line.2036"></a> |
| <span class="sourceLineNo">2037</span> * @throws IOException if a remote or network exception occurs<a name="line.2037"></a> |
| <span class="sourceLineNo">2038</span> */<a name="line.2038"></a> |
| <span class="sourceLineNo">2039</span> default void updateReplicationPeerConfig(String peerId, ReplicationPeerConfig peerConfig)<a name="line.2039"></a> |
| <span class="sourceLineNo">2040</span> throws IOException {<a name="line.2040"></a> |
| <span class="sourceLineNo">2041</span> get(updateReplicationPeerConfigAsync(peerId, peerConfig), getSyncWaitTimeout(),<a name="line.2041"></a> |
| <span class="sourceLineNo">2042</span> TimeUnit.MILLISECONDS);<a name="line.2042"></a> |
| <span class="sourceLineNo">2043</span> }<a name="line.2043"></a> |
| <span class="sourceLineNo">2044</span><a name="line.2044"></a> |
| <span class="sourceLineNo">2045</span> /**<a name="line.2045"></a> |
| <span class="sourceLineNo">2046</span> * Update the peerConfig for the specified peer but does not block and wait for it.<a name="line.2046"></a> |
| <span class="sourceLineNo">2047</span> * <p/><a name="line.2047"></a> |
| <span class="sourceLineNo">2048</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.2048"></a> |
| <span class="sourceLineNo">2049</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.2049"></a> |
| <span class="sourceLineNo">2050</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.2050"></a> |
| <span class="sourceLineNo">2051</span> * @param peerId a short name that identifies the peer<a name="line.2051"></a> |
| <span class="sourceLineNo">2052</span> * @param peerConfig new config for the replication peer<a name="line.2052"></a> |
| <span class="sourceLineNo">2053</span> * @return the result of the async operation<a name="line.2053"></a> |
| <span class="sourceLineNo">2054</span> * @throws IOException IOException if a remote or network exception occurs<a name="line.2054"></a> |
| <span class="sourceLineNo">2055</span> */<a name="line.2055"></a> |
| <span class="sourceLineNo">2056</span> Future<Void> updateReplicationPeerConfigAsync(String peerId, ReplicationPeerConfig peerConfig)<a name="line.2056"></a> |
| <span class="sourceLineNo">2057</span> throws IOException;<a name="line.2057"></a> |
| <span class="sourceLineNo">2058</span><a name="line.2058"></a> |
| <span class="sourceLineNo">2059</span> /**<a name="line.2059"></a> |
| <span class="sourceLineNo">2060</span> * Append the replicable table column family config from the specified peer.<a name="line.2060"></a> |
| <span class="sourceLineNo">2061</span> * @param id a short that identifies the cluster<a name="line.2061"></a> |
| <span class="sourceLineNo">2062</span> * @param tableCfs A map from tableName to column family names<a name="line.2062"></a> |
| <span class="sourceLineNo">2063</span> * @throws ReplicationException if tableCfs has conflict with existing config<a name="line.2063"></a> |
| <span class="sourceLineNo">2064</span> * @throws IOException if a remote or network exception occurs<a name="line.2064"></a> |
| <span class="sourceLineNo">2065</span> */<a name="line.2065"></a> |
| <span class="sourceLineNo">2066</span> default void appendReplicationPeerTableCFs(String id, Map<TableName, List<String>> tableCfs)<a name="line.2066"></a> |
| <span class="sourceLineNo">2067</span> throws ReplicationException, IOException {<a name="line.2067"></a> |
| <span class="sourceLineNo">2068</span> if (tableCfs == null) {<a name="line.2068"></a> |
| <span class="sourceLineNo">2069</span> throw new ReplicationException("tableCfs is null");<a name="line.2069"></a> |
| <span class="sourceLineNo">2070</span> }<a name="line.2070"></a> |
| <span class="sourceLineNo">2071</span> ReplicationPeerConfig peerConfig = getReplicationPeerConfig(id);<a name="line.2071"></a> |
| <span class="sourceLineNo">2072</span> ReplicationPeerConfig newPeerConfig =<a name="line.2072"></a> |
| <span class="sourceLineNo">2073</span> ReplicationPeerConfigUtil.appendTableCFsToReplicationPeerConfig(tableCfs, peerConfig);<a name="line.2073"></a> |
| <span class="sourceLineNo">2074</span> updateReplicationPeerConfig(id, newPeerConfig);<a name="line.2074"></a> |
| <span class="sourceLineNo">2075</span> }<a name="line.2075"></a> |
| <span class="sourceLineNo">2076</span><a name="line.2076"></a> |
| <span class="sourceLineNo">2077</span> /**<a name="line.2077"></a> |
| <span class="sourceLineNo">2078</span> * Remove some table-cfs from config of the specified peer.<a name="line.2078"></a> |
| <span class="sourceLineNo">2079</span> * @param id a short name that identifies the cluster<a name="line.2079"></a> |
| <span class="sourceLineNo">2080</span> * @param tableCfs A map from tableName to column family names<a name="line.2080"></a> |
| <span class="sourceLineNo">2081</span> * @throws ReplicationException if tableCfs has conflict with existing config<a name="line.2081"></a> |
| <span class="sourceLineNo">2082</span> * @throws IOException if a remote or network exception occurs<a name="line.2082"></a> |
| <span class="sourceLineNo">2083</span> */<a name="line.2083"></a> |
| <span class="sourceLineNo">2084</span> default void removeReplicationPeerTableCFs(String id, Map<TableName, List<String>> tableCfs)<a name="line.2084"></a> |
| <span class="sourceLineNo">2085</span> throws ReplicationException, IOException {<a name="line.2085"></a> |
| <span class="sourceLineNo">2086</span> if (tableCfs == null) {<a name="line.2086"></a> |
| <span class="sourceLineNo">2087</span> throw new ReplicationException("tableCfs is null");<a name="line.2087"></a> |
| <span class="sourceLineNo">2088</span> }<a name="line.2088"></a> |
| <span class="sourceLineNo">2089</span> ReplicationPeerConfig peerConfig = getReplicationPeerConfig(id);<a name="line.2089"></a> |
| <span class="sourceLineNo">2090</span> ReplicationPeerConfig newPeerConfig =<a name="line.2090"></a> |
| <span class="sourceLineNo">2091</span> ReplicationPeerConfigUtil.removeTableCFsFromReplicationPeerConfig(tableCfs, peerConfig, id);<a name="line.2091"></a> |
| <span class="sourceLineNo">2092</span> updateReplicationPeerConfig(id, newPeerConfig);<a name="line.2092"></a> |
| <span class="sourceLineNo">2093</span> }<a name="line.2093"></a> |
| <span class="sourceLineNo">2094</span><a name="line.2094"></a> |
| <span class="sourceLineNo">2095</span> /**<a name="line.2095"></a> |
| <span class="sourceLineNo">2096</span> * Return a list of replication peers.<a name="line.2096"></a> |
| <span class="sourceLineNo">2097</span> * @return a list of replication peers description<a name="line.2097"></a> |
| <span class="sourceLineNo">2098</span> * @throws IOException if a remote or network exception occurs<a name="line.2098"></a> |
| <span class="sourceLineNo">2099</span> */<a name="line.2099"></a> |
| <span class="sourceLineNo">2100</span> List<ReplicationPeerDescription> listReplicationPeers() throws IOException;<a name="line.2100"></a> |
| <span class="sourceLineNo">2101</span><a name="line.2101"></a> |
| <span class="sourceLineNo">2102</span> /**<a name="line.2102"></a> |
| <span class="sourceLineNo">2103</span> * Return a list of replication peers.<a name="line.2103"></a> |
| <span class="sourceLineNo">2104</span> * @param pattern The compiled regular expression to match peer id<a name="line.2104"></a> |
| <span class="sourceLineNo">2105</span> * @return a list of replication peers description<a name="line.2105"></a> |
| <span class="sourceLineNo">2106</span> * @throws IOException if a remote or network exception occurs<a name="line.2106"></a> |
| <span class="sourceLineNo">2107</span> */<a name="line.2107"></a> |
| <span class="sourceLineNo">2108</span> List<ReplicationPeerDescription> listReplicationPeers(Pattern pattern) throws IOException;<a name="line.2108"></a> |
| <span class="sourceLineNo">2109</span><a name="line.2109"></a> |
| <span class="sourceLineNo">2110</span> /**<a name="line.2110"></a> |
| <span class="sourceLineNo">2111</span> * Transit current cluster to a new state in a synchronous replication peer.<a name="line.2111"></a> |
| <span class="sourceLineNo">2112</span> * @param peerId a short name that identifies the peer<a name="line.2112"></a> |
| <span class="sourceLineNo">2113</span> * @param state a new state of current cluster<a name="line.2113"></a> |
| <span class="sourceLineNo">2114</span> * @throws IOException if a remote or network exception occurs<a name="line.2114"></a> |
| <span class="sourceLineNo">2115</span> */<a name="line.2115"></a> |
| <span class="sourceLineNo">2116</span> default void transitReplicationPeerSyncReplicationState(String peerId, SyncReplicationState state)<a name="line.2116"></a> |
| <span class="sourceLineNo">2117</span> throws IOException {<a name="line.2117"></a> |
| <span class="sourceLineNo">2118</span> get(transitReplicationPeerSyncReplicationStateAsync(peerId, state), getSyncWaitTimeout(),<a name="line.2118"></a> |
| <span class="sourceLineNo">2119</span> TimeUnit.MILLISECONDS);<a name="line.2119"></a> |
| <span class="sourceLineNo">2120</span> }<a name="line.2120"></a> |
| <span class="sourceLineNo">2121</span><a name="line.2121"></a> |
| <span class="sourceLineNo">2122</span> /**<a name="line.2122"></a> |
| <span class="sourceLineNo">2123</span> * Transit current cluster to a new state in a synchronous replication peer. But does not block<a name="line.2123"></a> |
| <span class="sourceLineNo">2124</span> * and wait for it.<a name="line.2124"></a> |
| <span class="sourceLineNo">2125</span> * <p><a name="line.2125"></a> |
| <span class="sourceLineNo">2126</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.2126"></a> |
| <span class="sourceLineNo">2127</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.2127"></a> |
| <span class="sourceLineNo">2128</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.2128"></a> |
| <span class="sourceLineNo">2129</span> * @param peerId a short name that identifies the peer<a name="line.2129"></a> |
| <span class="sourceLineNo">2130</span> * @param state a new state of current cluster<a name="line.2130"></a> |
| <span class="sourceLineNo">2131</span> * @throws IOException if a remote or network exception occurs<a name="line.2131"></a> |
| <span class="sourceLineNo">2132</span> */<a name="line.2132"></a> |
| <span class="sourceLineNo">2133</span> Future<Void> transitReplicationPeerSyncReplicationStateAsync(String peerId,<a name="line.2133"></a> |
| <span class="sourceLineNo">2134</span> SyncReplicationState state) throws IOException;<a name="line.2134"></a> |
| <span class="sourceLineNo">2135</span><a name="line.2135"></a> |
| <span class="sourceLineNo">2136</span> /**<a name="line.2136"></a> |
| <span class="sourceLineNo">2137</span> * Get the current cluster state in a synchronous replication peer.<a name="line.2137"></a> |
| <span class="sourceLineNo">2138</span> * @param peerId a short name that identifies the peer<a name="line.2138"></a> |
| <span class="sourceLineNo">2139</span> * @return the current cluster state<a name="line.2139"></a> |
| <span class="sourceLineNo">2140</span> * @throws IOException if a remote or network exception occurs<a name="line.2140"></a> |
| <span class="sourceLineNo">2141</span> */<a name="line.2141"></a> |
| <span class="sourceLineNo">2142</span> default SyncReplicationState getReplicationPeerSyncReplicationState(String peerId)<a name="line.2142"></a> |
| <span class="sourceLineNo">2143</span> throws IOException {<a name="line.2143"></a> |
| <span class="sourceLineNo">2144</span> List<ReplicationPeerDescription> peers = listReplicationPeers(Pattern.compile(peerId));<a name="line.2144"></a> |
| <span class="sourceLineNo">2145</span> if (peers.isEmpty() || !peers.get(0).getPeerId().equals(peerId)) {<a name="line.2145"></a> |
| <span class="sourceLineNo">2146</span> throw new IOException("Replication peer " + peerId + " does not exist");<a name="line.2146"></a> |
| <span class="sourceLineNo">2147</span> }<a name="line.2147"></a> |
| <span class="sourceLineNo">2148</span> return peers.get(0).getSyncReplicationState();<a name="line.2148"></a> |
| <span class="sourceLineNo">2149</span> }<a name="line.2149"></a> |
| <span class="sourceLineNo">2150</span><a name="line.2150"></a> |
| <span class="sourceLineNo">2151</span> /**<a name="line.2151"></a> |
| <span class="sourceLineNo">2152</span> * Mark region server(s) as decommissioned to prevent additional regions from getting<a name="line.2152"></a> |
| <span class="sourceLineNo">2153</span> * assigned to them. Optionally unload the regions on the servers. If there are multiple servers<a name="line.2153"></a> |
| <span class="sourceLineNo">2154</span> * to be decommissioned, decommissioning them at the same time can prevent wasteful region<a name="line.2154"></a> |
| <span class="sourceLineNo">2155</span> * movements. Region unloading is asynchronous.<a name="line.2155"></a> |
| <span class="sourceLineNo">2156</span> * @param servers The list of servers to decommission.<a name="line.2156"></a> |
| <span class="sourceLineNo">2157</span> * @param offload True to offload the regions from the decommissioned servers<a name="line.2157"></a> |
| <span class="sourceLineNo">2158</span> * @throws IOException if a remote or network exception occurs<a name="line.2158"></a> |
| <span class="sourceLineNo">2159</span> */<a name="line.2159"></a> |
| <span class="sourceLineNo">2160</span> void decommissionRegionServers(List<ServerName> servers, boolean offload) throws IOException;<a name="line.2160"></a> |
| <span class="sourceLineNo">2161</span><a name="line.2161"></a> |
| <span class="sourceLineNo">2162</span> /**<a name="line.2162"></a> |
| <span class="sourceLineNo">2163</span> * List region servers marked as decommissioned, which can not be assigned regions.<a name="line.2163"></a> |
| <span class="sourceLineNo">2164</span> * @return List of decommissioned region servers.<a name="line.2164"></a> |
| <span class="sourceLineNo">2165</span> * @throws IOException if a remote or network exception occurs<a name="line.2165"></a> |
| <span class="sourceLineNo">2166</span> */<a name="line.2166"></a> |
| <span class="sourceLineNo">2167</span> List<ServerName> listDecommissionedRegionServers() throws IOException;<a name="line.2167"></a> |
| <span class="sourceLineNo">2168</span><a name="line.2168"></a> |
| <span class="sourceLineNo">2169</span> /**<a name="line.2169"></a> |
| <span class="sourceLineNo">2170</span> * Remove decommission marker from a region server to allow regions assignments.<a name="line.2170"></a> |
| <span class="sourceLineNo">2171</span> * Load regions onto the server if a list of regions is given. Region loading is<a name="line.2171"></a> |
| <span class="sourceLineNo">2172</span> * asynchronous.<a name="line.2172"></a> |
| <span class="sourceLineNo">2173</span> * @param server The server to recommission.<a name="line.2173"></a> |
| <span class="sourceLineNo">2174</span> * @param encodedRegionNames Regions to load onto the server.<a name="line.2174"></a> |
| <span class="sourceLineNo">2175</span> * @throws IOException if a remote or network exception occurs<a name="line.2175"></a> |
| <span class="sourceLineNo">2176</span> */<a name="line.2176"></a> |
| <span class="sourceLineNo">2177</span> void recommissionRegionServer(ServerName server, List<byte[]> encodedRegionNames)<a name="line.2177"></a> |
| <span class="sourceLineNo">2178</span> throws IOException;<a name="line.2178"></a> |
| <span class="sourceLineNo">2179</span><a name="line.2179"></a> |
| <span class="sourceLineNo">2180</span> /**<a name="line.2180"></a> |
| <span class="sourceLineNo">2181</span> * Find all table and column families that are replicated from this cluster<a name="line.2181"></a> |
| <span class="sourceLineNo">2182</span> * @return the replicated table-cfs list of this cluster.<a name="line.2182"></a> |
| <span class="sourceLineNo">2183</span> * @throws IOException if a remote or network exception occurs<a name="line.2183"></a> |
| <span class="sourceLineNo">2184</span> */<a name="line.2184"></a> |
| <span class="sourceLineNo">2185</span> List<TableCFs> listReplicatedTableCFs() throws IOException;<a name="line.2185"></a> |
| <span class="sourceLineNo">2186</span><a name="line.2186"></a> |
| <span class="sourceLineNo">2187</span> /**<a name="line.2187"></a> |
| <span class="sourceLineNo">2188</span> * Enable a table's replication switch.<a name="line.2188"></a> |
| <span class="sourceLineNo">2189</span> * @param tableName name of the table<a name="line.2189"></a> |
| <span class="sourceLineNo">2190</span> * @throws IOException if a remote or network exception occurs<a name="line.2190"></a> |
| <span class="sourceLineNo">2191</span> */<a name="line.2191"></a> |
| <span class="sourceLineNo">2192</span> void enableTableReplication(TableName tableName) throws IOException;<a name="line.2192"></a> |
| <span class="sourceLineNo">2193</span><a name="line.2193"></a> |
| <span class="sourceLineNo">2194</span> /**<a name="line.2194"></a> |
| <span class="sourceLineNo">2195</span> * Disable a table's replication switch.<a name="line.2195"></a> |
| <span class="sourceLineNo">2196</span> * @param tableName name of the table<a name="line.2196"></a> |
| <span class="sourceLineNo">2197</span> * @throws IOException if a remote or network exception occurs<a name="line.2197"></a> |
| <span class="sourceLineNo">2198</span> */<a name="line.2198"></a> |
| <span class="sourceLineNo">2199</span> void disableTableReplication(TableName tableName) throws IOException;<a name="line.2199"></a> |
| <span class="sourceLineNo">2200</span><a name="line.2200"></a> |
| <span class="sourceLineNo">2201</span> /**<a name="line.2201"></a> |
| <span class="sourceLineNo">2202</span> * Clear compacting queues on a regionserver.<a name="line.2202"></a> |
| <span class="sourceLineNo">2203</span> * @param serverName the region server name<a name="line.2203"></a> |
| <span class="sourceLineNo">2204</span> * @param queues the set of queue name<a name="line.2204"></a> |
| <span class="sourceLineNo">2205</span> * @throws IOException if a remote or network exception occurs<a name="line.2205"></a> |
| <span class="sourceLineNo">2206</span> * @throws InterruptedException<a name="line.2206"></a> |
| <span class="sourceLineNo">2207</span> */<a name="line.2207"></a> |
| <span class="sourceLineNo">2208</span> void clearCompactionQueues(ServerName serverName, Set<String> queues)<a name="line.2208"></a> |
| <span class="sourceLineNo">2209</span> throws IOException, InterruptedException;<a name="line.2209"></a> |
| <span class="sourceLineNo">2210</span><a name="line.2210"></a> |
| <span class="sourceLineNo">2211</span> /**<a name="line.2211"></a> |
| <span class="sourceLineNo">2212</span> * List dead region servers.<a name="line.2212"></a> |
| <span class="sourceLineNo">2213</span> * @return List of dead region servers.<a name="line.2213"></a> |
| <span class="sourceLineNo">2214</span> */<a name="line.2214"></a> |
| <span class="sourceLineNo">2215</span> default List<ServerName> listDeadServers() throws IOException {<a name="line.2215"></a> |
| <span class="sourceLineNo">2216</span> return getClusterMetrics(EnumSet.of(Option.DEAD_SERVERS)).getDeadServerNames();<a name="line.2216"></a> |
| <span class="sourceLineNo">2217</span> }<a name="line.2217"></a> |
| <span class="sourceLineNo">2218</span><a name="line.2218"></a> |
| <span class="sourceLineNo">2219</span> /**<a name="line.2219"></a> |
| <span class="sourceLineNo">2220</span> * Clear dead region servers from master.<a name="line.2220"></a> |
| <span class="sourceLineNo">2221</span> * @param servers list of dead region servers.<a name="line.2221"></a> |
| <span class="sourceLineNo">2222</span> * @throws IOException if a remote or network exception occurs<a name="line.2222"></a> |
| <span class="sourceLineNo">2223</span> * @return List of servers that are not cleared<a name="line.2223"></a> |
| <span class="sourceLineNo">2224</span> */<a name="line.2224"></a> |
| <span class="sourceLineNo">2225</span> List<ServerName> clearDeadServers(List<ServerName> servers) throws IOException;<a name="line.2225"></a> |
| <span class="sourceLineNo">2226</span><a name="line.2226"></a> |
| <span class="sourceLineNo">2227</span> /**<a name="line.2227"></a> |
| <span class="sourceLineNo">2228</span> * Create a new table by cloning the existent table schema.<a name="line.2228"></a> |
| <span class="sourceLineNo">2229</span> * @param tableName name of the table to be cloned<a name="line.2229"></a> |
| <span class="sourceLineNo">2230</span> * @param newTableName name of the new table where the table will be created<a name="line.2230"></a> |
| <span class="sourceLineNo">2231</span> * @param preserveSplits True if the splits should be preserved<a name="line.2231"></a> |
| <span class="sourceLineNo">2232</span> * @throws IOException if a remote or network exception occurs<a name="line.2232"></a> |
| <span class="sourceLineNo">2233</span> */<a name="line.2233"></a> |
| <span class="sourceLineNo">2234</span> void cloneTableSchema(TableName tableName, TableName newTableName, boolean preserveSplits)<a name="line.2234"></a> |
| <span class="sourceLineNo">2235</span> throws IOException;<a name="line.2235"></a> |
| <span class="sourceLineNo">2236</span><a name="line.2236"></a> |
| <span class="sourceLineNo">2237</span> /**<a name="line.2237"></a> |
| <span class="sourceLineNo">2238</span> * Switch the rpc throttle enable state.<a name="line.2238"></a> |
| <span class="sourceLineNo">2239</span> * @param enable Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.2239"></a> |
| <span class="sourceLineNo">2240</span> * @return Previous rpc throttle enabled value<a name="line.2240"></a> |
| <span class="sourceLineNo">2241</span> * @throws IOException if a remote or network exception occurs<a name="line.2241"></a> |
| <span class="sourceLineNo">2242</span> */<a name="line.2242"></a> |
| <span class="sourceLineNo">2243</span> boolean switchRpcThrottle(boolean enable) throws IOException;<a name="line.2243"></a> |
| <span class="sourceLineNo">2244</span><a name="line.2244"></a> |
| <span class="sourceLineNo">2245</span> /**<a name="line.2245"></a> |
| <span class="sourceLineNo">2246</span> * Get if the rpc throttle is enabled.<a name="line.2246"></a> |
| <span class="sourceLineNo">2247</span> * @return True if rpc throttle is enabled<a name="line.2247"></a> |
| <span class="sourceLineNo">2248</span> * @throws IOException if a remote or network exception occurs<a name="line.2248"></a> |
| <span class="sourceLineNo">2249</span> */<a name="line.2249"></a> |
| <span class="sourceLineNo">2250</span> boolean isRpcThrottleEnabled() throws IOException;<a name="line.2250"></a> |
| <span class="sourceLineNo">2251</span><a name="line.2251"></a> |
| <span class="sourceLineNo">2252</span> /**<a name="line.2252"></a> |
| <span class="sourceLineNo">2253</span> * Switch the exceed throttle quota. If enabled, user/table/namespace throttle quota<a name="line.2253"></a> |
| <span class="sourceLineNo">2254</span> * can be exceeded if region server has availble quota.<a name="line.2254"></a> |
| <span class="sourceLineNo">2255</span> * @param enable Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.2255"></a> |
| <span class="sourceLineNo">2256</span> * @return Previous exceed throttle enabled value<a name="line.2256"></a> |
| <span class="sourceLineNo">2257</span> * @throws IOException if a remote or network exception occurs<a name="line.2257"></a> |
| <span class="sourceLineNo">2258</span> */<a name="line.2258"></a> |
| <span class="sourceLineNo">2259</span> boolean exceedThrottleQuotaSwitch(final boolean enable) throws IOException;<a name="line.2259"></a> |
| <span class="sourceLineNo">2260</span><a name="line.2260"></a> |
| <span class="sourceLineNo">2261</span> /**<a name="line.2261"></a> |
| <span class="sourceLineNo">2262</span> * Fetches the table sizes on the filesystem as tracked by the HBase Master.<a name="line.2262"></a> |
| <span class="sourceLineNo">2263</span> * @throws IOException if a remote or network exception occurs<a name="line.2263"></a> |
| <span class="sourceLineNo">2264</span> */<a name="line.2264"></a> |
| <span class="sourceLineNo">2265</span> Map<TableName, Long> getSpaceQuotaTableSizes() throws IOException;<a name="line.2265"></a> |
| <span class="sourceLineNo">2266</span><a name="line.2266"></a> |
| <span class="sourceLineNo">2267</span> /**<a name="line.2267"></a> |
| <span class="sourceLineNo">2268</span> * Fetches the observed {@link SpaceQuotaSnapshotView}s observed by a RegionServer.<a name="line.2268"></a> |
| <span class="sourceLineNo">2269</span> * @throws IOException if a remote or network exception occurs<a name="line.2269"></a> |
| <span class="sourceLineNo">2270</span> */<a name="line.2270"></a> |
| <span class="sourceLineNo">2271</span> Map<TableName, ? extends SpaceQuotaSnapshotView> getRegionServerSpaceQuotaSnapshots(<a name="line.2271"></a> |
| <span class="sourceLineNo">2272</span> ServerName serverName) throws IOException;<a name="line.2272"></a> |
| <span class="sourceLineNo">2273</span><a name="line.2273"></a> |
| <span class="sourceLineNo">2274</span> /**<a name="line.2274"></a> |
| <span class="sourceLineNo">2275</span> * Returns the Master's view of a quota on the given {@code namespace} or null if the Master has<a name="line.2275"></a> |
| <span class="sourceLineNo">2276</span> * no quota information on that namespace.<a name="line.2276"></a> |
| <span class="sourceLineNo">2277</span> * @throws IOException if a remote or network exception occurs<a name="line.2277"></a> |
| <span class="sourceLineNo">2278</span> */<a name="line.2278"></a> |
| <span class="sourceLineNo">2279</span> SpaceQuotaSnapshotView getCurrentSpaceQuotaSnapshot(String namespace) throws IOException;<a name="line.2279"></a> |
| <span class="sourceLineNo">2280</span><a name="line.2280"></a> |
| <span class="sourceLineNo">2281</span> /**<a name="line.2281"></a> |
| <span class="sourceLineNo">2282</span> * Returns the Master's view of a quota on the given {@code tableName} or null if the Master has<a name="line.2282"></a> |
| <span class="sourceLineNo">2283</span> * no quota information on that table.<a name="line.2283"></a> |
| <span class="sourceLineNo">2284</span> * @throws IOException if a remote or network exception occurs<a name="line.2284"></a> |
| <span class="sourceLineNo">2285</span> */<a name="line.2285"></a> |
| <span class="sourceLineNo">2286</span> SpaceQuotaSnapshotView getCurrentSpaceQuotaSnapshot(TableName tableName) throws IOException;<a name="line.2286"></a> |
| <span class="sourceLineNo">2287</span><a name="line.2287"></a> |
| <span class="sourceLineNo">2288</span> /**<a name="line.2288"></a> |
| <span class="sourceLineNo">2289</span> * Grants user specific permissions<a name="line.2289"></a> |
| <span class="sourceLineNo">2290</span> * @param userPermission user name and the specific permission<a name="line.2290"></a> |
| <span class="sourceLineNo">2291</span> * @param mergeExistingPermissions If set to false, later granted permissions will override<a name="line.2291"></a> |
| <span class="sourceLineNo">2292</span> * previous granted permissions. otherwise, it'll merge with previous granted<a name="line.2292"></a> |
| <span class="sourceLineNo">2293</span> * permissions.<a name="line.2293"></a> |
| <span class="sourceLineNo">2294</span> * @throws IOException if a remote or network exception occurs<a name="line.2294"></a> |
| <span class="sourceLineNo">2295</span> */<a name="line.2295"></a> |
| <span class="sourceLineNo">2296</span> void grant(UserPermission userPermission, boolean mergeExistingPermissions) throws IOException;<a name="line.2296"></a> |
| <span class="sourceLineNo">2297</span><a name="line.2297"></a> |
| <span class="sourceLineNo">2298</span> /**<a name="line.2298"></a> |
| <span class="sourceLineNo">2299</span> * Revokes user specific permissions<a name="line.2299"></a> |
| <span class="sourceLineNo">2300</span> * @param userPermission user name and the specific permission<a name="line.2300"></a> |
| <span class="sourceLineNo">2301</span> * @throws IOException if a remote or network exception occurs<a name="line.2301"></a> |
| <span class="sourceLineNo">2302</span> */<a name="line.2302"></a> |
| <span class="sourceLineNo">2303</span> void revoke(UserPermission userPermission) throws IOException;<a name="line.2303"></a> |
| <span class="sourceLineNo">2304</span><a name="line.2304"></a> |
| <span class="sourceLineNo">2305</span> /**<a name="line.2305"></a> |
| <span class="sourceLineNo">2306</span> * Get the global/namespace/table permissions for user<a name="line.2306"></a> |
| <span class="sourceLineNo">2307</span> * @param getUserPermissionsRequest A request contains which user, global, namespace or table<a name="line.2307"></a> |
| <span class="sourceLineNo">2308</span> * permissions needed<a name="line.2308"></a> |
| <span class="sourceLineNo">2309</span> * @return The user and permission list<a name="line.2309"></a> |
| <span class="sourceLineNo">2310</span> * @throws IOException if a remote or network exception occurs<a name="line.2310"></a> |
| <span class="sourceLineNo">2311</span> */<a name="line.2311"></a> |
| <span class="sourceLineNo">2312</span> List<UserPermission> getUserPermissions(GetUserPermissionsRequest getUserPermissionsRequest)<a name="line.2312"></a> |
| <span class="sourceLineNo">2313</span> throws IOException;<a name="line.2313"></a> |
| <span class="sourceLineNo">2314</span><a name="line.2314"></a> |
| <span class="sourceLineNo">2315</span> /**<a name="line.2315"></a> |
| <span class="sourceLineNo">2316</span> * Check if the user has specific permissions<a name="line.2316"></a> |
| <span class="sourceLineNo">2317</span> * @param userName the user name<a name="line.2317"></a> |
| <span class="sourceLineNo">2318</span> * @param permissions the specific permission list<a name="line.2318"></a> |
| <span class="sourceLineNo">2319</span> * @return True if user has the specific permissions<a name="line.2319"></a> |
| <span class="sourceLineNo">2320</span> * @throws IOException if a remote or network exception occurs<a name="line.2320"></a> |
| <span class="sourceLineNo">2321</span> */<a name="line.2321"></a> |
| <span class="sourceLineNo">2322</span> List<Boolean> hasUserPermissions(String userName, List<Permission> permissions)<a name="line.2322"></a> |
| <span class="sourceLineNo">2323</span> throws IOException;<a name="line.2323"></a> |
| <span class="sourceLineNo">2324</span><a name="line.2324"></a> |
| <span class="sourceLineNo">2325</span> /**<a name="line.2325"></a> |
| <span class="sourceLineNo">2326</span> * Check if call user has specific permissions<a name="line.2326"></a> |
| <span class="sourceLineNo">2327</span> * @param permissions the specific permission list<a name="line.2327"></a> |
| <span class="sourceLineNo">2328</span> * @return True if user has the specific permissions<a name="line.2328"></a> |
| <span class="sourceLineNo">2329</span> * @throws IOException if a remote or network exception occurs<a name="line.2329"></a> |
| <span class="sourceLineNo">2330</span> */<a name="line.2330"></a> |
| <span class="sourceLineNo">2331</span> default List<Boolean> hasUserPermissions(List<Permission> permissions) throws IOException {<a name="line.2331"></a> |
| <span class="sourceLineNo">2332</span> return hasUserPermissions(null, permissions);<a name="line.2332"></a> |
| <span class="sourceLineNo">2333</span> }<a name="line.2333"></a> |
| <span class="sourceLineNo">2334</span><a name="line.2334"></a> |
| <span class="sourceLineNo">2335</span> /**<a name="line.2335"></a> |
| <span class="sourceLineNo">2336</span> * Turn on or off the auto snapshot cleanup based on TTL.<a name="line.2336"></a> |
| <span class="sourceLineNo">2337</span> *<a name="line.2337"></a> |
| <span class="sourceLineNo">2338</span> * @param on Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.2338"></a> |
| <span class="sourceLineNo">2339</span> * @param synchronous If <code>true</code>, it waits until current snapshot cleanup is completed,<a name="line.2339"></a> |
| <span class="sourceLineNo">2340</span> * if outstanding.<a name="line.2340"></a> |
| <span class="sourceLineNo">2341</span> * @return Previous auto snapshot cleanup value<a name="line.2341"></a> |
| <span class="sourceLineNo">2342</span> * @throws IOException if a remote or network exception occurs<a name="line.2342"></a> |
| <span class="sourceLineNo">2343</span> */<a name="line.2343"></a> |
| <span class="sourceLineNo">2344</span> boolean snapshotCleanupSwitch(final boolean on, final boolean synchronous)<a name="line.2344"></a> |
| <span class="sourceLineNo">2345</span> throws IOException;<a name="line.2345"></a> |
| <span class="sourceLineNo">2346</span><a name="line.2346"></a> |
| <span class="sourceLineNo">2347</span> /**<a name="line.2347"></a> |
| <span class="sourceLineNo">2348</span> * Query the current state of the auto snapshot cleanup based on TTL.<a name="line.2348"></a> |
| <span class="sourceLineNo">2349</span> *<a name="line.2349"></a> |
| <span class="sourceLineNo">2350</span> * @return <code>true</code> if the auto snapshot cleanup is enabled,<a name="line.2350"></a> |
| <span class="sourceLineNo">2351</span> * <code>false</code> otherwise.<a name="line.2351"></a> |
| <span class="sourceLineNo">2352</span> * @throws IOException if a remote or network exception occurs<a name="line.2352"></a> |
| <span class="sourceLineNo">2353</span> */<a name="line.2353"></a> |
| <span class="sourceLineNo">2354</span> boolean isSnapshotCleanupEnabled() throws IOException;<a name="line.2354"></a> |
| <span class="sourceLineNo">2355</span><a name="line.2355"></a> |
| <span class="sourceLineNo">2356</span> /**<a name="line.2356"></a> |
| <span class="sourceLineNo">2357</span> * Retrieves online slow/large RPC logs from the provided list of<a name="line.2357"></a> |
| <span class="sourceLineNo">2358</span> * RegionServers<a name="line.2358"></a> |
| <span class="sourceLineNo">2359</span> *<a name="line.2359"></a> |
| <span class="sourceLineNo">2360</span> * @param serverNames Server names to get slowlog responses from<a name="line.2360"></a> |
| <span class="sourceLineNo">2361</span> * @param logQueryFilter filter to be used if provided (determines slow / large RPC logs)<a name="line.2361"></a> |
| <span class="sourceLineNo">2362</span> * @return online slowlog response list<a name="line.2362"></a> |
| <span class="sourceLineNo">2363</span> * @throws IOException if a remote or network exception occurs<a name="line.2363"></a> |
| <span class="sourceLineNo">2364</span> * @deprecated since 2.4.0 and will be removed in 4.0.0.<a name="line.2364"></a> |
| <span class="sourceLineNo">2365</span> * Use {@link #getLogEntries(Set, String, ServerType, int, Map)} instead.<a name="line.2365"></a> |
| <span class="sourceLineNo">2366</span> */<a name="line.2366"></a> |
| <span class="sourceLineNo">2367</span> @Deprecated<a name="line.2367"></a> |
| <span class="sourceLineNo">2368</span> default List<OnlineLogRecord> getSlowLogResponses(final Set<ServerName> serverNames,<a name="line.2368"></a> |
| <span class="sourceLineNo">2369</span> final LogQueryFilter logQueryFilter) throws IOException {<a name="line.2369"></a> |
| <span class="sourceLineNo">2370</span> String logType;<a name="line.2370"></a> |
| <span class="sourceLineNo">2371</span> if (LogQueryFilter.Type.LARGE_LOG.equals(logQueryFilter.getType())) {<a name="line.2371"></a> |
| <span class="sourceLineNo">2372</span> logType = "LARGE_LOG";<a name="line.2372"></a> |
| <span class="sourceLineNo">2373</span> } else {<a name="line.2373"></a> |
| <span class="sourceLineNo">2374</span> logType = "SLOW_LOG";<a name="line.2374"></a> |
| <span class="sourceLineNo">2375</span> }<a name="line.2375"></a> |
| <span class="sourceLineNo">2376</span> Map<String, Object> filterParams = new HashMap<>();<a name="line.2376"></a> |
| <span class="sourceLineNo">2377</span> filterParams.put("regionName", logQueryFilter.getRegionName());<a name="line.2377"></a> |
| <span class="sourceLineNo">2378</span> filterParams.put("clientAddress", logQueryFilter.getClientAddress());<a name="line.2378"></a> |
| <span class="sourceLineNo">2379</span> filterParams.put("tableName", logQueryFilter.getTableName());<a name="line.2379"></a> |
| <span class="sourceLineNo">2380</span> filterParams.put("userName", logQueryFilter.getUserName());<a name="line.2380"></a> |
| <span class="sourceLineNo">2381</span> filterParams.put("filterByOperator", logQueryFilter.getFilterByOperator().toString());<a name="line.2381"></a> |
| <span class="sourceLineNo">2382</span> List<LogEntry> logEntries =<a name="line.2382"></a> |
| <span class="sourceLineNo">2383</span> getLogEntries(serverNames, logType, ServerType.REGION_SERVER, logQueryFilter.getLimit(),<a name="line.2383"></a> |
| <span class="sourceLineNo">2384</span> filterParams);<a name="line.2384"></a> |
| <span class="sourceLineNo">2385</span> return logEntries.stream().map(logEntry -> (OnlineLogRecord) logEntry)<a name="line.2385"></a> |
| <span class="sourceLineNo">2386</span> .collect(Collectors.toList());<a name="line.2386"></a> |
| <span class="sourceLineNo">2387</span> }<a name="line.2387"></a> |
| <span class="sourceLineNo">2388</span><a name="line.2388"></a> |
| <span class="sourceLineNo">2389</span> /**<a name="line.2389"></a> |
| <span class="sourceLineNo">2390</span> * Clears online slow/large RPC logs from the provided list of<a name="line.2390"></a> |
| <span class="sourceLineNo">2391</span> * RegionServers<a name="line.2391"></a> |
| <span class="sourceLineNo">2392</span> *<a name="line.2392"></a> |
| <span class="sourceLineNo">2393</span> * @param serverNames Set of Server names to clean slowlog responses from<a name="line.2393"></a> |
| <span class="sourceLineNo">2394</span> * @return List of booleans representing if online slowlog response buffer is cleaned<a name="line.2394"></a> |
| <span class="sourceLineNo">2395</span> * from each RegionServer<a name="line.2395"></a> |
| <span class="sourceLineNo">2396</span> * @throws IOException if a remote or network exception occurs<a name="line.2396"></a> |
| <span class="sourceLineNo">2397</span> */<a name="line.2397"></a> |
| <span class="sourceLineNo">2398</span> List<Boolean> clearSlowLogResponses(final Set<ServerName> serverNames)<a name="line.2398"></a> |
| <span class="sourceLineNo">2399</span> throws IOException;<a name="line.2399"></a> |
| <span class="sourceLineNo">2400</span><a name="line.2400"></a> |
| <span class="sourceLineNo">2401</span> /**<a name="line.2401"></a> |
| <span class="sourceLineNo">2402</span> * Creates a new RegionServer group with the given name<a name="line.2402"></a> |
| <span class="sourceLineNo">2403</span> * @param groupName the name of the group<a name="line.2403"></a> |
| <span class="sourceLineNo">2404</span> * @throws IOException if a remote or network exception occurs<a name="line.2404"></a> |
| <span class="sourceLineNo">2405</span> */<a name="line.2405"></a> |
| <span class="sourceLineNo">2406</span> void addRSGroup(String groupName) throws IOException;<a name="line.2406"></a> |
| <span class="sourceLineNo">2407</span><a name="line.2407"></a> |
| <span class="sourceLineNo">2408</span> /**<a name="line.2408"></a> |
| <span class="sourceLineNo">2409</span> * Get group info for the given group name<a name="line.2409"></a> |
| <span class="sourceLineNo">2410</span> * @param groupName the group name<a name="line.2410"></a> |
| <span class="sourceLineNo">2411</span> * @return group info<a name="line.2411"></a> |
| <span class="sourceLineNo">2412</span> * @throws IOException if a remote or network exception occurs<a name="line.2412"></a> |
| <span class="sourceLineNo">2413</span> */<a name="line.2413"></a> |
| <span class="sourceLineNo">2414</span> RSGroupInfo getRSGroup(String groupName) throws IOException;<a name="line.2414"></a> |
| <span class="sourceLineNo">2415</span><a name="line.2415"></a> |
| <span class="sourceLineNo">2416</span> /**<a name="line.2416"></a> |
| <span class="sourceLineNo">2417</span> * Get group info for the given hostPort<a name="line.2417"></a> |
| <span class="sourceLineNo">2418</span> * @param hostPort HostPort to get RSGroupInfo for<a name="line.2418"></a> |
| <span class="sourceLineNo">2419</span> * @throws IOException if a remote or network exception occurs<a name="line.2419"></a> |
| <span class="sourceLineNo">2420</span> */<a name="line.2420"></a> |
| <span class="sourceLineNo">2421</span> RSGroupInfo getRSGroup(Address hostPort) throws IOException;<a name="line.2421"></a> |
| <span class="sourceLineNo">2422</span><a name="line.2422"></a> |
| <span class="sourceLineNo">2423</span> /**<a name="line.2423"></a> |
| <span class="sourceLineNo">2424</span> * Get group info for the given table<a name="line.2424"></a> |
| <span class="sourceLineNo">2425</span> * @param tableName table name to get RSGroupInfo for<a name="line.2425"></a> |
| <span class="sourceLineNo">2426</span> * @throws IOException if a remote or network exception occurs<a name="line.2426"></a> |
| <span class="sourceLineNo">2427</span> */<a name="line.2427"></a> |
| <span class="sourceLineNo">2428</span> RSGroupInfo getRSGroup(TableName tableName) throws IOException;<a name="line.2428"></a> |
| <span class="sourceLineNo">2429</span><a name="line.2429"></a> |
| <span class="sourceLineNo">2430</span> /**<a name="line.2430"></a> |
| <span class="sourceLineNo">2431</span> * Lists current set of RegionServer groups<a name="line.2431"></a> |
| <span class="sourceLineNo">2432</span> * @throws IOException if a remote or network exception occurs<a name="line.2432"></a> |
| <span class="sourceLineNo">2433</span> */<a name="line.2433"></a> |
| <span class="sourceLineNo">2434</span> List<RSGroupInfo> listRSGroups() throws IOException;<a name="line.2434"></a> |
| <span class="sourceLineNo">2435</span><a name="line.2435"></a> |
| <span class="sourceLineNo">2436</span> /**<a name="line.2436"></a> |
| <span class="sourceLineNo">2437</span> * Get all tables in this RegionServer group.<a name="line.2437"></a> |
| <span class="sourceLineNo">2438</span> * @param groupName the group name<a name="line.2438"></a> |
| <span class="sourceLineNo">2439</span> * @throws IOException if a remote or network exception occurs<a name="line.2439"></a> |
| <span class="sourceLineNo">2440</span> * @see #getConfiguredNamespacesAndTablesInRSGroup(String)<a name="line.2440"></a> |
| <span class="sourceLineNo">2441</span> */<a name="line.2441"></a> |
| <span class="sourceLineNo">2442</span> List<TableName> listTablesInRSGroup(String groupName) throws IOException;<a name="line.2442"></a> |
| <span class="sourceLineNo">2443</span><a name="line.2443"></a> |
| <span class="sourceLineNo">2444</span> /**<a name="line.2444"></a> |
| <span class="sourceLineNo">2445</span> * Get the namespaces and tables which have this RegionServer group in descriptor.<a name="line.2445"></a> |
| <span class="sourceLineNo">2446</span> * <p/><a name="line.2446"></a> |
| <span class="sourceLineNo">2447</span> * The difference between this method and {@link #listTablesInRSGroup(String)} is that, this<a name="line.2447"></a> |
| <span class="sourceLineNo">2448</span> * method will not include the table which is actually in this RegionServr group but without the<a name="line.2448"></a> |
| <span class="sourceLineNo">2449</span> * RegionServer group configuration in its {@link TableDescriptor}. For example, we have a group<a name="line.2449"></a> |
| <span class="sourceLineNo">2450</span> * 'A', and we make namespace 'nsA' in this group, then all the tables under this namespace will<a name="line.2450"></a> |
| <span class="sourceLineNo">2451</span> * in the group 'A', but this method will not return these tables but only the namespace 'nsA',<a name="line.2451"></a> |
| <span class="sourceLineNo">2452</span> * while the {@link #listTablesInRSGroup(String)} will return all these tables.<a name="line.2452"></a> |
| <span class="sourceLineNo">2453</span> * @param groupName the group name<a name="line.2453"></a> |
| <span class="sourceLineNo">2454</span> * @throws IOException if a remote or network exception occurs<a name="line.2454"></a> |
| <span class="sourceLineNo">2455</span> * @see #listTablesInRSGroup(String)<a name="line.2455"></a> |
| <span class="sourceLineNo">2456</span> */<a name="line.2456"></a> |
| <span class="sourceLineNo">2457</span> Pair<List<String>, List<TableName>> getConfiguredNamespacesAndTablesInRSGroup(String groupName)<a name="line.2457"></a> |
| <span class="sourceLineNo">2458</span> throws IOException;<a name="line.2458"></a> |
| <span class="sourceLineNo">2459</span><a name="line.2459"></a> |
| <span class="sourceLineNo">2460</span> /**<a name="line.2460"></a> |
| <span class="sourceLineNo">2461</span> * Remove RegionServer group associated with the given name<a name="line.2461"></a> |
| <span class="sourceLineNo">2462</span> * @param groupName the group name<a name="line.2462"></a> |
| <span class="sourceLineNo">2463</span> * @throws IOException if a remote or network exception occurs<a name="line.2463"></a> |
| <span class="sourceLineNo">2464</span> */<a name="line.2464"></a> |
| <span class="sourceLineNo">2465</span> void removeRSGroup(String groupName) throws IOException;<a name="line.2465"></a> |
| <span class="sourceLineNo">2466</span><a name="line.2466"></a> |
| <span class="sourceLineNo">2467</span> /**<a name="line.2467"></a> |
| <span class="sourceLineNo">2468</span> * Remove decommissioned servers from group<a name="line.2468"></a> |
| <span class="sourceLineNo">2469</span> * 1. Sometimes we may find the server aborted due to some hardware failure and we must offline<a name="line.2469"></a> |
| <span class="sourceLineNo">2470</span> * the server for repairing. Or we need to move some servers to join other clusters.<a name="line.2470"></a> |
| <span class="sourceLineNo">2471</span> * So we need to remove these servers from the group.<a name="line.2471"></a> |
| <span class="sourceLineNo">2472</span> * 2. Dead/recovering/live servers will be disallowed.<a name="line.2472"></a> |
| <span class="sourceLineNo">2473</span> * @param servers set of servers to remove<a name="line.2473"></a> |
| <span class="sourceLineNo">2474</span> * @throws IOException if a remote or network exception occurs<a name="line.2474"></a> |
| <span class="sourceLineNo">2475</span> */<a name="line.2475"></a> |
| <span class="sourceLineNo">2476</span> void removeServersFromRSGroup(Set<Address> servers) throws IOException;<a name="line.2476"></a> |
| <span class="sourceLineNo">2477</span><a name="line.2477"></a> |
| <span class="sourceLineNo">2478</span> /**<a name="line.2478"></a> |
| <span class="sourceLineNo">2479</span> * Move given set of servers to the specified target RegionServer group<a name="line.2479"></a> |
| <span class="sourceLineNo">2480</span> * @param servers set of servers to move<a name="line.2480"></a> |
| <span class="sourceLineNo">2481</span> * @param targetGroup the group to move servers to<a name="line.2481"></a> |
| <span class="sourceLineNo">2482</span> * @throws IOException if a remote or network exception occurs<a name="line.2482"></a> |
| <span class="sourceLineNo">2483</span> */<a name="line.2483"></a> |
| <span class="sourceLineNo">2484</span> void moveServersToRSGroup(Set<Address> servers, String targetGroup) throws IOException;<a name="line.2484"></a> |
| <span class="sourceLineNo">2485</span><a name="line.2485"></a> |
| <span class="sourceLineNo">2486</span> /**<a name="line.2486"></a> |
| <span class="sourceLineNo">2487</span> * Set the RegionServer group for tables<a name="line.2487"></a> |
| <span class="sourceLineNo">2488</span> * @param tables tables to set group for<a name="line.2488"></a> |
| <span class="sourceLineNo">2489</span> * @param groupName group name for tables<a name="line.2489"></a> |
| <span class="sourceLineNo">2490</span> * @throws IOException if a remote or network exception occurs<a name="line.2490"></a> |
| <span class="sourceLineNo">2491</span> */<a name="line.2491"></a> |
| <span class="sourceLineNo">2492</span> void setRSGroup(Set<TableName> tables, String groupName) throws IOException;<a name="line.2492"></a> |
| <span class="sourceLineNo">2493</span><a name="line.2493"></a> |
| <span class="sourceLineNo">2494</span> /**<a name="line.2494"></a> |
| <span class="sourceLineNo">2495</span> * Balance regions in the given RegionServer group<a name="line.2495"></a> |
| <span class="sourceLineNo">2496</span> * @param groupName the group name<a name="line.2496"></a> |
| <span class="sourceLineNo">2497</span> * @return boolean Whether balance ran or not<a name="line.2497"></a> |
| <span class="sourceLineNo">2498</span> * @throws IOException if a remote or network exception occurs<a name="line.2498"></a> |
| <span class="sourceLineNo">2499</span> */<a name="line.2499"></a> |
| <span class="sourceLineNo">2500</span> boolean balanceRSGroup(String groupName) throws IOException;<a name="line.2500"></a> |
| <span class="sourceLineNo">2501</span><a name="line.2501"></a> |
| <span class="sourceLineNo">2502</span> /**<a name="line.2502"></a> |
| <span class="sourceLineNo">2503</span> * Rename rsgroup<a name="line.2503"></a> |
| <span class="sourceLineNo">2504</span> * @param oldName old rsgroup name<a name="line.2504"></a> |
| <span class="sourceLineNo">2505</span> * @param newName new rsgroup name<a name="line.2505"></a> |
| <span class="sourceLineNo">2506</span> * @throws IOException if a remote or network exception occurs<a name="line.2506"></a> |
| <span class="sourceLineNo">2507</span> */<a name="line.2507"></a> |
| <span class="sourceLineNo">2508</span> void renameRSGroup(String oldName, String newName) throws IOException;<a name="line.2508"></a> |
| <span class="sourceLineNo">2509</span><a name="line.2509"></a> |
| <span class="sourceLineNo">2510</span> /**<a name="line.2510"></a> |
| <span class="sourceLineNo">2511</span> * Update RSGroup configuration<a name="line.2511"></a> |
| <span class="sourceLineNo">2512</span> * @param groupName the group name<a name="line.2512"></a> |
| <span class="sourceLineNo">2513</span> * @param configuration new configuration of the group name to be set<a name="line.2513"></a> |
| <span class="sourceLineNo">2514</span> * @throws IOException if a remote or network exception occurs<a name="line.2514"></a> |
| <span class="sourceLineNo">2515</span> */<a name="line.2515"></a> |
| <span class="sourceLineNo">2516</span> void updateRSGroupConfig(String groupName, Map<String, String> configuration) throws IOException;<a name="line.2516"></a> |
| <span class="sourceLineNo">2517</span><a name="line.2517"></a> |
| <span class="sourceLineNo">2518</span> /**<a name="line.2518"></a> |
| <span class="sourceLineNo">2519</span> * Retrieve recent online records from HMaster / RegionServers.<a name="line.2519"></a> |
| <span class="sourceLineNo">2520</span> * Examples include slow/large RPC logs, balancer decisions by master.<a name="line.2520"></a> |
| <span class="sourceLineNo">2521</span> *<a name="line.2521"></a> |
| <span class="sourceLineNo">2522</span> * @param serverNames servers to retrieve records from, useful in case of records maintained<a name="line.2522"></a> |
| <span class="sourceLineNo">2523</span> * by RegionServer as we can select specific server. In case of servertype=MASTER, logs will<a name="line.2523"></a> |
| <span class="sourceLineNo">2524</span> * only come from the currently active master.<a name="line.2524"></a> |
| <span class="sourceLineNo">2525</span> * @param logType string representing type of log records<a name="line.2525"></a> |
| <span class="sourceLineNo">2526</span> * @param serverType enum for server type: HMaster or RegionServer<a name="line.2526"></a> |
| <span class="sourceLineNo">2527</span> * @param limit put a limit to list of records that server should send in response<a name="line.2527"></a> |
| <span class="sourceLineNo">2528</span> * @param filterParams additional filter params<a name="line.2528"></a> |
| <span class="sourceLineNo">2529</span> * @return Log entries representing online records from servers<a name="line.2529"></a> |
| <span class="sourceLineNo">2530</span> * @throws IOException if a remote or network exception occurs<a name="line.2530"></a> |
| <span class="sourceLineNo">2531</span> */<a name="line.2531"></a> |
| <span class="sourceLineNo">2532</span> List<LogEntry> getLogEntries(Set<ServerName> serverNames, String logType,<a name="line.2532"></a> |
| <span class="sourceLineNo">2533</span> ServerType serverType, int limit, Map<String, Object> filterParams) throws IOException;<a name="line.2533"></a> |
| <span class="sourceLineNo">2534</span>}<a name="line.2534"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
