http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4abd958d/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html index c41d157..dbb2f3e 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html @@ -267,543 +267,612 @@ <span class="sourceLineNo">259</span> * @param put data to put if check succeeds<a name="line.259"></a> <span class="sourceLineNo">260</span> * @throws IOException e<a name="line.260"></a> <span class="sourceLineNo">261</span> * @return true if the new put was executed, false otherwise<a name="line.261"></a> -<span class="sourceLineNo">262</span> */<a name="line.262"></a> -<span class="sourceLineNo">263</span> boolean checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.263"></a> -<span class="sourceLineNo">264</span> byte[] value, Put put) throws IOException;<a name="line.264"></a> -<span class="sourceLineNo">265</span><a name="line.265"></a> -<span class="sourceLineNo">266</span> /**<a name="line.266"></a> -<span class="sourceLineNo">267</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.267"></a> -<span class="sourceLineNo">268</span> * value. If it does, it adds the put. If the passed value is null, the check<a name="line.268"></a> -<span class="sourceLineNo">269</span> * is for the lack of column (ie: non-existence)<a name="line.269"></a> -<span class="sourceLineNo">270</span> *<a name="line.270"></a> -<span class="sourceLineNo">271</span> * The expected value argument of this call is on the left and the current<a name="line.271"></a> -<span class="sourceLineNo">272</span> * value of the cell is on the right side of the comparison operator.<a name="line.272"></a> -<span class="sourceLineNo">273</span> *<a name="line.273"></a> -<span class="sourceLineNo">274</span> * Ie. eg. GREATER operator means expected value > existing <=> add the put.<a name="line.274"></a> +<span class="sourceLineNo">262</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.262"></a> +<span class="sourceLineNo">263</span> */<a name="line.263"></a> +<span class="sourceLineNo">264</span> @Deprecated<a name="line.264"></a> +<span class="sourceLineNo">265</span> boolean checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.265"></a> +<span class="sourceLineNo">266</span> byte[] value, Put put) throws IOException;<a name="line.266"></a> +<span class="sourceLineNo">267</span><a name="line.267"></a> +<span class="sourceLineNo">268</span> /**<a name="line.268"></a> +<span class="sourceLineNo">269</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.269"></a> +<span class="sourceLineNo">270</span> * value. If it does, it adds the put. If the passed value is null, the check<a name="line.270"></a> +<span class="sourceLineNo">271</span> * is for the lack of column (ie: non-existence)<a name="line.271"></a> +<span class="sourceLineNo">272</span> *<a name="line.272"></a> +<span class="sourceLineNo">273</span> * The expected value argument of this call is on the left and the current<a name="line.273"></a> +<span class="sourceLineNo">274</span> * value of the cell is on the right side of the comparison operator.<a name="line.274"></a> <span class="sourceLineNo">275</span> *<a name="line.275"></a> -<span class="sourceLineNo">276</span> * @param row to check<a name="line.276"></a> -<span class="sourceLineNo">277</span> * @param family column family to check<a name="line.277"></a> -<span class="sourceLineNo">278</span> * @param qualifier column qualifier to check<a name="line.278"></a> -<span class="sourceLineNo">279</span> * @param compareOp comparison operator to use<a name="line.279"></a> -<span class="sourceLineNo">280</span> * @param value the expected value<a name="line.280"></a> -<span class="sourceLineNo">281</span> * @param put data to put if check succeeds<a name="line.281"></a> -<span class="sourceLineNo">282</span> * @throws IOException e<a name="line.282"></a> -<span class="sourceLineNo">283</span> * @return true if the new put was executed, false otherwise<a name="line.283"></a> -<span class="sourceLineNo">284</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use<a name="line.284"></a> -<span class="sourceLineNo">285</span> * {@link #checkAndPut(byte[], byte[], byte[], CompareOperator, byte[], Put)}}<a name="line.285"></a> -<span class="sourceLineNo">286</span> */<a name="line.286"></a> -<span class="sourceLineNo">287</span> @Deprecated<a name="line.287"></a> -<span class="sourceLineNo">288</span> boolean checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.288"></a> -<span class="sourceLineNo">289</span> CompareFilter.CompareOp compareOp, byte[] value, Put put) throws IOException;<a name="line.289"></a> -<span class="sourceLineNo">290</span><a name="line.290"></a> -<span class="sourceLineNo">291</span> /**<a name="line.291"></a> -<span class="sourceLineNo">292</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.292"></a> -<span class="sourceLineNo">293</span> * value. If it does, it adds the put. If the passed value is null, the check<a name="line.293"></a> -<span class="sourceLineNo">294</span> * is for the lack of column (ie: non-existence)<a name="line.294"></a> -<span class="sourceLineNo">295</span> *<a name="line.295"></a> -<span class="sourceLineNo">296</span> * The expected value argument of this call is on the left and the current<a name="line.296"></a> -<span class="sourceLineNo">297</span> * value of the cell is on the right side of the comparison operator.<a name="line.297"></a> -<span class="sourceLineNo">298</span> *<a name="line.298"></a> -<span class="sourceLineNo">299</span> * Ie. eg. GREATER operator means expected value > existing <=> add the put.<a name="line.299"></a> -<span class="sourceLineNo">300</span> *<a name="line.300"></a> -<span class="sourceLineNo">301</span> * @param row to check<a name="line.301"></a> -<span class="sourceLineNo">302</span> * @param family column family to check<a name="line.302"></a> -<span class="sourceLineNo">303</span> * @param qualifier column qualifier to check<a name="line.303"></a> -<span class="sourceLineNo">304</span> * @param op comparison operator to use<a name="line.304"></a> -<span class="sourceLineNo">305</span> * @param value the expected value<a name="line.305"></a> -<span class="sourceLineNo">306</span> * @param put data to put if check succeeds<a name="line.306"></a> -<span class="sourceLineNo">307</span> * @throws IOException e<a name="line.307"></a> -<span class="sourceLineNo">308</span> * @return true if the new put was executed, false otherwise<a name="line.308"></a> -<span class="sourceLineNo">309</span> */<a name="line.309"></a> -<span class="sourceLineNo">310</span> boolean checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.310"></a> -<span class="sourceLineNo">311</span> CompareOperator op, byte[] value, Put put) throws IOException;<a name="line.311"></a> -<span class="sourceLineNo">312</span><a name="line.312"></a> -<span class="sourceLineNo">313</span> /**<a name="line.313"></a> -<span class="sourceLineNo">314</span> * Deletes the specified cells/row.<a name="line.314"></a> -<span class="sourceLineNo">315</span> *<a name="line.315"></a> -<span class="sourceLineNo">316</span> * @param delete The object that specifies what to delete.<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @throws IOException if a remote or network exception occurs.<a name="line.317"></a> -<span class="sourceLineNo">318</span> * @since 0.20.0<a name="line.318"></a> -<span class="sourceLineNo">319</span> */<a name="line.319"></a> -<span class="sourceLineNo">320</span> void delete(Delete delete) throws IOException;<a name="line.320"></a> -<span class="sourceLineNo">321</span><a name="line.321"></a> -<span class="sourceLineNo">322</span> /**<a name="line.322"></a> -<span class="sourceLineNo">323</span> * Batch Deletes the specified cells/rows from the table.<a name="line.323"></a> -<span class="sourceLineNo">324</span> * <p><a name="line.324"></a> -<span class="sourceLineNo">325</span> * If a specified row does not exist, {@link Delete} will report as though sucessful<a name="line.325"></a> -<span class="sourceLineNo">326</span> * delete; no exception will be thrown. If there are any failures even after retries,<a name="line.326"></a> -<span class="sourceLineNo">327</span> * a * {@link RetriesExhaustedWithDetailsException} will be thrown.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * RetriesExhaustedWithDetailsException contains lists of failed {@link Delete}s and<a name="line.328"></a> -<span class="sourceLineNo">329</span> * corresponding remote exceptions.<a name="line.329"></a> -<span class="sourceLineNo">330</span> *<a name="line.330"></a> -<span class="sourceLineNo">331</span> * @param deletes List of things to delete. The input list gets modified by this<a name="line.331"></a> -<span class="sourceLineNo">332</span> * method. All successfully applied {@link Delete}s in the list are removed (in particular it<a name="line.332"></a> -<span class="sourceLineNo">333</span> * gets re-ordered, so the order in which the elements are inserted in the list gives no<a name="line.333"></a> -<span class="sourceLineNo">334</span> * guarantee as to the order in which the {@link Delete}s are executed).<a name="line.334"></a> -<span class="sourceLineNo">335</span> * @throws IOException if a remote or network exception occurs. In that case<a name="line.335"></a> -<span class="sourceLineNo">336</span> * the {@code deletes} argument will contain the {@link Delete} instances<a name="line.336"></a> -<span class="sourceLineNo">337</span> * that have not be successfully applied.<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @since 0.20.1<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @apiNote In 3.0.0 version, the input list {@code deletes} will no longer be modified. Also,<a name="line.339"></a> -<span class="sourceLineNo">340</span> * {@link #put(List)} runs pre-flight validations on the input list on client. Currently<a name="line.340"></a> -<span class="sourceLineNo">341</span> * {@link #delete(List)} doesn't run validations on the client, there is no need currently,<a name="line.341"></a> -<span class="sourceLineNo">342</span> * but this may change in the future. An * {@link IllegalArgumentException} will be thrown<a name="line.342"></a> -<span class="sourceLineNo">343</span> * in this case.<a name="line.343"></a> -<span class="sourceLineNo">344</span> */<a name="line.344"></a> -<span class="sourceLineNo">345</span> void delete(List<Delete> deletes) throws IOException;<a name="line.345"></a> -<span class="sourceLineNo">346</span><a name="line.346"></a> -<span class="sourceLineNo">347</span> /**<a name="line.347"></a> -<span class="sourceLineNo">348</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.348"></a> -<span class="sourceLineNo">349</span> * value. If it does, it adds the delete. If the passed value is null, the<a name="line.349"></a> -<span class="sourceLineNo">350</span> * check is for the lack of column (ie: non-existance)<a name="line.350"></a> -<span class="sourceLineNo">351</span> *<a name="line.351"></a> -<span class="sourceLineNo">352</span> * @param row to check<a name="line.352"></a> -<span class="sourceLineNo">353</span> * @param family column family to check<a name="line.353"></a> -<span class="sourceLineNo">354</span> * @param qualifier column qualifier to check<a name="line.354"></a> -<span class="sourceLineNo">355</span> * @param value the expected value<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @param delete data to delete if check succeeds<a name="line.356"></a> -<span class="sourceLineNo">357</span> * @throws IOException e<a name="line.357"></a> -<span class="sourceLineNo">358</span> * @return true if the new delete was executed, false otherwise<a name="line.358"></a> -<span class="sourceLineNo">359</span> */<a name="line.359"></a> -<span class="sourceLineNo">360</span> boolean checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.360"></a> -<span class="sourceLineNo">361</span> byte[] value, Delete delete) throws IOException;<a name="line.361"></a> -<span class="sourceLineNo">362</span><a name="line.362"></a> -<span class="sourceLineNo">363</span> /**<a name="line.363"></a> -<span class="sourceLineNo">364</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.364"></a> -<span class="sourceLineNo">365</span> * value. If it does, it adds the delete. If the passed value is null, the<a name="line.365"></a> -<span class="sourceLineNo">366</span> * check is for the lack of column (ie: non-existence)<a name="line.366"></a> -<span class="sourceLineNo">367</span> *<a name="line.367"></a> -<span class="sourceLineNo">368</span> * The expected value argument of this call is on the left and the current<a name="line.368"></a> -<span class="sourceLineNo">369</span> * value of the cell is on the right side of the comparison operator.<a name="line.369"></a> -<span class="sourceLineNo">370</span> *<a name="line.370"></a> -<span class="sourceLineNo">371</span> * Ie. eg. GREATER operator means expected value > existing <=> add the delete.<a name="line.371"></a> +<span class="sourceLineNo">276</span> * Ie. eg. GREATER operator means expected value > existing <=> add the put.<a name="line.276"></a> +<span class="sourceLineNo">277</span> *<a name="line.277"></a> +<span class="sourceLineNo">278</span> * @param row to check<a name="line.278"></a> +<span class="sourceLineNo">279</span> * @param family column family to check<a name="line.279"></a> +<span class="sourceLineNo">280</span> * @param qualifier column qualifier to check<a name="line.280"></a> +<span class="sourceLineNo">281</span> * @param compareOp comparison operator to use<a name="line.281"></a> +<span class="sourceLineNo">282</span> * @param value the expected value<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @param put data to put if check succeeds<a name="line.283"></a> +<span class="sourceLineNo">284</span> * @throws IOException e<a name="line.284"></a> +<span class="sourceLineNo">285</span> * @return true if the new put was executed, false otherwise<a name="line.285"></a> +<span class="sourceLineNo">286</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.286"></a> +<span class="sourceLineNo">287</span> */<a name="line.287"></a> +<span class="sourceLineNo">288</span> @Deprecated<a name="line.288"></a> +<span class="sourceLineNo">289</span> boolean checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.289"></a> +<span class="sourceLineNo">290</span> CompareFilter.CompareOp compareOp, byte[] value, Put put) throws IOException;<a name="line.290"></a> +<span class="sourceLineNo">291</span><a name="line.291"></a> +<span class="sourceLineNo">292</span> /**<a name="line.292"></a> +<span class="sourceLineNo">293</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.293"></a> +<span class="sourceLineNo">294</span> * value. If it does, it adds the put. If the passed value is null, the check<a name="line.294"></a> +<span class="sourceLineNo">295</span> * is for the lack of column (ie: non-existence)<a name="line.295"></a> +<span class="sourceLineNo">296</span> *<a name="line.296"></a> +<span class="sourceLineNo">297</span> * The expected value argument of this call is on the left and the current<a name="line.297"></a> +<span class="sourceLineNo">298</span> * value of the cell is on the right side of the comparison operator.<a name="line.298"></a> +<span class="sourceLineNo">299</span> *<a name="line.299"></a> +<span class="sourceLineNo">300</span> * Ie. eg. GREATER operator means expected value > existing <=> add the put.<a name="line.300"></a> +<span class="sourceLineNo">301</span> *<a name="line.301"></a> +<span class="sourceLineNo">302</span> * @param row to check<a name="line.302"></a> +<span class="sourceLineNo">303</span> * @param family column family to check<a name="line.303"></a> +<span class="sourceLineNo">304</span> * @param qualifier column qualifier to check<a name="line.304"></a> +<span class="sourceLineNo">305</span> * @param op comparison operator to use<a name="line.305"></a> +<span class="sourceLineNo">306</span> * @param value the expected value<a name="line.306"></a> +<span class="sourceLineNo">307</span> * @param put data to put if check succeeds<a name="line.307"></a> +<span class="sourceLineNo">308</span> * @throws IOException e<a name="line.308"></a> +<span class="sourceLineNo">309</span> * @return true if the new put was executed, false otherwise<a name="line.309"></a> +<span class="sourceLineNo">310</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.310"></a> +<span class="sourceLineNo">311</span> */<a name="line.311"></a> +<span class="sourceLineNo">312</span> @Deprecated<a name="line.312"></a> +<span class="sourceLineNo">313</span> boolean checkAndPut(byte[] row, byte[] family, byte[] qualifier, CompareOperator op,<a name="line.313"></a> +<span class="sourceLineNo">314</span> byte[] value, Put put) throws IOException;<a name="line.314"></a> +<span class="sourceLineNo">315</span><a name="line.315"></a> +<span class="sourceLineNo">316</span> /**<a name="line.316"></a> +<span class="sourceLineNo">317</span> * Deletes the specified cells/row.<a name="line.317"></a> +<span class="sourceLineNo">318</span> *<a name="line.318"></a> +<span class="sourceLineNo">319</span> * @param delete The object that specifies what to delete.<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @throws IOException if a remote or network exception occurs.<a name="line.320"></a> +<span class="sourceLineNo">321</span> * @since 0.20.0<a name="line.321"></a> +<span class="sourceLineNo">322</span> */<a name="line.322"></a> +<span class="sourceLineNo">323</span> void delete(Delete delete) throws IOException;<a name="line.323"></a> +<span class="sourceLineNo">324</span><a name="line.324"></a> +<span class="sourceLineNo">325</span> /**<a name="line.325"></a> +<span class="sourceLineNo">326</span> * Batch Deletes the specified cells/rows from the table.<a name="line.326"></a> +<span class="sourceLineNo">327</span> * <p><a name="line.327"></a> +<span class="sourceLineNo">328</span> * If a specified row does not exist, {@link Delete} will report as though sucessful<a name="line.328"></a> +<span class="sourceLineNo">329</span> * delete; no exception will be thrown. If there are any failures even after retries,<a name="line.329"></a> +<span class="sourceLineNo">330</span> * a * {@link RetriesExhaustedWithDetailsException} will be thrown.<a name="line.330"></a> +<span class="sourceLineNo">331</span> * RetriesExhaustedWithDetailsException contains lists of failed {@link Delete}s and<a name="line.331"></a> +<span class="sourceLineNo">332</span> * corresponding remote exceptions.<a name="line.332"></a> +<span class="sourceLineNo">333</span> *<a name="line.333"></a> +<span class="sourceLineNo">334</span> * @param deletes List of things to delete. The input list gets modified by this<a name="line.334"></a> +<span class="sourceLineNo">335</span> * method. All successfully applied {@link Delete}s in the list are removed (in particular it<a name="line.335"></a> +<span class="sourceLineNo">336</span> * gets re-ordered, so the order in which the elements are inserted in the list gives no<a name="line.336"></a> +<span class="sourceLineNo">337</span> * guarantee as to the order in which the {@link Delete}s are executed).<a name="line.337"></a> +<span class="sourceLineNo">338</span> * @throws IOException if a remote or network exception occurs. In that case<a name="line.338"></a> +<span class="sourceLineNo">339</span> * the {@code deletes} argument will contain the {@link Delete} instances<a name="line.339"></a> +<span class="sourceLineNo">340</span> * that have not be successfully applied.<a name="line.340"></a> +<span class="sourceLineNo">341</span> * @since 0.20.1<a name="line.341"></a> +<span class="sourceLineNo">342</span> * @apiNote In 3.0.0 version, the input list {@code deletes} will no longer be modified. Also,<a name="line.342"></a> +<span class="sourceLineNo">343</span> * {@link #put(List)} runs pre-flight validations on the input list on client. Currently<a name="line.343"></a> +<span class="sourceLineNo">344</span> * {@link #delete(List)} doesn't run validations on the client, there is no need currently,<a name="line.344"></a> +<span class="sourceLineNo">345</span> * but this may change in the future. An * {@link IllegalArgumentException} will be thrown<a name="line.345"></a> +<span class="sourceLineNo">346</span> * in this case.<a name="line.346"></a> +<span class="sourceLineNo">347</span> */<a name="line.347"></a> +<span class="sourceLineNo">348</span> void delete(List<Delete> deletes) throws IOException;<a name="line.348"></a> +<span class="sourceLineNo">349</span><a name="line.349"></a> +<span class="sourceLineNo">350</span> /**<a name="line.350"></a> +<span class="sourceLineNo">351</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.351"></a> +<span class="sourceLineNo">352</span> * value. If it does, it adds the delete. If the passed value is null, the<a name="line.352"></a> +<span class="sourceLineNo">353</span> * check is for the lack of column (ie: non-existance)<a name="line.353"></a> +<span class="sourceLineNo">354</span> *<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @param row to check<a name="line.355"></a> +<span class="sourceLineNo">356</span> * @param family column family to check<a name="line.356"></a> +<span class="sourceLineNo">357</span> * @param qualifier column qualifier to check<a name="line.357"></a> +<span class="sourceLineNo">358</span> * @param value the expected value<a name="line.358"></a> +<span class="sourceLineNo">359</span> * @param delete data to delete if check succeeds<a name="line.359"></a> +<span class="sourceLineNo">360</span> * @throws IOException e<a name="line.360"></a> +<span class="sourceLineNo">361</span> * @return true if the new delete was executed, false otherwise<a name="line.361"></a> +<span class="sourceLineNo">362</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.362"></a> +<span class="sourceLineNo">363</span> */<a name="line.363"></a> +<span class="sourceLineNo">364</span> @Deprecated<a name="line.364"></a> +<span class="sourceLineNo">365</span> boolean checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.365"></a> +<span class="sourceLineNo">366</span> byte[] value, Delete delete) throws IOException;<a name="line.366"></a> +<span class="sourceLineNo">367</span><a name="line.367"></a> +<span class="sourceLineNo">368</span> /**<a name="line.368"></a> +<span class="sourceLineNo">369</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.369"></a> +<span class="sourceLineNo">370</span> * value. If it does, it adds the delete. If the passed value is null, the<a name="line.370"></a> +<span class="sourceLineNo">371</span> * check is for the lack of column (ie: non-existence)<a name="line.371"></a> <span class="sourceLineNo">372</span> *<a name="line.372"></a> -<span class="sourceLineNo">373</span> * @param row to check<a name="line.373"></a> -<span class="sourceLineNo">374</span> * @param family column family to check<a name="line.374"></a> -<span class="sourceLineNo">375</span> * @param qualifier column qualifier to check<a name="line.375"></a> -<span class="sourceLineNo">376</span> * @param compareOp comparison operator to use<a name="line.376"></a> -<span class="sourceLineNo">377</span> * @param value the expected value<a name="line.377"></a> -<span class="sourceLineNo">378</span> * @param delete data to delete if check succeeds<a name="line.378"></a> -<span class="sourceLineNo">379</span> * @throws IOException e<a name="line.379"></a> -<span class="sourceLineNo">380</span> * @return true if the new delete was executed, false otherwise<a name="line.380"></a> -<span class="sourceLineNo">381</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use<a name="line.381"></a> -<span class="sourceLineNo">382</span> * {@link #checkAndDelete(byte[], byte[], byte[], byte[], Delete)}<a name="line.382"></a> -<span class="sourceLineNo">383</span> */<a name="line.383"></a> -<span class="sourceLineNo">384</span> @Deprecated<a name="line.384"></a> -<span class="sourceLineNo">385</span> boolean checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.385"></a> -<span class="sourceLineNo">386</span> CompareFilter.CompareOp compareOp, byte[] value, Delete delete) throws IOException;<a name="line.386"></a> -<span class="sourceLineNo">387</span><a name="line.387"></a> -<span class="sourceLineNo">388</span> /**<a name="line.388"></a> -<span class="sourceLineNo">389</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.389"></a> -<span class="sourceLineNo">390</span> * value. If it does, it adds the delete. If the passed value is null, the<a name="line.390"></a> -<span class="sourceLineNo">391</span> * check is for the lack of column (ie: non-existence)<a name="line.391"></a> -<span class="sourceLineNo">392</span> *<a name="line.392"></a> -<span class="sourceLineNo">393</span> * The expected value argument of this call is on the left and the current<a name="line.393"></a> -<span class="sourceLineNo">394</span> * value of the cell is on the right side of the comparison operator.<a name="line.394"></a> -<span class="sourceLineNo">395</span> *<a name="line.395"></a> -<span class="sourceLineNo">396</span> * Ie. eg. GREATER operator means expected value > existing <=> add the delete.<a name="line.396"></a> -<span class="sourceLineNo">397</span> *<a name="line.397"></a> -<span class="sourceLineNo">398</span> * @param row to check<a name="line.398"></a> -<span class="sourceLineNo">399</span> * @param family column family to check<a name="line.399"></a> -<span class="sourceLineNo">400</span> * @param qualifier column qualifier to check<a name="line.400"></a> -<span class="sourceLineNo">401</span> * @param op comparison operator to use<a name="line.401"></a> -<span class="sourceLineNo">402</span> * @param value the expected value<a name="line.402"></a> -<span class="sourceLineNo">403</span> * @param delete data to delete if check succeeds<a name="line.403"></a> -<span class="sourceLineNo">404</span> * @throws IOException e<a name="line.404"></a> -<span class="sourceLineNo">405</span> * @return true if the new delete was executed, false otherwise<a name="line.405"></a> -<span class="sourceLineNo">406</span> */<a name="line.406"></a> -<span class="sourceLineNo">407</span> boolean checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.407"></a> -<span class="sourceLineNo">408</span> CompareOperator op, byte[] value, Delete delete) throws IOException;<a name="line.408"></a> -<span class="sourceLineNo">409</span><a name="line.409"></a> -<span class="sourceLineNo">410</span> /**<a name="line.410"></a> -<span class="sourceLineNo">411</span> * Performs multiple mutations atomically on a single row. Currently<a name="line.411"></a> -<span class="sourceLineNo">412</span> * {@link Put} and {@link Delete} are supported.<a name="line.412"></a> -<span class="sourceLineNo">413</span> *<a name="line.413"></a> -<span class="sourceLineNo">414</span> * @param rm object that specifies the set of mutations to perform atomically<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @throws IOException<a name="line.415"></a> -<span class="sourceLineNo">416</span> */<a name="line.416"></a> -<span class="sourceLineNo">417</span> void mutateRow(final RowMutations rm) throws IOException;<a name="line.417"></a> -<span class="sourceLineNo">418</span><a name="line.418"></a> -<span class="sourceLineNo">419</span> /**<a name="line.419"></a> -<span class="sourceLineNo">420</span> * Appends values to one or more columns within a single row.<a name="line.420"></a> -<span class="sourceLineNo">421</span> * <p><a name="line.421"></a> -<span class="sourceLineNo">422</span> * This operation guaranteed atomicity to readers. Appends are done<a name="line.422"></a> -<span class="sourceLineNo">423</span> * under a single row lock, so write operations to a row are synchronized, and<a name="line.423"></a> -<span class="sourceLineNo">424</span> * readers are guaranteed to see this operation fully completed.<a name="line.424"></a> -<span class="sourceLineNo">425</span> *<a name="line.425"></a> -<span class="sourceLineNo">426</span> * @param append object that specifies the columns and amounts to be used<a name="line.426"></a> -<span class="sourceLineNo">427</span> * for the increment operations<a name="line.427"></a> -<span class="sourceLineNo">428</span> * @throws IOException e<a name="line.428"></a> -<span class="sourceLineNo">429</span> * @return values of columns after the append operation (maybe null)<a name="line.429"></a> -<span class="sourceLineNo">430</span> */<a name="line.430"></a> -<span class="sourceLineNo">431</span> Result append(final Append append) throws IOException;<a name="line.431"></a> -<span class="sourceLineNo">432</span><a name="line.432"></a> -<span class="sourceLineNo">433</span> /**<a name="line.433"></a> -<span class="sourceLineNo">434</span> * Increments one or more columns within a single row.<a name="line.434"></a> -<span class="sourceLineNo">435</span> * <p><a name="line.435"></a> -<span class="sourceLineNo">436</span> * This operation ensures atomicity to readers. Increments are done<a name="line.436"></a> -<span class="sourceLineNo">437</span> * under a single row lock, so write operations to a row are synchronized, and<a name="line.437"></a> -<span class="sourceLineNo">438</span> * readers are guaranteed to see this operation fully completed.<a name="line.438"></a> -<span class="sourceLineNo">439</span> *<a name="line.439"></a> -<span class="sourceLineNo">440</span> * @param increment object that specifies the columns and amounts to be used<a name="line.440"></a> -<span class="sourceLineNo">441</span> * for the increment operations<a name="line.441"></a> -<span class="sourceLineNo">442</span> * @throws IOException e<a name="line.442"></a> -<span class="sourceLineNo">443</span> * @return values of columns after the increment<a name="line.443"></a> -<span class="sourceLineNo">444</span> */<a name="line.444"></a> -<span class="sourceLineNo">445</span> Result increment(final Increment increment) throws IOException;<a name="line.445"></a> -<span class="sourceLineNo">446</span><a name="line.446"></a> -<span class="sourceLineNo">447</span> /**<a name="line.447"></a> -<span class="sourceLineNo">448</span> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.448"></a> -<span class="sourceLineNo">449</span> * <p><a name="line.449"></a> -<span class="sourceLineNo">450</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @param row The row that contains the cell to increment.<a name="line.451"></a> -<span class="sourceLineNo">452</span> * @param family The column family of the cell to increment.<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.453"></a> -<span class="sourceLineNo">454</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.454"></a> -<span class="sourceLineNo">455</span> * amount is negative).<a name="line.455"></a> -<span class="sourceLineNo">456</span> * @return The new value, post increment.<a name="line.456"></a> -<span class="sourceLineNo">457</span> * @throws IOException if a remote or network exception occurs.<a name="line.457"></a> -<span class="sourceLineNo">458</span> */<a name="line.458"></a> -<span class="sourceLineNo">459</span> long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.459"></a> -<span class="sourceLineNo">460</span> long amount) throws IOException;<a name="line.460"></a> -<span class="sourceLineNo">461</span><a name="line.461"></a> -<span class="sourceLineNo">462</span> /**<a name="line.462"></a> -<span class="sourceLineNo">463</span> * Atomically increments a column value. If the column value already exists<a name="line.463"></a> -<span class="sourceLineNo">464</span> * and is not a big-endian long, this could throw an exception. If the column<a name="line.464"></a> -<span class="sourceLineNo">465</span> * value does not yet exist it is initialized to <code>amount</code> and<a name="line.465"></a> -<span class="sourceLineNo">466</span> * written to the specified column.<a name="line.466"></a> -<span class="sourceLineNo">467</span> *<a name="line.467"></a> -<span class="sourceLineNo">468</span> * <p>Setting durability to {@link Durability#SKIP_WAL} means that in a fail<a name="line.468"></a> -<span class="sourceLineNo">469</span> * scenario you will lose any increments that have not been flushed.<a name="line.469"></a> -<span class="sourceLineNo">470</span> * @param row The row that contains the cell to increment.<a name="line.470"></a> -<span class="sourceLineNo">471</span> * @param family The column family of the cell to increment.<a name="line.471"></a> -<span class="sourceLineNo">472</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.473"></a> -<span class="sourceLineNo">474</span> * amount is negative).<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @param durability The persistence guarantee for this increment.<a name="line.475"></a> -<span class="sourceLineNo">476</span> * @return The new value, post increment.<a name="line.476"></a> -<span class="sourceLineNo">477</span> * @throws IOException if a remote or network exception occurs.<a name="line.477"></a> -<span class="sourceLineNo">478</span> */<a name="line.478"></a> -<span class="sourceLineNo">479</span> long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.479"></a> -<span class="sourceLineNo">480</span> long amount, Durability durability) throws IOException;<a name="line.480"></a> -<span class="sourceLineNo">481</span><a name="line.481"></a> -<span class="sourceLineNo">482</span> /**<a name="line.482"></a> -<span class="sourceLineNo">483</span> * Releases any resources held or pending changes in internal buffers.<a name="line.483"></a> -<span class="sourceLineNo">484</span> *<a name="line.484"></a> -<span class="sourceLineNo">485</span> * @throws IOException if a remote or network exception occurs.<a name="line.485"></a> -<span class="sourceLineNo">486</span> */<a name="line.486"></a> -<span class="sourceLineNo">487</span> @Override<a name="line.487"></a> -<span class="sourceLineNo">488</span> void close() throws IOException;<a name="line.488"></a> -<span class="sourceLineNo">489</span><a name="line.489"></a> -<span class="sourceLineNo">490</span> /**<a name="line.490"></a> -<span class="sourceLineNo">491</span> * Creates and returns a {@link com.google.protobuf.RpcChannel} instance connected to the<a name="line.491"></a> -<span class="sourceLineNo">492</span> * table region containing the specified row. The row given does not actually have<a name="line.492"></a> -<span class="sourceLineNo">493</span> * to exist. Whichever region would contain the row based on start and end keys will<a name="line.493"></a> -<span class="sourceLineNo">494</span> * be used. Note that the {@code row} parameter is also not passed to the<a name="line.494"></a> -<span class="sourceLineNo">495</span> * coprocessor handler registered for this protocol, unless the {@code row}<a name="line.495"></a> -<span class="sourceLineNo">496</span> * is separately passed as an argument in the service request. The parameter<a name="line.496"></a> -<span class="sourceLineNo">497</span> * here is only used to locate the region used to handle the call.<a name="line.497"></a> -<span class="sourceLineNo">498</span> *<a name="line.498"></a> -<span class="sourceLineNo">499</span> * <p><a name="line.499"></a> -<span class="sourceLineNo">500</span> * The obtained {@link com.google.protobuf.RpcChannel} instance can be used to access a published<a name="line.500"></a> -<span class="sourceLineNo">501</span> * coprocessor {@link com.google.protobuf.Service} using standard protobuf service invocations:<a name="line.501"></a> -<span class="sourceLineNo">502</span> * </p><a name="line.502"></a> -<span class="sourceLineNo">503</span> *<a name="line.503"></a> -<span class="sourceLineNo">504</span> * <div style="background-color: #cccccc; padding: 2px"><a name="line.504"></a> -<span class="sourceLineNo">505</span> * <blockquote><pre><a name="line.505"></a> -<span class="sourceLineNo">506</span> * CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey);<a name="line.506"></a> -<span class="sourceLineNo">507</span> * MyService.BlockingInterface service = MyService.newBlockingStub(channel);<a name="line.507"></a> -<span class="sourceLineNo">508</span> * MyCallRequest request = MyCallRequest.newBuilder()<a name="line.508"></a> -<span class="sourceLineNo">509</span> * ...<a name="line.509"></a> -<span class="sourceLineNo">510</span> * .build();<a name="line.510"></a> -<span class="sourceLineNo">511</span> * MyCallResponse response = service.myCall(null, request);<a name="line.511"></a> -<span class="sourceLineNo">512</span> * </pre></blockquote></div><a name="line.512"></a> -<span class="sourceLineNo">513</span> *<a name="line.513"></a> -<span class="sourceLineNo">514</span> * @param row The row key used to identify the remote region location<a name="line.514"></a> -<span class="sourceLineNo">515</span> * @return A CoprocessorRpcChannel instance<a name="line.515"></a> -<span class="sourceLineNo">516</span> */<a name="line.516"></a> -<span class="sourceLineNo">517</span> CoprocessorRpcChannel coprocessorService(byte[] row);<a name="line.517"></a> -<span class="sourceLineNo">518</span><a name="line.518"></a> -<span class="sourceLineNo">519</span> /**<a name="line.519"></a> -<span class="sourceLineNo">520</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.520"></a> -<span class="sourceLineNo">521</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.521"></a> -<span class="sourceLineNo">522</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.522"></a> -<span class="sourceLineNo">523</span> * with each {@link com.google.protobuf.Service} instance.<a name="line.523"></a> -<span class="sourceLineNo">524</span> *<a name="line.524"></a> -<span class="sourceLineNo">525</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.525"></a> -<span class="sourceLineNo">526</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.526"></a> -<span class="sourceLineNo">527</span> * selection will start with the first table region.<a name="line.527"></a> -<span class="sourceLineNo">528</span> * @param endKey select regions up to and including the region containing this row. If {@code<a name="line.528"></a> -<span class="sourceLineNo">529</span> * null}, selection will continue through the last table region.<a name="line.529"></a> -<span class="sourceLineNo">530</span> * @param callable this instance's {@link org.apache.hadoop.hbase.client.coprocessor.Batch<a name="line.530"></a> -<span class="sourceLineNo">531</span> * .Call#call}<a name="line.531"></a> -<span class="sourceLineNo">532</span> * method will be invoked once per table region, using the {@link com.google.protobuf.Service}<a name="line.532"></a> -<span class="sourceLineNo">533</span> * instance connected to that region.<a name="line.533"></a> -<span class="sourceLineNo">534</span> * @param <T> the {@link com.google.protobuf.Service} subclass to connect to<a name="line.534"></a> -<span class="sourceLineNo">535</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.535"></a> -<span class="sourceLineNo">536</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.536"></a> -<span class="sourceLineNo">537</span> * @return a map of result values keyed by region name<a name="line.537"></a> -<span class="sourceLineNo">538</span> */<a name="line.538"></a> -<span class="sourceLineNo">539</span> <T extends Service, R> Map<byte[],R> coprocessorService(final Class<T> service,<a name="line.539"></a> -<span class="sourceLineNo">540</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable)<a name="line.540"></a> -<span class="sourceLineNo">541</span> throws ServiceException, Throwable;<a name="line.541"></a> -<span class="sourceLineNo">542</span><a name="line.542"></a> -<span class="sourceLineNo">543</span> /**<a name="line.543"></a> -<span class="sourceLineNo">544</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.544"></a> -<span class="sourceLineNo">545</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.545"></a> -<span class="sourceLineNo">546</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.546"></a> -<span class="sourceLineNo">547</span> * with each {@link Service} instance.<a name="line.547"></a> -<span class="sourceLineNo">548</span> *<a name="line.548"></a> -<span class="sourceLineNo">549</span> * <p> The given {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],<a name="line.549"></a> -<span class="sourceLineNo">550</span> * byte[], Object)} method will be called with the return value from each region's {@link<a name="line.550"></a> -<span class="sourceLineNo">551</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} invocation. </p><a name="line.551"></a> +<span class="sourceLineNo">373</span> * The expected value argument of this call is on the left and the current<a name="line.373"></a> +<span class="sourceLineNo">374</span> * value of the cell is on the right side of the comparison operator.<a name="line.374"></a> +<span class="sourceLineNo">375</span> *<a name="line.375"></a> +<span class="sourceLineNo">376</span> * Ie. eg. GREATER operator means expected value > existing <=> add the delete.<a name="line.376"></a> +<span class="sourceLineNo">377</span> *<a name="line.377"></a> +<span class="sourceLineNo">378</span> * @param row to check<a name="line.378"></a> +<span class="sourceLineNo">379</span> * @param family column family to check<a name="line.379"></a> +<span class="sourceLineNo">380</span> * @param qualifier column qualifier to check<a name="line.380"></a> +<span class="sourceLineNo">381</span> * @param compareOp comparison operator to use<a name="line.381"></a> +<span class="sourceLineNo">382</span> * @param value the expected value<a name="line.382"></a> +<span class="sourceLineNo">383</span> * @param delete data to delete if check succeeds<a name="line.383"></a> +<span class="sourceLineNo">384</span> * @throws IOException e<a name="line.384"></a> +<span class="sourceLineNo">385</span> * @return true if the new delete was executed, false otherwise<a name="line.385"></a> +<span class="sourceLineNo">386</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.386"></a> +<span class="sourceLineNo">387</span> */<a name="line.387"></a> +<span class="sourceLineNo">388</span> @Deprecated<a name="line.388"></a> +<span class="sourceLineNo">389</span> boolean checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.389"></a> +<span class="sourceLineNo">390</span> CompareFilter.CompareOp compareOp, byte[] value, Delete delete) throws IOException;<a name="line.390"></a> +<span class="sourceLineNo">391</span><a name="line.391"></a> +<span class="sourceLineNo">392</span> /**<a name="line.392"></a> +<span class="sourceLineNo">393</span> * Atomically checks if a row/family/qualifier value matches the expected<a name="line.393"></a> +<span class="sourceLineNo">394</span> * value. If it does, it adds the delete. If the passed value is null, the<a name="line.394"></a> +<span class="sourceLineNo">395</span> * check is for the lack of column (ie: non-existence)<a name="line.395"></a> +<span class="sourceLineNo">396</span> *<a name="line.396"></a> +<span class="sourceLineNo">397</span> * The expected value argument of this call is on the left and the current<a name="line.397"></a> +<span class="sourceLineNo">398</span> * value of the cell is on the right side of the comparison operator.<a name="line.398"></a> +<span class="sourceLineNo">399</span> *<a name="line.399"></a> +<span class="sourceLineNo">400</span> * Ie. eg. GREATER operator means expected value > existing <=> add the delete.<a name="line.400"></a> +<span class="sourceLineNo">401</span> *<a name="line.401"></a> +<span class="sourceLineNo">402</span> * @param row to check<a name="line.402"></a> +<span class="sourceLineNo">403</span> * @param family column family to check<a name="line.403"></a> +<span class="sourceLineNo">404</span> * @param qualifier column qualifier to check<a name="line.404"></a> +<span class="sourceLineNo">405</span> * @param op comparison operator to use<a name="line.405"></a> +<span class="sourceLineNo">406</span> * @param value the expected value<a name="line.406"></a> +<span class="sourceLineNo">407</span> * @param delete data to delete if check succeeds<a name="line.407"></a> +<span class="sourceLineNo">408</span> * @throws IOException e<a name="line.408"></a> +<span class="sourceLineNo">409</span> * @return true if the new delete was executed, false otherwise<a name="line.409"></a> +<span class="sourceLineNo">410</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #checkAndMutate(byte[], byte[])}<a name="line.410"></a> +<span class="sourceLineNo">411</span> */<a name="line.411"></a> +<span class="sourceLineNo">412</span> @Deprecated<a name="line.412"></a> +<span class="sourceLineNo">413</span> boolean checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.413"></a> +<span class="sourceLineNo">414</span> CompareOperator op, byte[] value, Delete delete) throws IOException;<a name="line.414"></a> +<span class="sourceLineNo">415</span><a name="line.415"></a> +<span class="sourceLineNo">416</span> /**<a name="line.416"></a> +<span class="sourceLineNo">417</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.417"></a> +<span class="sourceLineNo">418</span> * adds the Put/Delete/RowMutations.<a name="line.418"></a> +<span class="sourceLineNo">419</span> * <p><a name="line.419"></a> +<span class="sourceLineNo">420</span> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.<a name="line.420"></a> +<span class="sourceLineNo">421</span> * This is a fluent style API, the code is like:<a name="line.421"></a> +<span class="sourceLineNo">422</span> *<a name="line.422"></a> +<span class="sourceLineNo">423</span> * <pre><a name="line.423"></a> +<span class="sourceLineNo">424</span> * <code><a name="line.424"></a> +<span class="sourceLineNo">425</span> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put);<a name="line.425"></a> +<span class="sourceLineNo">426</span> * </code><a name="line.426"></a> +<span class="sourceLineNo">427</span> * </pre><a name="line.427"></a> +<span class="sourceLineNo">428</span> */<a name="line.428"></a> +<span class="sourceLineNo">429</span> CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family);<a name="line.429"></a> +<span class="sourceLineNo">430</span> /**<a name="line.430"></a> +<span class="sourceLineNo">431</span> * A helper class for sending checkAndMutate request.<a name="line.431"></a> +<span class="sourceLineNo">432</span> */<a name="line.432"></a> +<span class="sourceLineNo">433</span> interface CheckAndMutateBuilder {<a name="line.433"></a> +<span class="sourceLineNo">434</span><a name="line.434"></a> +<span class="sourceLineNo">435</span> /**<a name="line.435"></a> +<span class="sourceLineNo">436</span> * @param qualifier column qualifier to check.<a name="line.436"></a> +<span class="sourceLineNo">437</span> */<a name="line.437"></a> +<span class="sourceLineNo">438</span> CheckAndMutateBuilder qualifier(byte[] qualifier);<a name="line.438"></a> +<span class="sourceLineNo">439</span><a name="line.439"></a> +<span class="sourceLineNo">440</span> /**<a name="line.440"></a> +<span class="sourceLineNo">441</span> * Check for lack of column.<a name="line.441"></a> +<span class="sourceLineNo">442</span> */<a name="line.442"></a> +<span class="sourceLineNo">443</span> CheckAndMutateBuilder ifNotExists();<a name="line.443"></a> +<span class="sourceLineNo">444</span><a name="line.444"></a> +<span class="sourceLineNo">445</span> /**<a name="line.445"></a> +<span class="sourceLineNo">446</span> * Check for equality.<a name="line.446"></a> +<span class="sourceLineNo">447</span> * @param value the expected value<a name="line.447"></a> +<span class="sourceLineNo">448</span> */<a name="line.448"></a> +<span class="sourceLineNo">449</span> default CheckAndMutateBuilder ifEquals(byte[] value) {<a name="line.449"></a> +<span class="sourceLineNo">450</span> return ifMatches(CompareOperator.EQUAL, value);<a name="line.450"></a> +<span class="sourceLineNo">451</span> }<a name="line.451"></a> +<span class="sourceLineNo">452</span><a name="line.452"></a> +<span class="sourceLineNo">453</span> /**<a name="line.453"></a> +<span class="sourceLineNo">454</span> * @param compareOp comparison operator to use<a name="line.454"></a> +<span class="sourceLineNo">455</span> * @param value the expected value<a name="line.455"></a> +<span class="sourceLineNo">456</span> */<a name="line.456"></a> +<span class="sourceLineNo">457</span> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] value);<a name="line.457"></a> +<span class="sourceLineNo">458</span><a name="line.458"></a> +<span class="sourceLineNo">459</span> /**<a name="line.459"></a> +<span class="sourceLineNo">460</span> * @param put data to put if check succeeds<a name="line.460"></a> +<span class="sourceLineNo">461</span> * @return {@code true} if the new put was executed, {@code false} otherwise.<a name="line.461"></a> +<span class="sourceLineNo">462</span> */<a name="line.462"></a> +<span class="sourceLineNo">463</span> boolean thenPut(Put put) throws IOException;<a name="line.463"></a> +<span class="sourceLineNo">464</span><a name="line.464"></a> +<span class="sourceLineNo">465</span> /**<a name="line.465"></a> +<span class="sourceLineNo">466</span> * @param delete data to delete if check succeeds<a name="line.466"></a> +<span class="sourceLineNo">467</span> * @return {@code true} if the new delete was executed, {@code false} otherwise.<a name="line.467"></a> +<span class="sourceLineNo">468</span> */<a name="line.468"></a> +<span class="sourceLineNo">469</span> boolean thenDelete(Delete delete) throws IOException;<a name="line.469"></a> +<span class="sourceLineNo">470</span> /**<a name="line.470"></a> +<span class="sourceLineNo">471</span> * @param mutation mutations to perform if check succeeds<a name="line.471"></a> +<span class="sourceLineNo">472</span> * @return true if the new mutation was executed, false otherwise.<a name="line.472"></a> +<span class="sourceLineNo">473</span> */<a name="line.473"></a> +<span class="sourceLineNo">474</span> boolean thenMutate(RowMutations mutation) throws IOException;<a name="line.474"></a> +<span class="sourceLineNo">475</span><a name="line.475"></a> +<span class="sourceLineNo">476</span> }<a name="line.476"></a> +<span class="sourceLineNo">477</span><a name="line.477"></a> +<span class="sourceLineNo">478</span> /**<a name="line.478"></a> +<span class="sourceLineNo">479</span> * Performs multiple mutations atomically on a single row. Currently<a name="line.479"></a> +<span class="sourceLineNo">480</span> * {@link Put} and {@link Delete} are supported.<a name="line.480"></a> +<span class="sourceLineNo">481</span> *<a name="line.481"></a> +<span class="sourceLineNo">482</span> * @param rm object that specifies the set of mutations to perform atomically<a name="line.482"></a> +<span class="sourceLineNo">483</span> * @throws IOException<a name="line.483"></a> +<span class="sourceLineNo">484</span> */<a name="line.484"></a> +<span class="sourceLineNo">485</span> void mutateRow(final RowMutations rm) throws IOException;<a name="line.485"></a> +<span class="sourceLineNo">486</span><a name="line.486"></a> +<span class="sourceLineNo">487</span> /**<a name="line.487"></a> +<span class="sourceLineNo">488</span> * Appends values to one or more columns within a single row.<a name="line.488"></a> +<span class="sourceLineNo">489</span> * <p><a name="line.489"></a> +<span class="sourceLineNo">490</span> * This operation guaranteed atomicity to readers. Appends are done<a name="line.490"></a> +<span class="sourceLineNo">491</span> * under a single row lock, so write operations to a row are synchronized, and<a name="line.491"></a> +<span class="sourceLineNo">492</span> * readers are guaranteed to see this operation fully completed.<a name="line.492"></a> +<span class="sourceLineNo">493</span> *<a name="line.493"></a> +<span class="sourceLineNo">494</span> * @param append object that specifies the columns and amounts to be used<a name="line.494"></a> +<span class="sourceLineNo">495</span> * for the increment operations<a name="line.495"></a> +<span class="sourceLineNo">496</span> * @throws IOException e<a name="line.496"></a> +<span class="sourceLineNo">497</span> * @return values of columns after the append operation (maybe null)<a name="line.497"></a> +<span class="sourceLineNo">498</span> */<a name="line.498"></a> +<span class="sourceLineNo">499</span> Result append(final Append append) throws IOException;<a name="line.499"></a> +<span class="sourceLineNo">500</span><a name="line.500"></a> +<span class="sourceLineNo">501</span> /**<a name="line.501"></a> +<span class="sourceLineNo">502</span> * Increments one or more columns within a single row.<a name="line.502"></a> +<span class="sourceLineNo">503</span> * <p><a name="line.503"></a> +<span class="sourceLineNo">504</span> * This operation ensures atomicity to readers. Increments are done<a name="line.504"></a> +<span class="sourceLineNo">505</span> * under a single row lock, so write operations to a row are synchronized, and<a name="line.505"></a> +<span class="sourceLineNo">506</span> * readers are guaranteed to see this operation fully completed.<a name="line.506"></a> +<span class="sourceLineNo">507</span> *<a name="line.507"></a> +<span class="sourceLineNo">508</span> * @param increment object that specifies the columns and amounts to be used<a name="line.508"></a> +<span class="sourceLineNo">509</span> * for the increment operations<a name="line.509"></a> +<span class="sourceLineNo">510</span> * @throws IOException e<a name="line.510"></a> +<span class="sourceLineNo">511</span> * @return values of columns after the increment<a name="line.511"></a> +<span class="sourceLineNo">512</span> */<a name="line.512"></a> +<span class="sourceLineNo">513</span> Result increment(final Increment increment) throws IOException;<a name="line.513"></a> +<span class="sourceLineNo">514</span><a name="line.514"></a> +<span class="sourceLineNo">515</span> /**<a name="line.515"></a> +<span class="sourceLineNo">516</span> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}<a name="line.516"></a> +<span class="sourceLineNo">517</span> * <p><a name="line.517"></a> +<span class="sourceLineNo">518</span> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.<a name="line.518"></a> +<span class="sourceLineNo">519</span> * @param row The row that contains the cell to increment.<a name="line.519"></a> +<span class="sourceLineNo">520</span> * @param family The column family of the cell to increment.<a name="line.520"></a> +<span class="sourceLineNo">521</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.521"></a> +<span class="sourceLineNo">522</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.522"></a> +<span class="sourceLineNo">523</span> * amount is negative).<a name="line.523"></a> +<span class="sourceLineNo">524</span> * @return The new value, post increment.<a name="line.524"></a> +<span class="sourceLineNo">525</span> * @throws IOException if a remote or network exception occurs.<a name="line.525"></a> +<span class="sourceLineNo">526</span> */<a name="line.526"></a> +<span class="sourceLineNo">527</span> long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.527"></a> +<span class="sourceLineNo">528</span> long amount) throws IOException;<a name="line.528"></a> +<span class="sourceLineNo">529</span><a name="line.529"></a> +<span class="sourceLineNo">530</span> /**<a name="line.530"></a> +<span class="sourceLineNo">531</span> * Atomically increments a column value. If the column value already exists<a name="line.531"></a> +<span class="sourceLineNo">532</span> * and is not a big-endian long, this could throw an exception. If the column<a name="line.532"></a> +<span class="sourceLineNo">533</span> * value does not yet exist it is initialized to <code>amount</code> and<a name="line.533"></a> +<span class="sourceLineNo">534</span> * written to the specified column.<a name="line.534"></a> +<span class="sourceLineNo">535</span> *<a name="line.535"></a> +<span class="sourceLineNo">536</span> * <p>Setting durability to {@link Durability#SKIP_WAL} means that in a fail<a name="line.536"></a> +<span class="sourceLineNo">537</span> * scenario you will lose any increments that have not been flushed.<a name="line.537"></a> +<span class="sourceLineNo">538</span> * @param row The row that contains the cell to increment.<a name="line.538"></a> +<span class="sourceLineNo">539</span> * @param family The column family of the cell to increment.<a name="line.539"></a> +<span class="sourceLineNo">540</span> * @param qualifier The column qualifier of the cell to increment.<a name="line.540"></a> +<span class="sourceLineNo">541</span> * @param amount The amount to increment the cell with (or decrement, if the<a name="line.541"></a> +<span class="sourceLineNo">542</span> * amount is negative).<a name="line.542"></a> +<span class="sourceLineNo">543</span> * @param durability The persistence guarantee for this increment.<a name="line.543"></a> +<span class="sourceLineNo">544</span> * @return The new value, post increment.<a name="line.544"></a> +<span class="sourceLineNo">545</span> * @throws IOException if a remote or network exception occurs.<a name="line.545"></a> +<span class="sourceLineNo">546</span> */<a name="line.546"></a> +<span class="sourceLineNo">547</span> long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier,<a name="line.547"></a> +<span class="sourceLineNo">548</span> long amount, Durability durability) throws IOException;<a name="line.548"></a> +<span class="sourceLineNo">549</span><a name="line.549"></a> +<span class="sourceLineNo">550</span> /**<a name="line.550"></a> +<span class="sourceLineNo">551</span> * Releases any resources held or pending changes in internal buffers.<a name="line.551"></a> <span class="sourceLineNo">552</span> *<a name="line.552"></a> -<span class="sourceLineNo">553</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.553"></a> -<span class="sourceLineNo">554</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.554"></a> -<span class="sourceLineNo">555</span> * selection will start with the first table region.<a name="line.555"></a> -<span class="sourceLineNo">556</span> * @param endKey select regions up to and including the region containing this row. If {@code<a name="line.556"></a> -<span class="sourceLineNo">557</span> * null}, selection will continue through the last table region.<a name="line.557"></a> -<span class="sourceLineNo">558</span> * @param callable this instance's {@link org.apache.hadoop.hbase.client.coprocessor.Batch<a name="line.558"></a> -<span class="sourceLineNo">559</span> * .Call#call}<a name="line.559"></a> -<span class="sourceLineNo">560</span> * method will be invoked once per table region, using the {@link Service} instance connected to<a name="line.560"></a> -<span class="sourceLineNo">561</span> * that region.<a name="line.561"></a> -<span class="sourceLineNo">562</span> * @param callback<a name="line.562"></a> -<span class="sourceLineNo">563</span> * @param <T> the {@link Service} subclass to connect to<a name="line.563"></a> -<span class="sourceLineNo">564</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.564"></a> -<span class="sourceLineNo">565</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.565"></a> -<span class="sourceLineNo">566</span> */<a name="line.566"></a> -<span class="sourceLineNo">567</span> <T extends Service, R> void coprocessorService(final Class<T> service,<a name="line.567"></a> -<span class="sourceLineNo">568</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable,<a name="line.568"></a> -<span class="sourceLineNo">569</span> final Batch.Callback<R> callback) throws ServiceException, Throwable;<a name="line.569"></a> -<span class="sourceLineNo">570</span><a name="line.570"></a> -<span class="sourceLineNo">571</span> /**<a name="line.571"></a> -<span class="sourceLineNo">572</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.572"></a> -<span class="sourceLineNo">573</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), all<a name="line.573"></a> -<span class="sourceLineNo">574</span> * the invocations to the same region server will be batched into one call. The coprocessor<a name="line.574"></a> -<span class="sourceLineNo">575</span> * service is invoked according to the service instance, method name and parameters.<a name="line.575"></a> -<span class="sourceLineNo">576</span> *<a name="line.576"></a> -<span class="sourceLineNo">577</span> * @param methodDescriptor<a name="line.577"></a> -<span class="sourceLineNo">578</span> * the descriptor for the protobuf service method to call.<a name="line.578"></a> -<span class="sourceLineNo">579</span> * @param request<a name="line.579"></a> -<span class="sourceLineNo">580</span> * the method call parameters<a name="line.580"></a> -<span class="sourceLineNo">581</span> * @param startKey<a name="line.581"></a> -<span class="sourceLineNo">582</span> * start region selection with region containing this row. If {@code null}, the<a name="line.582"></a> -<span class="sourceLineNo">583</span> * selection will start with the first table region.<a name="line.583"></a> -<span class="sourceLineNo">584</span> * @param endKey<a name="line.584"></a> -<span class="sourceLineNo">585</span> * select regions up to and including the region containing this row. If {@code null},<a name="line.585"></a> -<span class="sourceLineNo">586</span> * selection will continue through the last table region.<a name="line.586"></a> -<span class="sourceLineNo">587</span> * @param responsePrototype<a name="line.587"></a> -<span class="sourceLineNo">588</span> * the proto type of the response of the method in Service.<a name="line.588"></a> -<span class="sourceLineNo">589</span> * @param <R><a name="line.589"></a> -<span class="sourceLineNo">590</span> * the response type for the coprocessor Service method<a name="line.590"></a> -<span class="sourceLineNo">591</span> * @throws ServiceException<a name="line.591"></a> -<span class="sourceLineNo">592</span> * @throws Throwable<a name="line.592"></a> -<span class="sourceLineNo">593</span> * @return a map of result values keyed by region name<a name="line.593"></a> -<span class="sourceLineNo">594</span> */<a name="line.594"></a> -<span class="sourceLineNo">595</span> <R extends Message> Map<byte[], R> batchCoprocessorService(<a name="line.595"></a> -<span class="sourceLineNo">596</span> Descriptors.MethodDescriptor methodDescriptor, Message request,<a name="line.596"></a> -<span class="sourceLineNo">597</span> byte[] startKey, byte[] endKey, R responsePrototype) throws ServiceException, Throwable;<a name="line.597"></a> -<span class="sourceLineNo">598</span><a name="line.598"></a> -<span class="sourceLineNo">599</span> /**<a name="line.599"></a> -<span class="sourceLineNo">600</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.600"></a> -<span class="sourceLineNo">601</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), all<a name="line.601"></a> -<span class="sourceLineNo">602</span> * the invocations to the same region server will be batched into one call. The coprocessor<a name="line.602"></a> -<span class="sourceLineNo">603</span> * service is invoked according to the service instance, method name and parameters.<a name="line.603"></a> -<span class="sourceLineNo">604</span> *<a name="line.604"></a> -<span class="sourceLineNo">605</span> * <p><a name="line.605"></a> -<span class="sourceLineNo">606</span> * The given<a name="line.606"></a> -<span class="sourceLineNo">607</span> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],byte[],Object)}<a name="line.607"></a> -<span class="sourceLineNo">608</span> * method will be called with the return value from each region's invocation.<a name="line.608"></a> -<span class="sourceLineNo">609</span> * </p><a name="line.609"></a> -<span class="sourceLineNo">610</span> *<a name="line.610"></a> -<span class="sourceLineNo">611</span> * @param methodDescriptor<a name="line.611"></a> -<span class="sourceLineNo">612</span> * the descriptor for the protobuf service method to call.<a name="line.612"></a> -<span class="sourceLineNo">613</span> * @param request<a name="line.613"></a> -<span class="sourceLineNo">614</span> * the method call parameters<a name="line.614"></a> -<span class="sourceLineNo">615</span> * @param startKey<a name="line.615"></a> -<span class="sourceLineNo">616</span> * start region selection with region containing this row. If {@code null}, the<a name="line.616"></a> -<span class="sourceLineNo">617</span> * selection will start with the first table region.<a name="line.617"></a> -<span class="sourceLineNo">618</span> * @param endKey<a name="line.618"></a> -<span class="sourceLineNo">619</span> * select regions up to and including the region containing this row. If {@code null},<a name="line.619"></a> -<span class="sourceLineNo">620</span> * selection will continue through the last table region.<a name="line.620"></a> -<span class="sourceLineNo">621</span> * @param responsePrototype<a name="line.621"></a> -<span class="sourceLineNo">622</span> * the proto type of the response of the method in Service.<a name="line.622"></a> -<span class="sourceLineNo">623</span> * @param callback<a name="line.623"></a> -<span class="sourceLineNo">624</span> * callback to invoke with the response for each region<a name="line.624"></a> -<span class="sourceLineNo">625</span> * @param <R><a name="line.625"></a> -<span class="sourceLineNo">626</span> * the response type for the coprocessor Service method<a name="line.626"></a> -<span class="sourceLineNo">627</span> * @throws ServiceException<a name="line.627"></a> -<span class="sourceLineNo">628</span> * @throws Throwable<a name="line.628"></a> -<span class="sourceLineNo">629</span> */<a name="line.629"></a> -<span class="sourceLineNo">630</span> <R extends Message> void batchCoprocessorService(Descriptors.MethodDescriptor methodDescriptor,<a name="line.630"></a> -<span class="sourceLineNo">631</span> Message request, byte[] startKey, byte[] endKey, R responsePrototype,<a name="line.631"></a> -<span class="sourceLineNo">632</span> Batch.Callback<R> callback) throws ServiceException, Throwable;<a name="line.632"></a> -<span class="sourceLineNo">633</span><a name="line.633"></a> -<span class="sourceLineNo">634</span> /**<a name="line.634"></a> -<span class="sourceLineNo">635</span> * Atomically checks if a row/family/qualifier value matches the expected value.<a name="line.635"></a> -<span class="sourceLineNo">636</span> * If it does, it performs the row mutations. If the passed value is null, the check<a name="line.636"></a> -<span class="sourceLineNo">637</span> * is for the lack of column (ie: non-existence)<a name="line.637"></a> -<span class="sourceLineNo">638</span> *<a name="line.638"></a> -<span class="sourceLineNo">639</span> * The expected value argument of this call is on the left and the current<a name="line.639"></a> -<span class="sourceLineNo">640</span> * value of the cell is on the right side of the comparison operator.<a name="line.640"></a> -<span class="sourceLineNo">641</span> *<a name="line.641"></a> -<span class="sourceLineNo">642</span> * Ie. eg. GREATER operator means expected value > existing <=> perform row mutations.<a name="line.642"></a> -<span class="sourceLineNo">643</span> *<a name="line.643"></a> -<span class="sourceLineNo">644</span> * @param row to check<a name="line.644"></a> -<span class="sourceLineNo">645</span> * @param family column family to check<a name="line.645"></a> -<span class="sourceLineNo">646</span> * @param qualifier column qualifier to check<a name="line.646"></a> -<span class="sourceLineNo">647</span> * @param compareOp the comparison operator<a name="line.647"></a> -<span class="sourceLineNo">648</span> * @param value the expected value<a name="line.648"></a> -<span class="sourceLineNo">649</span> * @param mutation mutations to perform if check succeeds<a name="line.649"></a> -<span class="sourceLineNo">650</span> * @throws IOException e<a name="line.650"></a> -<span class="sourceLineNo">651</span> * @return true if the new put was executed, false otherwise<a name="line.651"></a> -<span class="sourceLineNo">652</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use<a name="line.652"></a> -<span class="sourceLineNo">653</span> * {@link #checkAndMutate(byte[], byte[], byte[], CompareOperator, byte[], RowMutations)}<a name="line.653"></a> -<span class="sourceLineNo">654</span> */<a name="line.654"></a> -<span class="sourceLineNo">655</span> @Deprecated<a name="line.655"></a> -<span class="sourceLineNo">656</span> boolean checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.656"></a> -<span class="sourceLineNo">657</span> CompareFilter.CompareOp compareOp, byte[] value, RowMutations mutation) throws IOException;<a name="line.657"></a> -<span class="sourceLineNo">658</span><a name="line.658"></a> -<span class="sourceLineNo">659</span> /**<a name="line.659"></a> -<span class="sourceLineNo">660</span> * Atomically checks if a row/family/qualifier value matches the expected value.<a name="line.660"></a> -<span class="sourceLineNo">661</span> * If it does, it performs the row mutations. If the passed value is null, the check<a name="line.661"></a> -<span class="sourceLineNo">662</span> * is for the lack of column (ie: non-existence)<a name="line.662"></a> -<span class="sourceLineNo">663</span> *<a name="line.663"></a> -<span class="sourceLineNo">664</span> * The expected value argument of this call is on the left and the current<a name="line.664"></a> -<span class="sourceLineNo">665</span> * value of the cell is on the right side of the comparison operator.<a name="line.665"></a> -<span class="sourceLineNo">666</span> *<a name="line.666"></a> -<span class="sourceLineNo">667</span> * Ie. eg. GREATER operator means expected value > existing <=> perform row mutations.<a name="line.667"></a> -<span class="sourceLineNo">668</span> *<a name="line.668"></a> -<span class="sourceLineNo">669</span> * @param row to check<a name="line.669"></a> -<span class="sourceLineNo">670</span> * @param family column family to check<a name="line.670"></a> -<span class="sourceLineNo">671</span> * @param qualifier column qualifier to check<a name="line.671"></a> -<span class="sourceLineNo">672</span> * @param op the comparison operator<a name="line.672"></a> -<span class="sourceLineNo">673</span> * @param value the expected value<a name="line.673"></a> -<span class="sourceLineNo">674</span> * @param mutation mutations to perform if check succeeds<a name="line.674"></a> -<span class="sourceLineNo">675</span> * @throws IOException e<a name="line.675"></a> -<span class="sourceLineNo">676</span> * @return true if the new put was executed, false otherwise<a name="line.676"></a> -<span class="sourceLineNo">677</span> */<a name="line.677"></a> -<span class="sourceLineNo">678</span> boolean checkAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op,<a name="line.678"></a> -<span class="sourceLineNo">679</span> byte[] value, RowMutations mutation) throws IOException;<a name="line.679"></a> -<span class="sourceLineNo">680</span><a name="line.680"></a> -<span class="sourceLineNo">681</span> /**<a name="line.681"></a> -<span class="sourceLineNo">682</span> * Get timeout of each rpc request in this Table instance. It will be overridden by a more<a name="line.682"></a> -<span class="sourceLineNo">683</span> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.<a name="line.683"></a> -<span class="sourceLineNo">684</span> * @see #getReadRpcTimeout(TimeUnit)<a name="line.684"></a> -<span class="sourceLineNo">685</span> * @see #getWriteRpcTimeout(TimeUnit)<a name="line.685"></a> -<span class="sourceLineNo">686</span> * @param unit the unit of time the timeout to be represented in<a name="line.686"></a> -<span class="sourceLineNo">687</span> * @return rpc timeout in the specified time unit<a name="line.687"></a> -<span class="sourceLineNo">688</span> */<a name="line.688"></a> -<span class="sourceLineNo">689</span> long getRpcTimeout(TimeUnit unit);<a name="line.689"></a> -<span class="sourceLineNo">690</span><a name="line.690"></a> -<span class="sourceLineNo">691</span> /**<a name="line.691"></a> -<span class="sourceLineNo">692</span> * Get timeout (millisecond) of each rpc request in this Table instance.<a name="line.692"></a> -<span class="sourceLineNo">693</span> *<a name="line.693"></a> -<span class="sourceLineNo">694</span> * @return Currently configured read timeout<a name="line.694"></a> -<span class="sourceLineNo">695</span> * @deprecated use {@link #getReadRpcTimeout(TimeUnit)} or<a name="line.695"></a> -<span class="sourceLineNo">696</span> * {@link #getWriteRpcTimeout(TimeUnit)} instead<a name="line.696"></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> @Override<a name="line.555"></a> +<span class="sourceLineNo">556</span> void close() throws IOException;<a name="line.556"></a> +<span class="sourceLineNo">557</span><a name="line.557"></a> +<span class="sourceLineNo">558</span> /**<a name="line.558"></a> +<span class="sourceLineNo">559</span> * Creates and returns a {@link com.google.protobuf.RpcChannel} instance connected to the<a name="line.559"></a> +<span class="sourceLineNo">560</span> * table region containing the specified row. The row given does not actually have<a name="line.560"></a> +<span class="sourceLineNo">561</span> * to exist. Whichever region would contain the row based on start and end keys will<a name="line.561"></a> +<span class="sourceLineNo">562</span> * be used. Note that the {@code row} parameter is also not passed to the<a name="line.562"></a> +<span class="sourceLineNo">563</span> * coprocessor handler registered for this protocol, unless the {@code row}<a name="line.563"></a> +<span class="sourceLineNo">564</span> * is separately passed as an argument in the service request. The parameter<a name="line.564"></a> +<span class="sourceLineNo">565</span> * here is only used to locate the region used to handle the call.<a name="line.565"></a> +<span class="sourceLineNo">566</span> *<a name="line.566"></a> +<span class="sourceLineNo">567</span> * <p><a name="line.567"></a> +<span class="sourceLineNo">568</span> * The obtained {@link com.google.protobuf.RpcChannel} instance can be used to access a published<a name="line.568"></a> +<span class="sourceLineNo">569</span> * coprocessor {@link com.google.protobuf.Service} using standard protobuf service invocations:<a name="line.569"></a> +<span class="sourceLineNo">570</span> * </p><a name="line.570"></a> +<span class="sourceLineNo">571</span> *<a name="line.571"></a> +<span class="sourceLineNo">572</span> * <div style="background-color: #cccccc; padding: 2px"><a name="line.572"></a> +<span class="sourceLineNo">573</span> * <blockquote><pre><a name="line.573"></a> +<span class="sourceLineNo">574</span> * CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey);<a name="line.574"></a> +<span class="sourceLineNo">575</span> * MyService.BlockingInterface service = MyService.newBlockingStub(channel);<a name="line.575"></a> +<span class="sourceLineNo">576</span> * MyCallRequest request = MyCallRequest.newBuilder()<a name="line.576"></a> +<span class="sourceLineNo">577</span> * ...<a name="line.577"></a> +<span class="sourceLineNo">578</span> * .build();<a name="line.578"></a> +<span class="sourceLineNo">579</span> * MyCallResponse response = service.myCall(null, request);<a name="line.579"></a> +<span class="sourceLineNo">580</span> * </pre></blockquote></div><a name="line.580"></a> +<span class="sourceLineNo">581</span> *<a name="line.581"></a> +<span class="sourceLineNo">582</span> * @param row The row key used to identify the remote region location<a name="line.582"></a> +<span class="sourceLineNo">583</span> * @return A CoprocessorRpcChannel instance<a name="line.583"></a> +<span class="sourceLineNo">584</span> */<a name="line.584"></a> +<span class="sourceLineNo">585</span> CoprocessorRpcChannel coprocessorService(byte[] row);<a name="line.585"></a> +<span class="sourceLineNo">586</span><a name="line.586"></a> +<span class="sourceLineNo">587</span> /**<a name="line.587"></a> +<span class="sourceLineNo">588</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.588"></a> +<span class="sourceLineNo">589</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.589"></a> +<span class="sourceLineNo">590</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.590"></a> +<span class="sourceLineNo">591</span> * with each {@link com.google.protobuf.Service} instance.<a name="line.591"></a> +<span class="sourceLineNo">592</span> *<a name="line.592"></a> +<span class="sourceLineNo">593</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.593"></a> +<span class="sourceLineNo">594</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.594"></a> +<span class="sourceLineNo">595</span> * selection will start with the first table region.<a name="line.595"></a> +<span class="sourceLineNo">596</span> * @param endKey select regions up to and including the region containing this row. If {@code<a name="line.596"></a> +<span class="sourceLineNo">597</span> * null}, selection will continue through the last table region.<a name="line.597"></a> +<span class="sourceLineNo">598</span> * @param callable this instance's {@link org.apache.hadoop.hbase.client.coprocessor.Batch<a name="line.598"></a> +<span class="sourceLineNo">599</span> * .Call#call}<a name="line.599"></a> +<span class="sourceLineNo">600</span> * method will be invoked once per table region, using the {@link com.google.protobuf.Service}<a name="line.600"></a> +<span class="sourceLineNo">601</span> * instance connected to that region.<a name="line.601"></a> +<span class="sourceLineNo">602</span> * @param <T> the {@link com.google.protobuf.Service} subclass to connect to<a name="line.602"></a> +<span class="sourceLineNo">603</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.603"></a> +<span class="sourceLineNo">604</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.604"></a> +<span class="sourceLineNo">605</span> * @return a map of result values keyed by region name<a name="line.605"></a> +<span class="sourceLineNo">606</span> */<a name="line.606"></a> +<span class="sourceLineNo">607</span> <T extends Service, R> Map<byte[],R> coprocessorService(final Class<T> service,<a name="line.607"></a> +<span class="sourceLineNo">608</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable)<a name="line.608"></a> +<span class="sourceLineNo">609</span> throws ServiceException, Throwable;<a name="line.609"></a> +<span class="sourceLineNo">610</span><a name="line.610"></a> +<span class="sourceLineNo">611</span> /**<a name="line.611"></a> +<span class="sourceLineNo">612</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.612"></a> +<span class="sourceLineNo">613</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), and<a name="line.613"></a> +<span class="sourceLineNo">614</span> * invokes the passed {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.614"></a> +<span class="sourceLineNo">615</span> * with each {@link Service} instance.<a name="line.615"></a> +<span class="sourceLineNo">616</span> *<a name="line.616"></a> +<span class="sourceLineNo">617</span> * <p> The given {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],<a name="line.617"></a> +<span class="sourceLineNo">618</span> * byte[], Object)} method will be called with the return value from each region's {@link<a name="line.618"></a> +<span class="sourceLineNo">619</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} invocation. </p><a name="line.619"></a> +<span class="sourceLineNo">620</span> *<a name="line.620"></a> +<span class="sourceLineNo">621</span> * @param service the protocol buffer {@code Service} implementation to call<a name="line.621"></a> +<span class="sourceLineNo">622</span> * @param startKey start region selection with region containing this row. If {@code null}, the<a name="line.622"></a> +<span class="sourceLineNo">623</span> * selection will start with the first table region.<a name="line.623"></a> +<span class="sourceLineNo">624</span> * @param endKey select regions up to and including the region containing this row. If {@code<a name="line.624"></a> +<span class="sourceLineNo">625</span> * null}, selection will continue through the last table region.<a name="line.625"></a> +<span class="sourceLineNo">626</span> * @param callable this instance's {@link org.apache.hadoop.hbase.client.coprocessor.Batch<a name="line.626"></a> +<span class="sourceLineNo">627</span> * .Call#call}<a name="line.627"></a> +<span class="sourceLineNo">628</span> * method will be invoked once per table region, using the {@link Service} instance connected to<a name="line.628"></a> +<span class="sourceLineNo">629</span> * that region.<a name="line.629"></a> +<span class="sourceLineNo">630</span> * @param callback<a name="line.630"></a> +<span class="sourceLineNo">631</span> * @param <T> the {@link Service} subclass to connect to<a name="line.631"></a> +<span class="sourceLineNo">632</span> * @param <R> Return type for the {@code callable} parameter's {@link<a name="line.632"></a> +<span class="sourceLineNo">633</span> * org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method<a name="line.633"></a> +<span class="sourceLineNo">634</span> */<a name="line.634"></a> +<span class="sourceLineNo">635</span> <T extends Service, R> void coprocessorService(final Class<T> service,<a name="line.635"></a> +<span class="sourceLineNo">636</span> byte[] startKey, byte[] endKey, final Batch.Call<T,R> callable,<a name="line.636"></a> +<span class="sourceLineNo">637</span> final Batch.Callback<R> callback) throws ServiceException, Throwable;<a name="line.637"></a> +<span class="sourceLineNo">638</span><a name="line.638"></a> +<span class="sourceLineNo">639</span> /**<a name="line.639"></a> +<span class="sourceLineNo">640</span> * Creates an instance of the given {@link com.google.protobuf.Service} subclass for each table<a name="line.640"></a> +<span class="sourceLineNo">641</span> * region spanning the range from the {@code startKey} row to {@code endKey} row (inclusive), all<a name="line.641"></a> +<span class="sourceLineNo">642</span> * the invocations to the same region server will be batched into one call. The coprocessor<a name="line.642"></a> +<span class="sourceLineNo">643</span> * service is invoked according to the service instance, method name and parameters.<a name="line.643"></a> +<span class="sourceLineNo">644</span> *<a name="line.644"></a> +<span class="sourceLineNo">645</span> * @param methodDescriptor<a name="line.645"></a> +<span class="sourceLineNo">646</span> * the descriptor for the protobuf service method to call.<a name="line.646"></a> +<span class="sourceLineNo">647</span> * @param request<a name="line.647"></a> +<span class="sourceLineNo">648</span> * the method call parameters<a name="line.648"></a> +<span class="sourceLineNo">649</span> * @param startKey<a name="line.649"></a> +<span class="sourceLineNo">650</span> * start region
<TRUNCATED>
