http://git-wip-us.apache.org/repos/asf/hbase-site/blob/17128d27/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html index 2fdac6a..def5ec9 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/Admin.html @@ -1192,686 +1192,686 @@ <span class="sourceLineNo">1184</span> *<a name="line.1184"></a> <span class="sourceLineNo">1185</span> * @param regionName region to split<a name="line.1185"></a> <span class="sourceLineNo">1186</span> * @throws IOException if a remote or network exception occurs<a name="line.1186"></a> -<span class="sourceLineNo">1187</span> */<a name="line.1187"></a> -<span class="sourceLineNo">1188</span> void splitRegion(final byte[] regionName) throws IOException;<a name="line.1188"></a> -<span class="sourceLineNo">1189</span><a name="line.1189"></a> -<span class="sourceLineNo">1190</span> /**<a name="line.1190"></a> -<span class="sourceLineNo">1191</span> * Split a table. Asynchronous operation.<a name="line.1191"></a> -<span class="sourceLineNo">1192</span> *<a name="line.1192"></a> -<span class="sourceLineNo">1193</span> * @param tableName table to split<a name="line.1193"></a> -<span class="sourceLineNo">1194</span> * @param splitPoint the explicit position to split on<a name="line.1194"></a> -<span class="sourceLineNo">1195</span> * @throws IOException if a remote or network exception occurs<a name="line.1195"></a> -<span class="sourceLineNo">1196</span> */<a name="line.1196"></a> -<span class="sourceLineNo">1197</span> void split(final TableName tableName, final byte[] splitPoint)<a name="line.1197"></a> -<span class="sourceLineNo">1198</span> throws IOException;<a name="line.1198"></a> -<span class="sourceLineNo">1199</span><a name="line.1199"></a> -<span class="sourceLineNo">1200</span> /**<a name="line.1200"></a> -<span class="sourceLineNo">1201</span> * Split an individual region. Asynchronous operation.<a name="line.1201"></a> -<span class="sourceLineNo">1202</span> *<a name="line.1202"></a> -<span class="sourceLineNo">1203</span> * @param regionName region to split<a name="line.1203"></a> -<span class="sourceLineNo">1204</span> * @param splitPoint the explicit position to split on<a name="line.1204"></a> -<span class="sourceLineNo">1205</span> * @throws IOException if a remote or network exception occurs<a name="line.1205"></a> -<span class="sourceLineNo">1206</span> */<a name="line.1206"></a> -<span class="sourceLineNo">1207</span> void splitRegion(final byte[] regionName, final byte[] splitPoint)<a name="line.1207"></a> -<span class="sourceLineNo">1208</span> throws IOException;<a name="line.1208"></a> -<span class="sourceLineNo">1209</span><a name="line.1209"></a> -<span class="sourceLineNo">1210</span> /**<a name="line.1210"></a> -<span class="sourceLineNo">1211</span> * Modify an existing table, more IRB friendly version.<a name="line.1211"></a> -<span class="sourceLineNo">1212</span> *<a name="line.1212"></a> -<span class="sourceLineNo">1213</span> * @param tableName name of table.<a name="line.1213"></a> -<span class="sourceLineNo">1214</span> * @param htd modified description of the table<a name="line.1214"></a> -<span class="sourceLineNo">1215</span> * @throws IOException if a remote or network exception occurs<a name="line.1215"></a> -<span class="sourceLineNo">1216</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1216"></a> -<span class="sourceLineNo">1217</span> * use {@link #modifyTable(TableDescriptor)}<a name="line.1217"></a> -<span class="sourceLineNo">1218</span> */<a name="line.1218"></a> -<span class="sourceLineNo">1219</span> @Deprecated<a name="line.1219"></a> -<span class="sourceLineNo">1220</span> void modifyTable(final TableName tableName, final HTableDescriptor htd)<a name="line.1220"></a> -<span class="sourceLineNo">1221</span> throws IOException;<a name="line.1221"></a> +<span class="sourceLineNo">1187</span> * @deprecated Since 2.0. Will be removed in 3.0. Use<a name="line.1187"></a> +<span class="sourceLineNo">1188</span> * {@link #splitRegionAsync(byte[], byte[])} instead.<a name="line.1188"></a> +<span class="sourceLineNo">1189</span> */<a name="line.1189"></a> +<span class="sourceLineNo">1190</span> void splitRegion(final byte[] regionName) throws IOException;<a name="line.1190"></a> +<span class="sourceLineNo">1191</span><a name="line.1191"></a> +<span class="sourceLineNo">1192</span> /**<a name="line.1192"></a> +<span class="sourceLineNo">1193</span> * Split a table. Asynchronous operation.<a name="line.1193"></a> +<span class="sourceLineNo">1194</span> *<a name="line.1194"></a> +<span class="sourceLineNo">1195</span> * @param tableName table to split<a name="line.1195"></a> +<span class="sourceLineNo">1196</span> * @param splitPoint the explicit position to split on<a name="line.1196"></a> +<span class="sourceLineNo">1197</span> * @throws IOException if a remote or network exception occurs<a name="line.1197"></a> +<span class="sourceLineNo">1198</span> */<a name="line.1198"></a> +<span class="sourceLineNo">1199</span> void split(final TableName tableName, final byte[] splitPoint)<a name="line.1199"></a> +<span class="sourceLineNo">1200</span> throws IOException;<a name="line.1200"></a> +<span class="sourceLineNo">1201</span><a name="line.1201"></a> +<span class="sourceLineNo">1202</span> /**<a name="line.1202"></a> +<span class="sourceLineNo">1203</span> * Split an individual region. Asynchronous operation.<a name="line.1203"></a> +<span class="sourceLineNo">1204</span> *<a name="line.1204"></a> +<span class="sourceLineNo">1205</span> * @param regionName region to split<a name="line.1205"></a> +<span class="sourceLineNo">1206</span> * @param splitPoint the explicit position to split on<a name="line.1206"></a> +<span class="sourceLineNo">1207</span> * @throws IOException if a remote or network exception occurs<a name="line.1207"></a> +<span class="sourceLineNo">1208</span> * @deprecated Since 2.0. Will be removed in 3.0. Use<a name="line.1208"></a> +<span class="sourceLineNo">1209</span> * {@link #splitRegionAsync(byte[], byte[])} instead.<a name="line.1209"></a> +<span class="sourceLineNo">1210</span> */<a name="line.1210"></a> +<span class="sourceLineNo">1211</span> void splitRegion(final byte[] regionName, final byte[] splitPoint)<a name="line.1211"></a> +<span class="sourceLineNo">1212</span> throws IOException;<a name="line.1212"></a> +<span class="sourceLineNo">1213</span><a name="line.1213"></a> +<span class="sourceLineNo">1214</span> /**<a name="line.1214"></a> +<span class="sourceLineNo">1215</span> * Split an individual region. Asynchronous operation.<a name="line.1215"></a> +<span class="sourceLineNo">1216</span> * @param regionName region to split<a name="line.1216"></a> +<span class="sourceLineNo">1217</span> * @param splitPoint the explicit position to split on<a name="line.1217"></a> +<span class="sourceLineNo">1218</span> * @throws IOException if a remote or network exception occurs<a name="line.1218"></a> +<span class="sourceLineNo">1219</span> */<a name="line.1219"></a> +<span class="sourceLineNo">1220</span> Future<Void> splitRegionAsync(byte[] regionName, byte[] splitPoint)<a name="line.1220"></a> +<span class="sourceLineNo">1221</span> throws IOException;<a name="line.1221"></a> <span class="sourceLineNo">1222</span><a name="line.1222"></a> <span class="sourceLineNo">1223</span> /**<a name="line.1223"></a> <span class="sourceLineNo">1224</span> * Modify an existing table, more IRB friendly version.<a name="line.1224"></a> <span class="sourceLineNo">1225</span> *<a name="line.1225"></a> -<span class="sourceLineNo">1226</span> * @param td modified description of the table<a name="line.1226"></a> -<span class="sourceLineNo">1227</span> * @throws IOException if a remote or network exception occurs<a name="line.1227"></a> -<span class="sourceLineNo">1228</span> */<a name="line.1228"></a> -<span class="sourceLineNo">1229</span> void modifyTable(final TableDescriptor td) throws IOException;<a name="line.1229"></a> -<span class="sourceLineNo">1230</span><a name="line.1230"></a> -<span class="sourceLineNo">1231</span> /**<a name="line.1231"></a> -<span class="sourceLineNo">1232</span> * Modify an existing table, more IRB friendly version. Asynchronous operation. This means that<a name="line.1232"></a> -<span class="sourceLineNo">1233</span> * it may be a while before your schema change is updated across all of the table.<a name="line.1233"></a> -<span class="sourceLineNo">1234</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1234"></a> -<span class="sourceLineNo">1235</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.1235"></a> -<span class="sourceLineNo">1236</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.1236"></a> -<span class="sourceLineNo">1237</span> * operation to complete.<a name="line.1237"></a> +<span class="sourceLineNo">1226</span> * @param tableName name of table.<a name="line.1226"></a> +<span class="sourceLineNo">1227</span> * @param htd modified description of the table<a name="line.1227"></a> +<span class="sourceLineNo">1228</span> * @throws IOException if a remote or network exception occurs<a name="line.1228"></a> +<span class="sourceLineNo">1229</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1229"></a> +<span class="sourceLineNo">1230</span> * use {@link #modifyTable(TableDescriptor)}<a name="line.1230"></a> +<span class="sourceLineNo">1231</span> */<a name="line.1231"></a> +<span class="sourceLineNo">1232</span> @Deprecated<a name="line.1232"></a> +<span class="sourceLineNo">1233</span> void modifyTable(final TableName tableName, final HTableDescriptor htd)<a name="line.1233"></a> +<span class="sourceLineNo">1234</span> throws IOException;<a name="line.1234"></a> +<span class="sourceLineNo">1235</span><a name="line.1235"></a> +<span class="sourceLineNo">1236</span> /**<a name="line.1236"></a> +<span class="sourceLineNo">1237</span> * Modify an existing table, more IRB friendly version.<a name="line.1237"></a> <span class="sourceLineNo">1238</span> *<a name="line.1238"></a> -<span class="sourceLineNo">1239</span> * @param tableName name of table.<a name="line.1239"></a> -<span class="sourceLineNo">1240</span> * @param htd modified description of the table<a name="line.1240"></a> -<span class="sourceLineNo">1241</span> * @throws IOException if a remote or network exception occurs<a name="line.1241"></a> -<span class="sourceLineNo">1242</span> * @return the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the<a name="line.1242"></a> -<span class="sourceLineNo">1243</span> * operation to complete<a name="line.1243"></a> -<span class="sourceLineNo">1244</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1244"></a> -<span class="sourceLineNo">1245</span> * use {@link #modifyTableAsync(TableDescriptor)}<a name="line.1245"></a> -<span class="sourceLineNo">1246</span> */<a name="line.1246"></a> -<span class="sourceLineNo">1247</span> @Deprecated<a name="line.1247"></a> -<span class="sourceLineNo">1248</span> Future<Void> modifyTableAsync(final TableName tableName, final HTableDescriptor htd)<a name="line.1248"></a> -<span class="sourceLineNo">1249</span> throws IOException;<a name="line.1249"></a> -<span class="sourceLineNo">1250</span><a name="line.1250"></a> -<span class="sourceLineNo">1251</span> /**<a name="line.1251"></a> -<span class="sourceLineNo">1252</span> * Modify an existing table, more IRB friendly version. Asynchronous operation. This means that<a name="line.1252"></a> -<span class="sourceLineNo">1253</span> * it may be a while before your schema change is updated across all of the table.<a name="line.1253"></a> -<span class="sourceLineNo">1254</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1254"></a> -<span class="sourceLineNo">1255</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.1255"></a> -<span class="sourceLineNo">1256</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.1256"></a> -<span class="sourceLineNo">1257</span> * operation to complete.<a name="line.1257"></a> -<span class="sourceLineNo">1258</span> *<a name="line.1258"></a> -<span class="sourceLineNo">1259</span> * @param td description of the table<a name="line.1259"></a> -<span class="sourceLineNo">1260</span> * @throws IOException if a remote or network exception occurs<a name="line.1260"></a> -<span class="sourceLineNo">1261</span> * @return the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the<a name="line.1261"></a> -<span class="sourceLineNo">1262</span> * operation to complete<a name="line.1262"></a> -<span class="sourceLineNo">1263</span> */<a name="line.1263"></a> -<span class="sourceLineNo">1264</span> Future<Void> modifyTableAsync(TableDescriptor td)<a name="line.1264"></a> -<span class="sourceLineNo">1265</span> throws IOException;<a name="line.1265"></a> -<span class="sourceLineNo">1266</span><a name="line.1266"></a> -<span class="sourceLineNo">1267</span> /**<a name="line.1267"></a> -<span class="sourceLineNo">1268</span> * Shuts down the HBase cluster<a name="line.1268"></a> -<span class="sourceLineNo">1269</span> *<a name="line.1269"></a> -<span class="sourceLineNo">1270</span> * @throws IOException if a remote or network exception occurs<a name="line.1270"></a> -<span class="sourceLineNo">1271</span> */<a name="line.1271"></a> -<span class="sourceLineNo">1272</span> void shutdown() throws IOException;<a name="line.1272"></a> -<span class="sourceLineNo">1273</span><a name="line.1273"></a> -<span class="sourceLineNo">1274</span> /**<a name="line.1274"></a> -<span class="sourceLineNo">1275</span> * Shuts down the current HBase master only. Does not shutdown the cluster.<a name="line.1275"></a> -<span class="sourceLineNo">1276</span> *<a name="line.1276"></a> -<span class="sourceLineNo">1277</span> * @throws IOException if a remote or network exception occurs<a name="line.1277"></a> -<span class="sourceLineNo">1278</span> * @see #shutdown()<a name="line.1278"></a> -<span class="sourceLineNo">1279</span> */<a name="line.1279"></a> -<span class="sourceLineNo">1280</span> void stopMaster() throws IOException;<a name="line.1280"></a> -<span class="sourceLineNo">1281</span><a name="line.1281"></a> -<span class="sourceLineNo">1282</span> /**<a name="line.1282"></a> -<span class="sourceLineNo">1283</span> * Check whether Master is in maintenance mode<a name="line.1283"></a> -<span class="sourceLineNo">1284</span> *<a name="line.1284"></a> -<span class="sourceLineNo">1285</span> * @throws IOException if a remote or network exception occurs<a name="line.1285"></a> -<span class="sourceLineNo">1286</span> */<a name="line.1286"></a> -<span class="sourceLineNo">1287</span> boolean isMasterInMaintenanceMode() throws IOException;<a name="line.1287"></a> -<span class="sourceLineNo">1288</span><a name="line.1288"></a> -<span class="sourceLineNo">1289</span> /**<a name="line.1289"></a> -<span class="sourceLineNo">1290</span> * Stop the designated regionserver<a name="line.1290"></a> -<span class="sourceLineNo">1291</span> *<a name="line.1291"></a> -<span class="sourceLineNo">1292</span> * @param hostnamePort Hostname and port delimited by a <code>:</code> as in<a name="line.1292"></a> -<span class="sourceLineNo">1293</span> * <code>example.org:1234</code><a name="line.1293"></a> -<span class="sourceLineNo">1294</span> * @throws IOException if a remote or network exception occurs<a name="line.1294"></a> -<span class="sourceLineNo">1295</span> */<a name="line.1295"></a> -<span class="sourceLineNo">1296</span> void stopRegionServer(final String hostnamePort) throws IOException;<a name="line.1296"></a> -<span class="sourceLineNo">1297</span><a name="line.1297"></a> -<span class="sourceLineNo">1298</span> /**<a name="line.1298"></a> -<span class="sourceLineNo">1299</span> * @return cluster status<a name="line.1299"></a> -<span class="sourceLineNo">1300</span> * @throws IOException if a remote or network exception occurs<a name="line.1300"></a> -<span class="sourceLineNo">1301</span> */<a name="line.1301"></a> -<span class="sourceLineNo">1302</span> ClusterStatus getClusterStatus() throws IOException;<a name="line.1302"></a> -<span class="sourceLineNo">1303</span><a name="line.1303"></a> -<span class="sourceLineNo">1304</span> /**<a name="line.1304"></a> -<span class="sourceLineNo">1305</span> * Get {@link RegionLoad} of all regions hosted on a regionserver.<a name="line.1305"></a> -<span class="sourceLineNo">1306</span> *<a name="line.1306"></a> -<span class="sourceLineNo">1307</span> * @param sn region server from which regionload is required.<a name="line.1307"></a> -<span class="sourceLineNo">1308</span> * @return region load map of all regions hosted on a region server<a name="line.1308"></a> -<span class="sourceLineNo">1309</span> * @throws IOException if a remote or network exception occurs<a name="line.1309"></a> -<span class="sourceLineNo">1310</span> */<a name="line.1310"></a> -<span class="sourceLineNo">1311</span> Map<byte[], RegionLoad> getRegionLoad(ServerName sn) throws IOException;<a name="line.1311"></a> -<span class="sourceLineNo">1312</span><a name="line.1312"></a> -<span class="sourceLineNo">1313</span> /**<a name="line.1313"></a> -<span class="sourceLineNo">1314</span> * Get {@link RegionLoad} of all regions hosted on a regionserver for a table.<a name="line.1314"></a> -<span class="sourceLineNo">1315</span> *<a name="line.1315"></a> -<span class="sourceLineNo">1316</span> * @param sn region server from which regionload is required.<a name="line.1316"></a> -<span class="sourceLineNo">1317</span> * @param tableName get region load of regions belonging to the table<a name="line.1317"></a> -<span class="sourceLineNo">1318</span> * @return region load map of all regions of a table hosted on a region server<a name="line.1318"></a> -<span class="sourceLineNo">1319</span> * @throws IOException if a remote or network exception occurs<a name="line.1319"></a> -<span class="sourceLineNo">1320</span> */<a name="line.1320"></a> -<span class="sourceLineNo">1321</span> Map<byte[], RegionLoad> getRegionLoad(ServerName sn, TableName tableName) throws IOException;<a name="line.1321"></a> -<span class="sourceLineNo">1322</span><a name="line.1322"></a> -<span class="sourceLineNo">1323</span> /**<a name="line.1323"></a> -<span class="sourceLineNo">1324</span> * @return Configuration used by the instance.<a name="line.1324"></a> -<span class="sourceLineNo">1325</span> */<a name="line.1325"></a> -<span class="sourceLineNo">1326</span> Configuration getConfiguration();<a name="line.1326"></a> -<span class="sourceLineNo">1327</span><a name="line.1327"></a> -<span class="sourceLineNo">1328</span> /**<a name="line.1328"></a> -<span class="sourceLineNo">1329</span> * Create a new namespace. Blocks until namespace has been successfully created or an exception<a name="line.1329"></a> -<span class="sourceLineNo">1330</span> * is thrown.<a name="line.1330"></a> -<span class="sourceLineNo">1331</span> *<a name="line.1331"></a> -<span class="sourceLineNo">1332</span> * @param descriptor descriptor which describes the new namespace<a name="line.1332"></a> +<span class="sourceLineNo">1239</span> * @param td modified description of the table<a name="line.1239"></a> +<span class="sourceLineNo">1240</span> * @throws IOException if a remote or network exception occurs<a name="line.1240"></a> +<span class="sourceLineNo">1241</span> */<a name="line.1241"></a> +<span class="sourceLineNo">1242</span> void modifyTable(final TableDescriptor td) throws IOException;<a name="line.1242"></a> +<span class="sourceLineNo">1243</span><a name="line.1243"></a> +<span class="sourceLineNo">1244</span> /**<a name="line.1244"></a> +<span class="sourceLineNo">1245</span> * Modify an existing table, more IRB friendly version. Asynchronous operation. This means that<a name="line.1245"></a> +<span class="sourceLineNo">1246</span> * it may be a while before your schema change is updated across all of the table.<a name="line.1246"></a> +<span class="sourceLineNo">1247</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1247"></a> +<span class="sourceLineNo">1248</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.1248"></a> +<span class="sourceLineNo">1249</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.1249"></a> +<span class="sourceLineNo">1250</span> * operation to complete.<a name="line.1250"></a> +<span class="sourceLineNo">1251</span> *<a name="line.1251"></a> +<span class="sourceLineNo">1252</span> * @param tableName name of table.<a name="line.1252"></a> +<span class="sourceLineNo">1253</span> * @param htd modified description of the table<a name="line.1253"></a> +<span class="sourceLineNo">1254</span> * @throws IOException if a remote or network exception occurs<a name="line.1254"></a> +<span class="sourceLineNo">1255</span> * @return the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the<a name="line.1255"></a> +<span class="sourceLineNo">1256</span> * operation to complete<a name="line.1256"></a> +<span class="sourceLineNo">1257</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1257"></a> +<span class="sourceLineNo">1258</span> * use {@link #modifyTableAsync(TableDescriptor)}<a name="line.1258"></a> +<span class="sourceLineNo">1259</span> */<a name="line.1259"></a> +<span class="sourceLineNo">1260</span> @Deprecated<a name="line.1260"></a> +<span class="sourceLineNo">1261</span> Future<Void> modifyTableAsync(final TableName tableName, final HTableDescriptor htd)<a name="line.1261"></a> +<span class="sourceLineNo">1262</span> throws IOException;<a name="line.1262"></a> +<span class="sourceLineNo">1263</span><a name="line.1263"></a> +<span class="sourceLineNo">1264</span> /**<a name="line.1264"></a> +<span class="sourceLineNo">1265</span> * Modify an existing table, more IRB friendly version. Asynchronous operation. This means that<a name="line.1265"></a> +<span class="sourceLineNo">1266</span> * it may be a while before your schema change is updated across all of the table.<a name="line.1266"></a> +<span class="sourceLineNo">1267</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1267"></a> +<span class="sourceLineNo">1268</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.1268"></a> +<span class="sourceLineNo">1269</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.1269"></a> +<span class="sourceLineNo">1270</span> * operation to complete.<a name="line.1270"></a> +<span class="sourceLineNo">1271</span> *<a name="line.1271"></a> +<span class="sourceLineNo">1272</span> * @param td description of the table<a name="line.1272"></a> +<span class="sourceLineNo">1273</span> * @throws IOException if a remote or network exception occurs<a name="line.1273"></a> +<span class="sourceLineNo">1274</span> * @return the result of the async modify. You can use Future.get(long, TimeUnit) to wait on the<a name="line.1274"></a> +<span class="sourceLineNo">1275</span> * operation to complete<a name="line.1275"></a> +<span class="sourceLineNo">1276</span> */<a name="line.1276"></a> +<span class="sourceLineNo">1277</span> Future<Void> modifyTableAsync(TableDescriptor td)<a name="line.1277"></a> +<span class="sourceLineNo">1278</span> throws IOException;<a name="line.1278"></a> +<span class="sourceLineNo">1279</span><a name="line.1279"></a> +<span class="sourceLineNo">1280</span> /**<a name="line.1280"></a> +<span class="sourceLineNo">1281</span> * Shuts down the HBase cluster<a name="line.1281"></a> +<span class="sourceLineNo">1282</span> *<a name="line.1282"></a> +<span class="sourceLineNo">1283</span> * @throws IOException if a remote or network exception occurs<a name="line.1283"></a> +<span class="sourceLineNo">1284</span> */<a name="line.1284"></a> +<span class="sourceLineNo">1285</span> void shutdown() throws IOException;<a name="line.1285"></a> +<span class="sourceLineNo">1286</span><a name="line.1286"></a> +<span class="sourceLineNo">1287</span> /**<a name="line.1287"></a> +<span class="sourceLineNo">1288</span> * Shuts down the current HBase master only. Does not shutdown the cluster.<a name="line.1288"></a> +<span class="sourceLineNo">1289</span> *<a name="line.1289"></a> +<span class="sourceLineNo">1290</span> * @throws IOException if a remote or network exception occurs<a name="line.1290"></a> +<span class="sourceLineNo">1291</span> * @see #shutdown()<a name="line.1291"></a> +<span class="sourceLineNo">1292</span> */<a name="line.1292"></a> +<span class="sourceLineNo">1293</span> void stopMaster() throws IOException;<a name="line.1293"></a> +<span class="sourceLineNo">1294</span><a name="line.1294"></a> +<span class="sourceLineNo">1295</span> /**<a name="line.1295"></a> +<span class="sourceLineNo">1296</span> * Check whether Master is in maintenance mode<a name="line.1296"></a> +<span class="sourceLineNo">1297</span> *<a name="line.1297"></a> +<span class="sourceLineNo">1298</span> * @throws IOException if a remote or network exception occurs<a name="line.1298"></a> +<span class="sourceLineNo">1299</span> */<a name="line.1299"></a> +<span class="sourceLineNo">1300</span> boolean isMasterInMaintenanceMode() throws IOException;<a name="line.1300"></a> +<span class="sourceLineNo">1301</span><a name="line.1301"></a> +<span class="sourceLineNo">1302</span> /**<a name="line.1302"></a> +<span class="sourceLineNo">1303</span> * Stop the designated regionserver<a name="line.1303"></a> +<span class="sourceLineNo">1304</span> *<a name="line.1304"></a> +<span class="sourceLineNo">1305</span> * @param hostnamePort Hostname and port delimited by a <code>:</code> as in<a name="line.1305"></a> +<span class="sourceLineNo">1306</span> * <code>example.org:1234</code><a name="line.1306"></a> +<span class="sourceLineNo">1307</span> * @throws IOException if a remote or network exception occurs<a name="line.1307"></a> +<span class="sourceLineNo">1308</span> */<a name="line.1308"></a> +<span class="sourceLineNo">1309</span> void stopRegionServer(final String hostnamePort) throws IOException;<a name="line.1309"></a> +<span class="sourceLineNo">1310</span><a name="line.1310"></a> +<span class="sourceLineNo">1311</span> /**<a name="line.1311"></a> +<span class="sourceLineNo">1312</span> * @return cluster status<a name="line.1312"></a> +<span class="sourceLineNo">1313</span> * @throws IOException if a remote or network exception occurs<a name="line.1313"></a> +<span class="sourceLineNo">1314</span> */<a name="line.1314"></a> +<span class="sourceLineNo">1315</span> ClusterStatus getClusterStatus() throws IOException;<a name="line.1315"></a> +<span class="sourceLineNo">1316</span><a name="line.1316"></a> +<span class="sourceLineNo">1317</span> /**<a name="line.1317"></a> +<span class="sourceLineNo">1318</span> * Get {@link RegionLoad} of all regions hosted on a regionserver.<a name="line.1318"></a> +<span class="sourceLineNo">1319</span> *<a name="line.1319"></a> +<span class="sourceLineNo">1320</span> * @param sn region server from which regionload is required.<a name="line.1320"></a> +<span class="sourceLineNo">1321</span> * @return region load map of all regions hosted on a region server<a name="line.1321"></a> +<span class="sourceLineNo">1322</span> * @throws IOException if a remote or network exception occurs<a name="line.1322"></a> +<span class="sourceLineNo">1323</span> */<a name="line.1323"></a> +<span class="sourceLineNo">1324</span> Map<byte[], RegionLoad> getRegionLoad(ServerName sn) throws IOException;<a name="line.1324"></a> +<span class="sourceLineNo">1325</span><a name="line.1325"></a> +<span class="sourceLineNo">1326</span> /**<a name="line.1326"></a> +<span class="sourceLineNo">1327</span> * Get {@link RegionLoad} of all regions hosted on a regionserver for a table.<a name="line.1327"></a> +<span class="sourceLineNo">1328</span> *<a name="line.1328"></a> +<span class="sourceLineNo">1329</span> * @param sn region server from which regionload is required.<a name="line.1329"></a> +<span class="sourceLineNo">1330</span> * @param tableName get region load of regions belonging to the table<a name="line.1330"></a> +<span class="sourceLineNo">1331</span> * @return region load map of all regions of a table hosted on a region server<a name="line.1331"></a> +<span class="sourceLineNo">1332</span> * @throws IOException if a remote or network exception occurs<a name="line.1332"></a> <span class="sourceLineNo">1333</span> */<a name="line.1333"></a> -<span class="sourceLineNo">1334</span> void createNamespace(final NamespaceDescriptor descriptor)<a name="line.1334"></a> -<span class="sourceLineNo">1335</span> throws IOException;<a name="line.1335"></a> -<span class="sourceLineNo">1336</span><a name="line.1336"></a> -<span class="sourceLineNo">1337</span> /**<a name="line.1337"></a> -<span class="sourceLineNo">1338</span> * Create a new namespace<a name="line.1338"></a> -<span class="sourceLineNo">1339</span> *<a name="line.1339"></a> -<span class="sourceLineNo">1340</span> * @param descriptor descriptor which describes the new namespace<a name="line.1340"></a> -<span class="sourceLineNo">1341</span> * @return the result of the async create namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1341"></a> -<span class="sourceLineNo">1342</span> * wait on the operation to complete.<a name="line.1342"></a> -<span class="sourceLineNo">1343</span> */<a name="line.1343"></a> -<span class="sourceLineNo">1344</span> Future<Void> createNamespaceAsync(final NamespaceDescriptor descriptor)<a name="line.1344"></a> -<span class="sourceLineNo">1345</span> throws IOException;<a name="line.1345"></a> -<span class="sourceLineNo">1346</span><a name="line.1346"></a> -<span class="sourceLineNo">1347</span> /**<a name="line.1347"></a> -<span class="sourceLineNo">1348</span> * Modify an existing namespace. Blocks until namespace has been successfully modified or an<a name="line.1348"></a> -<span class="sourceLineNo">1349</span> * exception is thrown.<a name="line.1349"></a> -<span class="sourceLineNo">1350</span> *<a name="line.1350"></a> -<span class="sourceLineNo">1351</span> * @param descriptor descriptor which describes the new namespace<a name="line.1351"></a> -<span class="sourceLineNo">1352</span> */<a name="line.1352"></a> -<span class="sourceLineNo">1353</span> void modifyNamespace(final NamespaceDescriptor descriptor)<a name="line.1353"></a> -<span class="sourceLineNo">1354</span> throws IOException;<a name="line.1354"></a> -<span class="sourceLineNo">1355</span><a name="line.1355"></a> -<span class="sourceLineNo">1356</span> /**<a name="line.1356"></a> -<span class="sourceLineNo">1357</span> * Modify an existing namespace<a name="line.1357"></a> -<span class="sourceLineNo">1358</span> *<a name="line.1358"></a> -<span class="sourceLineNo">1359</span> * @param descriptor descriptor which describes the new namespace<a name="line.1359"></a> -<span class="sourceLineNo">1360</span> * @return the result of the async modify namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1360"></a> -<span class="sourceLineNo">1361</span> * wait on the operation to complete.<a name="line.1361"></a> -<span class="sourceLineNo">1362</span> */<a name="line.1362"></a> -<span class="sourceLineNo">1363</span> Future<Void> modifyNamespaceAsync(final NamespaceDescriptor descriptor)<a name="line.1363"></a> -<span class="sourceLineNo">1364</span> throws IOException;<a name="line.1364"></a> -<span class="sourceLineNo">1365</span><a name="line.1365"></a> -<span class="sourceLineNo">1366</span> /**<a name="line.1366"></a> -<span class="sourceLineNo">1367</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.1367"></a> -<span class="sourceLineNo">1368</span> * Blocks until namespace has been successfully deleted or an<a name="line.1368"></a> -<span class="sourceLineNo">1369</span> * exception is thrown.<a name="line.1369"></a> -<span class="sourceLineNo">1370</span> *<a name="line.1370"></a> -<span class="sourceLineNo">1371</span> * @param name namespace name<a name="line.1371"></a> -<span class="sourceLineNo">1372</span> */<a name="line.1372"></a> -<span class="sourceLineNo">1373</span> void deleteNamespace(final String name) throws IOException;<a name="line.1373"></a> -<span class="sourceLineNo">1374</span><a name="line.1374"></a> -<span class="sourceLineNo">1375</span> /**<a name="line.1375"></a> -<span class="sourceLineNo">1376</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.1376"></a> -<span class="sourceLineNo">1377</span> *<a name="line.1377"></a> -<span class="sourceLineNo">1378</span> * @param name namespace name<a name="line.1378"></a> -<span class="sourceLineNo">1379</span> * @return the result of the async delete namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1379"></a> -<span class="sourceLineNo">1380</span> * wait on the operation to complete.<a name="line.1380"></a> -<span class="sourceLineNo">1381</span> */<a name="line.1381"></a> -<span class="sourceLineNo">1382</span> Future<Void> deleteNamespaceAsync(final String name) throws IOException;<a name="line.1382"></a> -<span class="sourceLineNo">1383</span><a name="line.1383"></a> -<span class="sourceLineNo">1384</span> /**<a name="line.1384"></a> -<span class="sourceLineNo">1385</span> * Get a namespace descriptor by name<a name="line.1385"></a> -<span class="sourceLineNo">1386</span> *<a name="line.1386"></a> -<span class="sourceLineNo">1387</span> * @param name name of namespace descriptor<a name="line.1387"></a> -<span class="sourceLineNo">1388</span> * @return A descriptor<a name="line.1388"></a> -<span class="sourceLineNo">1389</span> * @throws org.apache.hadoop.hbase.NamespaceNotFoundException<a name="line.1389"></a> -<span class="sourceLineNo">1390</span> * @throws IOException if a remote or network exception occurs<a name="line.1390"></a> -<span class="sourceLineNo">1391</span> */<a name="line.1391"></a> -<span class="sourceLineNo">1392</span> NamespaceDescriptor getNamespaceDescriptor(final String name)<a name="line.1392"></a> -<span class="sourceLineNo">1393</span> throws NamespaceNotFoundException, IOException;<a name="line.1393"></a> -<span class="sourceLineNo">1394</span><a name="line.1394"></a> -<span class="sourceLineNo">1395</span> /**<a name="line.1395"></a> -<span class="sourceLineNo">1396</span> * List available namespace descriptors<a name="line.1396"></a> -<span class="sourceLineNo">1397</span> *<a name="line.1397"></a> -<span class="sourceLineNo">1398</span> * @return List of descriptors<a name="line.1398"></a> -<span class="sourceLineNo">1399</span> */<a name="line.1399"></a> -<span class="sourceLineNo">1400</span> NamespaceDescriptor[] listNamespaceDescriptors()<a name="line.1400"></a> -<span class="sourceLineNo">1401</span> throws IOException;<a name="line.1401"></a> -<span class="sourceLineNo">1402</span><a name="line.1402"></a> -<span class="sourceLineNo">1403</span> /**<a name="line.1403"></a> -<span class="sourceLineNo">1404</span> * Get list of table descriptors by namespace<a name="line.1404"></a> -<span class="sourceLineNo">1405</span> *<a name="line.1405"></a> -<span class="sourceLineNo">1406</span> * @param name namespace name<a name="line.1406"></a> -<span class="sourceLineNo">1407</span> * @return HTD[] the read-only tableDescriptors<a name="line.1407"></a> -<span class="sourceLineNo">1408</span> * @throws IOException<a name="line.1408"></a> -<span class="sourceLineNo">1409</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1409"></a> -<span class="sourceLineNo">1410</span> * use {@link #listTableDescriptorsByNamespace(byte[])}<a name="line.1410"></a> -<span class="sourceLineNo">1411</span> */<a name="line.1411"></a> -<span class="sourceLineNo">1412</span> @Deprecated<a name="line.1412"></a> -<span class="sourceLineNo">1413</span> HTableDescriptor[] listTableDescriptorsByNamespace(final String name)<a name="line.1413"></a> -<span class="sourceLineNo">1414</span> throws IOException;<a name="line.1414"></a> +<span class="sourceLineNo">1334</span> Map<byte[], RegionLoad> getRegionLoad(ServerName sn, TableName tableName) throws IOException;<a name="line.1334"></a> +<span class="sourceLineNo">1335</span><a name="line.1335"></a> +<span class="sourceLineNo">1336</span> /**<a name="line.1336"></a> +<span class="sourceLineNo">1337</span> * @return Configuration used by the instance.<a name="line.1337"></a> +<span class="sourceLineNo">1338</span> */<a name="line.1338"></a> +<span class="sourceLineNo">1339</span> Configuration getConfiguration();<a name="line.1339"></a> +<span class="sourceLineNo">1340</span><a name="line.1340"></a> +<span class="sourceLineNo">1341</span> /**<a name="line.1341"></a> +<span class="sourceLineNo">1342</span> * Create a new namespace. Blocks until namespace has been successfully created or an exception<a name="line.1342"></a> +<span class="sourceLineNo">1343</span> * is thrown.<a name="line.1343"></a> +<span class="sourceLineNo">1344</span> *<a name="line.1344"></a> +<span class="sourceLineNo">1345</span> * @param descriptor descriptor which describes the new namespace<a name="line.1345"></a> +<span class="sourceLineNo">1346</span> */<a name="line.1346"></a> +<span class="sourceLineNo">1347</span> void createNamespace(final NamespaceDescriptor descriptor)<a name="line.1347"></a> +<span class="sourceLineNo">1348</span> throws IOException;<a name="line.1348"></a> +<span class="sourceLineNo">1349</span><a name="line.1349"></a> +<span class="sourceLineNo">1350</span> /**<a name="line.1350"></a> +<span class="sourceLineNo">1351</span> * Create a new namespace<a name="line.1351"></a> +<span class="sourceLineNo">1352</span> *<a name="line.1352"></a> +<span class="sourceLineNo">1353</span> * @param descriptor descriptor which describes the new namespace<a name="line.1353"></a> +<span class="sourceLineNo">1354</span> * @return the result of the async create namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1354"></a> +<span class="sourceLineNo">1355</span> * wait on the operation to complete.<a name="line.1355"></a> +<span class="sourceLineNo">1356</span> */<a name="line.1356"></a> +<span class="sourceLineNo">1357</span> Future<Void> createNamespaceAsync(final NamespaceDescriptor descriptor)<a name="line.1357"></a> +<span class="sourceLineNo">1358</span> throws IOException;<a name="line.1358"></a> +<span class="sourceLineNo">1359</span><a name="line.1359"></a> +<span class="sourceLineNo">1360</span> /**<a name="line.1360"></a> +<span class="sourceLineNo">1361</span> * Modify an existing namespace. Blocks until namespace has been successfully modified or an<a name="line.1361"></a> +<span class="sourceLineNo">1362</span> * exception is thrown.<a name="line.1362"></a> +<span class="sourceLineNo">1363</span> *<a name="line.1363"></a> +<span class="sourceLineNo">1364</span> * @param descriptor descriptor which describes the new namespace<a name="line.1364"></a> +<span class="sourceLineNo">1365</span> */<a name="line.1365"></a> +<span class="sourceLineNo">1366</span> void modifyNamespace(final NamespaceDescriptor descriptor)<a name="line.1366"></a> +<span class="sourceLineNo">1367</span> throws IOException;<a name="line.1367"></a> +<span class="sourceLineNo">1368</span><a name="line.1368"></a> +<span class="sourceLineNo">1369</span> /**<a name="line.1369"></a> +<span class="sourceLineNo">1370</span> * Modify an existing namespace<a name="line.1370"></a> +<span class="sourceLineNo">1371</span> *<a name="line.1371"></a> +<span class="sourceLineNo">1372</span> * @param descriptor descriptor which describes the new namespace<a name="line.1372"></a> +<span class="sourceLineNo">1373</span> * @return the result of the async modify namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1373"></a> +<span class="sourceLineNo">1374</span> * wait on the operation to complete.<a name="line.1374"></a> +<span class="sourceLineNo">1375</span> */<a name="line.1375"></a> +<span class="sourceLineNo">1376</span> Future<Void> modifyNamespaceAsync(final NamespaceDescriptor descriptor)<a name="line.1376"></a> +<span class="sourceLineNo">1377</span> throws IOException;<a name="line.1377"></a> +<span class="sourceLineNo">1378</span><a name="line.1378"></a> +<span class="sourceLineNo">1379</span> /**<a name="line.1379"></a> +<span class="sourceLineNo">1380</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.1380"></a> +<span class="sourceLineNo">1381</span> * Blocks until namespace has been successfully deleted or an<a name="line.1381"></a> +<span class="sourceLineNo">1382</span> * exception is thrown.<a name="line.1382"></a> +<span class="sourceLineNo">1383</span> *<a name="line.1383"></a> +<span class="sourceLineNo">1384</span> * @param name namespace name<a name="line.1384"></a> +<span class="sourceLineNo">1385</span> */<a name="line.1385"></a> +<span class="sourceLineNo">1386</span> void deleteNamespace(final String name) throws IOException;<a name="line.1386"></a> +<span class="sourceLineNo">1387</span><a name="line.1387"></a> +<span class="sourceLineNo">1388</span> /**<a name="line.1388"></a> +<span class="sourceLineNo">1389</span> * Delete an existing namespace. Only empty namespaces (no tables) can be removed.<a name="line.1389"></a> +<span class="sourceLineNo">1390</span> *<a name="line.1390"></a> +<span class="sourceLineNo">1391</span> * @param name namespace name<a name="line.1391"></a> +<span class="sourceLineNo">1392</span> * @return the result of the async delete namespace operation. Use Future.get(long, TimeUnit) to<a name="line.1392"></a> +<span class="sourceLineNo">1393</span> * wait on the operation to complete.<a name="line.1393"></a> +<span class="sourceLineNo">1394</span> */<a name="line.1394"></a> +<span class="sourceLineNo">1395</span> Future<Void> deleteNamespaceAsync(final String name) throws IOException;<a name="line.1395"></a> +<span class="sourceLineNo">1396</span><a name="line.1396"></a> +<span class="sourceLineNo">1397</span> /**<a name="line.1397"></a> +<span class="sourceLineNo">1398</span> * Get a namespace descriptor by name<a name="line.1398"></a> +<span class="sourceLineNo">1399</span> *<a name="line.1399"></a> +<span class="sourceLineNo">1400</span> * @param name name of namespace descriptor<a name="line.1400"></a> +<span class="sourceLineNo">1401</span> * @return A descriptor<a name="line.1401"></a> +<span class="sourceLineNo">1402</span> * @throws org.apache.hadoop.hbase.NamespaceNotFoundException<a name="line.1402"></a> +<span class="sourceLineNo">1403</span> * @throws IOException if a remote or network exception occurs<a name="line.1403"></a> +<span class="sourceLineNo">1404</span> */<a name="line.1404"></a> +<span class="sourceLineNo">1405</span> NamespaceDescriptor getNamespaceDescriptor(final String name)<a name="line.1405"></a> +<span class="sourceLineNo">1406</span> throws NamespaceNotFoundException, IOException;<a name="line.1406"></a> +<span class="sourceLineNo">1407</span><a name="line.1407"></a> +<span class="sourceLineNo">1408</span> /**<a name="line.1408"></a> +<span class="sourceLineNo">1409</span> * List available namespace descriptors<a name="line.1409"></a> +<span class="sourceLineNo">1410</span> *<a name="line.1410"></a> +<span class="sourceLineNo">1411</span> * @return List of descriptors<a name="line.1411"></a> +<span class="sourceLineNo">1412</span> */<a name="line.1412"></a> +<span class="sourceLineNo">1413</span> NamespaceDescriptor[] listNamespaceDescriptors()<a name="line.1413"></a> +<span class="sourceLineNo">1414</span> throws IOException;<a name="line.1414"></a> <span class="sourceLineNo">1415</span><a name="line.1415"></a> <span class="sourceLineNo">1416</span> /**<a name="line.1416"></a> <span class="sourceLineNo">1417</span> * Get list of table descriptors by namespace<a name="line.1417"></a> <span class="sourceLineNo">1418</span> *<a name="line.1418"></a> <span class="sourceLineNo">1419</span> * @param name namespace name<a name="line.1419"></a> -<span class="sourceLineNo">1420</span> * @return returns a list of TableDescriptors<a name="line.1420"></a> +<span class="sourceLineNo">1420</span> * @return HTD[] the read-only tableDescriptors<a name="line.1420"></a> <span class="sourceLineNo">1421</span> * @throws IOException<a name="line.1421"></a> -<span class="sourceLineNo">1422</span> */<a name="line.1422"></a> -<span class="sourceLineNo">1423</span> List<TableDescriptor> listTableDescriptorsByNamespace(final byte[] name)<a name="line.1423"></a> -<span class="sourceLineNo">1424</span> throws IOException;<a name="line.1424"></a> -<span class="sourceLineNo">1425</span><a name="line.1425"></a> -<span class="sourceLineNo">1426</span> /**<a name="line.1426"></a> -<span class="sourceLineNo">1427</span> * Get list of table names by namespace<a name="line.1427"></a> -<span class="sourceLineNo">1428</span> *<a name="line.1428"></a> -<span class="sourceLineNo">1429</span> * @param name namespace name<a name="line.1429"></a> -<span class="sourceLineNo">1430</span> * @return The list of table names in the namespace<a name="line.1430"></a> -<span class="sourceLineNo">1431</span> * @throws IOException<a name="line.1431"></a> -<span class="sourceLineNo">1432</span> */<a name="line.1432"></a> -<span class="sourceLineNo">1433</span> TableName[] listTableNamesByNamespace(final String name)<a name="line.1433"></a> -<span class="sourceLineNo">1434</span> throws IOException;<a name="line.1434"></a> -<span class="sourceLineNo">1435</span><a name="line.1435"></a> -<span class="sourceLineNo">1436</span> /**<a name="line.1436"></a> -<span class="sourceLineNo">1437</span> * Get the regions of a given table.<a name="line.1437"></a> -<span class="sourceLineNo">1438</span> *<a name="line.1438"></a> -<span class="sourceLineNo">1439</span> * @param tableName the name of the table<a name="line.1439"></a> -<span class="sourceLineNo">1440</span> * @return List of {@link HRegionInfo}.<a name="line.1440"></a> -<span class="sourceLineNo">1441</span> * @throws IOException<a name="line.1441"></a> -<span class="sourceLineNo">1442</span> */<a name="line.1442"></a> -<span class="sourceLineNo">1443</span> List<HRegionInfo> getTableRegions(final TableName tableName)<a name="line.1443"></a> -<span class="sourceLineNo">1444</span> throws IOException;<a name="line.1444"></a> -<span class="sourceLineNo">1445</span><a name="line.1445"></a> -<span class="sourceLineNo">1446</span> @Override<a name="line.1446"></a> -<span class="sourceLineNo">1447</span> void close() throws IOException;<a name="line.1447"></a> +<span class="sourceLineNo">1422</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1422"></a> +<span class="sourceLineNo">1423</span> * use {@link #listTableDescriptorsByNamespace(byte[])}<a name="line.1423"></a> +<span class="sourceLineNo">1424</span> */<a name="line.1424"></a> +<span class="sourceLineNo">1425</span> @Deprecated<a name="line.1425"></a> +<span class="sourceLineNo">1426</span> HTableDescriptor[] listTableDescriptorsByNamespace(final String name)<a name="line.1426"></a> +<span class="sourceLineNo">1427</span> throws IOException;<a name="line.1427"></a> +<span class="sourceLineNo">1428</span><a name="line.1428"></a> +<span class="sourceLineNo">1429</span> /**<a name="line.1429"></a> +<span class="sourceLineNo">1430</span> * Get list of table descriptors by namespace<a name="line.1430"></a> +<span class="sourceLineNo">1431</span> *<a name="line.1431"></a> +<span class="sourceLineNo">1432</span> * @param name namespace name<a name="line.1432"></a> +<span class="sourceLineNo">1433</span> * @return returns a list of TableDescriptors<a name="line.1433"></a> +<span class="sourceLineNo">1434</span> * @throws IOException<a name="line.1434"></a> +<span class="sourceLineNo">1435</span> */<a name="line.1435"></a> +<span class="sourceLineNo">1436</span> List<TableDescriptor> listTableDescriptorsByNamespace(final byte[] name)<a name="line.1436"></a> +<span class="sourceLineNo">1437</span> throws IOException;<a name="line.1437"></a> +<span class="sourceLineNo">1438</span><a name="line.1438"></a> +<span class="sourceLineNo">1439</span> /**<a name="line.1439"></a> +<span class="sourceLineNo">1440</span> * Get list of table names by namespace<a name="line.1440"></a> +<span class="sourceLineNo">1441</span> *<a name="line.1441"></a> +<span class="sourceLineNo">1442</span> * @param name namespace name<a name="line.1442"></a> +<span class="sourceLineNo">1443</span> * @return The list of table names in the namespace<a name="line.1443"></a> +<span class="sourceLineNo">1444</span> * @throws IOException<a name="line.1444"></a> +<span class="sourceLineNo">1445</span> */<a name="line.1445"></a> +<span class="sourceLineNo">1446</span> TableName[] listTableNamesByNamespace(final String name)<a name="line.1446"></a> +<span class="sourceLineNo">1447</span> throws IOException;<a name="line.1447"></a> <span class="sourceLineNo">1448</span><a name="line.1448"></a> <span class="sourceLineNo">1449</span> /**<a name="line.1449"></a> -<span class="sourceLineNo">1450</span> * Get tableDescriptors<a name="line.1450"></a> +<span class="sourceLineNo">1450</span> * Get the regions of a given table.<a name="line.1450"></a> <span class="sourceLineNo">1451</span> *<a name="line.1451"></a> -<span class="sourceLineNo">1452</span> * @param tableNames List of table names<a name="line.1452"></a> -<span class="sourceLineNo">1453</span> * @return HTD[] the read-only tableDescriptors<a name="line.1453"></a> -<span class="sourceLineNo">1454</span> * @throws IOException if a remote or network exception occurs<a name="line.1454"></a> -<span class="sourceLineNo">1455</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1455"></a> -<span class="sourceLineNo">1456</span> * use {@link #listTableDescriptors(List)}<a name="line.1456"></a> -<span class="sourceLineNo">1457</span> */<a name="line.1457"></a> -<span class="sourceLineNo">1458</span> @Deprecated<a name="line.1458"></a> -<span class="sourceLineNo">1459</span> HTableDescriptor[] getTableDescriptorsByTableName(List<TableName> tableNames)<a name="line.1459"></a> -<span class="sourceLineNo">1460</span> throws IOException;<a name="line.1460"></a> +<span class="sourceLineNo">1452</span> * @param tableName the name of the table<a name="line.1452"></a> +<span class="sourceLineNo">1453</span> * @return List of {@link HRegionInfo}.<a name="line.1453"></a> +<span class="sourceLineNo">1454</span> * @throws IOException<a name="line.1454"></a> +<span class="sourceLineNo">1455</span> */<a name="line.1455"></a> +<span class="sourceLineNo">1456</span> List<HRegionInfo> getTableRegions(final TableName tableName)<a name="line.1456"></a> +<span class="sourceLineNo">1457</span> throws IOException;<a name="line.1457"></a> +<span class="sourceLineNo">1458</span><a name="line.1458"></a> +<span class="sourceLineNo">1459</span> @Override<a name="line.1459"></a> +<span class="sourceLineNo">1460</span> void close() throws IOException;<a name="line.1460"></a> <span class="sourceLineNo">1461</span><a name="line.1461"></a> <span class="sourceLineNo">1462</span> /**<a name="line.1462"></a> <span class="sourceLineNo">1463</span> * Get tableDescriptors<a name="line.1463"></a> <span class="sourceLineNo">1464</span> *<a name="line.1464"></a> <span class="sourceLineNo">1465</span> * @param tableNames List of table names<a name="line.1465"></a> -<span class="sourceLineNo">1466</span> * @return returns a list of TableDescriptors<a name="line.1466"></a> +<span class="sourceLineNo">1466</span> * @return HTD[] the read-only tableDescriptors<a name="line.1466"></a> <span class="sourceLineNo">1467</span> * @throws IOException if a remote or network exception occurs<a name="line.1467"></a> -<span class="sourceLineNo">1468</span> */<a name="line.1468"></a> -<span class="sourceLineNo">1469</span> List<TableDescriptor> listTableDescriptors(List<TableName> tableNames)<a name="line.1469"></a> -<span class="sourceLineNo">1470</span> throws IOException;<a name="line.1470"></a> -<span class="sourceLineNo">1471</span><a name="line.1471"></a> -<span class="sourceLineNo">1472</span> /**<a name="line.1472"></a> -<span class="sourceLineNo">1473</span> * Get tableDescriptors<a name="line.1473"></a> -<span class="sourceLineNo">1474</span> *<a name="line.1474"></a> -<span class="sourceLineNo">1475</span> * @param names List of table names<a name="line.1475"></a> -<span class="sourceLineNo">1476</span> * @return HTD[] the read-only tableDescriptors<a name="line.1476"></a> -<span class="sourceLineNo">1477</span> * @throws IOException if a remote or network exception occurs<a name="line.1477"></a> -<span class="sourceLineNo">1478</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1478"></a> -<span class="sourceLineNo">1479</span> * use {@link #listTableDescriptors(List)}<a name="line.1479"></a> -<span class="sourceLineNo">1480</span> */<a name="line.1480"></a> -<span class="sourceLineNo">1481</span> @Deprecated<a name="line.1481"></a> -<span class="sourceLineNo">1482</span> HTableDescriptor[] getTableDescriptors(List<String> names)<a name="line.1482"></a> +<span class="sourceLineNo">1468</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1468"></a> +<span class="sourceLineNo">1469</span> * use {@link #listTableDescriptors(List)}<a name="line.1469"></a> +<span class="sourceLineNo">1470</span> */<a name="line.1470"></a> +<span class="sourceLineNo">1471</span> @Deprecated<a name="line.1471"></a> +<span class="sourceLineNo">1472</span> HTableDescriptor[] getTableDescriptorsByTableName(List<TableName> tableNames)<a name="line.1472"></a> +<span class="sourceLineNo">1473</span> throws IOException;<a name="line.1473"></a> +<span class="sourceLineNo">1474</span><a name="line.1474"></a> +<span class="sourceLineNo">1475</span> /**<a name="line.1475"></a> +<span class="sourceLineNo">1476</span> * Get tableDescriptors<a name="line.1476"></a> +<span class="sourceLineNo">1477</span> *<a name="line.1477"></a> +<span class="sourceLineNo">1478</span> * @param tableNames List of table names<a name="line.1478"></a> +<span class="sourceLineNo">1479</span> * @return returns a list of TableDescriptors<a name="line.1479"></a> +<span class="sourceLineNo">1480</span> * @throws IOException if a remote or network exception occurs<a name="line.1480"></a> +<span class="sourceLineNo">1481</span> */<a name="line.1481"></a> +<span class="sourceLineNo">1482</span> List<TableDescriptor> listTableDescriptors(List<TableName> tableNames)<a name="line.1482"></a> <span class="sourceLineNo">1483</span> throws IOException;<a name="line.1483"></a> <span class="sourceLineNo">1484</span><a name="line.1484"></a> <span class="sourceLineNo">1485</span> /**<a name="line.1485"></a> -<span class="sourceLineNo">1486</span> * abort a procedure<a name="line.1486"></a> -<span class="sourceLineNo">1487</span> * @param procId ID of the procedure to abort<a name="line.1487"></a> -<span class="sourceLineNo">1488</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1488"></a> -<span class="sourceLineNo">1489</span> * @return true if aborted, false if procedure already completed or does not exist<a name="line.1489"></a> -<span class="sourceLineNo">1490</span> * @throws IOException<a name="line.1490"></a> -<span class="sourceLineNo">1491</span> */<a name="line.1491"></a> -<span class="sourceLineNo">1492</span> boolean abortProcedure(<a name="line.1492"></a> -<span class="sourceLineNo">1493</span> final long procId,<a name="line.1493"></a> -<span class="sourceLineNo">1494</span> final boolean mayInterruptIfRunning) throws IOException;<a name="line.1494"></a> -<span class="sourceLineNo">1495</span><a name="line.1495"></a> -<span class="sourceLineNo">1496</span> /**<a name="line.1496"></a> -<span class="sourceLineNo">1497</span> * Abort a procedure but does not block and wait for it be completely removed.<a name="line.1497"></a> -<span class="sourceLineNo">1498</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1498"></a> -<span class="sourceLineNo">1499</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.1499"></a> -<span class="sourceLineNo">1500</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.1500"></a> -<span class="sourceLineNo">1501</span> * operation to complete.<a name="line.1501"></a> -<span class="sourceLineNo">1502</span> *<a name="line.1502"></a> -<span class="sourceLineNo">1503</span> * @param procId ID of the procedure to abort<a name="line.1503"></a> -<span class="sourceLineNo">1504</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1504"></a> -<span class="sourceLineNo">1505</span> * @return true if aborted, false if procedure already completed or does not exist<a name="line.1505"></a> -<span class="sourceLineNo">1506</span> * @throws IOException<a name="line.1506"></a> -<span class="sourceLineNo">1507</span> */<a name="line.1507"></a> -<span class="sourceLineNo">1508</span> Future<Boolean> abortProcedureAsync(<a name="line.1508"></a> -<span class="sourceLineNo">1509</span> final long procId,<a name="line.1509"></a> -<span class="sourceLineNo">1510</span> final boolean mayInterruptIfRunning) throws IOException;<a name="line.1510"></a> -<span class="sourceLineNo">1511</span><a name="line.1511"></a> -<span class="sourceLineNo">1512</span> /**<a name="line.1512"></a> -<span class="sourceLineNo">1513</span> * List procedures<a name="line.1513"></a> -<span class="sourceLineNo">1514</span> * @return procedure list<a name="line.1514"></a> -<span class="sourceLineNo">1515</span> * @throws IOException<a name="line.1515"></a> -<span class="sourceLineNo">1516</span> */<a name="line.1516"></a> -<span class="sourceLineNo">1517</span> ProcedureInfo[] listProcedures()<a name="line.1517"></a> -<span class="sourceLineNo">1518</span> throws IOException;<a name="line.1518"></a> -<span class="sourceLineNo">1519</span><a name="line.1519"></a> -<span class="sourceLineNo">1520</span> /**<a name="line.1520"></a> -<span class="sourceLineNo">1521</span> * List locks.<a name="line.1521"></a> -<span class="sourceLineNo">1522</span> * @return lock list<a name="line.1522"></a> -<span class="sourceLineNo">1523</span> * @throws IOException if a remote or network exception occurs<a name="line.1523"></a> -<span class="sourceLineNo">1524</span> */<a name="line.1524"></a> -<span class="sourceLineNo">1525</span> LockInfo[] listLocks()<a name="line.1525"></a> -<span class="sourceLineNo">1526</span> throws IOException;<a name="line.1526"></a> -<span class="sourceLineNo">1527</span><a name="line.1527"></a> -<span class="sourceLineNo">1528</span> /**<a name="line.1528"></a> -<span class="sourceLineNo">1529</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.1529"></a> -<span class="sourceLineNo">1530</span> *<a name="line.1530"></a> -<span class="sourceLineNo">1531</span> * Note that the actual rolling of the log writer is asynchronous and may not be complete when<a name="line.1531"></a> -<span class="sourceLineNo">1532</span> * this method returns. As a side effect of this call, the named region server may schedule<a name="line.1532"></a> -<span class="sourceLineNo">1533</span> * store flushes at the request of the wal.<a name="line.1533"></a> -<span class="sourceLineNo">1534</span> *<a name="line.1534"></a> -<span class="sourceLineNo">1535</span> * @param serverName The servername of the regionserver.<a name="line.1535"></a> +<span class="sourceLineNo">1486</span> * Get tableDescriptors<a name="line.1486"></a> +<span class="sourceLineNo">1487</span> *<a name="line.1487"></a> +<span class="sourceLineNo">1488</span> * @param names List of table names<a name="line.1488"></a> +<span class="sourceLineNo">1489</span> * @return HTD[] the read-only tableDescriptors<a name="line.1489"></a> +<span class="sourceLineNo">1490</span> * @throws IOException if a remote or network exception occurs<a name="line.1490"></a> +<span class="sourceLineNo">1491</span> * @deprecated since 2.0 version and will be removed in 3.0 version.<a name="line.1491"></a> +<span class="sourceLineNo">1492</span> * use {@link #listTableDescriptors(List)}<a name="line.1492"></a> +<span class="sourceLineNo">1493</span> */<a name="line.1493"></a> +<span class="sourceLineNo">1494</span> @Deprecated<a name="line.1494"></a> +<span class="sourceLineNo">1495</span> HTableDescriptor[] getTableDescriptors(List<String> names)<a name="line.1495"></a> +<span class="sourceLineNo">1496</span> throws IOException;<a name="line.1496"></a> +<span class="sourceLineNo">1497</span><a name="line.1497"></a> +<span class="sourceLineNo">1498</span> /**<a name="line.1498"></a> +<span class="sourceLineNo">1499</span> * abort a procedure<a name="line.1499"></a> +<span class="sourceLineNo">1500</span> * @param procId ID of the procedure to abort<a name="line.1500"></a> +<span class="sourceLineNo">1501</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1501"></a> +<span class="sourceLineNo">1502</span> * @return true if aborted, false if procedure already completed or does not exist<a name="line.1502"></a> +<span class="sourceLineNo">1503</span> * @throws IOException<a name="line.1503"></a> +<span class="sourceLineNo">1504</span> */<a name="line.1504"></a> +<span class="sourceLineNo">1505</span> boolean abortProcedure(<a name="line.1505"></a> +<span class="sourceLineNo">1506</span> final long procId,<a name="line.1506"></a> +<span class="sourceLineNo">1507</span> final boolean mayInterruptIfRunning) throws IOException;<a name="line.1507"></a> +<span class="sourceLineNo">1508</span><a name="line.1508"></a> +<span class="sourceLineNo">1509</span> /**<a name="line.1509"></a> +<span class="sourceLineNo">1510</span> * Abort a procedure but does not block and wait for it be completely removed.<a name="line.1510"></a> +<span class="sourceLineNo">1511</span> * You can use Future.get(long, TimeUnit) to wait on the operation to complete.<a name="line.1511"></a> +<span class="sourceLineNo">1512</span> * It may throw ExecutionException if there was an error while executing the operation<a name="line.1512"></a> +<span class="sourceLineNo">1513</span> * or TimeoutException in case the wait timeout was not long enough to allow the<a name="line.1513"></a> +<span class="sourceLineNo">1514</span> * operation to complete.<a name="line.1514"></a> +<span class="sourceLineNo">1515</span> *<a name="line.1515"></a> +<span class="sourceLineNo">1516</span> * @param procId ID of the procedure to abort<a name="line.1516"></a> +<span class="sourceLineNo">1517</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1517"></a> +<span class="sourceLineNo">1518</span> * @return true if aborted, false if procedure already completed or does not exist<a name="line.1518"></a> +<span class="sourceLineNo">1519</span> * @throws IOException<a name="line.1519"></a> +<span class="sourceLineNo">1520</span> */<a name="line.1520"></a> +<span class="sourceLineNo">1521</span> Future<Boolean> abortProcedureAsync(<a name="line.1521"></a> +<span class="sourceLineNo">1522</span> final long procId,<a name="line.1522"></a> +<span class="sourceLineNo">1523</span> final boolean mayInterruptIfRunning) throws IOException;<a name="line.1523"></a> +<span class="sourceLineNo">1524</span><a name="line.1524"></a> +<span class="sourceLineNo">1525</span> /**<a name="line.1525"></a> +<span class="sourceLineNo">1526</span> * List procedures<a name="line.1526"></a> +<span class="sourceLineNo">1527</span> * @return procedure list<a name="line.1527"></a> +<span class="sourceLineNo">1528</span> * @throws IOException<a name="line.1528"></a> +<span class="sourceLineNo">1529</span> */<a name="line.1529"></a> +<span class="sourceLineNo">1530</span> ProcedureInfo[] listProcedures()<a name="line.1530"></a> +<span class="sourceLineNo">1531</span> throws IOException;<a name="line.1531"></a> +<span class="sourceLineNo">1532</span><a name="line.1532"></a> +<span class="sourceLineNo">1533</span> /**<a name="line.1533"></a> +<span class="sourceLineNo">1534</span> * List locks.<a name="line.1534"></a> +<span class="sourceLineNo">1535</span> * @return lock list<a name="line.1535"></a> <span class="sourceLineNo">1536</span> * @throws IOException if a remote or network exception occurs<a name="line.1536"></a> -<span class="sourceLineNo">1537</span> * @throws org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException<a name="line.1537"></a> -<span class="sourceLineNo">1538</span> */<a name="line.1538"></a> -<span class="sourceLineNo">1539</span> void rollWALWriter(ServerName serverName) throws IOException, FailedLogCloseException;<a name="line.1539"></a> +<span class="sourceLineNo">1537</span> */<a name="line.1537"></a> +<span class="sourceLineNo">1538</span> LockInfo[] listLocks()<a name="line.1538"></a> +<span class="sourceLineNo">1539</span> throws IOException;<a name="line.1539"></a> <span class="sourceLineNo">1540</span><a name="line.1540"></a> <span class="sourceLineNo">1541</span> /**<a name="line.1541"></a> -<span class="sourceLineNo">1542</span> * Helper delegage to getClusterStatus().getMasterCoprocessors().<a name="line.1542"></a> -<span class="sourceLineNo">1543</span> * @return an array of master coprocessors<a name="line.1543"></a> -<span class="sourceLineNo">1544</span> * @see org.apache.hadoop.hbase.ClusterStatus#getMasterCoprocessors()<a name="line.1544"></a> -<span class="sourceLineNo">1545</span> */<a name="line.1545"></a> -<span class="sourceLineNo">1546</span> String[] getMasterCoprocessors() throws IOException;<a name="line.1546"></a> -<span class="sourceLineNo">1547</span><a name="line.1547"></a> -<span class="sourceLineNo">1548</span> /**<a name="line.1548"></a> -<span class="sourceLineNo">1549</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1549"></a> -<span class="sourceLineNo">1550</span> * compaction, both, or none.<a name="line.1550"></a> -<span class="sourceLineNo">1551</span> *<a name="line.1551"></a> -<span class="sourceLineNo">1552</span> * @param tableName table to examine<a name="line.1552"></a> -<span class="sourceLineNo">1553</span> * @return the current compaction state<a name="line.1553"></a> -<span class="sourceLineNo">1554</span> * @throws IOException if a remote or network exception occurs<a name="line.1554"></a> -<span class="sourceLineNo">1555</span> */<a name="line.1555"></a> -<span class="sourceLineNo">1556</span> CompactionState getCompactionState(final TableName tableName)<a name="line.1556"></a> -<span class="sourceLineNo">1557</span> throws IOException;<a name="line.1557"></a> -<span class="sourceLineNo">1558</span><a name="line.1558"></a> -<span class="sourceLineNo">1559</span> /**<a name="line.1559"></a> -<span class="sourceLineNo">1560</span> * Get the current compaction state of region. It could be in a major compaction, a minor<a name="line.1560"></a> -<span class="sourceLineNo">1561</span> * compaction, both, or none.<a name="line.1561"></a> -<span class="sourceLineNo">1562</span> *<a name="line.1562"></a> -<span class="sourceLineNo">1563</span> * @param regionName region to examine<a name="line.1563"></a> -<span class="sourceLineNo">1564</span> * @return the current compaction state<a name="line.1564"></a> -<span class="sourceLineNo">1565</span> * @throws IOException if a remote or network exception occurs<a name="line.1565"></a> -<span class="sourceLineNo">1566</span> */<a name="line.1566"></a> -<span class="sourceLineNo">1567</span> CompactionState getCompactionStateForRegion(<a name="line.1567"></a> -<span class="sourceLineNo">1568</span> final byte[] regionName) throws IOException;<a name="line.1568"></a> -<span class="sourceLineNo">1569</span><a name="line.1569"></a> -<span class="sourceLineNo">1570</span> /**<a name="line.1570"></a> -<span class="sourceLineNo">1571</span> * Get the timestamp of the last major compaction for the passed table<a name="line.1571"></a> -<span class="sourceLineNo">1572</span> *<a name="line.1572"></a> -<span class="sourceLineNo">1573</span> * The timestamp of the oldest HFile resulting from a major compaction of that table,<a name="line.1573"></a> -<span class="sourceLineNo">1574</span> * or 0 if no such HFile could be found.<a name="line.1574"></a> +<span class="sourceLineNo">1542</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.1542"></a> +<span class="sourceLineNo">1543</span> *<a name="line.1543"></a> +<span class="sourceLineNo">1544</span> * Note that the actual rolling of the log writer is asynchronous and may not be complete when<a name="line.1544"></a> +<span class="sourceLineNo">1545</span> * this method returns. As a side effect of this call, the named region server may schedule<a name="line.1545"></a> +<span class="sourceLineNo">1546</span> * store flushes at the request of the wal.<a name="line.1546"></a> +<span class="sourceLineNo">1547</span> *<a name="line.1547"></a> +<span class="sourceLineNo">1548</span> * @param serverName The servername of the regionserver.<a name="line.1548"></a> +<span class="sourceLineNo">1549</span> * @throws IOException if a remote or network exception occurs<a name="line.1549"></a> +<span class="sourceLineNo">1550</span> * @throws org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException<a name="line.1550"></a> +<span class="sourceLineNo">1551</span> */<a name="line.1551"></a> +<span class="sourceLineNo">1552</span> void rollWALWriter(ServerName serverName) throws IOException, FailedLogCloseException;<a name="line.1552"></a> +<span class="sourceLineNo">1553</span><a name="line.1553"></a> +<span class="sourceLineNo">1554</span> /**<a name="line.1554"></a> +<span class="sourceLineNo">1555</span> * Helper delegage to getClusterStatus().getMasterCoprocessors().<a name="line.1555"></a> +<span class="sourceLineNo">1556</span> * @return an array of master coprocessors<a name="line.1556"></a> +<span class="sourceLineNo">1557</span> * @see org.apache.hadoop.hbase.ClusterStatus#getMasterCoprocessors()<a name="line.1557"></a> +<span class="sourceLineNo">1558</span> */<a name="line.1558"></a> +<span class="sourceLineNo">1559</span> String[] getMasterCoprocessors() throws IOException;<a name="line.1559"></a> +<span class="sourceLineNo">1560</span><a name="line.1560"></a> +<span class="sourceLineNo">1561</span> /**<a name="line.1561"></a> +<span class="sourceLineNo">1562</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1562"></a> +<span class="sourceLineNo">1563</span> * compaction, both, or none.<a name="line.1563"></a> +<span class="sourceLineNo">1564</span> *<a name="line.1564"></a> +<span class="sourceLineNo">1565</span> * @param tableName table to examine<a name="line.1565"></a> +<span class="sourceLineNo">1566</span> * @return the current compaction state<a name="line.1566"></a> +<span class="sourceLineNo">1567</span> * @throws IOException if a remote or network exception occurs<a name="line.1567"></a> +<span class="sourceLineNo">1568</span> */<a name="line.1568"></a> +<span class="sourceLineNo">1569</span> CompactionState getCompactionState(final TableName tableName)<a name="line.1569"></a> +<span class="sourceLineNo">1570</span> throws IOException;<a name="line.1570"></a> +<span class="sourceLineNo">1571</span><a name="line.1571"></a> +<span class="sourceLineNo">1572</span> /**<a name="line.1572"></a> +<span class="sourceLineNo">1573</span> * Get the current compaction state of region. It could be in a major compaction, a minor<a name="line.1573"></a> +<span class="sourceLineNo">1574</span> * compaction, both, or none.<a name="line.1574"></a> <span class="sourceLineNo">1575</span> *<a name="line.1575"></a> -<span class="sourceLineNo">1576</span> * @param tableName table to examine<a name="line.1576"></a> -<span class="sourceLineNo">1577</span> * @return the last major compaction timestamp or 0<a name="line.1577"></a> +<span class="sourceLineNo">1576</span> * @param regionName region to examine<a name="line.1576"></a> +<span class="sourceLineNo">1577</span> * @return the current compaction state<a name="line.1577"></a> <span class="sourceLineNo">1578</span> * @throws IOException if a remote or network exception occurs<a name="line.1578"></a> <span class="sourceLineNo">1579</span> */<a name="line.1579"></a> -<span class="sourceLineNo">1580</span> long getLastMajorCompactionTimestamp(final TableName tableName)<a name="line.1580"></a> -<span class="sourceLineNo">1581</span> throws IOException;<a name="line.1581"></a> +<span class="sourceLineNo">1580</span> CompactionState getCompactionStateForRegion(<a name="line.1580"></a> +<span class="sourceLineNo">1581</span> final byte[] regionName) throws IOException;<a name="line.1581"></a> <span class="sourceLineNo">1582</span><a name="line.1582"></a> <span class="sourceLineNo">1583</span> /**<a name="line.1583"></a> -<span class="sourceLineNo">1584</span> * Get the timestamp of the last major compaction for the passed region.<a name="line.1584"></a> +<span class="sourceLineNo">1584</span> * Get the timestamp of the last major compaction for the passed table<a name="line.1584"></a> <span class="sourceLineNo">1585</span> *<a name="line.1585"></a> -<span class="sourceLineNo">1586</span> * The timestamp of the oldest HFile resulting from a major compaction of that region,<a name="line.1586"></a> +<span class="sourceLineNo">1586</span> * The timestamp of the oldest HFile resulting from a major compaction of that table,<a name="line.1586"></a> <span class="sourceLineNo">1587</span> * or 0 if no such HFile could be found.<a name="line.1587"></a> <span class="sourceLineNo">1588</span> *<a name="line.1588"></a> -<span class="sourceLineNo">1589</span> * @param regionName region to examine<a name="line.1589"></a> +<span class="sourceLineNo">1589</span> * @param tableName table to examine<a name="line.1589"></a> <span class="sourceLineNo">1590</span> * @return the last major compaction timestamp or 0<a name="line.1590"></a> <span class="sourceLineNo">1591</span> * @throws IOException if a remote or network exception occurs<a name="line.1591"></a> <span class="sourceLineNo">1592</span> */<a name="line.1592"></a> -<span class="sourceLineNo">1593</span> long getLastMajorCompactionTimestampForRegion(final byte[] regionName)<a name="line.1593"></a> -<span class="sourceLineNo">1594</span> throws IOException;<a name="line.1594"></a> +<span class="sourceLineNo">1593</span> long getLastMajorCompactionTimestamp(final TableName tableName)<a name="line.1593"></a> +<span class="sourceLineNo">1594</span> throws IOException;<a name="line.1594"></a> <span class="sourceLineNo">1595</span><a name="line.1595"></a> <span class="sourceLineNo">1596</span> /**<a name="line.1596"></a> -<span class="sourceLineNo">1597</span> * Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be<a name="line.1597"></a> -<span class="sourceLineNo">1598</span> * taken. If the table is disabled, an offline snapshot is taken. Snapshots are considered unique<a name="line.1598"></a> -<span class="sourceLineNo">1599</span> * based on <b>the name of the snapshot</b>. Attempts to take a snapshot with the same name (even<a name="line.1599"></a> -<span class="sourceLineNo">1600</span> * a different type or with different parameters) will fail with a {@link<a name="line.1600"></a> -<span class="sourceLineNo">1601</span> * org.apache.hadoop.hbase.snapshot.SnapshotCreationException} indicating the duplicate naming.<a name="line.1601"></a> -<span class="sourceLineNo">1602</span> * Snapshot names follow the same naming constraints as tables in HBase. See {@link<a name="line.1602"></a> -<span class="sourceLineNo">1603</span> * org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.1603"></a> -<span class="sourceLineNo">1604</span> *<a name="line.1604"></a> -<span class="sourceLineNo">1605</span> * @param snapshotName name of the snapshot to be created<a name="line.1605"></a> -<span class="sourceLineNo">1606</span> * @param tableName name of the table for which snapshot is created<a name="line.1606"></a> -<span class="sourceLineNo">1607</span> * @throws IOException if a remote or network exception occurs<a name="line.1607"></a> -<span class="sourceLineNo">1608</span> * @throws org.apache.hadoop.hbase.snapshot.SnapshotCreationException if snapshot creation failed<a name="line.1608"></a> -<span class="sourceLineNo">1609</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1609"></a> -<span class="sourceLineNo">1610</span> */<a name="line.1610"></a> -<span class="sourceLineNo">1611</span> void snapshot(final String snapshotName, final TableName tableName)<a name="line.1611"></a> -<span class="sourceLineNo">1612</span> throws IOException, SnapshotCreationException, IllegalArgumentException;<a name="line.1612"></a> -<span class="sourceLineNo">1613</span><a name="line.1613"></a> -<span class="sourceLineNo">1614</span> /**<a name="line.1614"></a> -<span class="sourceLineNo">1615</span> * Create a timestamp consistent snapshot for the given table. Snapshots are considered unique<a name="line.1615"></a> -<span class="sourceLineNo">1616</span> * based on <b>the name of the snapshot</b>. Attempts to take a snapshot with the same name (even<a name="line.1616"></a> -<span class="sourceLineNo">1617</span> * different type or with different parameters) will fail with a {@link SnapshotCreationException}<a name="line.1617"></a> -<span class="sourceLineNo">1618</span> * indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in<a name="line.1618"></a> -<span class="sourceLineNo">1619</span> * HBase.<a name="line.1619"></a> -<span class="sourceLineNo">1620</span> *<a name="line.1620"></a> -<span class="sourceLineNo">1621</span> * @param snapshotName name of the snapshot to be created<a name="line.1621"></a> -<span class="sourceLineNo">1622</span> * @param tableName name of the table for which snapshot is created<a name="line.1622"></a> -<span class="sourceLineNo">1623</span> * @throws IOException if a remote or network exception occurs<a name="line.1623"></a> -<span class="sourceLineNo">1624</span> * @throws SnapshotCreationException if snapshot creation failed<a name="line.1624"></a> -<span class="sourceLineNo">1625</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1625"></a> -<span class="sourceLineNo">1626</span> */<a name="line.1626"></a> -<span class="sourceLineNo">1627</span> void snapshot(final byte[] snapshotName, final TableName tableName)<a name="line.1627"></a> -<span class="sourceLineNo">1628</span> throws IOException, SnapshotCreationException, IllegalArgumentException;<a name="line.1628"></a> -<span class="sourceLineNo">1629</span><a name="line.1629"></a> -<span class="sourceLineNo">1630</span> /**<a name="line.1630"></a> -<span class="sourceLineNo">1631</span> * Create typed snapshot of the table. Snapshots are considered unique based on <b>the name of the<a name="line.1631"></a> -<span class="sourceLineNo">1632</span> * snapshot</b>. Attempts to take a snapshot with the same name (even a different type or with<a name="line.1632"></a> -<span class="sourceLineNo">1633</span> * different parameters) will fail with a {@link SnapshotCreationException} indicating the<a name="line.1633"></a> -<span class="sourceLineNo">1634</span> * duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See<a name="line.1634"></a> -<span class="sourceLineNo">1635</span> * {@link org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}.<a name="line.1635"></a> -<span class="sourceLineNo">1636</span> *<a name="line.1636"></a> -<span class="sourceLineNo">1637</span> * @param snapshotName name to give the snapshot on the filesystem. Must be unique from all other<a name="line.1637"></a> -<span class="sourceLineNo">1638</span> * snapshots stored on the cluster<a name="line.1638"></a> -<span class="sourceLineNo">1639</span> * @param tableName name of the table to snapshot<a name="line.1639"></a> -<span class="sourceLineNo">1640</span> * @param type type of snapshot to take<a name="line.1640"></a> -<span class="sourceLineNo">1641</span> * @throws IOException we fail to reach the master<a name="line.1641"></a> -<span class="sourceLineNo">1642</span> * @throws SnapshotCreationException if snapshot creation failed<a name="line.1642"></a> -<span class="sourceLineNo">1643</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1643"></a> -<span class="sourceLineNo">1644</span> */<a name="line.1644"></a> -<span class="sourceLineNo">1645</span> void snapshot(final String snapshotName,<a name="line.1645"></a> -<span class="sourceLineNo">1646</span> final TableName tableName,<a name="line.1646"></a> -<span class="sourceLineNo">1647</span> SnapshotType type) throws IOException, SnapshotCreationException,<a name="line.1647"></a> -<span class="sourceLineNo">1648</span> IllegalArgumentException;<a name="line.1648"></a> -<span class="sourceLineNo">1649</span><a name="line.1649"></a> -<span class="sourceLineNo">1650</span> /**<a name="line.1650"></a> -<span class="sourceLineNo">1651</span> * Take a snapshot and wait for the server to complete that snapshot (blocking). Only a single<a name="line.1651"></a> -<span class="sourceLineNo">1652</span> * snapshot should be taken at a time for an instance of HBase, or results may be undefined (you<a name="line.1652"></a> -<span class="sourceLineNo">1653</span> * can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a<a name="line.1653"></a> -<span class="sourceLineNo">1654</span> * single cluster). Snapshots are considered unique based on <b>the name of the snapshot</b>.<a name="line.1654"></a> -<span class="sourceLineNo">1655</span> * Attempts to take a snapshot with the same name (even a different type or with different<a name="line.1655"></a> -<span class="sourceLineNo">1656</span> * parameters) will fail with a {@link SnapshotCreationException} indicating the duplicate naming.<a name="line.1656"></a> -<span class="sourceLineNo">1657</span> * Snapshot names follow the same naming constraints as tables in HBase. See {@link<a name="line.1657"></a> -<span class="sourceLineNo">1658</span> * org.apache.hadoop.hbase.TableName#isLegalFullyQualifiedTableName(byte[])}. You should probably<a name="line.1658"></a> -<span class="sourceLineNo">1659</span> * use {@link #snapshot(String, org.apache.hadoop.hbase.TableName)} or<a name="line.1659"></a> -<span class="sourceLineNo">1660</span> * {@link #snapshot(byte[], org.apache.hadoop.hbase.TableName)} unless you are sure about the type<a name="line.1660"></a> -<span class="sourceLineNo">1661</span> * of snapshot that you want to take.<a name="line.1661"></a> -<span class="sourceLineNo">1662</span> *<a name="line.1662"></a> -<span class="sourceLineNo">1663</span> * @param snapshot snapshot to take<a name="line.1663"></a> -<span class="sourceLineNo">1664</span> * @throws IOException or we lose contact with the master.<a name="line.1664"></a> -<span class="sourceLineNo">1665</span> * @throws SnapshotCreationException if snapshot failed to be taken<a name="line.1665"></a> -<span class="sourceLineNo">1666</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1666"></a> -<span class="sourceLineNo">1667</span> */<a name="line.1667"></a> -<span class="sourceLineNo">1668</span> void snapshot(SnapshotDescription snapshot)<a name="line.1668"></a> -<span class="sourceLineNo">1669</span> throws IOException, SnapshotCreationException, IllegalArgumentException;<a name="line.1669"></a> -<span class="sourceLineNo">1670</span><a name="line.1670"></a> -<span class="sourceLineNo">1671</span> /**<a name="line.1671"></a> -<span class="sourceLineNo">1672</span> * Take a snapshot without waiting for the server to complete that snapshot (asynchronous) Only a<a name="line.1672"></a> -<span class="sourceLineNo">1673</span> * single snapshot should be taken at a time, or results may be undefined.<a name="line.1673"></a> -<span class="sourceLineNo">1674</span> *<a name="line.1674"></a> -<span class="sourceLineNo">1675</span> * @param snapshot snapshot to take<a name="line.1675"></a> -<span class="sourceLineNo">1676</span> * @throws IOException if the snapshot did not succeed or we lose contact with the master.<a name="line.1676"></a> -<span class="sourceLineNo">1677</span> * @throws SnapshotCreationException if snapshot creation failed<a name="line.1677"></a> -<span class="sourceLineNo">1678</span> * @throws IllegalArgumentException if the snapshot request is formatted incorrectly<a name="line.1678"></a> -<span class="sourceLineNo">1679</span> */<a name="line.1679"></a> -<span class="sourceLineNo">1680</span> void takeSnapshotAsync(SnapshotDescription snapshot)<a name="line.1680"></a> -<span class="sourceLineNo">1681</span> throws IOException, SnapshotCreationException;<a name="line.1681"></a> -<span class="sourceLineNo">1682</span><a name="line.1682"></a> -<span class="sourceLineNo">1683</span> /**<a name="line.1683"></a> -<span class="sourceLineNo">1684</span> * Check the current state of the passed snapshot. There are three possible states: <ol><a name="line.1684"></a> -<span class="sourceLineNo">1685</span> * <li>running - returns <tt>false</tt></li> <li>finished - returns <tt>true</tt></li><a name="line.1685"></a> -<span class="sourceLineNo">1686</span> * <li>finished with error - throws the exception that caused the snapshot to fail</li> </ol> The<a name="line.1686"></a> -<span class="sourceLineNo">1687</span> * cluster only knows about the most recent snapshot. Therefore, if another snapshot has been<a name="line.1687"></a> -<span class="sourceLineNo">1688</span> * run/started since the snap
<TRUNCATED>
