http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html index f37f18d..c00f30a 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html @@ -28,1810 +28,1959 @@ <span class="sourceLineNo">020</span><a name="line.20"></a> <span class="sourceLineNo">021</span>import java.io.Closeable;<a name="line.21"></a> <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import java.util.concurrent.Future;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import java.util.regex.Pattern;<a name="line.26"></a> -<span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.conf.Configuration;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.Abortable;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.ClusterStatus;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HColumnDescriptor;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.HRegionInfo;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.HTableDescriptor;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.NamespaceNotFoundException;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.ProcedureInfo;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.RegionLoad;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.ServerName;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.TableExistsException;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.TableName;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.TableNotFoundException;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.42"></a> -<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.43"></a> -<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.44"></a> -<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel;<a name="line.45"></a> -<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.46"></a> -<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.quotas.QuotaRetriever;<a name="line.47"></a> -<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.48"></a> -<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException;<a name="line.49"></a> -<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.snapshot.HBaseSnapshotException;<a name="line.50"></a> -<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.snapshot.RestoreSnapshotException;<a name="line.51"></a> -<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.snapshot.SnapshotCreationException;<a name="line.52"></a> -<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.snapshot.UnknownSnapshotException;<a name="line.53"></a> -<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.54"></a> -<span class="sourceLineNo">055</span><a name="line.55"></a> -<span class="sourceLineNo">056</span>/**<a name="line.56"></a> -<span class="sourceLineNo">057</span> * The administrative API for HBase. Obtain an instance from an {@link Connection#getAdmin()} and<a name="line.57"></a> -<span class="sourceLineNo">058</span> * call {@link #close()} afterwards.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * <p>Admin can be used to create, drop, list, enable and disable tables, add and drop table<a name="line.59"></a> -<span class="sourceLineNo">060</span> * column families and other administrative operations.<a name="line.60"></a> -<span class="sourceLineNo">061</span> *<a name="line.61"></a> -<span class="sourceLineNo">062</span> * @see ConnectionFactory<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @see Connection<a name="line.63"></a> -<span class="sourceLineNo">064</span> * @see Table<a name="line.64"></a> -<span class="sourceLineNo">065</span> * @since 0.99.0<a name="line.65"></a> -<span class="sourceLineNo">066</span> */<a name="line.66"></a> -<span class="sourceLineNo">067</span>@InterfaceAudience.Public<a name="line.67"></a> -<span class="sourceLineNo">068</span>@InterfaceStability.Evolving<a name="line.68"></a> -<span class="sourceLineNo">069</span>public interface Admin extends Abortable, Closeable {<a name="line.69"></a> -<span class="sourceLineNo">070</span> int getOperationTimeout();<a name="line.70"></a> -<span class="sourceLineNo">071</span><a name="line.71"></a> -<span class="sourceLineNo">072</span> @Override<a name="line.72"></a> -<span class="sourceLineNo">073</span> void abort(String why, Throwable e);<a name="line.73"></a> -<span class="sourceLineNo">074</span><a name="line.74"></a> -<span class="sourceLineNo">075</span> @Override<a name="line.75"></a> -<span class="sourceLineNo">076</span> boolean isAborted();<a name="line.76"></a> -<span class="sourceLineNo">077</span><a name="line.77"></a> -<span class="sourceLineNo">078</span> /**<a name="line.78"></a> -<span class="sourceLineNo">079</span> * @return Connection used by this object.<a name="line.79"></a> -<span class="sourceLineNo">080</span> */<a name="line.80"></a> -<span class="sourceLineNo">081</span> Connection getConnection();<a name="line.81"></a> -<span class="sourceLineNo">082</span><a name="line.82"></a> -<span class="sourceLineNo">083</span> /**<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @param tableName Table to check.<a name="line.84"></a> -<span class="sourceLineNo">085</span> * @return True if table exists already.<a name="line.85"></a> -<span class="sourceLineNo">086</span> * @throws IOException<a name="line.86"></a> -<span class="sourceLineNo">087</span> */<a name="line.87"></a> -<span class="sourceLineNo">088</span> boolean tableExists(final TableName tableName) throws IOException;<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> /**<a name="line.90"></a> -<span class="sourceLineNo">091</span> * List all the userspace tables.<a name="line.91"></a> -<span class="sourceLineNo">092</span> *<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @return - returns an array of HTableDescriptors<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @throws IOException if a remote or network exception occurs<a name="line.94"></a> -<span class="sourceLineNo">095</span> */<a name="line.95"></a> -<span class="sourceLineNo">096</span> HTableDescriptor[] listTables() throws IOException;<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> /**<a name="line.98"></a> -<span class="sourceLineNo">099</span> * List all the userspace tables matching the given pattern.<a name="line.99"></a> -<span class="sourceLineNo">100</span> *<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @param pattern The compiled regular expression to match against<a name="line.101"></a> -<span class="sourceLineNo">102</span> * @return - returns an array of HTableDescriptors<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @throws IOException if a remote or network exception occurs<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @see #listTables()<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> HTableDescriptor[] listTables(Pattern pattern) throws IOException;<a name="line.106"></a> -<span class="sourceLineNo">107</span><a name="line.107"></a> -<span class="sourceLineNo">108</span> /**<a name="line.108"></a> -<span class="sourceLineNo">109</span> * List all the userspace tables matching the given regular expression.<a name="line.109"></a> -<span class="sourceLineNo">110</span> *<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @param regex The regular expression to match against<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @return - returns an array of HTableDescriptors<a name="line.112"></a> -<span class="sourceLineNo">113</span> * @throws IOException if a remote or network exception occurs<a name="line.113"></a> -<span class="sourceLineNo">114</span> * @see #listTables(java.util.regex.Pattern)<a name="line.114"></a> -<span class="sourceLineNo">115</span> */<a name="line.115"></a> -<span class="sourceLineNo">116</span> HTableDescriptor[] listTables(String regex) throws IOException;<a name="line.116"></a> -<span class="sourceLineNo">117</span><a name="line.117"></a> -<span class="sourceLineNo">118</span> /**<a name="line.118"></a> -<span class="sourceLineNo">119</span> * List all the tables matching the given pattern.<a name="line.119"></a> -<span class="sourceLineNo">120</span> *<a name="line.120"></a> -<span class="sourceLineNo">121</span> * @param pattern The compiled regular expression to match against<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @param includeSysTables False to match only against userspace tables<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @return - returns an array of HTableDescriptors<a name="line.123"></a> -<span class="sourceLineNo">124</span> * @throws IOException if a remote or network exception occurs<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @see #listTables()<a name="line.125"></a> -<span class="sourceLineNo">126</span> */<a name="line.126"></a> -<span class="sourceLineNo">127</span> HTableDescriptor[] listTables(Pattern pattern, boolean includeSysTables)<a name="line.127"></a> -<span class="sourceLineNo">128</span> throws IOException;<a name="line.128"></a> -<span class="sourceLineNo">129</span><a name="line.129"></a> -<span class="sourceLineNo">130</span> /**<a name="line.130"></a> -<span class="sourceLineNo">131</span> * List all the tables matching the given pattern.<a name="line.131"></a> -<span class="sourceLineNo">132</span> *<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @param regex The regular expression to match against<a name="line.133"></a> -<span class="sourceLineNo">134</span> * @param includeSysTables False to match only against userspace tables<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @return - returns an array of HTableDescriptors<a name="line.135"></a> -<span class="sourceLineNo">136</span> * @throws IOException if a remote or network exception occurs<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @see #listTables(java.util.regex.Pattern, boolean)<a name="line.137"></a> -<span class="sourceLineNo">138</span> */<a name="line.138"></a> -<span class="sourceLineNo">139</span> HTableDescriptor[] listTables(String regex, boolean includeSysTables)<a name="line.139"></a> -<span class="sourceLineNo">140</span> 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 of the names of userspace tables.<a name="line.143"></a> -<span class="sourceLineNo">144</span> *<a name="line.144"></a> -<span class="sourceLineNo">145</span> * @return TableName[] table names<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @throws IOException if a remote or network exception occurs<a name="line.146"></a> -<span class="sourceLineNo">147</span> */<a name="line.147"></a> -<span class="sourceLineNo">148</span> TableName[] listTableNames() throws IOException;<a name="line.148"></a> -<span class="sourceLineNo">149</span><a name="line.149"></a> -<span class="sourceLineNo">150</span> /**<a name="line.150"></a> -<span class="sourceLineNo">151</span> * List all of the names of userspace tables.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @param pattern The regular expression to match against<a name="line.152"></a> -<span class="sourceLineNo">153</span> * @return TableName[] table names<a name="line.153"></a> -<span class="sourceLineNo">154</span> * @throws IOException if a remote or network exception occurs<a name="line.154"></a> -<span class="sourceLineNo">155</span> */<a name="line.155"></a> -<span class="sourceLineNo">156</span> TableName[] listTableNames(Pattern pattern) throws IOException;<a name="line.156"></a> -<span class="sourceLineNo">157</span><a name="line.157"></a> -<span class="sourceLineNo">158</span> /**<a name="line.158"></a> -<span class="sourceLineNo">159</span> * List all of the names of userspace tables.<a name="line.159"></a> -<span class="sourceLineNo">160</span> * @param regex The regular expression to match against<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @return TableName[] table names<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @throws IOException if a remote or network exception occurs<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> TableName[] listTableNames(String regex) 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> * @param pattern The regular expression to match against<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @param includeSysTables False to match only against userspace tables<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @return TableName[] table names<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @throws IOException if a remote or network exception occurs<a name="line.171"></a> -<span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> TableName[] listTableNames(final Pattern pattern, final boolean includeSysTables)<a name="line.173"></a> -<span class="sourceLineNo">174</span> throws IOException;<a name="line.174"></a> -<span class="sourceLineNo">175</span><a name="line.175"></a> -<span class="sourceLineNo">176</span> /**<a name="line.176"></a> -<span class="sourceLineNo">177</span> * List all of the names of userspace tables.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @param regex The regular expression to match against<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @param includeSysTables False to match only against userspace tables<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return TableName[] table names<a name="line.180"></a> -<span class="sourceLineNo">181</span> * @throws IOException if a remote or network exception occurs<a name="line.181"></a> -<span class="sourceLineNo">182</span> */<a name="line.182"></a> -<span class="sourceLineNo">183</span> TableName[] listTableNames(final String regex, final boolean includeSysTables)<a name="line.183"></a> -<span class="sourceLineNo">184</span> throws IOException;<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * Method for getting the tableDescriptor<a name="line.187"></a> -<span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @param tableName as a {@link TableName}<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @return the tableDescriptor<a name="line.190"></a> -<span class="sourceLineNo">191</span> * @throws org.apache.hadoop.hbase.TableNotFoundException<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @throws IOException if a remote or network exception occurs<a name="line.192"></a> -<span class="sourceLineNo">193</span> */<a name="line.193"></a> -<span class="sourceLineNo">194</span> HTableDescriptor getTableDescriptor(final TableName tableName)<a name="line.194"></a> -<span class="sourceLineNo">195</span> throws TableNotFoundException, IOException;<a name="line.195"></a> -<span class="sourceLineNo">196</span><a name="line.196"></a> -<span class="sourceLineNo">197</span> /**<a name="line.197"></a> -<span class="sourceLineNo">198</span> * Creates a new table. Synchronous operation.<a name="line.198"></a> -<span class="sourceLineNo">199</span> *<a name="line.199"></a> -<span class="sourceLineNo">200</span> * @param desc table descriptor for table<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.202"></a> -<span class="sourceLineNo">203</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.203"></a> -<span class="sourceLineNo">204</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.204"></a> -<span class="sourceLineNo">205</span> * @throws IOException if a remote or network exception occurs<a name="line.205"></a> -<span class="sourceLineNo">206</span> */<a name="line.206"></a> -<span class="sourceLineNo">207</span> void createTable(HTableDescriptor desc) throws IOException;<a name="line.207"></a> -<span class="sourceLineNo">208</span><a name="line.208"></a> -<span class="sourceLineNo">209</span> /**<a name="line.209"></a> -<span class="sourceLineNo">210</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.210"></a> -<span class="sourceLineNo">211</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.211"></a> -<span class="sourceLineNo">212</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.212"></a> -<span class="sourceLineNo">213</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.213"></a> -<span class="sourceLineNo">214</span> * segments to make the required number of total regions. Synchronous operation.<a name="line.214"></a> -<span class="sourceLineNo">215</span> *<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @param desc table descriptor for table<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param startKey beginning of key range<a name="line.217"></a> -<span class="sourceLineNo">218</span> * @param endKey end of key range<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @param numRegions the total number of regions to create<a name="line.219"></a> -<span class="sourceLineNo">220</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.220"></a> -<span class="sourceLineNo">221</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.221"></a> -<span class="sourceLineNo">222</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.222"></a> -<span class="sourceLineNo">223</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @throws IOException<a name="line.224"></a> -<span class="sourceLineNo">225</span> */<a name="line.225"></a> -<span class="sourceLineNo">226</span> void createTable(HTableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)<a name="line.226"></a> -<span class="sourceLineNo">227</span> throws IOException;<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> /**<a name="line.229"></a> -<span class="sourceLineNo">230</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.230"></a> -<span class="sourceLineNo">231</span> * The total number of regions created will be the number of split keys plus one. Synchronous<a name="line.231"></a> -<span class="sourceLineNo">232</span> * operation. Note : Avoid passing empty split key.<a name="line.232"></a> -<span class="sourceLineNo">233</span> *<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @param desc table descriptor for table<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.235"></a> -<span class="sourceLineNo">236</span> * @throws IllegalArgumentException if the table name is reserved, if the split keys are repeated<a name="line.236"></a> -<span class="sourceLineNo">237</span> * and if the split key has empty byte array.<a name="line.237"></a> -<span class="sourceLineNo">238</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.239"></a> -<span class="sourceLineNo">240</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @throws IOException<a name="line.241"></a> -<span class="sourceLineNo">242</span> */<a name="line.242"></a> -<span class="sourceLineNo">243</span> void createTable(final HTableDescriptor desc, byte[][] splitKeys) throws IOException;<a name="line.243"></a> -<span class="sourceLineNo">244</span><a name="line.244"></a> -<span class="sourceLineNo">245</span> /**<a name="line.245"></a> -<span class="sourceLineNo">246</span> * Creates a new table but does not block and wait for it to come online.<a name="line.246"></a> -<span class="sourceLineNo">247</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.247"></a> -<span class="sourceLineNo">248</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.248"></a> -<span class="sourceLineNo">249</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.249"></a> -<span class="sourceLineNo">250</span> * operation to complete.<a name="line.250"></a> -<span class="sourceLineNo">251</span> * Throws IllegalArgumentException Bad table name, if the split keys<a name="line.251"></a> -<span class="sourceLineNo">252</span> * are repeated and if the split key has empty byte array.<a name="line.252"></a> -<span class="sourceLineNo">253</span> *<a name="line.253"></a> -<span class="sourceLineNo">254</span> * @param desc table descriptor for table<a name="line.254"></a> -<span class="sourceLineNo">255</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.255"></a> -<span class="sourceLineNo">256</span> * @throws IOException if a remote or network exception occurs<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @return the result of the async creation. You can use Future.get(long, TimeUnit)<a name="line.257"></a> -<span class="sourceLineNo">258</span> * to wait on the operation to complete.<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> Future<Void> createTableAsync(final HTableDescriptor desc, final byte[][] splitKeys)<a name="line.260"></a> -<span class="sourceLineNo">261</span> throws IOException;<a name="line.261"></a> -<span class="sourceLineNo">262</span><a name="line.262"></a> -<span class="sourceLineNo">263</span> /**<a name="line.263"></a> -<span class="sourceLineNo">264</span> * Deletes a table. Synchronous operation.<a name="line.264"></a> -<span class="sourceLineNo">265</span> *<a name="line.265"></a> -<span class="sourceLineNo">266</span> * @param tableName name of table to delete<a name="line.266"></a> -<span class="sourceLineNo">267</span> * @throws IOException if a remote or network exception occurs<a name="line.267"></a> -<span class="sourceLineNo">268</span> */<a name="line.268"></a> -<span class="sourceLineNo">269</span> void deleteTable(final TableName tableName) throws IOException;<a name="line.269"></a> -<span class="sourceLineNo">270</span><a name="line.270"></a> -<span class="sourceLineNo">271</span> /**<a name="line.271"></a> -<span class="sourceLineNo">272</span> * Deletes the table but does not block and wait for it be completely removed.<a name="line.272"></a> -<span class="sourceLineNo">273</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.273"></a> -<span class="sourceLineNo">274</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.274"></a> -<span class="sourceLineNo">275</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.275"></a> -<span class="sourceLineNo">276</span> * operation to complete.<a name="line.276"></a> -<span class="sourceLineNo">277</span> *<a name="line.277"></a> -<span class="sourceLineNo">278</span> * @param tableName name of table to delete<a name="line.278"></a> -<span class="sourceLineNo">279</span> * @throws IOException if a remote or network exception occurs<a name="line.279"></a> -<span class="sourceLineNo">280</span> * @return the result of the async delete. You can use Future.get(long, TimeUnit)<a name="line.280"></a> -<span class="sourceLineNo">281</span> * to wait on the operation to complete.<a name="line.281"></a> -<span class="sourceLineNo">282</span> */<a name="line.282"></a> -<span class="sourceLineNo">283</span> Future<Void> deleteTableAsync(TableName tableName) throws IOException;<a name="line.283"></a> -<span class="sourceLineNo">284</span><a name="line.284"></a> -<span class="sourceLineNo">285</span> /**<a name="line.285"></a> -<span class="sourceLineNo">286</span> * Deletes tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.286"></a> -<span class="sourceLineNo">287</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.287"></a> -<span class="sourceLineNo">288</span> * #listTables(java.lang.String)} and {@link #deleteTable(org.apache.hadoop.hbase.TableName)}<a name="line.288"></a> -<span class="sourceLineNo">289</span> *<a name="line.289"></a> -<span class="sourceLineNo">290</span> * @param regex The regular expression to match table names against<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @return Table descriptors for tables that couldn't be deleted<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @throws IOException<a name="line.292"></a> -<span class="sourceLineNo">293</span> * @see #deleteTables(java.util.regex.Pattern)<a name="line.293"></a> -<span class="sourceLineNo">294</span> * @see #deleteTable(org.apache.hadoop.hbase.TableName)<a name="line.294"></a> -<span class="sourceLineNo">295</span> */<a name="line.295"></a> -<span class="sourceLineNo">296</span> HTableDescriptor[] deleteTables(String regex) throws IOException;<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> * Delete tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.299"></a> -<span class="sourceLineNo">300</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.300"></a> -<span class="sourceLineNo">301</span> * #listTables(java.util.regex.Pattern) } and<a name="line.301"></a> -<span class="sourceLineNo">302</span> * {@link #deleteTable(org.apache.hadoop.hbase.TableName)}<a name="line.302"></a> -<span class="sourceLineNo">303</span> *<a name="line.303"></a> -<span class="sourceLineNo">304</span> * @param pattern The pattern to match table names against<a name="line.304"></a> -<span class="sourceLineNo">305</span> * @return Table descriptors for tables that couldn't be deleted<a name="line.305"></a> -<span class="sourceLineNo">306</span> * @throws IOException<a name="line.306"></a> -<span class="sourceLineNo">307</span> */<a name="line.307"></a> -<span class="sourceLineNo">308</span> HTableDescriptor[] deleteTables(Pattern pattern) throws IOException;<a name="line.308"></a> -<span class="sourceLineNo">309</span><a name="line.309"></a> -<span class="sourceLineNo">310</span> /**<a name="line.310"></a> -<span class="sourceLineNo">311</span> * Truncate a table.<a name="line.311"></a> -<span class="sourceLineNo">312</span> * Synchronous operation.<a name="line.312"></a> -<span class="sourceLineNo">313</span> *<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 True 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> public void truncateTable(final TableName tableName, final boolean preserveSplits)<a name="line.318"></a> -<span class="sourceLineNo">319</span> throws IOException;<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> * Truncate the table but does not block and wait for it be completely enabled. You can use<a name="line.322"></a> -<span class="sourceLineNo">323</span> * Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.323"></a> -<span class="sourceLineNo">324</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.324"></a> -<span class="sourceLineNo">325</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @param tableName name of table to delete<a name="line.326"></a> -<span class="sourceLineNo">327</span> * @param preserveSplits true if the splits should be preserved<a name="line.327"></a> -<span class="sourceLineNo">328</span> * @throws IOException if a remote or network exception occurs<a name="line.328"></a> -<span class="sourceLineNo">329</span> * @return the result of the async truncate. You can use Future.get(long, TimeUnit) to wait on the<a name="line.329"></a> -<span class="sourceLineNo">330</span> * operation to complete.<a name="line.330"></a> -<span class="sourceLineNo">331</span> */<a name="line.331"></a> -<span class="sourceLineNo">332</span> Future<Void> truncateTableAsync(final TableName tableName, final boolean preserveSplits)<a name="line.332"></a> -<span class="sourceLineNo">333</span> throws IOException;<a name="line.333"></a> -<span class="sourceLineNo">334</span><a name="line.334"></a> -<span class="sourceLineNo">335</span> /**<a name="line.335"></a> -<span class="sourceLineNo">336</span> * Enable a table. May timeout. Use {@link #enableTableAsync(org.apache.hadoop.hbase.TableName)}<a name="line.336"></a> -<span class="sourceLineNo">337</span> * and {@link #isTableEnabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in<a name="line.337"></a> -<span class="sourceLineNo">338</span> * disabled state for it to be enabled.<a name="line.338"></a> -<span class="sourceLineNo">339</span> *<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 if a remote or network exception occurs There could be couple types of<a name="line.341"></a> -<span class="sourceLineNo">342</span> * IOException TableNotFoundException means the table doesn't exist. TableNotDisabledException<a name="line.342"></a> -<span class="sourceLineNo">343</span> * 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> void enableTable(final TableName tableName) throws IOException;<a name="line.348"></a> -<span class="sourceLineNo">349</span><a name="line.349"></a> -<span class="sourceLineNo">350</span> /**<a name="line.350"></a> -<span class="sourceLineNo">351</span> * Enable the table but does not block and wait for it be completely enabled.<a name="line.351"></a> -<span class="sourceLineNo">352</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.352"></a> -<span class="sourceLineNo">353</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.353"></a> -<span class="sourceLineNo">354</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.354"></a> -<span class="sourceLineNo">355</span> * operation to complete.<a name="line.355"></a> -<span class="sourceLineNo">356</span> *<a name="line.356"></a> -<span class="sourceLineNo">357</span> * @param tableName name of table to delete<a name="line.357"></a> -<span class="sourceLineNo">358</span> * @throws IOException if a remote or network exception occurs<a name="line.358"></a> -<span class="sourceLineNo">359</span> * @return the result of the async enable. You can use Future.get(long, TimeUnit)<a name="line.359"></a> -<span class="sourceLineNo">360</span> * to wait on the operation to complete.<a name="line.360"></a> -<span class="sourceLineNo">361</span> */<a name="line.361"></a> -<span class="sourceLineNo">362</span> Future<Void> enableTableAsync(final TableName tableName) throws IOException;<a name="line.362"></a> -<span class="sourceLineNo">363</span><a name="line.363"></a> -<span class="sourceLineNo">364</span> /**<a name="line.364"></a> -<span class="sourceLineNo">365</span> * Enable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.365"></a> -<span class="sourceLineNo">366</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.366"></a> -<span class="sourceLineNo">367</span> * #listTables(java.lang.String)} and {@link #enableTable(org.apache.hadoop.hbase.TableName)}<a name="line.367"></a> -<span class="sourceLineNo">368</span> *<a name="line.368"></a> -<span class="sourceLineNo">369</span> * @param regex The regular expression to match table names against<a name="line.369"></a> -<span class="sourceLineNo">370</span> * @throws IOException<a name="line.370"></a> -<span class="sourceLineNo">371</span> * @see #enableTables(java.util.regex.Pattern)<a name="line.371"></a> -<span class="sourceLineNo">372</span> * @see #enableTable(org.apache.hadoop.hbase.TableName)<a name="line.372"></a> -<span class="sourceLineNo">373</span> */<a name="line.373"></a> -<span class="sourceLineNo">374</span> HTableDescriptor[] enableTables(String regex) throws IOException;<a name="line.374"></a> -<span class="sourceLineNo">375</span><a name="line.375"></a> -<span class="sourceLineNo">376</span> /**<a name="line.376"></a> -<span class="sourceLineNo">377</span> * Enable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.377"></a> -<span class="sourceLineNo">378</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.378"></a> -<span class="sourceLineNo">379</span> * #listTables(java.util.regex.Pattern) } and<a name="line.379"></a> -<span class="sourceLineNo">380</span> * {@link #enableTable(org.apache.hadoop.hbase.TableName)}<a name="line.380"></a> -<span class="sourceLineNo">381</span> *<a name="line.381"></a> -<span class="sourceLineNo">382</span> * @param pattern The pattern to match table names against<a name="line.382"></a> -<span class="sourceLineNo">383</span> * @throws IOException<a name="line.383"></a> -<span class="sourceLineNo">384</span> */<a name="line.384"></a> -<span class="sourceLineNo">385</span> HTableDescriptor[] enableTables(Pattern pattern) throws IOException;<a name="line.385"></a> -<span class="sourceLineNo">386</span><a name="line.386"></a> -<span class="sourceLineNo">387</span> /**<a name="line.387"></a> -<span class="sourceLineNo">388</span> * Disable the table but does not block and wait for it be completely disabled.<a name="line.388"></a> -<span class="sourceLineNo">389</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.389"></a> -<span class="sourceLineNo">390</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.390"></a> -<span class="sourceLineNo">391</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.391"></a> -<span class="sourceLineNo">392</span> * operation to complete.<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 delete<a name="line.394"></a> -<span class="sourceLineNo">395</span> * @throws IOException if a remote or network exception occurs<a name="line.395"></a> -<span class="sourceLineNo">396</span> * @return the result of the async disable. You can use Future.get(long, TimeUnit)<a name="line.396"></a> -<span class="sourceLineNo">397</span> * to wait on the operation to complete.<a name="line.397"></a> -<span class="sourceLineNo">398</span> */<a name="line.398"></a> -<span class="sourceLineNo">399</span> Future<Void> disableTableAsync(final TableName tableName) throws IOException;<a name="line.399"></a> -<span class="sourceLineNo">400</span><a name="line.400"></a> -<span class="sourceLineNo">401</span> /**<a name="line.401"></a> -<span class="sourceLineNo">402</span> * Disable table and wait on completion. May timeout eventually. Use {@link<a name="line.402"></a> -<span class="sourceLineNo">403</span> * #disableTableAsync(org.apache.hadoop.hbase.TableName)} and<a name="line.403"></a> -<span class="sourceLineNo">404</span> * {@link #isTableDisabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in<a name="line.404"></a> -<span class="sourceLineNo">405</span> * enabled state for it to be disabled.<a name="line.405"></a> -<span class="sourceLineNo">406</span> *<a name="line.406"></a> -<span class="sourceLineNo">407</span> * @param tableName<a name="line.407"></a> -<span class="sourceLineNo">408</span> * @throws IOException There could be couple types of IOException TableNotFoundException means the<a name="line.408"></a> -<span class="sourceLineNo">409</span> * table doesn't exist. TableNotEnabledException means the table isn't in enabled state.<a name="line.409"></a> -<span class="sourceLineNo">410</span> */<a name="line.410"></a> -<span class="sourceLineNo">411</span> void disableTable(final TableName tableName) throws IOException;<a name="line.411"></a> -<span class="sourceLineNo">412</span><a name="line.412"></a> -<span class="sourceLineNo">413</span> /**<a name="line.413"></a> -<span class="sourceLineNo">414</span> * Disable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.414"></a> -<span class="sourceLineNo">415</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.415"></a> -<span class="sourceLineNo">416</span> * #listTables(java.lang.String)} and {@link #disableTable(org.apache.hadoop.hbase.TableName)}<a name="line.416"></a> -<span class="sourceLineNo">417</span> *<a name="line.417"></a> -<span class="sourceLineNo">418</span> * @param regex The regular expression to match table names against<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @return Table descriptors for tables that couldn't be disabled<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @throws IOException<a name="line.420"></a> -<span class="sourceLineNo">421</span> * @see #disableTables(java.util.regex.Pattern)<a name="line.421"></a> -<span class="sourceLineNo">422</span> * @see #disableTable(org.apache.hadoop.hbase.TableName)<a name="line.422"></a> -<span class="sourceLineNo">423</span> */<a name="line.423"></a> -<span class="sourceLineNo">424</span> HTableDescriptor[] disableTables(String regex) throws IOException;<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> * Disable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.427"></a> -<span class="sourceLineNo">428</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.428"></a> -<span class="sourceLineNo">429</span> * #listTables(java.util.regex.Pattern) } and<a name="line.429"></a> -<span class="sourceLineNo">430</span> * {@link #disableTable(org.apache.hadoop.hbase.TableName)}<a name="line.430"></a> -<span class="sourceLineNo">431</span> *<a name="line.431"></a> -<span class="sourceLineNo">432</span> * @param pattern The pattern to match table names against<a name="line.432"></a> -<span class="sourceLineNo">433</span> * @return Table descriptors for tables that couldn't be disabled<a name="line.433"></a> -<span class="sourceLineNo">434</span> * @throws IOException<a name="line.434"></a> -<span class="sourceLineNo">435</span> */<a name="line.435"></a> -<span class="sourceLineNo">436</span> HTableDescriptor[] disableTables(Pattern pattern) throws IOException;<a name="line.436"></a> -<span class="sourceLineNo">437</span><a name="line.437"></a> -<span class="sourceLineNo">438</span> /**<a name="line.438"></a> -<span class="sourceLineNo">439</span> * @param tableName name of table to check<a name="line.439"></a> -<span class="sourceLineNo">440</span> * @return true if table is on-line<a name="line.440"></a> -<span class="sourceLineNo">441</span> * @throws IOException if a remote or network exception occurs<a name="line.441"></a> -<span class="sourceLineNo">442</span> */<a name="line.442"></a> -<span class="sourceLineNo">443</span> boolean isTableEnabled(TableName tableName) throws IOException;<a name="line.443"></a> -<span class="sourceLineNo">444</span><a name="line.444"></a> -<span class="sourceLineNo">445</span> /**<a name="line.445"></a> -<span class="sourceLineNo">446</span> * @param tableName name of table to check<a name="line.446"></a> -<span class="sourceLineNo">447</span> * @return true if table is off-line<a name="line.447"></a> -<span class="sourceLineNo">448</span> * @throws IOException if a remote or network exception occurs<a name="line.448"></a> -<span class="sourceLineNo">449</span> */<a name="line.449"></a> -<span class="sourceLineNo">450</span> boolean isTableDisabled(TableName tableName) throws IOException;<a name="line.450"></a> -<span class="sourceLineNo">451</span><a name="line.451"></a> -<span class="sourceLineNo">452</span> /**<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @param tableName name of table to check<a name="line.453"></a> -<span class="sourceLineNo">454</span> * @return true if all regions of the table are available<a name="line.454"></a> -<span class="sourceLineNo">455</span> * @throws IOException if a remote or network exception occurs<a name="line.455"></a> -<span class="sourceLineNo">456</span> */<a name="line.456"></a> -<span class="sourceLineNo">457</span> boolean isTableAvailable(TableName tableName) throws IOException;<a name="line.457"></a> -<span class="sourceLineNo">458</span><a name="line.458"></a> -<span class="sourceLineNo">459</span> /**<a name="line.459"></a> -<span class="sourceLineNo">460</span> * Use this api to check if the table has been created with the specified number of splitkeys<a name="line.460"></a> -<span class="sourceLineNo">461</span> * which was used while creating the given table. Note : If this api is used after a table's<a name="line.461"></a> -<span class="sourceLineNo">462</span> * region gets splitted, the api may return false.<a name="line.462"></a> -<span class="sourceLineNo">463</span> *<a name="line.463"></a> -<span class="sourceLineNo">464</span> * @param tableName name of table to check<a name="line.464"></a> -<span class="sourceLineNo">465</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.465"></a> -<span class="sourceLineNo">466</span> * @throws IOException if a remote or network excpetion occurs<a name="line.466"></a> -<span class="sourceLineNo">467</span> */<a name="line.467"></a> -<span class="sourceLineNo">468</span> boolean isTableAvailable(TableName tableName, byte[][] splitKeys) throws IOException;<a name="line.468"></a> -<span class="sourceLineNo">469</span><a name="line.469"></a> -<span class="sourceLineNo">470</span> /**<a name="line.470"></a> -<span class="sourceLineNo">471</span> * Get the status of alter command - indicates how many regions have received the updated schema<a name="line.471"></a> -<span class="sourceLineNo">472</span> * Asynchronous operation.<a name="line.472"></a> -<span class="sourceLineNo">473</span> *<a name="line.473"></a> -<span class="sourceLineNo">474</span> * @param tableName TableName instance<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @return Pair indicating the number of regions updated Pair.getFirst() is the regions that are<a name="line.475"></a> -<span class="sourceLineNo">476</span> * yet to be updated Pair.getSecond() is the total number of regions of the table<a name="line.476"></a> -<span class="sourceLineNo">477</span> * @throws IOException if a remote or network exception occurs<a name="line.477"></a> -<span class="sourceLineNo">478</span> */<a name="line.478"></a> -<span class="sourceLineNo">479</span> Pair<Integer, Integer> getAlterStatus(final TableName tableName) throws IOException;<a name="line.479"></a> -<span class="sourceLineNo">480</span><a name="line.480"></a> -<span class="sourceLineNo">481</span> /**<a name="line.481"></a> -<span class="sourceLineNo">482</span> * Get the status of alter command - indicates how many regions have received the updated schema<a name="line.482"></a> -<span class="sourceLineNo">483</span> * Asynchronous operation.<a name="line.483"></a> -<span class="sourceLineNo">484</span> *<a name="line.484"></a> -<span class="sourceLineNo">485</span> * @param tableName name of the table to get the status of<a name="line.485"></a> -<span class="sourceLineNo">486</span> * @return Pair indicating the number of regions updated Pair.getFirst() is the regions that are<a name="line.486"></a> -<span class="sourceLineNo">487</span> * yet to be updated Pair.getSecond() is the total number of regions of the table<a name="line.487"></a> -<span class="sourceLineNo">488</span> * @throws IOException if a remote or network exception occurs<a name="line.488"></a> -<span class="sourceLineNo">489</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #getAlterStatus(TableName)}<a name="line.489"></a> -<span class="sourceLineNo">490</span> * instead.<a name="line.490"></a> -<span class="sourceLineNo">491</span> */<a name="line.491"></a> -<span class="sourceLineNo">492</span> @Deprecated<a name="line.492"></a> -<span class="sourceLineNo">493</span> Pair<Integer, Integer> getAlterStatus(final byte[] tableName) throws IOException;<a name="line.493"></a> -<span class="sourceLineNo">494</span><a name="line.494"></a> -<span class="sourceLineNo">495</span> /**<a name="line.495"></a> -<span class="sourceLineNo">496</span> * Add a column family to an existing table. Asynchronous operation.<a name="line.496"></a> -<span class="sourceLineNo">497</span> *<a name="line.497"></a> -<span class="sourceLineNo">498</span> * @param tableName name of the table to add column family to<a name="line.498"></a> -<span class="sourceLineNo">499</span> * @param columnFamily column family descriptor of column family to be added<a name="line.499"></a> -<span class="sourceLineNo">500</span> * @throws IOException if a remote or network exception occurs<a name="line.500"></a> -<span class="sourceLineNo">501</span> * @deprecated As of release 2.0.0.<a name="line.501"></a> -<span class="sourceLineNo">502</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-1989">HBASE-1989</a>).<a name="line.502"></a> -<span class="sourceLineNo">503</span> * This will be removed in HBase 3.0.0.<a name="line.503"></a> -<span class="sourceLineNo">504</span> * Use {@link #addColumnFamily(TableName, HColumnDescriptor)}.<a name="line.504"></a> -<span class="sourceLineNo">505</span> */<a name="line.505"></a> -<span class="sourceLineNo">506</span> @Deprecated<a name="line.506"></a> -<span class="sourceLineNo">507</span> void addColumn(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.507"></a> -<span class="sourceLineNo">508</span> 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> * Add a column family to an existing table.<a name="line.511"></a> -<span class="sourceLineNo">512</span> *<a name="line.512"></a> -<span class="sourceLineNo">513</span> * @param tableName name of the table to add column family to<a name="line.513"></a> -<span class="sourceLineNo">514</span> * @param columnFamily column family descriptor of column family to be added<a name="line.514"></a> -<span class="sourceLineNo">515</span> * @throws IOException if a remote or network exception occurs<a name="line.515"></a> -<span class="sourceLineNo">516</span> */<a name="line.516"></a> -<span class="sourceLineNo">517</span> void addColumnFamily(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.517"></a> -<span class="sourceLineNo">518</span> throws IOException;<a name="line.518"></a> -<span class="sourceLineNo">519</span><a name="line.519"></a> -<span class="sourceLineNo">520</span> /**<a name="line.520"></a> -<span class="sourceLineNo">521</span> * Add a column family to an existing table. Asynchronous operation.<a name="line.521"></a> -<span class="sourceLineNo">522</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.522"></a> -<span class="sourceLineNo">523</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.523"></a> -<span class="sourceLineNo">524</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.524"></a> -<span class="sourceLineNo">525</span> * operation to complete.<a name="line.525"></a> -<span class="sourceLineNo">526</span> *<a name="line.526"></a> -<span class="sourceLineNo">527</span> * @param tableName name of the table to add column family to<a name="line.527"></a> -<span class="sourceLineNo">528</span> * @param columnFamily column family descriptor of column family to be added<a name="line.528"></a> -<span class="sourceLineNo">529</span> * @throws IOException if a remote or network exception occurs<a name="line.529"></a> -<span class="sourceLineNo">530</span> * @return the result of the async add column family. You can use Future.get(long, TimeUnit) to<a name="line.530"></a> -<span class="sourceLineNo">531</span> * wait on the operation to complete.<a name="line.531"></a> -<span class="sourceLineNo">532</span> */<a name="line.532"></a> -<span class="sourceLineNo">533</span> Future<Void> addColumnFamilyAsync(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.533"></a> -<span class="sourceLineNo">534</span> 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> * Delete a column family from a table. Asynchronous operation.<a name="line.537"></a> -<span class="sourceLineNo">538</span> *<a name="line.538"></a> -<span class="sourceLineNo">539</span> * @param tableName name of table<a name="line.539"></a> -<span class="sourceLineNo">540</span> * @param columnFamily name of column family to be deleted<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> * @deprecated As of release 2.0.0.<a name="line.542"></a> -<span class="sourceLineNo">543</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-1989">HBASE-1989</a>).<a name="line.543"></a> -<span class="sourceLineNo">544</span> * This will be removed in HBase 3.0.0.<a name="line.544"></a> -<span class="sourceLineNo">545</span> * Use {@link #deleteColumnFamily(TableName, byte[])}}.<a name="line.545"></a> -<span class="sourceLineNo">546</span> */<a name="line.546"></a> -<span class="sourceLineNo">547</span> @Deprecated<a name="line.547"></a> -<span class="sourceLineNo">548</span> void deleteColumn(final TableName tableName, final byte[] columnFamily) throws IOException;<a name="line.548"></a> -<span class="sourceLineNo">549</span><a name="line.549"></a> -<span class="sourceLineNo">550</span> /**<a name="line.550"></a> -<span class="sourceLineNo">551</span> * Delete a column family from a table. Asynchronous operation.<a name="line.551"></a> -<span class="sourceLineNo">552</span> *<a name="line.552"></a> -<span class="sourceLineNo">553</span> * @param tableName name of table<a name="line.553"></a> -<span class="sourceLineNo">554</span> * @param columnFamily name of column family to be deleted<a name="line.554"></a> -<span class="sourceLineNo">555</span> * @throws IOException if a remote or network exception occurs<a name="line.555"></a> -<span class="sourceLineNo">556</span> */<a name="line.556"></a> -<span class="sourceLineNo">557</span> void deleteColumnFamily(final TableName tableName, final byte[] columnFamily) throws IOException;<a name="line.557"></a> -<span class="sourceLineNo">558</span><a name="line.558"></a> -<span class="sourceLineNo">559</span> /**<a name="line.559"></a> -<span class="sourceLineNo">560</span> * Delete a column family from a table. Asynchronous operation.<a name="line.560"></a> -<span class="sourceLineNo">561</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.561"></a> -<span class="sourceLineNo">562</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.562"></a> -<span class="sourceLineNo">563</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.563"></a> -<span class="sourceLineNo">564</span> * operation to complete.<a name="line.564"></a> -<span class="sourceLineNo">565</span> *<a name="line.565"></a> -<span class="sourceLineNo">566</span> * @param tableName name of table<a name="line.566"></a> -<span class="sourceLineNo">567</span> * @param columnFamily name of column family to be deleted<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> * @return the result of the async delete column family. You can use Future.get(long, TimeUnit) to<a name="line.569"></a> -<span class="sourceLineNo">570</span> * wait on the operation to complete.<a name="line.570"></a> -<span class="sourceLineNo">571</span> */<a name="line.571"></a> -<span class="sourceLineNo">572</span> Future<Void> deleteColumnFamilyAsync(final TableName tableName, final byte[] columnFamily)<a name="line.572"></a> -<span class="sourceLineNo">573</span> throws IOException;<a name="line.573"></a> -<span class="sourceLineNo">574</span><a name="line.574"></a> -<span class="sourceLineNo">575</span> /**<a name="line.575"></a> -<span class="sourceLineNo">576</span> * Modify an existing column family on a table.<a name="line.576"></a> -<span class="sourceLineNo">577</span> *<a name="line.577"></a> -<span class="sourceLineNo">578</span> * @param tableName name of table<a name="line.578"></a> -<span class="sourceLineNo">579</span> * @param columnFamily new column family descriptor to use<a name="line.579"></a> -<span class="sourceLineNo">580</span> * @throws IOException if a remote or network exception occurs<a name="line.580"></a> -<span class="sourceLineNo">581</span> * @deprecated As of release 2.0.0.<a name="line.581"></a> -<span class="sourceLineNo">582</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-1989">HBASE-1989</a>).<a name="line.582"></a> -<span class="sourceLineNo">583</span> * This will be removed in HBase 3.0.0.<a name="line.583"></a> -<span class="sourceLineNo">584</span> * Use {@link #modifyColumnFamily(TableName, HColumnDescriptor)}.<a name="line.584"></a> -<span class="sourceLineNo">585</span> */<a name="line.585"></a> -<span class="sourceLineNo">586</span> @Deprecated<a name="line.586"></a> -<span class="sourceLineNo">587</span> void modifyColumn(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.587"></a> -<span class="sourceLineNo">588</span> throws IOException;<a name="line.588"></a> -<span class="sourceLineNo">589</span><a name="line.589"></a> -<span class="sourceLineNo">590</span> /**<a name="line.590"></a> -<span class="sourceLineNo">591</span> * Modify an existing column family on a table.<a name="line.591"></a> -<span class="sourceLineNo">592</span> *<a name="line.592"></a> -<span class="sourceLineNo">593</span> * @param tableName name of table<a name="line.593"></a> -<span class="sourceLineNo">594</span> * @param columnFamily new column family descriptor to use<a name="line.594"></a> -<span class="sourceLineNo">595</span> * @throws IOException if a remote or network exception occurs<a name="line.595"></a> -<span class="sourceLineNo">596</span> */<a name="line.596"></a> -<span class="sourceLineNo">597</span> void modifyColumnFamily(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.597"></a> -<span class="sourceLineNo">598</span> throws IOException;<a name="line.598"></a> -<span class="sourceLineNo">599</span><a name="line.599"></a> -<span class="sourceLineNo">600</span> /**<a name="line.600"></a> -<span class="sourceLineNo">601</span> * Modify an existing column family on a table. Asynchronous operation.<a name="line.601"></a> -<span class="sourceLineNo">602</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.602"></a> -<span class="sourceLineNo">603</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.603"></a> -<span class="sourceLineNo">604</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.604"></a> -<span class="sourceLineNo">605</span> * operation to complete.<a name="line.605"></a> -<span class="sourceLineNo">606</span> *<a name="line.606"></a> -<span class="sourceLineNo">607</span> * @param tableName name of table<a name="line.607"></a> -<span class="sourceLineNo">608</span> * @param columnFamily new column family descriptor to use<a name="line.608"></a> -<span class="sourceLineNo">609</span> * @throws IOException if a remote or network exception occurs<a name="line.609"></a> -<span class="sourceLineNo">610</span> * @return the result of the async modify column family. You can use Future.get(long, TimeUnit) to<a name="line.610"></a> -<span class="sourceLineNo">611</span> * wait on the operation to complete.<a name="line.611"></a> -<span class="sourceLineNo">612</span> */<a name="line.612"></a> -<span class="sourceLineNo">613</span> Future<Void> modifyColumnFamilyAsync(TableName tableName, HColumnDescriptor columnFamily)<a name="line.613"></a> -<span class="sourceLineNo">614</span> throws IOException;<a name="line.614"></a> -<span class="sourceLineNo">615</span><a name="line.615"></a> -<span class="sourceLineNo">616</span><a name="line.616"></a> -<span class="sourceLineNo">617</span> /**<a name="line.617"></a> -<span class="sourceLineNo">618</span> * Close a region. For expert-admins. Runs close on the regionserver. The master will not be<a name="line.618"></a> -<span class="sourceLineNo">619</span> * informed of the close.<a name="line.619"></a> -<span class="sourceLineNo">620</span> *<a name="line.620"></a> -<span class="sourceLineNo">621</span> * @param regionname region name to close<a name="line.621"></a> -<span class="sourceLineNo">622</span> * @param serverName If supplied, we'll use this location rather than the one currently in<a name="line.622"></a> -<span class="sourceLineNo">623</span> * <code>hbase:meta</code><a name="line.623"></a> -<span class="sourceLineNo">624</span> * @throws IOException if a remote or network exception occurs<a name="line.624"></a> -<span class="sourceLineNo">625</span> */<a name="line.625"></a> -<span class="sourceLineNo">626</span> void closeRegion(final String regionname, final String serverName) throws IOException;<a name="line.626"></a> -<span class="sourceLineNo">627</span><a name="line.627"></a> -<span class="sourceLineNo">628</span> /**<a name="line.628"></a> -<span class="sourceLineNo">629</span> * Close a region. For expert-admins Runs close on the regionserver. The master will not be<a name="line.629"></a> -<span class="sourceLineNo">630</span> * informed of the close.<a name="line.630"></a> -<span class="sourceLineNo">631</span> *<a name="line.631"></a> -<span class="sourceLineNo">632</span> * @param regionname region name to close<a name="line.632"></a> -<span class="sourceLineNo">633</span> * @param serverName The servername of the regionserver. If passed null we will use servername<a name="line.633"></a> -<span class="sourceLineNo">634</span> * found in the hbase:meta table. A server name is made of host, port and startcode. Here is an<a name="line.634"></a> -<span class="sourceLineNo">635</span> * example: <code> host187.example.com,60020,1289493121758</code><a name="line.635"></a> -<span class="sourceLineNo">636</span> * @throws IOException if a remote or network exception occurs<a name="line.636"></a> -<span class="sourceLineNo">637</span> */<a name="line.637"></a> -<span class="sourceLineNo">638</span> void closeRegion(final byte[] regionname, final String serverName) throws IOException;<a name="line.638"></a> -<span class="sourceLineNo">639</span><a name="line.639"></a> -<span class="sourceLineNo">640</span> /**<a name="line.640"></a> -<span class="sourceLineNo">641</span> * For expert-admins. Runs close on the regionserver. Closes a region based on the encoded region<a name="line.641"></a> -<span class="sourceLineNo">642</span> * name. The region server name is mandatory. If the servername is provided then based on the<a name="line.642"></a> -<span class="sourceLineNo">643</span> * online regions in the specified regionserver the specified region will be closed. The master<a name="line.643"></a> -<span class="sourceLineNo">644</span> * will not be informed of the close. Note that the regionname is the encoded regionname.<a name="line.644"></a> -<span class="sourceLineNo">645</span> *<a name="line.645"></a> -<span class="sourceLineNo">646</span> * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name<a name="line.646"></a> -<span class="sourceLineNo">647</span> * suffix: e.g. if regionname is<a name="line.647"></a> -<span class="sourceLineNo">648</span> * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>,<a name="line.648"></a> -<span class="sourceLineNo">649</span> * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>.<a name="line.649"></a> -<span class="sourceLineNo">650</span> * @param serverName The servername of the regionserver. A server name is made of host, port and<a name="line.650"></a> -<span class="sourceLineNo">651</span> * startcode. This is mandatory. Here is an example:<a name="line.651"></a> -<span class="sourceLineNo">652</span> * <code> host187.example.com,60020,1289493121758</code><a name="line.652"></a> -<span class="sourceLineNo">653</span> * @return true if the region was closed, false if not.<a name="line.653"></a> -<span class="sourceLineNo">654</span> * @throws IOException if a remote or network exception occurs<a name="line.654"></a> -<span class="sourceLineNo">655</span> */<a name="line.655"></a> -<span class="sourceLineNo">656</span> boolean closeRegionWithEncodedRegionName(final String encodedRegionName, final String serverName)<a name="line.656"></a> -<span class="sourceLineNo">657</span> throws IOException;<a name="line.657"></a> -<span class="sourceLineNo">658</span><a name="line.658"></a> -<span class="sourceLineNo">659</span> /**<a name="line.659"></a> -<span class="sourceLineNo">660</span> * Close a region. For expert-admins Runs close on the regionserver. The master will not be<a name="line.660"></a> -<span class="sourceLineNo">661</span> * informed of the close.<a name="line.661"></a> -<span class="sourceLineNo">662</span> *<a name="line.662"></a> -<span class="sourceLineNo">663</span> * @param sn<a name="line.663"></a> -<span class="sourceLineNo">664</span> * @param hri<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> void closeRegion(final ServerName sn, final HRegionInfo hri) throws IOException;<a name="line.667"></a> -<span class="sourceLineNo">668</span><a name="line.668"></a> -<span class="sourceLineNo">669</span> /**<a name="line.669"></a> -<span class="sourceLineNo">670</span> * Get all the online regions on a region server.<a name="line.670"></a> -<span class="sourceLineNo">671</span> */<a name="line.671"></a> -<span class="sourceLineNo">672</span> List<HRegionInfo> getOnlineRegions(final ServerName sn) throws IOException;<a name="line.672"></a> -<span class="sourceLineNo">673</span><a name="line.673"></a> -<span class="sourceLineNo">674</span> /**<a name="line.674"></a> -<span class="sourceLineNo">675</span> * Flush a table. Synchronous operation.<a name="line.675"></a> -<span class="sourceLineNo">676</span> *<a name="line.676"></a> -<span class="sourceLineNo">677</span> * @param tableName table to flush<a name="line.677"></a> -<span class="sourceLineNo">678</span> * @throws IOException if a remote or network exception occurs<a name="line.678"></a> -<span class="sourceLineNo">679</span> */<a name="line.679"></a> -<span class="sourceLineNo">680</span> void flush(final TableName tableName) throws IOException;<a name="line.680"></a> -<span class="sourceLineNo">681</span><a name="line.681"></a> -<span class="sourceLineNo">682</span> /**<a name="line.682"></a> -<span class="sourceLineNo">683</span> * Flush an individual region. Synchronous operation.<a name="line.683"></a> -<span class="sourceLineNo">684</span> *<a name="line.684"></a> -<span class="sourceLineNo">685</span> * @param regionName region to flush<a name="line.685"></a> -<span class="sourceLineNo">686</span> * @throws IOException if a remote or network exception occurs<a name="line.686"></a> -<span class="sourceLineNo">687</span> */<a name="line.687"></a> -<span class="sourceLineNo">688</span> void flushRegion(final byte[] regionName) throws IOException;<a name="line.688"></a> -<span class="sourceLineNo">689</span><a name="line.689"></a> -<span class="sourceLineNo">690</span> /**<a name="line.690"></a> -<span class="sourceLineNo">691</span> * Compact a table. Asynchronous operation.<a name="line.691"></a> -<span class="sourceLineNo">692</span> *<a name="line.692"></a> -<span class="sourceLineNo">693</span> * @param tableName table to compact<a name="line.693"></a> -<span class="sourceLineNo">694</span> * @throws IOException if a remote or network exception occurs<a name="line.694"></a> -<span class="sourceLineNo">695</span> */<a name="line.695"></a> -<span class="sourceLineNo">696</span> void compact(final TableName tableName) throws IOException;<a name="line.696"></a> -<span class="sourceLineNo">697</span><a name="line.697"></a> -<span class="sourceLineNo">698</span> /**<a name="line.698"></a> -<span class="sourceLineNo">699</span> * Compact an individual region. Asynchronous operation.<a name="line.699"></a> -<span class="sourceLineNo">700</span> *<a name="line.700"></a> -<span class="sourceLineNo">701</span> * @param regionName region to compact<a name="line.701"></a> -<span class="sourceLineNo">702</span> * @throws IOException if a remote or network exception occurs<a name="line.702"></a> -<span class="sourceLineNo">703</span> */<a name="line.703"></a> -<span class="sourceLineNo">704</span> void compactRegion(final byte[] regionName) throws IOException;<a name="line.704"></a> -<span class="sourceLineNo">705</span><a name="line.705"></a> -<span class="sourceLineNo">706</span> /**<a name="line.706"></a> -<span class="sourceLineNo">707</span> * Compact a column family within a table. Asynchronous operation.<a name="line.707"></a> -<span class="sourceLineNo">708</span> *<a name="line.708"></a> -<span class="sourceLineNo">709</span> * @param tableName table to compact<a name="line.709"></a> -<span class="sourceLineNo">710</span> * @param columnFamily column family within a table<a name="line.710"></a> -<span class="sourceLineNo">711</span> * @throws IOException if a remote or network exception occurs<a name="line.711"></a> -<span class="sourceLineNo">712</span> */<a name="line.712"></a> -<span class="sourceLineNo">713</span> void compact(final TableName tableName, final byte[] columnFamily)<a name="line.713"></a> -<span class="sourceLineNo">714</span> throws IOException;<a name="line.714"></a> -<span class="sourceLineNo">715</span><a name="line.715"></a> -<span class="sourceLineNo">716</span> /**<a name="line.716"></a> -<span class="sourceLineNo">717</span> * Compact a column family within a region. Asynchronous operation.<a name="line.717"></a> -<span class="sourceLineNo">718</span> *<a name="line.718"></a> -<span class="sourceLineNo">719</span> * @param regionName region to compact<a name="line.719"></a> -<span class="sourceLineNo">720</span> * @param columnFamily column family within a region<a name="line.720"></a> -<span class="sourceLineNo">721</span> * @throws IOException if a remote or network exception occurs<a name="line.721"></a> -<span class="sourceLineNo">722</span> */<a name="line.722"></a> -<span class="sourceLineNo">723</span> void compactRegion(final byte[] regionName, final byte[] columnFamily)<a name="line.723"></a> -<span class="sourceLineNo">724</span> 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> * Major compact a table. Asynchronous operation.<a name="line.727"></a> -<span class="sourceLineNo">728</span> *<a name="line.728"></a> -<span class="sourceLineNo">729</span> * @param tableName table to major compact<a name="line.729"></a> -<span class="sourceLineNo">730</span> * @throws IOException if a remote or network exception occurs<a name="line.730"></a> -<span class="sourceLineNo">731</span> */<a name="line.731"></a> -<span class="sourceLineNo">732</span> void majorCompact(TableName tableName) throws IOException;<a name="line.732"></a> -<span class="sourceLineNo">733</span><a name="line.733"></a> -<span class="sourceLineNo">734</span> /**<a name="line.734"></a> -<span class="sourceLineNo">735</span> * Major compact a table or an individual region. Asynchronous operation.<a name="line.735"></a> -<span class="sourceLineNo">736</span> *<a name="line.736"></a> -<span class="sourceLineNo">737</span> * @param regionName region to major compact<a name="line.737"></a> -<span class="sourceLineNo">738</span> * @throws IOException if a remote or network exception occurs<a name="line.738"></a> -<span class="sourceLineNo">739</span> */<a name="line.739"></a> -<span class="sourceLineNo">740</span> void majorCompactRegion(final byte[] regionName) throws IOException;<a name="line.740"></a> -<span class="sourceLineNo">741</span><a name="line.741"></a> -<span class="sourceLineNo">742</span> /**<a name="line.742"></a> -<span class="sourceLineNo">743</span> * Major compact a column family within a table. Asynchronous operation.<a name="line.743"></a> -<span class="sourceLineNo">744</span> *<a name="line.744"></a> -<span class="sourceLineNo">745</span> * @param tableName table to major compact<a name="line.745"></a> -<span class="sourceLineNo">746</span> * @param columnFamily column family within a table<a name="line.746"></a> -<span class="sourceLineNo">747</span> * @throws IOException if a remote or network exception occurs<a name="line.747"></a> -<span class="sourceLineNo">748</span> */<a name="line.748"></a> -<span class="sourceLineNo">749</span> void majorCompact(TableName tableName, final byte[] columnFamily)<a name="line.749"></a> -<span class="sourceLineNo">750</span> throws IOException;<a name="line.750"></a> -<span class="sourceLineNo">751</span><a name="line.751"></a> -<span class="sourceLineNo">752</span> /**<a name="line.752"></a> -<span class="sourceLineNo">753</span> * Major compact a column family within region. Asynchronous operation.<a name="line.753"></a> -<span class="sourceLineNo">754</span> *<a name="line.754"></a> -<span class="sourceLineNo">755</span> * @param regionName egion to major compact<a name="line.755"></a> -<span class="sourceLineNo">756</span> * @param columnFamily column family within a region<a name="line.756"></a> -<span class="sourceLineNo">757</span> * @throws IOException if a remote or network exception occurs<a name="line.757"></a> -<span class="sourceLineNo">758</span> */<a name="line.758"></a> -<span class="sourceLineNo">759</span> void majorCompactRegion(final byte[] regionName, final byte[] columnFamily)<a name="line.759"></a> -<span class="sourceLineNo">760</span> throws IOException;<a name="line.760"></a> -<span class="sourceLineNo">761</span><a name="line.761"></a> -<span class="sourceLineNo">762</span> /**<a name="line.762"></a> -<span class="sourceLineNo">763</span> * Compact all regions on the region server<a name="line.763"></a> -<span class="sourceLineNo">764</span> * @param sn the region server name<a name="line.764"></a> -<span class="sourceLineNo">765</span> * @param major if it's major compaction<a name="line.765"></a> -<span class="sourceLineNo">766</span> * @throws IOException<a name="line.766"></a> -<span class="sourceLineNo">767</span> * @throws InterruptedException<a name="line.767"></a> -<span class="sourceLineNo">768</span> */<a name="line.768"></a> -<span class="sourceLineNo">769</span> public void compactRegionServer(final ServerName sn, boolean major)<a name="line.769"></a> -<span class="sourceLineNo">770</span> throws IOException, InterruptedException;<a name="line.770"></a> -<span class="sourceLineNo">771</span><a name="line.771"></a> -<span class="sourceLineNo">772</span> /**<a name="line.772"></a> -<span class="sourceLineNo">773</span> * Move the region <code>r</code> to <code>dest</code>.<a name="line.773"></a> -<span class="sourceLineNo">774</span> *<a name="line.774"></a> -<span class="sourceLineNo">775</span> * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name<a name="line.775"></a> -<span class="sourceLineNo">776</span> * suffix: e.g. if regionname is<a name="line.776"></a> -<span class="sourceLineNo">777</span> * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>,<a name="line.777"></a> -<span class="sourceLineNo">778</span> * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>.<a name="line.778"></a> -<span class="sourceLineNo">779</span> * @param destServerName The servername of the destination regionserver. If passed the empty byte<a name="line.779"></a> -<span class="sourceLineNo">780</span> * array we'll assign to a random server. A server name is made of host, port and startcode.<a name="line.780"></a> -<span class="sourceLineNo">781</span> * Here is an example: <code> host187.example.com,60020,1289493121758</code><a name="line.781"></a> -<span class="sourceLineNo">782</span> * @throws IOException if we can't find a region named<a name="line.782"></a> -<span class="sourceLineNo">783</span> * <code>encodedRegionName</code><a name="line.783"></a> -<span class="sourceLineNo">784</span> */<a name="line.784"></a> -<span class="sourceLineNo">785</span> void move(final byte[] encodedRegionName, final byte[] destServerName)<a name="line.785"></a> -<span class="sourceLineNo">786</span> throws IOException;<a name="line.786"></a> -<span class="sourceLineNo">787</span><a name="line.787"></a> -<span class="sourceLineNo">788</span> /**<a name="line.788"></a> -<span class="sourceLineNo">789</span> * @param regionName Region name to assign.<a name="line.789"></a> -<span class="sourceLineNo">790</span> */<a name="line.790"></a> -<span class="sourceLineNo">791</span> void assign(final byte[] regionName)<a name="line.791"></a> -<span class="sourceLineNo">792</span> throws IOException;<a name="line.792"></a> -<span class="sourceLineNo">793</span><a name="line.793"></a> -<span class="sourceLineNo">794</span> /**<a name="line.794"></a> -<span class="sourceLineNo">795</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.795"></a> -<span class="sourceLineNo">796</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use {@link<a name="line.796"></a> -<span class="sourceLineNo">797</span> * #move(byte[], byte[])} if you want to control the region movement.<a name="line.797"></a> -<span class="sourceLineNo">798</span> *<a name="line.798"></a> -<span class="sourceLineNo">799</span> * @param regionName Region to unassign. Will clear any existing RegionPlan if one found.<a name="line.799"></a> -<span class="sourceLineNo">800</span> * @param force If true, force unassign (Will remove region from regions-in-transition too if<a name="line.800"></a> -<span class="sourceLineNo">801</span> * present. If results in double assignment use hbck -fix to resolve. To be used by experts).<a name="line.801"></a> -<span class="sourceLineNo">802</span> */<a name="line.802"></a> -<span class="sourceLineNo">803</span> void unassign(final byte[] regionName, final boolean force)<a name="line.803"></a> -<span class="sourceLineNo">804</span> throws IOException;<a name="line.804"></a> -<span class="sourceLineNo">805</span><a name="line.805"></a> -<span class="sourceLineNo">806</span> /**<a name="line.806"></a> -<span class="sourceLineNo">807</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.807"></a> -<span class="sourceLineNo">808</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.808"></a> -<span class="sourceLineNo">809</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.809"></a> -<span class="sourceLineNo">810</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.810"></a> -<span class="sourceLineNo">811</span> * experts or hbck.<a name="line.811"></a> -<span class="sourceLineNo">812</span> *<a name="line.812"></a> -<span class="sourceLineNo">813</span> * @param regionName Region to offline.<a name="line.813"></a> -<span class="sourceLineNo">814</span> * @throws IOException<a name="line.814"></a> -<span class="sourceLineNo">815</span> */<a name="line.815"></a> -<span class="sourceLineNo">816</span> void offline(final byte[] regionName) throws IOException;<a name="line.816"></a> -<span class="sourceLineNo">817</span><a name="line.817"></a> -<span class="sourceLineNo">818</span> /**<a name="line.818"></a> -<span class="sourceLineNo">819</span> * Turn the load balancer on or off.<a name="line.819"></a> -<span class="sourceLineNo">820</span> *<a name="line.820"></a> -<span class="sourceLineNo">821</span> * @param synchronous If true, it waits until current balance() call, if outstanding, 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> */<a name="line.823"></a> -<span class="sourceLineNo">824</span> boolean setBalancerRunning(final boolean on, final boolean synchronous)<a name="line.824"></a> -<span class="sourceLineNo">825</span> 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 True if balancer ran, false otherwise.<a name="line.831"></a> -<span class="sourceLineNo">832</span> */<a name="line.832"></a> -<span class="sourceLineNo">833</span> boolean balancer() throws IOException;<a name="line.833"></a> -<span class="sourceLineNo">834</span><a name="line.834"></a> -<span class="sourceLineNo">835</span> /**<a name="line.835"></a> -<span class="sourceLineNo">836</span> * Invoke the balancer. Will run the balancer and if regions to move, it will<a name="line.836"></a> -<span class="sourceLineNo">837</span> * go ahead and do the reassignments. If there is region in transition, force parameter of true<a name="line.837"></a> -<span class="sourceLineNo">838</span> * would still run balancer. Can *not* run for other reasons. Check<a name="line.838"></a> -<span class="sourceLineNo">839</span> * logs.<a name="line.839"></a> -<span class="sourceLineNo">840</span> * @param force whether we should force balance even if there is region in transition<a name="line.840"></a> -<span class="sourceLineNo">841</span> * @return True if balancer ran, false otherwise.<a name="line.841"></a> -<span class="sourceLineNo">842</span> */<a name="line.842"></a> -<span class="sourceLineNo">843</span> boolean balancer(boolean force) throws IOException;<a name="line.843"></a> -<span class="sourceLineNo">844</span><a name="line.844"></a> -<span class="sourceLineNo">845</span> /**<a name="line.845"></a> -<span class="sourceLineNo">846</span> * Query the current state of the balancer<a name="line.846"></a> -<span class="sourceLineNo">847</span> *<a name="line.847"></a> -<span class="sourceLineNo">848</span> * @return true if the balancer is enabled, false otherwise.<a name="line.848"></a> -<span class="sourceLineNo">849</span> */<a name="line.849"></a> -<span class="sourceLineNo">850</span> boolean isBalancerEnabled() throws IOException;<a name="line.850"></a> -<span class="sourceLineNo">851</span><a name="line.851"></a> -<span class="sourceLineNo">852</span> /**<a name="line.852"></a> -<span class="sourceLineNo">853</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.853"></a> -<span class="sourceLineNo">854</span> *<a name="line.854"></a> -<span class="sourceLineNo">855</span> * @return True if region normalizer ran, false otherwise.<a name="line.855"></a> -<span class="sourceLineNo">856</span> */<a name="line.856"></a> -<span class="sourceLineNo">857</span> boolean normalize() throws IOException;<a name="line.857"></a> -<span class="sourceLineNo">858</span><a name="line.858"></a> -<span class="sourceLineNo">859</span> /**<a name="line.859"></a> -<span class="sourceLineNo">860</span> * Query the current state of the region normalizer<a name="line.860"></a> -<span class="sourceLineNo">861</span> *<a name="line.861"></a> -<span class="sourceLineNo">862</span> * @return true if region normalizer is enabled, false otherwise.<a name="line.862"></a> -<span class="sourceLineNo">863</span> */<a name="line.863"></a> -<span class="sourceLineNo">864</span> boolean isNormalizerEnabled() throws IOException;<a name="line.864"></a> -<span class="sourceLineNo">865</span><a name="line.865"></a> -<span class="sourceLineNo">866</span> /**<a name="line.866"></a> -<span class="sourceLineNo">867</span> * Turn region normalizer on or off.<a name="line.867"></a> -<span class="sourceLineNo">868</span> *<a name="line.868"></a> -<span class="sourceLineNo">869</span> * @return Previous normalizer value<a name="line.869"></a> -<span class="sourceLineNo">870</span> */<a name="line.870"></a> -<span class="sourceLineNo">871</span> boolean setNormalizerRunning(final boolean on)<a name="line.871"></a> -<span class="sourceLineNo">872</span> throws IOException;<a name="line.872"></a> -<span class="sourceLineNo">873</span><a name="line.873"></a> -<span class="sourceLineNo">874</span> /**<a name="line.874"></a> -<span class="sourceLineNo">875</span> * Enable/Disable the catalog janitor<a name="line.875"></a> -<span class="sourceLineNo">876</span> *<a name="line.876"></a> -<span class="sourceLineNo">877</span> * @param enable if true enables the catalog janitor<a name="line.877"></a> -<span class="sourceLineNo">878</span> * @return the previous state<a name="line.878"></a> -<span class="sourceLineNo">879</span> */<a name="line.879"></a> -<span class="sourceLineNo">880</span> boolean enableCatalogJanitor(boolean enable) throws IOException;<a name="line.880"></a> -<span class="sourceLineNo">881</span><a name="line.881"></a> -<span class=
<TRUNCATED>
