http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f55baeba/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 0437841..ba4fef3 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html @@ -40,1762 +40,1765 @@ <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.ProcedureInfo;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.ServerName;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.TableExistsException;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.TableName;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.TableNotFoundException;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.42"></a> -<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel;<a name="line.43"></a> -<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.44"></a> -<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.quotas.QuotaRetriever;<a name="line.45"></a> -<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.46"></a> -<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException;<a name="line.47"></a> -<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.snapshot.HBaseSnapshotException;<a name="line.48"></a> -<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.snapshot.RestoreSnapshotException;<a name="line.49"></a> -<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.snapshot.SnapshotCreationException;<a name="line.50"></a> -<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.snapshot.UnknownSnapshotException;<a name="line.51"></a> -<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.52"></a> -<span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span>/**<a name="line.54"></a> -<span class="sourceLineNo">055</span> * The administrative API for HBase. Obtain an instance from an {@link Connection#getAdmin()} and<a name="line.55"></a> -<span class="sourceLineNo">056</span> * call {@link #close()} afterwards.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * <p>Admin can be used to create, drop, list, enable and disable tables, add and drop table<a name="line.57"></a> -<span class="sourceLineNo">058</span> * column families and other administrative operations.<a name="line.58"></a> -<span class="sourceLineNo">059</span> *<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @see ConnectionFactory<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @see Connection<a name="line.61"></a> -<span class="sourceLineNo">062</span> * @see Table<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @since 0.99.0<a name="line.63"></a> -<span class="sourceLineNo">064</span> */<a name="line.64"></a> -<span class="sourceLineNo">065</span>@InterfaceAudience.Public<a name="line.65"></a> -<span class="sourceLineNo">066</span>@InterfaceStability.Evolving<a name="line.66"></a> -<span class="sourceLineNo">067</span>public interface Admin extends Abortable, Closeable {<a name="line.67"></a> -<span class="sourceLineNo">068</span> int getOperationTimeout();<a name="line.68"></a> -<span class="sourceLineNo">069</span><a name="line.69"></a> -<span class="sourceLineNo">070</span> @Override<a name="line.70"></a> -<span class="sourceLineNo">071</span> void abort(String why, Throwable e);<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> @Override<a name="line.73"></a> -<span class="sourceLineNo">074</span> boolean isAborted();<a name="line.74"></a> -<span class="sourceLineNo">075</span><a name="line.75"></a> -<span class="sourceLineNo">076</span> /**<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @return Connection used by this object.<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> Connection getConnection();<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param tableName Table to check.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @return True if table exists already.<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @throws IOException<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> boolean tableExists(final TableName tableName) throws IOException;<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * List all the userspace tables.<a name="line.89"></a> -<span class="sourceLineNo">090</span> *<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @return - returns an array of HTableDescriptors<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @throws IOException if a remote or network exception occurs<a name="line.92"></a> -<span class="sourceLineNo">093</span> */<a name="line.93"></a> -<span class="sourceLineNo">094</span> HTableDescriptor[] listTables() throws IOException;<a name="line.94"></a> -<span class="sourceLineNo">095</span><a name="line.95"></a> -<span class="sourceLineNo">096</span> /**<a name="line.96"></a> -<span class="sourceLineNo">097</span> * List all the userspace tables matching the given pattern.<a name="line.97"></a> -<span class="sourceLineNo">098</span> *<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @param pattern The compiled regular expression to match against<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @return - returns an array of HTableDescriptors<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @throws IOException if a remote or network exception occurs<a name="line.101"></a> -<span class="sourceLineNo">102</span> * @see #listTables()<a name="line.102"></a> -<span class="sourceLineNo">103</span> */<a name="line.103"></a> -<span class="sourceLineNo">104</span> HTableDescriptor[] listTables(Pattern pattern) throws IOException;<a name="line.104"></a> -<span class="sourceLineNo">105</span><a name="line.105"></a> -<span class="sourceLineNo">106</span> /**<a name="line.106"></a> -<span class="sourceLineNo">107</span> * List all the userspace tables matching the given regular expression.<a name="line.107"></a> -<span class="sourceLineNo">108</span> *<a name="line.108"></a> -<span class="sourceLineNo">109</span> * @param regex The regular expression to match against<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @return - returns an array of HTableDescriptors<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @throws IOException if a remote or network exception occurs<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @see #listTables(java.util.regex.Pattern)<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> HTableDescriptor[] listTables(String regex) throws IOException;<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> -<span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * List all the tables matching the given pattern.<a name="line.117"></a> -<span class="sourceLineNo">118</span> *<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @param pattern The compiled regular expression to match against<a name="line.119"></a> -<span class="sourceLineNo">120</span> * @param includeSysTables False to match only against userspace tables<a name="line.120"></a> -<span class="sourceLineNo">121</span> * @return - returns an array of HTableDescriptors<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> * @see #listTables()<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> HTableDescriptor[] listTables(Pattern pattern, boolean includeSysTables)<a name="line.125"></a> -<span class="sourceLineNo">126</span> throws IOException;<a name="line.126"></a> -<span class="sourceLineNo">127</span><a name="line.127"></a> -<span class="sourceLineNo">128</span> /**<a name="line.128"></a> -<span class="sourceLineNo">129</span> * List all the tables matching the given pattern.<a name="line.129"></a> -<span class="sourceLineNo">130</span> *<a name="line.130"></a> -<span class="sourceLineNo">131</span> * @param regex The regular expression to match against<a name="line.131"></a> -<span class="sourceLineNo">132</span> * @param includeSysTables False to match only against userspace tables<a name="line.132"></a> -<span class="sourceLineNo">133</span> * @return - returns an array of HTableDescriptors<a name="line.133"></a> -<span class="sourceLineNo">134</span> * @throws IOException if a remote or network exception occurs<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @see #listTables(java.util.regex.Pattern, boolean)<a name="line.135"></a> -<span class="sourceLineNo">136</span> */<a name="line.136"></a> -<span class="sourceLineNo">137</span> HTableDescriptor[] listTables(String regex, boolean includeSysTables)<a name="line.137"></a> -<span class="sourceLineNo">138</span> throws IOException;<a name="line.138"></a> -<span class="sourceLineNo">139</span><a name="line.139"></a> -<span class="sourceLineNo">140</span> /**<a name="line.140"></a> -<span class="sourceLineNo">141</span> * List all of the names of userspace tables.<a name="line.141"></a> -<span class="sourceLineNo">142</span> *<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @return TableName[] table names<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @throws IOException if a remote or network exception occurs<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> TableName[] listTableNames() throws IOException;<a name="line.146"></a> -<span class="sourceLineNo">147</span><a name="line.147"></a> -<span class="sourceLineNo">148</span> /**<a name="line.148"></a> -<span class="sourceLineNo">149</span> * List all of the names of userspace tables.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param pattern The regular expression to match against<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @return TableName[] table names<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @throws IOException if a remote or network exception occurs<a name="line.152"></a> -<span class="sourceLineNo">153</span> */<a name="line.153"></a> -<span class="sourceLineNo">154</span> TableName[] listTableNames(Pattern pattern) throws IOException;<a name="line.154"></a> -<span class="sourceLineNo">155</span><a name="line.155"></a> -<span class="sourceLineNo">156</span> /**<a name="line.156"></a> -<span class="sourceLineNo">157</span> * List all of the names of userspace tables.<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @param regex The regular expression to match against<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @return TableName[] table names<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> */<a name="line.161"></a> -<span class="sourceLineNo">162</span> TableName[] listTableNames(String regex) throws IOException;<a name="line.162"></a> -<span class="sourceLineNo">163</span><a name="line.163"></a> -<span class="sourceLineNo">164</span> /**<a name="line.164"></a> -<span class="sourceLineNo">165</span> * List all of the names of userspace tables.<a name="line.165"></a> -<span class="sourceLineNo">166</span> * @param pattern The regular expression to match against<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @param includeSysTables False to match only against userspace tables<a name="line.167"></a> -<span class="sourceLineNo">168</span> * @return TableName[] table names<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @throws IOException if a remote or network exception occurs<a name="line.169"></a> -<span class="sourceLineNo">170</span> */<a name="line.170"></a> -<span class="sourceLineNo">171</span> TableName[] listTableNames(final Pattern pattern, final boolean includeSysTables)<a name="line.171"></a> -<span class="sourceLineNo">172</span> 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 regex The regular expression to match against<a name="line.176"></a> -<span class="sourceLineNo">177</span> * @param includeSysTables False to match only against userspace tables<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @return TableName[] table names<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @throws IOException if a remote or network exception occurs<a name="line.179"></a> -<span class="sourceLineNo">180</span> */<a name="line.180"></a> -<span class="sourceLineNo">181</span> TableName[] listTableNames(final String regex, final boolean includeSysTables)<a name="line.181"></a> -<span class="sourceLineNo">182</span> throws IOException;<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> * Method for getting the tableDescriptor<a name="line.185"></a> -<span class="sourceLineNo">186</span> *<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @param tableName as a {@link TableName}<a name="line.187"></a> -<span class="sourceLineNo">188</span> * @return the tableDescriptor<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @throws org.apache.hadoop.hbase.TableNotFoundException<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @throws IOException if a remote or network exception occurs<a name="line.190"></a> -<span class="sourceLineNo">191</span> */<a name="line.191"></a> -<span class="sourceLineNo">192</span> HTableDescriptor getTableDescriptor(final TableName tableName)<a name="line.192"></a> -<span class="sourceLineNo">193</span> throws TableNotFoundException, IOException;<a name="line.193"></a> -<span class="sourceLineNo">194</span><a name="line.194"></a> -<span class="sourceLineNo">195</span> /**<a name="line.195"></a> -<span class="sourceLineNo">196</span> * Creates a new table. Synchronous operation.<a name="line.196"></a> -<span class="sourceLineNo">197</span> *<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @param desc table descriptor for table<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.199"></a> -<span class="sourceLineNo">200</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.201"></a> -<span class="sourceLineNo">202</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.202"></a> -<span class="sourceLineNo">203</span> * @throws IOException if a remote or network exception occurs<a name="line.203"></a> -<span class="sourceLineNo">204</span> */<a name="line.204"></a> -<span class="sourceLineNo">205</span> void createTable(HTableDescriptor desc) throws IOException;<a name="line.205"></a> -<span class="sourceLineNo">206</span><a name="line.206"></a> -<span class="sourceLineNo">207</span> /**<a name="line.207"></a> -<span class="sourceLineNo">208</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.208"></a> -<span class="sourceLineNo">209</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.209"></a> -<span class="sourceLineNo">210</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.210"></a> -<span class="sourceLineNo">211</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.211"></a> -<span class="sourceLineNo">212</span> * segments to make the required number of total regions. Synchronous operation.<a name="line.212"></a> -<span class="sourceLineNo">213</span> *<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @param desc table descriptor for table<a name="line.214"></a> -<span class="sourceLineNo">215</span> * @param startKey beginning of key range<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @param endKey end of key range<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param numRegions the total number of regions to create<a name="line.217"></a> -<span class="sourceLineNo">218</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.219"></a> -<span class="sourceLineNo">220</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.220"></a> -<span class="sourceLineNo">221</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.221"></a> -<span class="sourceLineNo">222</span> * @throws IOException<a name="line.222"></a> -<span class="sourceLineNo">223</span> */<a name="line.223"></a> -<span class="sourceLineNo">224</span> void createTable(HTableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)<a name="line.224"></a> -<span class="sourceLineNo">225</span> throws IOException;<a name="line.225"></a> -<span class="sourceLineNo">226</span><a name="line.226"></a> -<span class="sourceLineNo">227</span> /**<a name="line.227"></a> -<span class="sourceLineNo">228</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * The total number of regions created will be the number of split keys plus one. Synchronous<a name="line.229"></a> -<span class="sourceLineNo">230</span> * operation. Note : Avoid passing empty split key.<a name="line.230"></a> -<span class="sourceLineNo">231</span> *<a name="line.231"></a> -<span class="sourceLineNo">232</span> * @param desc table descriptor for table<a name="line.232"></a> -<span class="sourceLineNo">233</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @throws IllegalArgumentException if the table name is reserved, if the split keys are repeated<a name="line.234"></a> -<span class="sourceLineNo">235</span> * and if the split key has empty byte array.<a name="line.235"></a> -<span class="sourceLineNo">236</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.236"></a> -<span class="sourceLineNo">237</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.237"></a> -<span class="sourceLineNo">238</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @throws IOException<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> void createTable(final HTableDescriptor desc, byte[][] splitKeys) throws IOException;<a name="line.241"></a> -<span class="sourceLineNo">242</span><a name="line.242"></a> -<span class="sourceLineNo">243</span> /**<a name="line.243"></a> -<span class="sourceLineNo">244</span> * Creates a new table but does not block and wait for it to come online.<a name="line.244"></a> -<span class="sourceLineNo">245</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.245"></a> -<span class="sourceLineNo">246</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.246"></a> -<span class="sourceLineNo">247</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.247"></a> -<span class="sourceLineNo">248</span> * operation to complete.<a name="line.248"></a> -<span class="sourceLineNo">249</span> * Throws IllegalArgumentException Bad table name, if the split keys<a name="line.249"></a> -<span class="sourceLineNo">250</span> * are repeated and if the split key has empty byte array.<a name="line.250"></a> -<span class="sourceLineNo">251</span> *<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param desc table descriptor for table<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.253"></a> -<span class="sourceLineNo">254</span> * @throws IOException if a remote or network exception occurs<a name="line.254"></a> -<span class="sourceLineNo">255</span> * @return the result of the async creation. You can use Future.get(long, TimeUnit)<a name="line.255"></a> -<span class="sourceLineNo">256</span> * to wait on the operation to complete.<a name="line.256"></a> -<span class="sourceLineNo">257</span> */<a name="line.257"></a> -<span class="sourceLineNo">258</span> Future<Void> createTableAsync(final HTableDescriptor desc, final byte[][] splitKeys)<a name="line.258"></a> -<span class="sourceLineNo">259</span> throws IOException;<a name="line.259"></a> -<span class="sourceLineNo">260</span><a name="line.260"></a> -<span class="sourceLineNo">261</span> /**<a name="line.261"></a> -<span class="sourceLineNo">262</span> * Deletes a table. Synchronous operation.<a name="line.262"></a> -<span class="sourceLineNo">263</span> *<a name="line.263"></a> -<span class="sourceLineNo">264</span> * @param tableName name of table to delete<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @throws IOException if a remote or network exception occurs<a name="line.265"></a> -<span class="sourceLineNo">266</span> */<a name="line.266"></a> -<span class="sourceLineNo">267</span> void deleteTable(final TableName tableName) throws IOException;<a name="line.267"></a> -<span class="sourceLineNo">268</span><a name="line.268"></a> -<span class="sourceLineNo">269</span> /**<a name="line.269"></a> -<span class="sourceLineNo">270</span> * Deletes the table but does not block and wait for it be completely removed.<a name="line.270"></a> -<span class="sourceLineNo">271</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.271"></a> -<span class="sourceLineNo">272</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.272"></a> -<span class="sourceLineNo">273</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.273"></a> -<span class="sourceLineNo">274</span> * operation to complete.<a name="line.274"></a> -<span class="sourceLineNo">275</span> *<a name="line.275"></a> -<span class="sourceLineNo">276</span> * @param tableName name of table to delete<a name="line.276"></a> -<span class="sourceLineNo">277</span> * @throws IOException if a remote or network exception occurs<a name="line.277"></a> -<span class="sourceLineNo">278</span> * @return the result of the async delete. You can use Future.get(long, TimeUnit)<a name="line.278"></a> -<span class="sourceLineNo">279</span> * to wait on the operation to complete.<a name="line.279"></a> -<span class="sourceLineNo">280</span> */<a name="line.280"></a> -<span class="sourceLineNo">281</span> Future<Void> deleteTableAsync(TableName tableName) throws IOException;<a name="line.281"></a> -<span class="sourceLineNo">282</span><a name="line.282"></a> -<span class="sourceLineNo">283</span> /**<a name="line.283"></a> -<span class="sourceLineNo">284</span> * Deletes tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.284"></a> -<span class="sourceLineNo">285</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.285"></a> -<span class="sourceLineNo">286</span> * #listTables(java.lang.String)} and {@link #deleteTable(org.apache.hadoop.hbase.TableName)}<a name="line.286"></a> -<span class="sourceLineNo">287</span> *<a name="line.287"></a> -<span class="sourceLineNo">288</span> * @param regex The regular expression to match table names against<a name="line.288"></a> -<span class="sourceLineNo">289</span> * @return Table descriptors for tables that couldn't be deleted<a name="line.289"></a> -<span class="sourceLineNo">290</span> * @throws IOException<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @see #deleteTables(java.util.regex.Pattern)<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @see #deleteTable(org.apache.hadoop.hbase.TableName)<a name="line.292"></a> -<span class="sourceLineNo">293</span> */<a name="line.293"></a> -<span class="sourceLineNo">294</span> HTableDescriptor[] deleteTables(String regex) throws IOException;<a name="line.294"></a> -<span class="sourceLineNo">295</span><a name="line.295"></a> -<span class="sourceLineNo">296</span> /**<a name="line.296"></a> -<span class="sourceLineNo">297</span> * Delete tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.297"></a> -<span class="sourceLineNo">298</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.298"></a> -<span class="sourceLineNo">299</span> * #listTables(java.util.regex.Pattern) } and<a name="line.299"></a> -<span class="sourceLineNo">300</span> * {@link #deleteTable(org.apache.hadoop.hbase.TableName)}<a name="line.300"></a> -<span class="sourceLineNo">301</span> *<a name="line.301"></a> -<span class="sourceLineNo">302</span> * @param pattern The pattern to match table names against<a name="line.302"></a> -<span class="sourceLineNo">303</span> * @return Table descriptors for tables that couldn't be deleted<a name="line.303"></a> -<span class="sourceLineNo">304</span> * @throws IOException<a name="line.304"></a> -<span class="sourceLineNo">305</span> */<a name="line.305"></a> -<span class="sourceLineNo">306</span> HTableDescriptor[] deleteTables(Pattern pattern) throws IOException;<a name="line.306"></a> -<span class="sourceLineNo">307</span><a name="line.307"></a> -<span class="sourceLineNo">308</span> /**<a name="line.308"></a> -<span class="sourceLineNo">309</span> * Truncate a table.<a name="line.309"></a> -<span class="sourceLineNo">310</span> * Synchronous operation.<a name="line.310"></a> -<span class="sourceLineNo">311</span> *<a name="line.311"></a> -<span class="sourceLineNo">312</span> * @param tableName name of table to truncate<a name="line.312"></a> -<span class="sourceLineNo">313</span> * @param preserveSplits True if the splits should be preserved<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @throws IOException if a remote or network exception occurs<a name="line.314"></a> -<span class="sourceLineNo">315</span> */<a name="line.315"></a> -<span class="sourceLineNo">316</span> public void truncateTable(final TableName tableName, final boolean preserveSplits)<a name="line.316"></a> -<span class="sourceLineNo">317</span> throws IOException;<a name="line.317"></a> -<span class="sourceLineNo">318</span><a name="line.318"></a> -<span class="sourceLineNo">319</span> /**<a name="line.319"></a> -<span class="sourceLineNo">320</span> * Truncate the table but does not block and wait for it be completely enabled. You can use<a name="line.320"></a> -<span class="sourceLineNo">321</span> * Future.get(long, TimeUnit) to wait on the operation to complete. It may throw<a name="line.321"></a> -<span class="sourceLineNo">322</span> * ExecutionException if there was an error while executing the operation or TimeoutException in<a name="line.322"></a> -<span class="sourceLineNo">323</span> * case the wait timeout was not long enough to allow the operation to complete.<a name="line.323"></a> -<span class="sourceLineNo">324</span> * @param tableName name of table to delete<a name="line.324"></a> -<span class="sourceLineNo">325</span> * @param preserveSplits true if the splits should be preserved<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @throws IOException if a remote or network exception occurs<a name="line.326"></a> -<span class="sourceLineNo">327</span> * @return the result of the async truncate. You can use Future.get(long, TimeUnit) to wait on the<a name="line.327"></a> -<span class="sourceLineNo">328</span> * operation to complete.<a name="line.328"></a> -<span class="sourceLineNo">329</span> */<a name="line.329"></a> -<span class="sourceLineNo">330</span> Future<Void> truncateTableAsync(final TableName tableName, final boolean preserveSplits)<a name="line.330"></a> -<span class="sourceLineNo">331</span> throws IOException;<a name="line.331"></a> -<span class="sourceLineNo">332</span><a name="line.332"></a> -<span class="sourceLineNo">333</span> /**<a name="line.333"></a> -<span class="sourceLineNo">334</span> * Enable a table. May timeout. Use {@link #enableTableAsync(org.apache.hadoop.hbase.TableName)}<a name="line.334"></a> -<span class="sourceLineNo">335</span> * and {@link #isTableEnabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in<a name="line.335"></a> -<span class="sourceLineNo">336</span> * disabled state for it to be enabled.<a name="line.336"></a> -<span class="sourceLineNo">337</span> *<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @param tableName name of the table<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @throws IOException if a remote or network exception occurs There could be couple types of<a name="line.339"></a> -<span class="sourceLineNo">340</span> * IOException TableNotFoundException means the table doesn't exist. TableNotDisabledException<a name="line.340"></a> -<span class="sourceLineNo">341</span> * means the table isn't in disabled state.<a name="line.341"></a> -<span class="sourceLineNo">342</span> * @see #isTableEnabled(org.apache.hadoop.hbase.TableName)<a name="line.342"></a> -<span class="sourceLineNo">343</span> * @see #disableTable(org.apache.hadoop.hbase.TableName)<a name="line.343"></a> -<span class="sourceLineNo">344</span> * @see #enableTableAsync(org.apache.hadoop.hbase.TableName)<a name="line.344"></a> -<span class="sourceLineNo">345</span> */<a name="line.345"></a> -<span class="sourceLineNo">346</span> void enableTable(final TableName tableName) throws IOException;<a name="line.346"></a> -<span class="sourceLineNo">347</span><a name="line.347"></a> -<span class="sourceLineNo">348</span> /**<a name="line.348"></a> -<span class="sourceLineNo">349</span> * Enable the table but does not block and wait for it be completely enabled.<a name="line.349"></a> -<span class="sourceLineNo">350</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.350"></a> -<span class="sourceLineNo">351</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.351"></a> -<span class="sourceLineNo">352</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.352"></a> -<span class="sourceLineNo">353</span> * operation to complete.<a name="line.353"></a> -<span class="sourceLineNo">354</span> *<a name="line.354"></a> -<span class="sourceLineNo">355</span> * @param tableName name of table to delete<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @throws IOException if a remote or network exception occurs<a name="line.356"></a> -<span class="sourceLineNo">357</span> * @return the result of the async enable. You can use Future.get(long, TimeUnit)<a name="line.357"></a> -<span class="sourceLineNo">358</span> * to wait on the operation to complete.<a name="line.358"></a> -<span class="sourceLineNo">359</span> */<a name="line.359"></a> -<span class="sourceLineNo">360</span> Future<Void> enableTableAsync(final TableName tableName) throws IOException;<a name="line.360"></a> -<span class="sourceLineNo">361</span><a name="line.361"></a> -<span class="sourceLineNo">362</span> /**<a name="line.362"></a> -<span class="sourceLineNo">363</span> * Enable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.363"></a> -<span class="sourceLineNo">364</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.364"></a> -<span class="sourceLineNo">365</span> * #listTables(java.lang.String)} and {@link #enableTable(org.apache.hadoop.hbase.TableName)}<a name="line.365"></a> -<span class="sourceLineNo">366</span> *<a name="line.366"></a> -<span class="sourceLineNo">367</span> * @param regex The regular expression to match table names against<a name="line.367"></a> -<span class="sourceLineNo">368</span> * @throws IOException<a name="line.368"></a> -<span class="sourceLineNo">369</span> * @see #enableTables(java.util.regex.Pattern)<a name="line.369"></a> -<span class="sourceLineNo">370</span> * @see #enableTable(org.apache.hadoop.hbase.TableName)<a name="line.370"></a> -<span class="sourceLineNo">371</span> */<a name="line.371"></a> -<span class="sourceLineNo">372</span> HTableDescriptor[] enableTables(String regex) throws IOException;<a name="line.372"></a> -<span class="sourceLineNo">373</span><a name="line.373"></a> -<span class="sourceLineNo">374</span> /**<a name="line.374"></a> -<span class="sourceLineNo">375</span> * Enable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.375"></a> -<span class="sourceLineNo">376</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.376"></a> -<span class="sourceLineNo">377</span> * #listTables(java.util.regex.Pattern) } and<a name="line.377"></a> -<span class="sourceLineNo">378</span> * {@link #enableTable(org.apache.hadoop.hbase.TableName)}<a name="line.378"></a> -<span class="sourceLineNo">379</span> *<a name="line.379"></a> -<span class="sourceLineNo">380</span> * @param pattern The pattern to match table names against<a name="line.380"></a> -<span class="sourceLineNo">381</span> * @throws IOException<a name="line.381"></a> -<span class="sourceLineNo">382</span> */<a name="line.382"></a> -<span class="sourceLineNo">383</span> HTableDescriptor[] enableTables(Pattern pattern) throws IOException;<a name="line.383"></a> -<span class="sourceLineNo">384</span><a name="line.384"></a> -<span class="sourceLineNo">385</span> /**<a name="line.385"></a> -<span class="sourceLineNo">386</span> * Disable the table but does not block and wait for it be completely disabled.<a name="line.386"></a> -<span class="sourceLineNo">387</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.387"></a> -<span class="sourceLineNo">388</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.388"></a> -<span class="sourceLineNo">389</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.389"></a> -<span class="sourceLineNo">390</span> * operation to complete.<a name="line.390"></a> -<span class="sourceLineNo">391</span> *<a name="line.391"></a> -<span class="sourceLineNo">392</span> * @param tableName name of table to delete<a name="line.392"></a> -<span class="sourceLineNo">393</span> * @throws IOException if a remote or network exception occurs<a name="line.393"></a> -<span class="sourceLineNo">394</span> * @return the result of the async disable. You can use Future.get(long, TimeUnit)<a name="line.394"></a> -<span class="sourceLineNo">395</span> * to wait on the operation to complete.<a name="line.395"></a> -<span class="sourceLineNo">396</span> */<a name="line.396"></a> -<span class="sourceLineNo">397</span> Future<Void> disableTableAsync(final TableName tableName) throws IOException;<a name="line.397"></a> -<span class="sourceLineNo">398</span><a name="line.398"></a> -<span class="sourceLineNo">399</span> /**<a name="line.399"></a> -<span class="sourceLineNo">400</span> * Disable table and wait on completion. May timeout eventually. Use {@link<a name="line.400"></a> -<span class="sourceLineNo">401</span> * #disableTableAsync(org.apache.hadoop.hbase.TableName)} and<a name="line.401"></a> -<span class="sourceLineNo">402</span> * {@link #isTableDisabled(org.apache.hadoop.hbase.TableName)} instead. The table has to be in<a name="line.402"></a> -<span class="sourceLineNo">403</span> * enabled state for it to be disabled.<a name="line.403"></a> -<span class="sourceLineNo">404</span> *<a name="line.404"></a> -<span class="sourceLineNo">405</span> * @param tableName<a name="line.405"></a> -<span class="sourceLineNo">406</span> * @throws IOException There could be couple types of IOException TableNotFoundException means the<a name="line.406"></a> -<span class="sourceLineNo">407</span> * table doesn't exist. TableNotEnabledException means the table isn't in enabled state.<a name="line.407"></a> -<span class="sourceLineNo">408</span> */<a name="line.408"></a> -<span class="sourceLineNo">409</span> void disableTable(final TableName tableName) throws IOException;<a name="line.409"></a> -<span class="sourceLineNo">410</span><a name="line.410"></a> -<span class="sourceLineNo">411</span> /**<a name="line.411"></a> -<span class="sourceLineNo">412</span> * Disable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.412"></a> -<span class="sourceLineNo">413</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.413"></a> -<span class="sourceLineNo">414</span> * #listTables(java.lang.String)} and {@link #disableTable(org.apache.hadoop.hbase.TableName)}<a name="line.414"></a> -<span class="sourceLineNo">415</span> *<a name="line.415"></a> -<span class="sourceLineNo">416</span> * @param regex The regular expression to match table names against<a name="line.416"></a> -<span class="sourceLineNo">417</span> * @return Table descriptors for tables that couldn't be disabled<a name="line.417"></a> -<span class="sourceLineNo">418</span> * @throws IOException<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @see #disableTables(java.util.regex.Pattern)<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @see #disableTable(org.apache.hadoop.hbase.TableName)<a name="line.420"></a> -<span class="sourceLineNo">421</span> */<a name="line.421"></a> -<span class="sourceLineNo">422</span> HTableDescriptor[] disableTables(String regex) throws IOException;<a name="line.422"></a> -<span class="sourceLineNo">423</span><a name="line.423"></a> -<span class="sourceLineNo">424</span> /**<a name="line.424"></a> -<span class="sourceLineNo">425</span> * Disable tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.425"></a> -<span class="sourceLineNo">426</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.426"></a> -<span class="sourceLineNo">427</span> * #listTables(java.util.regex.Pattern) } and<a name="line.427"></a> -<span class="sourceLineNo">428</span> * {@link #disableTable(org.apache.hadoop.hbase.TableName)}<a name="line.428"></a> -<span class="sourceLineNo">429</span> *<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param pattern The pattern to match table names against<a name="line.430"></a> -<span class="sourceLineNo">431</span> * @return Table descriptors for tables that couldn't be disabled<a name="line.431"></a> -<span class="sourceLineNo">432</span> * @throws IOException<a name="line.432"></a> -<span class="sourceLineNo">433</span> */<a name="line.433"></a> -<span class="sourceLineNo">434</span> HTableDescriptor[] disableTables(Pattern pattern) throws IOException;<a name="line.434"></a> -<span class="sourceLineNo">435</span><a name="line.435"></a> -<span class="sourceLineNo">436</span> /**<a name="line.436"></a> -<span class="sourceLineNo">437</span> * @param tableName name of table to check<a name="line.437"></a> -<span class="sourceLineNo">438</span> * @return true if table is on-line<a name="line.438"></a> -<span class="sourceLineNo">439</span> * @throws IOException if a remote or network exception occurs<a name="line.439"></a> -<span class="sourceLineNo">440</span> */<a name="line.440"></a> -<span class="sourceLineNo">441</span> boolean isTableEnabled(TableName tableName) 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> * @param tableName name of table to check<a name="line.444"></a> -<span class="sourceLineNo">445</span> * @return true if table is off-line<a name="line.445"></a> -<span class="sourceLineNo">446</span> * @throws IOException if a remote or network exception occurs<a name="line.446"></a> -<span class="sourceLineNo">447</span> */<a name="line.447"></a> -<span class="sourceLineNo">448</span> boolean isTableDisabled(TableName tableName) throws IOException;<a name="line.448"></a> -<span class="sourceLineNo">449</span><a name="line.449"></a> -<span class="sourceLineNo">450</span> /**<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @param tableName name of table to check<a name="line.451"></a> -<span class="sourceLineNo">452</span> * @return true if all regions of the table are available<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @throws IOException if a remote or network exception occurs<a name="line.453"></a> -<span class="sourceLineNo">454</span> */<a name="line.454"></a> -<span class="sourceLineNo">455</span> boolean isTableAvailable(TableName tableName) throws IOException;<a name="line.455"></a> -<span class="sourceLineNo">456</span><a name="line.456"></a> -<span class="sourceLineNo">457</span> /**<a name="line.457"></a> -<span class="sourceLineNo">458</span> * Use this api to check if the table has been created with the specified number of splitkeys<a name="line.458"></a> -<span class="sourceLineNo">459</span> * which was used while creating the given table. Note : If this api is used after a table's<a name="line.459"></a> -<span class="sourceLineNo">460</span> * region gets splitted, the api may return false.<a name="line.460"></a> -<span class="sourceLineNo">461</span> *<a name="line.461"></a> -<span class="sourceLineNo">462</span> * @param tableName name of table to check<a name="line.462"></a> -<span class="sourceLineNo">463</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.463"></a> -<span class="sourceLineNo">464</span> * @throws IOException if a remote or network excpetion occurs<a name="line.464"></a> -<span class="sourceLineNo">465</span> */<a name="line.465"></a> -<span class="sourceLineNo">466</span> boolean isTableAvailable(TableName tableName, byte[][] splitKeys) throws IOException;<a name="line.466"></a> -<span class="sourceLineNo">467</span><a name="line.467"></a> -<span class="sourceLineNo">468</span> /**<a name="line.468"></a> -<span class="sourceLineNo">469</span> * Get the status of alter command - indicates how many regions have received the updated schema<a name="line.469"></a> -<span class="sourceLineNo">470</span> * Asynchronous operation.<a name="line.470"></a> -<span class="sourceLineNo">471</span> *<a name="line.471"></a> -<span class="sourceLineNo">472</span> * @param tableName TableName instance<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @return Pair indicating the number of regions updated Pair.getFirst() is the regions that are<a name="line.473"></a> -<span class="sourceLineNo">474</span> * yet to be updated Pair.getSecond() is the total number of regions of the table<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @throws IOException if a remote or network exception occurs<a name="line.475"></a> -<span class="sourceLineNo">476</span> */<a name="line.476"></a> -<span class="sourceLineNo">477</span> Pair<Integer, Integer> getAlterStatus(final TableName tableName) throws IOException;<a name="line.477"></a> -<span class="sourceLineNo">478</span><a name="line.478"></a> -<span class="sourceLineNo">479</span> /**<a name="line.479"></a> -<span class="sourceLineNo">480</span> * Get the status of alter command - indicates how many regions have received the updated schema<a name="line.480"></a> -<span class="sourceLineNo">481</span> * Asynchronous operation.<a name="line.481"></a> -<span class="sourceLineNo">482</span> *<a name="line.482"></a> -<span class="sourceLineNo">483</span> * @param tableName name of the table to get the status of<a name="line.483"></a> -<span class="sourceLineNo">484</span> * @return Pair indicating the number of regions updated Pair.getFirst() is the regions that are<a name="line.484"></a> -<span class="sourceLineNo">485</span> * yet to be updated Pair.getSecond() is the total number of regions of the table<a name="line.485"></a> -<span class="sourceLineNo">486</span> * @throws IOException if a remote or network exception occurs<a name="line.486"></a> -<span class="sourceLineNo">487</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #getAlterStatus(TableName)}<a name="line.487"></a> -<span class="sourceLineNo">488</span> * instead.<a name="line.488"></a> -<span class="sourceLineNo">489</span> */<a name="line.489"></a> -<span class="sourceLineNo">490</span> @Deprecated<a name="line.490"></a> -<span class="sourceLineNo">491</span> Pair<Integer, Integer> getAlterStatus(final byte[] tableName) throws IOException;<a name="line.491"></a> -<span class="sourceLineNo">492</span><a name="line.492"></a> -<span class="sourceLineNo">493</span> /**<a name="line.493"></a> -<span class="sourceLineNo">494</span> * Add a column family to an existing table. Asynchronous operation.<a name="line.494"></a> -<span class="sourceLineNo">495</span> *<a name="line.495"></a> -<span class="sourceLineNo">496</span> * @param tableName name of the table to add column family to<a name="line.496"></a> -<span class="sourceLineNo">497</span> * @param columnFamily column family descriptor of column family to be added<a name="line.497"></a> -<span class="sourceLineNo">498</span> * @throws IOException if a remote or network exception occurs<a name="line.498"></a> -<span class="sourceLineNo">499</span> * @deprecated As of release 2.0.0.<a name="line.499"></a> -<span class="sourceLineNo">500</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-1989">HBASE-1989</a>).<a name="line.500"></a> -<span class="sourceLineNo">501</span> * This will be removed in HBase 3.0.0.<a name="line.501"></a> -<span class="sourceLineNo">502</span> * Use {@link #addColumnFamily(TableName, HColumnDescriptor)}.<a name="line.502"></a> -<span class="sourceLineNo">503</span> */<a name="line.503"></a> -<span class="sourceLineNo">504</span> @Deprecated<a name="line.504"></a> -<span class="sourceLineNo">505</span> void addColumn(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.505"></a> -<span class="sourceLineNo">506</span> throws IOException;<a name="line.506"></a> -<span class="sourceLineNo">507</span><a name="line.507"></a> -<span class="sourceLineNo">508</span> /**<a name="line.508"></a> -<span class="sourceLineNo">509</span> * Add a column family to an existing table.<a name="line.509"></a> -<span class="sourceLineNo">510</span> *<a name="line.510"></a> -<span class="sourceLineNo">511</span> * @param tableName name of the table to add column family to<a name="line.511"></a> -<span class="sourceLineNo">512</span> * @param columnFamily column family descriptor of column family to be added<a name="line.512"></a> -<span class="sourceLineNo">513</span> * @throws IOException if a remote or network exception occurs<a name="line.513"></a> -<span class="sourceLineNo">514</span> */<a name="line.514"></a> -<span class="sourceLineNo">515</span> void addColumnFamily(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.515"></a> -<span class="sourceLineNo">516</span> 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> * Add a column family to an existing table. Asynchronous operation.<a name="line.519"></a> -<span class="sourceLineNo">520</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.520"></a> -<span class="sourceLineNo">521</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.521"></a> -<span class="sourceLineNo">522</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.522"></a> -<span class="sourceLineNo">523</span> * operation to complete.<a name="line.523"></a> -<span class="sourceLineNo">524</span> *<a name="line.524"></a> -<span class="sourceLineNo">525</span> * @param tableName name of the table to add column family to<a name="line.525"></a> -<span class="sourceLineNo">526</span> * @param columnFamily column family descriptor of column family to be added<a name="line.526"></a> -<span class="sourceLineNo">527</span> * @throws IOException if a remote or network exception occurs<a name="line.527"></a> -<span class="sourceLineNo">528</span> * @return the result of the async add column family. You can use Future.get(long, TimeUnit) to<a name="line.528"></a> -<span class="sourceLineNo">529</span> * wait on the operation to complete.<a name="line.529"></a> -<span class="sourceLineNo">530</span> */<a name="line.530"></a> -<span class="sourceLineNo">531</span> Future<Void> addColumnFamilyAsync(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.531"></a> -<span class="sourceLineNo">532</span> throws IOException;<a name="line.532"></a> -<span class="sourceLineNo">533</span><a name="line.533"></a> -<span class="sourceLineNo">534</span> /**<a name="line.534"></a> -<span class="sourceLineNo">535</span> * Delete a column family from a table. Asynchronous operation.<a name="line.535"></a> -<span class="sourceLineNo">536</span> *<a name="line.536"></a> -<span class="sourceLineNo">537</span> * @param tableName name of table<a name="line.537"></a> -<span class="sourceLineNo">538</span> * @param columnFamily name of column family to be deleted<a name="line.538"></a> -<span class="sourceLineNo">539</span> * @throws IOException if a remote or network exception occurs<a name="line.539"></a> -<span class="sourceLineNo">540</span> * @deprecated As of release 2.0.0.<a name="line.540"></a> -<span class="sourceLineNo">541</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-1989">HBASE-1989</a>).<a name="line.541"></a> -<span class="sourceLineNo">542</span> * This will be removed in HBase 3.0.0.<a name="line.542"></a> -<span class="sourceLineNo">543</span> * Use {@link #deleteColumnFamily(TableName, byte[])}}.<a name="line.543"></a> -<span class="sourceLineNo">544</span> */<a name="line.544"></a> -<span class="sourceLineNo">545</span> @Deprecated<a name="line.545"></a> -<span class="sourceLineNo">546</span> void deleteColumn(final TableName tableName, final byte[] columnFamily) throws IOException;<a name="line.546"></a> -<span class="sourceLineNo">547</span><a name="line.547"></a> -<span class="sourceLineNo">548</span> /**<a name="line.548"></a> -<span class="sourceLineNo">549</span> * Delete a column family from a table. Asynchronous operation.<a name="line.549"></a> -<span class="sourceLineNo">550</span> *<a name="line.550"></a> -<span class="sourceLineNo">551</span> * @param tableName name of table<a name="line.551"></a> -<span class="sourceLineNo">552</span> * @param columnFamily name of column family to be deleted<a name="line.552"></a> -<span class="sourceLineNo">553</span> * @throws IOException if a remote or network exception occurs<a name="line.553"></a> -<span class="sourceLineNo">554</span> */<a name="line.554"></a> -<span class="sourceLineNo">555</span> void deleteColumnFamily(final TableName tableName, final byte[] columnFamily) throws IOException;<a name="line.555"></a> -<span class="sourceLineNo">556</span><a name="line.556"></a> -<span class="sourceLineNo">557</span> /**<a name="line.557"></a> -<span class="sourceLineNo">558</span> * Delete a column family from a table. Asynchronous operation.<a name="line.558"></a> -<span class="sourceLineNo">559</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.559"></a> -<span class="sourceLineNo">560</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.560"></a> -<span class="sourceLineNo">561</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.561"></a> -<span class="sourceLineNo">562</span> * operation to complete.<a name="line.562"></a> -<span class="sourceLineNo">563</span> *<a name="line.563"></a> -<span class="sourceLineNo">564</span> * @param tableName name of table<a name="line.564"></a> -<span class="sourceLineNo">565</span> * @param columnFamily name of column family to be deleted<a name="line.565"></a> -<span class="sourceLineNo">566</span> * @throws IOException if a remote or network exception occurs<a name="line.566"></a> -<span class="sourceLineNo">567</span> * @return the result of the async delete column family. You can use Future.get(long, TimeUnit) to<a name="line.567"></a> -<span class="sourceLineNo">568</span> * wait on the operation to complete.<a name="line.568"></a> -<span class="sourceLineNo">569</span> */<a name="line.569"></a> -<span class="sourceLineNo">570</span> Future<Void> deleteColumnFamilyAsync(final TableName tableName, final byte[] columnFamily)<a name="line.570"></a> -<span class="sourceLineNo">571</span> throws IOException;<a name="line.571"></a> -<span class="sourceLineNo">572</span><a name="line.572"></a> -<span class="sourceLineNo">573</span> /**<a name="line.573"></a> -<span class="sourceLineNo">574</span> * Modify an existing column family on a table.<a name="line.574"></a> -<span class="sourceLineNo">575</span> *<a name="line.575"></a> -<span class="sourceLineNo">576</span> * @param tableName name of table<a name="line.576"></a> -<span class="sourceLineNo">577</span> * @param columnFamily new column family descriptor to use<a name="line.577"></a> -<span class="sourceLineNo">578</span> * @throws IOException if a remote or network exception occurs<a name="line.578"></a> -<span class="sourceLineNo">579</span> * @deprecated As of release 2.0.0.<a name="line.579"></a> -<span class="sourceLineNo">580</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-1989">HBASE-1989</a>).<a name="line.580"></a> -<span class="sourceLineNo">581</span> * This will be removed in HBase 3.0.0.<a name="line.581"></a> -<span class="sourceLineNo">582</span> * Use {@link #modifyColumnFamily(TableName, HColumnDescriptor)}.<a name="line.582"></a> -<span class="sourceLineNo">583</span> */<a name="line.583"></a> -<span class="sourceLineNo">584</span> @Deprecated<a name="line.584"></a> -<span class="sourceLineNo">585</span> void modifyColumn(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.585"></a> -<span class="sourceLineNo">586</span> throws IOException;<a name="line.586"></a> -<span class="sourceLineNo">587</span><a name="line.587"></a> -<span class="sourceLineNo">588</span> /**<a name="line.588"></a> -<span class="sourceLineNo">589</span> * Modify an existing column family on a table.<a name="line.589"></a> -<span class="sourceLineNo">590</span> *<a name="line.590"></a> -<span class="sourceLineNo">591</span> * @param tableName name of table<a name="line.591"></a> -<span class="sourceLineNo">592</span> * @param columnFamily new column family descriptor to use<a name="line.592"></a> -<span class="sourceLineNo">593</span> * @throws IOException if a remote or network exception occurs<a name="line.593"></a> -<span class="sourceLineNo">594</span> */<a name="line.594"></a> -<span class="sourceLineNo">595</span> void modifyColumnFamily(final TableName tableName, final HColumnDescriptor columnFamily)<a name="line.595"></a> -<span class="sourceLineNo">596</span> throws IOException;<a name="line.596"></a> -<span class="sourceLineNo">597</span><a name="line.597"></a> -<span class="sourceLineNo">598</span> /**<a name="line.598"></a> -<span class="sourceLineNo">599</span> * Modify an existing column family on a table. Asynchronous operation.<a name="line.599"></a> -<span class="sourceLineNo">600</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.600"></a> -<span class="sourceLineNo">601</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.601"></a> -<span class="sourceLineNo">602</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.602"></a> -<span class="sourceLineNo">603</span> * operation to complete.<a name="line.603"></a> -<span class="sourceLineNo">604</span> *<a name="line.604"></a> -<span class="sourceLineNo">605</span> * @param tableName name of table<a name="line.605"></a> -<span class="sourceLineNo">606</span> * @param columnFamily new column family descriptor to use<a name="line.606"></a> -<span class="sourceLineNo">607</span> * @throws IOException if a remote or network exception occurs<a name="line.607"></a> -<span class="sourceLineNo">608</span> * @return the result of the async modify column family. You can use Future.get(long, TimeUnit) to<a name="line.608"></a> -<span class="sourceLineNo">609</span> * wait on the operation to complete.<a name="line.609"></a> -<span class="sourceLineNo">610</span> */<a name="line.610"></a> -<span class="sourceLineNo">611</span> Future<Void> modifyColumnFamilyAsync(TableName tableName, HColumnDescriptor columnFamily)<a name="line.611"></a> -<span class="sourceLineNo">612</span> throws IOException;<a name="line.612"></a> -<span class="sourceLineNo">613</span><a name="line.613"></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.ServerName;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.TableExistsException;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.TableName;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.TableNotFoundException;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.42"></a> +<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.43"></a> +<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel;<a name="line.44"></a> +<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.quotas.QuotaFilter;<a name="line.45"></a> +<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.quotas.QuotaRetriever;<a name="line.46"></a> +<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.quotas.QuotaSettings;<a name="line.47"></a> +<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException;<a name="line.48"></a> +<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.snapshot.HBaseSnapshotException;<a name="line.49"></a> +<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.snapshot.RestoreSnapshotException;<a name="line.50"></a> +<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.snapshot.SnapshotCreationException;<a name="line.51"></a> +<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.snapshot.UnknownSnapshotException;<a name="line.52"></a> +<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.53"></a> +<span class="sourceLineNo">054</span><a name="line.54"></a> +<span class="sourceLineNo">055</span>/**<a name="line.55"></a> +<span class="sourceLineNo">056</span> * The administrative API for HBase. Obtain an instance from an {@link Connection#getAdmin()} and<a name="line.56"></a> +<span class="sourceLineNo">057</span> * call {@link #close()} afterwards.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <p>Admin can be used to create, drop, list, enable and disable tables, add and drop table<a name="line.58"></a> +<span class="sourceLineNo">059</span> * column families and other administrative operations.<a name="line.59"></a> +<span class="sourceLineNo">060</span> *<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @see ConnectionFactory<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @see Connection<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @see Table<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @since 0.99.0<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span>@InterfaceAudience.Public<a name="line.66"></a> +<span class="sourceLineNo">067</span>@InterfaceStability.Evolving<a name="line.67"></a> +<span class="sourceLineNo">068</span>public interface Admin extends Abortable, Closeable {<a name="line.68"></a> +<span class="sourceLineNo">069</span> int getOperationTimeout();<a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> @Override<a name="line.71"></a> +<span class="sourceLineNo">072</span> void abort(String why, Throwable e);<a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> @Override<a name="line.74"></a> +<span class="sourceLineNo">075</span> boolean isAborted();<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> /**<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @return Connection used by this object.<a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span> Connection getConnection();<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span> /**<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @param tableName Table to check.<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @return True if table exists already.<a name="line.84"></a> +<span class="sourceLineNo">085</span> * @throws IOException<a name="line.85"></a> +<span class="sourceLineNo">086</span> */<a name="line.86"></a> +<span class="sourceLineNo">087</span> boolean tableExists(final TableName tableName) throws IOException;<a name="line.87"></a> +<span class="sourceLineNo">088</span><a name="line.88"></a> +<span class="sourceLineNo">089</span> /**<a name="line.89"></a> +<span class="sourceLineNo">090</span> * List all the userspace tables.<a name="line.90"></a> +<span class="sourceLineNo">091</span> *<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @return - returns an array of HTableDescriptors<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @throws IOException if a remote or network exception occurs<a name="line.93"></a> +<span class="sourceLineNo">094</span> */<a name="line.94"></a> +<span class="sourceLineNo">095</span> HTableDescriptor[] listTables() throws IOException;<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> /**<a name="line.97"></a> +<span class="sourceLineNo">098</span> * List all the userspace tables matching the given pattern.<a name="line.98"></a> +<span class="sourceLineNo">099</span> *<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @param pattern The compiled regular expression to match against<a name="line.100"></a> +<span class="sourceLineNo">101</span> * @return - returns an array of HTableDescriptors<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @throws IOException if a remote or network exception occurs<a name="line.102"></a> +<span class="sourceLineNo">103</span> * @see #listTables()<a name="line.103"></a> +<span class="sourceLineNo">104</span> */<a name="line.104"></a> +<span class="sourceLineNo">105</span> HTableDescriptor[] listTables(Pattern pattern) throws IOException;<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> /**<a name="line.107"></a> +<span class="sourceLineNo">108</span> * List all the userspace tables matching the given regular expression.<a name="line.108"></a> +<span class="sourceLineNo">109</span> *<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @param regex The regular expression to match against<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @return - returns an array of HTableDescriptors<a name="line.111"></a> +<span class="sourceLineNo">112</span> * @throws IOException if a remote or network exception occurs<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @see #listTables(java.util.regex.Pattern)<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> HTableDescriptor[] listTables(String regex) throws IOException;<a name="line.115"></a> +<span class="sourceLineNo">116</span><a name="line.116"></a> +<span class="sourceLineNo">117</span> /**<a name="line.117"></a> +<span class="sourceLineNo">118</span> * List all the tables matching the given pattern.<a name="line.118"></a> +<span class="sourceLineNo">119</span> *<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param pattern The compiled regular expression to match against<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @param includeSysTables False to match only against userspace tables<a name="line.121"></a> +<span class="sourceLineNo">122</span> * @return - returns an array of HTableDescriptors<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @throws IOException if a remote or network exception occurs<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @see #listTables()<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> HTableDescriptor[] listTables(Pattern pattern, boolean includeSysTables)<a name="line.126"></a> +<span class="sourceLineNo">127</span> throws IOException;<a name="line.127"></a> +<span class="sourceLineNo">128</span><a name="line.128"></a> +<span class="sourceLineNo">129</span> /**<a name="line.129"></a> +<span class="sourceLineNo">130</span> * List all the tables matching the given pattern.<a name="line.130"></a> +<span class="sourceLineNo">131</span> *<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @param regex The regular expression to match against<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @param includeSysTables False to match only against userspace tables<a name="line.133"></a> +<span class="sourceLineNo">134</span> * @return - returns an array of HTableDescriptors<a name="line.134"></a> +<span class="sourceLineNo">135</span> * @throws IOException if a remote or network exception occurs<a name="line.135"></a> +<span class="sourceLineNo">136</span> * @see #listTables(java.util.regex.Pattern, boolean)<a name="line.136"></a> +<span class="sourceLineNo">137</span> */<a name="line.137"></a> +<span class="sourceLineNo">138</span> HTableDescriptor[] listTables(String regex, boolean includeSysTables)<a name="line.138"></a> +<span class="sourceLineNo">139</span> throws IOException;<a name="line.139"></a> +<span class="sourceLineNo">140</span><a name="line.140"></a> +<span class="sourceLineNo">141</span> /**<a name="line.141"></a> +<span class="sourceLineNo">142</span> * List all of the names of userspace tables.<a name="line.142"></a> +<span class="sourceLineNo">143</span> *<a name="line.143"></a> +<span class="sourceLineNo">144</span> * @return TableName[] table names<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @throws IOException if a remote or network exception occurs<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> TableName[] listTableNames() throws IOException;<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span> /**<a name="line.149"></a> +<span class="sourceLineNo">150</span> * List all of the names of userspace tables.<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @param pattern The regular expression to match against<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @return TableName[] table names<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @throws IOException if a remote or network exception occurs<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> TableName[] listTableNames(Pattern pattern) throws IOException;<a name="line.155"></a> +<span class="sourceLineNo">156</span><a name="line.156"></a> +<span class="sourceLineNo">157</span> /**<a name="line.157"></a> +<span class="sourceLineNo">158</span> * List all of the names of userspace tables.<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @param regex The regular expression to match against<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @return TableName[] table names<a name="line.160"></a> +<span class="sourceLineNo">161</span> * @throws IOException if a remote or network exception occurs<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> TableName[] listTableNames(String regex) throws IOException;<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * List all of the names of userspace tables.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @param pattern The regular expression to match against<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param includeSysTables False to match only against userspace tables<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(final Pattern pattern, final boolean includeSysTables)<a name="line.172"></a> +<span class="sourceLineNo">173</span> throws IOException;<a name="line.173"></a> +<span class="sourceLineNo">174</span><a name="line.174"></a> +<span class="sourceLineNo">175</span> /**<a name="line.175"></a> +<span class="sourceLineNo">176</span> * List all of the names of userspace tables.<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @param regex The regular expression to match against<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @param includeSysTables False to match only against userspace tables<a name="line.178"></a> +<span class="sourceLineNo">179</span> * @return TableName[] table names<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @throws IOException if a remote or network exception occurs<a name="line.180"></a> +<span class="sourceLineNo">181</span> */<a name="line.181"></a> +<span class="sourceLineNo">182</span> TableName[] listTableNames(final String regex, final boolean includeSysTables)<a name="line.182"></a> +<span class="sourceLineNo">183</span> throws IOException;<a name="line.183"></a> +<span class="sourceLineNo">184</span><a name="line.184"></a> +<span class="sourceLineNo">185</span> /**<a name="line.185"></a> +<span class="sourceLineNo">186</span> * Method for getting the tableDescriptor<a name="line.186"></a> +<span class="sourceLineNo">187</span> *<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param tableName as a {@link TableName}<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @return the tableDescriptor<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @throws org.apache.hadoop.hbase.TableNotFoundException<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @throws IOException if a remote or network exception occurs<a name="line.191"></a> +<span class="sourceLineNo">192</span> */<a name="line.192"></a> +<span class="sourceLineNo">193</span> HTableDescriptor getTableDescriptor(final TableName tableName)<a name="line.193"></a> +<span class="sourceLineNo">194</span> throws TableNotFoundException, IOException;<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * Creates a new table. Synchronous operation.<a name="line.197"></a> +<span class="sourceLineNo">198</span> *<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param desc table descriptor for table<a name="line.199"></a> +<span class="sourceLineNo">200</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.200"></a> +<span class="sourceLineNo">201</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.201"></a> +<span class="sourceLineNo">202</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.202"></a> +<span class="sourceLineNo">203</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.203"></a> +<span class="sourceLineNo">204</span> * @throws IOException if a remote or network exception occurs<a name="line.204"></a> +<span class="sourceLineNo">205</span> */<a name="line.205"></a> +<span class="sourceLineNo">206</span> void createTable(HTableDescriptor desc) throws IOException;<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> /**<a name="line.208"></a> +<span class="sourceLineNo">209</span> * Creates a new table with the specified number of regions. The start key specified will become<a name="line.209"></a> +<span class="sourceLineNo">210</span> * the end key of the first region of the table, and the end key specified will become the start<a name="line.210"></a> +<span class="sourceLineNo">211</span> * key of the last region of the table (the first region has a null start key and the last region<a name="line.211"></a> +<span class="sourceLineNo">212</span> * has a null end key). BigInteger math will be used to divide the key range specified into enough<a name="line.212"></a> +<span class="sourceLineNo">213</span> * segments to make the required number of total regions. Synchronous operation.<a name="line.213"></a> +<span class="sourceLineNo">214</span> *<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param desc table descriptor for table<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @param startKey beginning of key range<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @param endKey end of key range<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @param numRegions the total number of regions to create<a name="line.218"></a> +<span class="sourceLineNo">219</span> * @throws IllegalArgumentException if the table name is reserved<a name="line.219"></a> +<span class="sourceLineNo">220</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.220"></a> +<span class="sourceLineNo">221</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.221"></a> +<span class="sourceLineNo">222</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @throws IOException<a name="line.223"></a> +<span class="sourceLineNo">224</span> */<a name="line.224"></a> +<span class="sourceLineNo">225</span> void createTable(HTableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)<a name="line.225"></a> +<span class="sourceLineNo">226</span> throws IOException;<a name="line.226"></a> +<span class="sourceLineNo">227</span><a name="line.227"></a> +<span class="sourceLineNo">228</span> /**<a name="line.228"></a> +<span class="sourceLineNo">229</span> * Creates a new table with an initial set of empty regions defined by the specified split keys.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * The total number of regions created will be the number of split keys plus one. Synchronous<a name="line.230"></a> +<span class="sourceLineNo">231</span> * operation. Note : Avoid passing empty split key.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param desc table descriptor for table<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @param splitKeys array of split keys for the initial regions of the table<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @throws IllegalArgumentException if the table name is reserved, if the split keys are repeated<a name="line.235"></a> +<span class="sourceLineNo">236</span> * and if the split key has empty byte array.<a name="line.236"></a> +<span class="sourceLineNo">237</span> * @throws org.apache.hadoop.hbase.MasterNotRunningException if master is not running<a name="line.237"></a> +<span class="sourceLineNo">238</span> * @throws org.apache.hadoop.hbase.TableExistsException if table already exists (If concurrent<a name="line.238"></a> +<span class="sourceLineNo">239</span> * threads, the table may have been created between test-for-existence and attempt-at-creation).<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @throws IOException<a name="line.240"></a> +<span class="sourceLineNo">241</span> */<a name="line.241"></a> +<span class="sourceLineNo">242</span> void createTable(final HTableDescriptor desc, byte[][] splitKeys) throws IOException;<a name="line.242"></a> +<span class="sourceLineNo">243</span><a name="line.243"></a> +<span class="sourceLineNo">244</span> /**<a name="line.244"></a> +<span class="sourceLineNo">245</span> * Creates a new table but does not block and wait for it to come online.<a name="line.245"></a> +<span class="sourceLineNo">246</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.246"></a> +<span class="sourceLineNo">247</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.247"></a> +<span class="sourceLineNo">248</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.248"></a> +<span class="sourceLineNo">249</span> * operation to complete.<a name="line.249"></a> +<span class="sourceLineNo">250</span> * Throws IllegalArgumentException Bad table name, if the split keys<a name="line.250"></a> +<span class="sourceLineNo">251</span> * are repeated and if the split key has empty byte array.<a name="line.251"></a> +<span class="sourceLineNo">252</span> *<a name="line.252"></a> +<span class="sourceLineNo">253</span> * @param desc table descriptor for table<a name="line.253"></a> +<span class="sourceLineNo">254</span> * @param splitKeys keys to check if the table has been created with all split keys<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @throws IOException if a remote or network exception occurs<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @return the result of the async creation. You can use Future.get(long, TimeUnit)<a name="line.256"></a> +<span class="sourceLineNo">257</span> * to wait on the operation to complete.<a name="line.257"></a> +<span class="sourceLineNo">258</span> */<a name="line.258"></a> +<span class="sourceLineNo">259</span> Future<Void> createTableAsync(final HTableDescriptor desc, final byte[][] splitKeys)<a name="line.259"></a> +<span class="sourceLineNo">260</span> throws IOException;<a name="line.260"></a> +<span class="sourceLineNo">261</span><a name="line.261"></a> +<span class="sourceLineNo">262</span> /**<a name="line.262"></a> +<span class="sourceLineNo">263</span> * Deletes a table. Synchronous operation.<a name="line.263"></a> +<span class="sourceLineNo">264</span> *<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @param tableName name of table to delete<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> */<a name="line.267"></a> +<span class="sourceLineNo">268</span> void deleteTable(final TableName tableName) throws IOException;<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * Deletes the table but does not block and wait for it be completely removed.<a name="line.271"></a> +<span class="sourceLineNo">272</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.272"></a> +<span class="sourceLineNo">273</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.273"></a> +<span class="sourceLineNo">274</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.274"></a> +<span class="sourceLineNo">275</span> * operation to complete.<a name="line.275"></a> +<span class="sourceLineNo">276</span> *<a name="line.276"></a> +<span class="sourceLineNo">277</span> * @param tableName name of table to delete<a name="line.277"></a> +<span class="sourceLineNo">278</span> * @throws IOException if a remote or network exception occurs<a name="line.278"></a> +<span class="sourceLineNo">279</span> * @return the result of the async delete. You can use Future.get(long, TimeUnit)<a name="line.279"></a> +<span class="sourceLineNo">280</span> * to wait on the operation to complete.<a name="line.280"></a> +<span class="sourceLineNo">281</span> */<a name="line.281"></a> +<span class="sourceLineNo">282</span> Future<Void> deleteTableAsync(TableName tableName) throws IOException;<a name="line.282"></a> +<span class="sourceLineNo">283</span><a name="line.283"></a> +<span class="sourceLineNo">284</span> /**<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Deletes tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.285"></a> +<span class="sourceLineNo">286</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.286"></a> +<span class="sourceLineNo">287</span> * #listTables(java.lang.String)} and {@link #deleteTable(org.apache.hadoop.hbase.TableName)}<a name="line.287"></a> +<span class="sourceLineNo">288</span> *<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @param regex The regular expression to match table names against<a name="line.289"></a> +<span class="sourceLineNo">290</span> * @return Table descriptors for tables that couldn't be deleted<a name="line.290"></a> +<span class="sourceLineNo">291</span> * @throws IOException<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @see #deleteTables(java.util.regex.Pattern)<a name="line.292"></a> +<span class="sourceLineNo">293</span> * @see #deleteTable(org.apache.hadoop.hbase.TableName)<a name="line.293"></a> +<span class="sourceLineNo">294</span> */<a name="line.294"></a> +<span class="sourceLineNo">295</span> HTableDescriptor[] deleteTables(String regex) throws IOException;<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> * Delete tables matching the passed in pattern and wait on completion. Warning: Use this method<a name="line.298"></a> +<span class="sourceLineNo">299</span> * carefully, there is no prompting and the effect is immediate. Consider using {@link<a name="line.299"></a> +<span class="sourceLineNo">300</span> * #listTables(java.util.regex.Pattern) } and<a name="line.300"></a> +<span class="sourceLineNo">301</span> * {@link #deleteTable(org.apache.hadoop.hbase.TableName)}<a name="line.301"></a> +<span class="sourceLineNo">302</span> *<a name="line.302"></a> +<spa
<TRUNCATED>
