http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1b9384b2/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/Region.BulkLoadListener.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/Region.BulkLoadListener.html b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/Region.BulkLoadListener.html index 5acbf19..365d061 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/Region.BulkLoadListener.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/Region.BulkLoadListener.html @@ -193,523 +193,526 @@ <span class="sourceLineNo">185</span> */<a name="line.185"></a> <span class="sourceLineNo">186</span> void updateReadRequestsCount(long i);<a name="line.186"></a> <span class="sourceLineNo">187</span><a name="line.187"></a> -<span class="sourceLineNo">188</span> /** @return write request count for this region */<a name="line.188"></a> -<span class="sourceLineNo">189</span> long getWriteRequestsCount();<a name="line.189"></a> +<span class="sourceLineNo">188</span> /** @return filtered read requests count for this region */<a name="line.188"></a> +<span class="sourceLineNo">189</span> long getFilteredReadRequestsCount();<a name="line.189"></a> <span class="sourceLineNo">190</span><a name="line.190"></a> -<span class="sourceLineNo">191</span> /**<a name="line.191"></a> -<span class="sourceLineNo">192</span> * Update the write request count for this region<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @param i increment<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> void updateWriteRequestsCount(long i);<a name="line.195"></a> -<span class="sourceLineNo">196</span><a name="line.196"></a> -<span class="sourceLineNo">197</span> /** @return memstore size for this region, in bytes */<a name="line.197"></a> -<span class="sourceLineNo">198</span> long getMemstoreSize();<a name="line.198"></a> +<span class="sourceLineNo">191</span> /** @return write request count for this region */<a name="line.191"></a> +<span class="sourceLineNo">192</span> long getWriteRequestsCount();<a name="line.192"></a> +<span class="sourceLineNo">193</span><a name="line.193"></a> +<span class="sourceLineNo">194</span> /**<a name="line.194"></a> +<span class="sourceLineNo">195</span> * Update the write request count for this region<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @param i increment<a name="line.196"></a> +<span class="sourceLineNo">197</span> */<a name="line.197"></a> +<span class="sourceLineNo">198</span> void updateWriteRequestsCount(long i);<a name="line.198"></a> <span class="sourceLineNo">199</span><a name="line.199"></a> -<span class="sourceLineNo">200</span> /** @return the number of mutations processed bypassing the WAL */<a name="line.200"></a> -<span class="sourceLineNo">201</span> long getNumMutationsWithoutWAL();<a name="line.201"></a> +<span class="sourceLineNo">200</span> /** @return memstore size for this region, in bytes */<a name="line.200"></a> +<span class="sourceLineNo">201</span> long getMemstoreSize();<a name="line.201"></a> <span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> /** @return the size of data processed bypassing the WAL, in bytes */<a name="line.203"></a> -<span class="sourceLineNo">204</span> long getDataInMemoryWithoutWAL();<a name="line.204"></a> +<span class="sourceLineNo">203</span> /** @return the number of mutations processed bypassing the WAL */<a name="line.203"></a> +<span class="sourceLineNo">204</span> long getNumMutationsWithoutWAL();<a name="line.204"></a> <span class="sourceLineNo">205</span><a name="line.205"></a> -<span class="sourceLineNo">206</span> /** @return the number of blocked requests */<a name="line.206"></a> -<span class="sourceLineNo">207</span> long getBlockedRequestsCount();<a name="line.207"></a> +<span class="sourceLineNo">206</span> /** @return the size of data processed bypassing the WAL, in bytes */<a name="line.206"></a> +<span class="sourceLineNo">207</span> long getDataInMemoryWithoutWAL();<a name="line.207"></a> <span class="sourceLineNo">208</span><a name="line.208"></a> -<span class="sourceLineNo">209</span> /** @return the number of checkAndMutate guards that passed */<a name="line.209"></a> -<span class="sourceLineNo">210</span> long getCheckAndMutateChecksPassed();<a name="line.210"></a> +<span class="sourceLineNo">209</span> /** @return the number of blocked requests */<a name="line.209"></a> +<span class="sourceLineNo">210</span> long getBlockedRequestsCount();<a name="line.210"></a> <span class="sourceLineNo">211</span><a name="line.211"></a> -<span class="sourceLineNo">212</span> /** @return the number of failed checkAndMutate guards */<a name="line.212"></a> -<span class="sourceLineNo">213</span> long getCheckAndMutateChecksFailed();<a name="line.213"></a> +<span class="sourceLineNo">212</span> /** @return the number of checkAndMutate guards that passed */<a name="line.212"></a> +<span class="sourceLineNo">213</span> long getCheckAndMutateChecksPassed();<a name="line.213"></a> <span class="sourceLineNo">214</span><a name="line.214"></a> -<span class="sourceLineNo">215</span> /** @return the MetricsRegion for this region */<a name="line.215"></a> -<span class="sourceLineNo">216</span> MetricsRegion getMetrics();<a name="line.216"></a> +<span class="sourceLineNo">215</span> /** @return the number of failed checkAndMutate guards */<a name="line.215"></a> +<span class="sourceLineNo">216</span> long getCheckAndMutateChecksFailed();<a name="line.216"></a> <span class="sourceLineNo">217</span><a name="line.217"></a> -<span class="sourceLineNo">218</span> /** @return the block distribution for all Stores managed by this region */<a name="line.218"></a> -<span class="sourceLineNo">219</span> HDFSBlocksDistribution getHDFSBlocksDistribution();<a name="line.219"></a> +<span class="sourceLineNo">218</span> /** @return the MetricsRegion for this region */<a name="line.218"></a> +<span class="sourceLineNo">219</span> MetricsRegion getMetrics();<a name="line.219"></a> <span class="sourceLineNo">220</span><a name="line.220"></a> -<span class="sourceLineNo">221</span> ///////////////////////////////////////////////////////////////////////////<a name="line.221"></a> -<span class="sourceLineNo">222</span> // Locking<a name="line.222"></a> +<span class="sourceLineNo">221</span> /** @return the block distribution for all Stores managed by this region */<a name="line.221"></a> +<span class="sourceLineNo">222</span> HDFSBlocksDistribution getHDFSBlocksDistribution();<a name="line.222"></a> <span class="sourceLineNo">223</span><a name="line.223"></a> -<span class="sourceLineNo">224</span> // Region read locks<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> /**<a name="line.226"></a> -<span class="sourceLineNo">227</span> * Operation enum is used in {@link Region#startRegionOperation} and elsewhere to provide<a name="line.227"></a> -<span class="sourceLineNo">228</span> * context for various checks.<a name="line.228"></a> -<span class="sourceLineNo">229</span> */<a name="line.229"></a> -<span class="sourceLineNo">230</span> enum Operation {<a name="line.230"></a> -<span class="sourceLineNo">231</span> ANY, GET, PUT, DELETE, SCAN, APPEND, INCREMENT, SPLIT_REGION, MERGE_REGION, BATCH_MUTATE,<a name="line.231"></a> -<span class="sourceLineNo">232</span> REPLAY_BATCH_MUTATE, COMPACT_REGION, REPLAY_EVENT<a name="line.232"></a> -<span class="sourceLineNo">233</span> }<a name="line.233"></a> -<span class="sourceLineNo">234</span><a name="line.234"></a> -<span class="sourceLineNo">235</span> /**<a name="line.235"></a> -<span class="sourceLineNo">236</span> * This method needs to be called before any public call that reads or<a name="line.236"></a> -<span class="sourceLineNo">237</span> * modifies data.<a name="line.237"></a> -<span class="sourceLineNo">238</span> * Acquires a read lock and checks if the region is closing or closed.<a name="line.238"></a> -<span class="sourceLineNo">239</span> * <p>{@link #closeRegionOperation} MUST then always be called after<a name="line.239"></a> -<span class="sourceLineNo">240</span> * the operation has completed, whether it succeeded or failed.<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @throws IOException<a name="line.241"></a> -<span class="sourceLineNo">242</span> */<a name="line.242"></a> -<span class="sourceLineNo">243</span> void startRegionOperation() throws IOException;<a name="line.243"></a> -<span class="sourceLineNo">244</span><a name="line.244"></a> -<span class="sourceLineNo">245</span> /**<a name="line.245"></a> -<span class="sourceLineNo">246</span> * This method needs to be called before any public call that reads or<a name="line.246"></a> -<span class="sourceLineNo">247</span> * modifies data.<a name="line.247"></a> -<span class="sourceLineNo">248</span> * Acquires a read lock and checks if the region is closing or closed.<a name="line.248"></a> -<span class="sourceLineNo">249</span> * <p>{@link #closeRegionOperation} MUST then always be called after<a name="line.249"></a> -<span class="sourceLineNo">250</span> * the operation has completed, whether it succeeded or failed.<a name="line.250"></a> -<span class="sourceLineNo">251</span> * @param op The operation is about to be taken on the region<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @throws IOException<a name="line.252"></a> -<span class="sourceLineNo">253</span> */<a name="line.253"></a> -<span class="sourceLineNo">254</span> void startRegionOperation(Operation op) throws IOException;<a name="line.254"></a> -<span class="sourceLineNo">255</span><a name="line.255"></a> -<span class="sourceLineNo">256</span> /**<a name="line.256"></a> -<span class="sourceLineNo">257</span> * Closes the region operation lock.<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @throws IOException<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> void closeRegionOperation() throws IOException;<a name="line.260"></a> -<span class="sourceLineNo">261</span><a name="line.261"></a> -<span class="sourceLineNo">262</span> // Row write locks<a name="line.262"></a> -<span class="sourceLineNo">263</span><a name="line.263"></a> -<span class="sourceLineNo">264</span> /**<a name="line.264"></a> -<span class="sourceLineNo">265</span> * Row lock held by a given thread.<a name="line.265"></a> -<span class="sourceLineNo">266</span> * One thread may acquire multiple locks on the same row simultaneously.<a name="line.266"></a> -<span class="sourceLineNo">267</span> * The locks must be released by calling release() from the same thread.<a name="line.267"></a> -<span class="sourceLineNo">268</span> */<a name="line.268"></a> -<span class="sourceLineNo">269</span> public interface RowLock {<a name="line.269"></a> -<span class="sourceLineNo">270</span> /**<a name="line.270"></a> -<span class="sourceLineNo">271</span> * Release the given lock. If there are no remaining locks held by the current thread<a name="line.271"></a> -<span class="sourceLineNo">272</span> * then unlock the row and allow other threads to acquire the lock.<a name="line.272"></a> -<span class="sourceLineNo">273</span> * @throws IllegalArgumentException if called by a different thread than the lock owning<a name="line.273"></a> -<span class="sourceLineNo">274</span> * thread<a name="line.274"></a> -<span class="sourceLineNo">275</span> */<a name="line.275"></a> -<span class="sourceLineNo">276</span> void release();<a name="line.276"></a> -<span class="sourceLineNo">277</span> }<a name="line.277"></a> -<span class="sourceLineNo">278</span><a name="line.278"></a> -<span class="sourceLineNo">279</span> /**<a name="line.279"></a> -<span class="sourceLineNo">280</span> * Tries to acquire a lock on the given row.<a name="line.280"></a> -<span class="sourceLineNo">281</span> * @param waitForLock if true, will block until the lock is available.<a name="line.281"></a> -<span class="sourceLineNo">282</span> * Otherwise, just tries to obtain the lock and returns<a name="line.282"></a> -<span class="sourceLineNo">283</span> * false if unavailable.<a name="line.283"></a> -<span class="sourceLineNo">284</span> * @return the row lock if acquired,<a name="line.284"></a> -<span class="sourceLineNo">285</span> * null if waitForLock was false and the lock was not acquired<a name="line.285"></a> -<span class="sourceLineNo">286</span> * @throws IOException if waitForLock was true and the lock could not be acquired after waiting<a name="line.286"></a> -<span class="sourceLineNo">287</span> */<a name="line.287"></a> -<span class="sourceLineNo">288</span> RowLock getRowLock(byte[] row, boolean waitForLock) throws IOException;<a name="line.288"></a> -<span class="sourceLineNo">289</span><a name="line.289"></a> -<span class="sourceLineNo">290</span> /**<a name="line.290"></a> -<span class="sourceLineNo">291</span> * If the given list of row locks is not null, releases all locks.<a name="line.291"></a> -<span class="sourceLineNo">292</span> */<a name="line.292"></a> -<span class="sourceLineNo">293</span> void releaseRowLocks(List<RowLock> rowLocks);<a name="line.293"></a> -<span class="sourceLineNo">294</span><a name="line.294"></a> -<span class="sourceLineNo">295</span> ///////////////////////////////////////////////////////////////////////////<a name="line.295"></a> -<span class="sourceLineNo">296</span> // Region operations<a name="line.296"></a> +<span class="sourceLineNo">224</span> ///////////////////////////////////////////////////////////////////////////<a name="line.224"></a> +<span class="sourceLineNo">225</span> // Locking<a name="line.225"></a> +<span class="sourceLineNo">226</span><a name="line.226"></a> +<span class="sourceLineNo">227</span> // Region read locks<a name="line.227"></a> +<span class="sourceLineNo">228</span><a name="line.228"></a> +<span class="sourceLineNo">229</span> /**<a name="line.229"></a> +<span class="sourceLineNo">230</span> * Operation enum is used in {@link Region#startRegionOperation} and elsewhere to provide<a name="line.230"></a> +<span class="sourceLineNo">231</span> * context for various checks.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> enum Operation {<a name="line.233"></a> +<span class="sourceLineNo">234</span> ANY, GET, PUT, DELETE, SCAN, APPEND, INCREMENT, SPLIT_REGION, MERGE_REGION, BATCH_MUTATE,<a name="line.234"></a> +<span class="sourceLineNo">235</span> REPLAY_BATCH_MUTATE, COMPACT_REGION, REPLAY_EVENT<a name="line.235"></a> +<span class="sourceLineNo">236</span> }<a name="line.236"></a> +<span class="sourceLineNo">237</span><a name="line.237"></a> +<span class="sourceLineNo">238</span> /**<a name="line.238"></a> +<span class="sourceLineNo">239</span> * This method needs to be called before any public call that reads or<a name="line.239"></a> +<span class="sourceLineNo">240</span> * modifies data.<a name="line.240"></a> +<span class="sourceLineNo">241</span> * Acquires a read lock and checks if the region is closing or closed.<a name="line.241"></a> +<span class="sourceLineNo">242</span> * <p>{@link #closeRegionOperation} MUST then always be called after<a name="line.242"></a> +<span class="sourceLineNo">243</span> * the operation has completed, whether it succeeded or failed.<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @throws IOException<a name="line.244"></a> +<span class="sourceLineNo">245</span> */<a name="line.245"></a> +<span class="sourceLineNo">246</span> void startRegionOperation() throws IOException;<a name="line.246"></a> +<span class="sourceLineNo">247</span><a name="line.247"></a> +<span class="sourceLineNo">248</span> /**<a name="line.248"></a> +<span class="sourceLineNo">249</span> * This method needs to be called before any public call that reads or<a name="line.249"></a> +<span class="sourceLineNo">250</span> * modifies data.<a name="line.250"></a> +<span class="sourceLineNo">251</span> * Acquires a read lock and checks if the region is closing or closed.<a name="line.251"></a> +<span class="sourceLineNo">252</span> * <p>{@link #closeRegionOperation} MUST then always be called after<a name="line.252"></a> +<span class="sourceLineNo">253</span> * the operation has completed, whether it succeeded or failed.<a name="line.253"></a> +<span class="sourceLineNo">254</span> * @param op The operation is about to be taken on the region<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @throws IOException<a name="line.255"></a> +<span class="sourceLineNo">256</span> */<a name="line.256"></a> +<span class="sourceLineNo">257</span> void startRegionOperation(Operation op) throws IOException;<a name="line.257"></a> +<span class="sourceLineNo">258</span><a name="line.258"></a> +<span class="sourceLineNo">259</span> /**<a name="line.259"></a> +<span class="sourceLineNo">260</span> * Closes the region operation lock.<a name="line.260"></a> +<span class="sourceLineNo">261</span> * @throws IOException<a name="line.261"></a> +<span class="sourceLineNo">262</span> */<a name="line.262"></a> +<span class="sourceLineNo">263</span> void closeRegionOperation() throws IOException;<a name="line.263"></a> +<span class="sourceLineNo">264</span><a name="line.264"></a> +<span class="sourceLineNo">265</span> // Row write locks<a name="line.265"></a> +<span class="sourceLineNo">266</span><a name="line.266"></a> +<span class="sourceLineNo">267</span> /**<a name="line.267"></a> +<span class="sourceLineNo">268</span> * Row lock held by a given thread.<a name="line.268"></a> +<span class="sourceLineNo">269</span> * One thread may acquire multiple locks on the same row simultaneously.<a name="line.269"></a> +<span class="sourceLineNo">270</span> * The locks must be released by calling release() from the same thread.<a name="line.270"></a> +<span class="sourceLineNo">271</span> */<a name="line.271"></a> +<span class="sourceLineNo">272</span> public interface RowLock {<a name="line.272"></a> +<span class="sourceLineNo">273</span> /**<a name="line.273"></a> +<span class="sourceLineNo">274</span> * Release the given lock. If there are no remaining locks held by the current thread<a name="line.274"></a> +<span class="sourceLineNo">275</span> * then unlock the row and allow other threads to acquire the lock.<a name="line.275"></a> +<span class="sourceLineNo">276</span> * @throws IllegalArgumentException if called by a different thread than the lock owning<a name="line.276"></a> +<span class="sourceLineNo">277</span> * thread<a name="line.277"></a> +<span class="sourceLineNo">278</span> */<a name="line.278"></a> +<span class="sourceLineNo">279</span> void release();<a name="line.279"></a> +<span class="sourceLineNo">280</span> }<a name="line.280"></a> +<span class="sourceLineNo">281</span><a name="line.281"></a> +<span class="sourceLineNo">282</span> /**<a name="line.282"></a> +<span class="sourceLineNo">283</span> * Tries to acquire a lock on the given row.<a name="line.283"></a> +<span class="sourceLineNo">284</span> * @param waitForLock if true, will block until the lock is available.<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Otherwise, just tries to obtain the lock and returns<a name="line.285"></a> +<span class="sourceLineNo">286</span> * false if unavailable.<a name="line.286"></a> +<span class="sourceLineNo">287</span> * @return the row lock if acquired,<a name="line.287"></a> +<span class="sourceLineNo">288</span> * null if waitForLock was false and the lock was not acquired<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @throws IOException if waitForLock was true and the lock could not be acquired after waiting<a name="line.289"></a> +<span class="sourceLineNo">290</span> */<a name="line.290"></a> +<span class="sourceLineNo">291</span> RowLock getRowLock(byte[] row, boolean waitForLock) throws IOException;<a name="line.291"></a> +<span class="sourceLineNo">292</span><a name="line.292"></a> +<span class="sourceLineNo">293</span> /**<a name="line.293"></a> +<span class="sourceLineNo">294</span> * If the given list of row locks is not null, releases all locks.<a name="line.294"></a> +<span class="sourceLineNo">295</span> */<a name="line.295"></a> +<span class="sourceLineNo">296</span> void releaseRowLocks(List<RowLock> rowLocks);<a name="line.296"></a> <span class="sourceLineNo">297</span><a name="line.297"></a> -<span class="sourceLineNo">298</span> /**<a name="line.298"></a> -<span class="sourceLineNo">299</span> * Perform one or more append operations on a row.<a name="line.299"></a> -<span class="sourceLineNo">300</span> * @param append<a name="line.300"></a> -<span class="sourceLineNo">301</span> * @param nonceGroup<a name="line.301"></a> -<span class="sourceLineNo">302</span> * @param nonce<a name="line.302"></a> -<span class="sourceLineNo">303</span> * @return result of the operation<a name="line.303"></a> -<span class="sourceLineNo">304</span> * @throws IOException<a name="line.304"></a> -<span class="sourceLineNo">305</span> */<a name="line.305"></a> -<span class="sourceLineNo">306</span> Result append(Append append, long nonceGroup, long nonce) throws IOException;<a name="line.306"></a> -<span class="sourceLineNo">307</span><a name="line.307"></a> -<span class="sourceLineNo">308</span> /**<a name="line.308"></a> -<span class="sourceLineNo">309</span> * Perform a batch of mutations.<a name="line.309"></a> -<span class="sourceLineNo">310</span> * <p><a name="line.310"></a> -<span class="sourceLineNo">311</span> * Note this supports only Put and Delete mutations and will ignore other types passed.<a name="line.311"></a> -<span class="sourceLineNo">312</span> * @param mutations the list of mutations<a name="line.312"></a> -<span class="sourceLineNo">313</span> * @param nonceGroup<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @param nonce<a name="line.314"></a> -<span class="sourceLineNo">315</span> * @return an array of OperationStatus which internally contains the<a name="line.315"></a> -<span class="sourceLineNo">316</span> * OperationStatusCode and the exceptionMessage if any.<a name="line.316"></a> -<span class="sourceLineNo">317</span> * @throws IOException<a name="line.317"></a> -<span class="sourceLineNo">318</span> */<a name="line.318"></a> -<span class="sourceLineNo">319</span> OperationStatus[] batchMutate(Mutation[] mutations, long nonceGroup, long nonce)<a name="line.319"></a> -<span class="sourceLineNo">320</span> 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> * Replay a batch of mutations.<a name="line.323"></a> -<span class="sourceLineNo">324</span> * @param mutations mutations to replay.<a name="line.324"></a> -<span class="sourceLineNo">325</span> * @param replaySeqId<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @return an array of OperationStatus which internally contains the<a name="line.326"></a> -<span class="sourceLineNo">327</span> * OperationStatusCode and the exceptionMessage if any.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * @throws IOException<a name="line.328"></a> -<span class="sourceLineNo">329</span> */<a name="line.329"></a> -<span class="sourceLineNo">330</span> OperationStatus[] batchReplay(MutationReplay[] mutations, long replaySeqId) throws IOException;<a name="line.330"></a> -<span class="sourceLineNo">331</span><a name="line.331"></a> -<span class="sourceLineNo">332</span> /**<a name="line.332"></a> -<span class="sourceLineNo">333</span> * Atomically checks if a row/family/qualifier value matches the expected value and if it does,<a name="line.333"></a> -<span class="sourceLineNo">334</span> * it performs the mutation. If the passed value is null, the lack of column value<a name="line.334"></a> -<span class="sourceLineNo">335</span> * (ie: non-existence) is used. See checkAndRowMutate to do many checkAndPuts at a time on a<a name="line.335"></a> -<span class="sourceLineNo">336</span> * single row.<a name="line.336"></a> -<span class="sourceLineNo">337</span> * @param row to check<a name="line.337"></a> -<span class="sourceLineNo">338</span> * @param family column family to check<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @param qualifier column qualifier to check<a name="line.339"></a> -<span class="sourceLineNo">340</span> * @param compareOp the comparison operator<a name="line.340"></a> -<span class="sourceLineNo">341</span> * @param comparator<a name="line.341"></a> -<span class="sourceLineNo">342</span> * @param mutation<a name="line.342"></a> -<span class="sourceLineNo">343</span> * @param writeToWAL<a name="line.343"></a> -<span class="sourceLineNo">344</span> * @return true if mutation was applied, false otherwise<a name="line.344"></a> -<span class="sourceLineNo">345</span> * @throws IOException<a name="line.345"></a> -<span class="sourceLineNo">346</span> */<a name="line.346"></a> -<span class="sourceLineNo">347</span> boolean checkAndMutate(byte [] row, byte [] family, byte [] qualifier, CompareOp compareOp,<a name="line.347"></a> -<span class="sourceLineNo">348</span> ByteArrayComparable comparator, Mutation mutation, boolean writeToWAL) 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 values and if it does,<a name="line.351"></a> -<span class="sourceLineNo">352</span> * it performs the row mutations. If the passed value is null, the lack of column value<a name="line.352"></a> -<span class="sourceLineNo">353</span> * (ie: non-existence) is used. Use to do many mutations on a single row. Use checkAndMutate<a name="line.353"></a> -<span class="sourceLineNo">354</span> * to do one checkAndMutate at a time.<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 compareOp the comparison operator<a name="line.358"></a> -<span class="sourceLineNo">359</span> * @param comparator<a name="line.359"></a> -<span class="sourceLineNo">360</span> * @param mutations<a name="line.360"></a> -<span class="sourceLineNo">361</span> * @param writeToWAL<a name="line.361"></a> -<span class="sourceLineNo">362</span> * @return true if mutations were applied, false otherwise<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @throws IOException<a name="line.363"></a> -<span class="sourceLineNo">364</span> */<a name="line.364"></a> -<span class="sourceLineNo">365</span> boolean checkAndRowMutate(byte [] row, byte [] family, byte [] qualifier, CompareOp compareOp,<a name="line.365"></a> -<span class="sourceLineNo">366</span> ByteArrayComparable comparator, RowMutations mutations, boolean writeToWAL)<a name="line.366"></a> -<span class="sourceLineNo">367</span> throws IOException;<a name="line.367"></a> -<span class="sourceLineNo">368</span><a name="line.368"></a> -<span class="sourceLineNo">369</span> /**<a name="line.369"></a> -<span class="sourceLineNo">370</span> * Deletes the specified cells/row.<a name="line.370"></a> -<span class="sourceLineNo">371</span> * @param delete<a name="line.371"></a> -<span class="sourceLineNo">372</span> * @throws IOException<a name="line.372"></a> -<span class="sourceLineNo">373</span> */<a name="line.373"></a> -<span class="sourceLineNo">374</span> void delete(Delete delete) throws IOException;<a name="line.374"></a> -<span class="sourceLineNo">375</span><a name="line.375"></a> -<span class="sourceLineNo">376</span> /**<a name="line.376"></a> -<span class="sourceLineNo">377</span> * Do a get based on the get parameter.<a name="line.377"></a> -<span class="sourceLineNo">378</span> * @param get query parameters<a name="line.378"></a> -<span class="sourceLineNo">379</span> * @return result of the operation<a name="line.379"></a> -<span class="sourceLineNo">380</span> */<a name="line.380"></a> -<span class="sourceLineNo">381</span> Result get(Get get) throws IOException;<a name="line.381"></a> -<span class="sourceLineNo">382</span><a name="line.382"></a> -<span class="sourceLineNo">383</span> /**<a name="line.383"></a> -<span class="sourceLineNo">384</span> * Do a get based on the get parameter.<a name="line.384"></a> -<span class="sourceLineNo">385</span> * @param get query parameters<a name="line.385"></a> -<span class="sourceLineNo">386</span> * @param withCoprocessor invoke coprocessor or not. We don't want to<a name="line.386"></a> -<span class="sourceLineNo">387</span> * always invoke cp.<a name="line.387"></a> -<span class="sourceLineNo">388</span> * @return list of cells resulting from the operation<a name="line.388"></a> -<span class="sourceLineNo">389</span> */<a name="line.389"></a> -<span class="sourceLineNo">390</span> List<Cell> get(Get get, boolean withCoprocessor) 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> * Return an iterator that scans over the HRegion, returning the indicated<a name="line.393"></a> -<span class="sourceLineNo">394</span> * columns and rows specified by the {@link Scan}.<a name="line.394"></a> -<span class="sourceLineNo">395</span> * <p><a name="line.395"></a> -<span class="sourceLineNo">396</span> * This Iterator must be closed by the caller.<a name="line.396"></a> -<span class="sourceLineNo">397</span> *<a name="line.397"></a> -<span class="sourceLineNo">398</span> * @param scan configured {@link Scan}<a name="line.398"></a> -<span class="sourceLineNo">399</span> * @return RegionScanner<a name="line.399"></a> -<span class="sourceLineNo">400</span> * @throws IOException read exceptions<a name="line.400"></a> -<span class="sourceLineNo">401</span> */<a name="line.401"></a> -<span class="sourceLineNo">402</span> RegionScanner getScanner(Scan scan) throws IOException;<a name="line.402"></a> -<span class="sourceLineNo">403</span><a name="line.403"></a> -<span class="sourceLineNo">404</span> /**<a name="line.404"></a> -<span class="sourceLineNo">405</span> * Return an iterator that scans over the HRegion, returning the indicated columns and rows<a name="line.405"></a> -<span class="sourceLineNo">406</span> * specified by the {@link Scan}. The scanner will also include the additional scanners passed<a name="line.406"></a> -<span class="sourceLineNo">407</span> * along with the scanners for the specified Scan instance. Should be careful with the usage to<a name="line.407"></a> -<span class="sourceLineNo">408</span> * pass additional scanners only within this Region<a name="line.408"></a> -<span class="sourceLineNo">409</span> * <p><a name="line.409"></a> -<span class="sourceLineNo">410</span> * This Iterator must be closed by the caller.<a name="line.410"></a> -<span class="sourceLineNo">411</span> *<a name="line.411"></a> -<span class="sourceLineNo">412</span> * @param scan configured {@link Scan}<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @param additionalScanners Any additional scanners to be used<a name="line.413"></a> -<span class="sourceLineNo">414</span> * @return RegionScanner<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @throws IOException read exceptions<a name="line.415"></a> -<span class="sourceLineNo">416</span> */<a name="line.416"></a> -<span class="sourceLineNo">417</span> RegionScanner getScanner(Scan scan, List<KeyValueScanner> additionalScanners) throws IOException;<a name="line.417"></a> -<span class="sourceLineNo">418</span><a name="line.418"></a> -<span class="sourceLineNo">419</span> /** The comparator to be used with the region */<a name="line.419"></a> -<span class="sourceLineNo">420</span> CellComparator getCellCompartor();<a name="line.420"></a> +<span class="sourceLineNo">298</span> ///////////////////////////////////////////////////////////////////////////<a name="line.298"></a> +<span class="sourceLineNo">299</span> // Region operations<a name="line.299"></a> +<span class="sourceLineNo">300</span><a name="line.300"></a> +<span class="sourceLineNo">301</span> /**<a name="line.301"></a> +<span class="sourceLineNo">302</span> * Perform one or more append operations on a row.<a name="line.302"></a> +<span class="sourceLineNo">303</span> * @param append<a name="line.303"></a> +<span class="sourceLineNo">304</span> * @param nonceGroup<a name="line.304"></a> +<span class="sourceLineNo">305</span> * @param nonce<a name="line.305"></a> +<span class="sourceLineNo">306</span> * @return result of the operation<a name="line.306"></a> +<span class="sourceLineNo">307</span> * @throws IOException<a name="line.307"></a> +<span class="sourceLineNo">308</span> */<a name="line.308"></a> +<span class="sourceLineNo">309</span> Result append(Append append, long nonceGroup, long nonce) throws IOException;<a name="line.309"></a> +<span class="sourceLineNo">310</span><a name="line.310"></a> +<span class="sourceLineNo">311</span> /**<a name="line.311"></a> +<span class="sourceLineNo">312</span> * Perform a batch of mutations.<a name="line.312"></a> +<span class="sourceLineNo">313</span> * <p><a name="line.313"></a> +<span class="sourceLineNo">314</span> * Note this supports only Put and Delete mutations and will ignore other types passed.<a name="line.314"></a> +<span class="sourceLineNo">315</span> * @param mutations the list of mutations<a name="line.315"></a> +<span class="sourceLineNo">316</span> * @param nonceGroup<a name="line.316"></a> +<span class="sourceLineNo">317</span> * @param nonce<a name="line.317"></a> +<span class="sourceLineNo">318</span> * @return an array of OperationStatus which internally contains the<a name="line.318"></a> +<span class="sourceLineNo">319</span> * OperationStatusCode and the exceptionMessage if any.<a name="line.319"></a> +<span class="sourceLineNo">320</span> * @throws IOException<a name="line.320"></a> +<span class="sourceLineNo">321</span> */<a name="line.321"></a> +<span class="sourceLineNo">322</span> OperationStatus[] batchMutate(Mutation[] mutations, long nonceGroup, long nonce)<a name="line.322"></a> +<span class="sourceLineNo">323</span> 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> * Replay a batch of mutations.<a name="line.326"></a> +<span class="sourceLineNo">327</span> * @param mutations mutations to replay.<a name="line.327"></a> +<span class="sourceLineNo">328</span> * @param replaySeqId<a name="line.328"></a> +<span class="sourceLineNo">329</span> * @return an array of OperationStatus which internally contains the<a name="line.329"></a> +<span class="sourceLineNo">330</span> * OperationStatusCode and the exceptionMessage if any.<a name="line.330"></a> +<span class="sourceLineNo">331</span> * @throws IOException<a name="line.331"></a> +<span class="sourceLineNo">332</span> */<a name="line.332"></a> +<span class="sourceLineNo">333</span> OperationStatus[] batchReplay(MutationReplay[] mutations, long replaySeqId) throws IOException;<a name="line.333"></a> +<span class="sourceLineNo">334</span><a name="line.334"></a> +<span class="sourceLineNo">335</span> /**<a name="line.335"></a> +<span class="sourceLineNo">336</span> * Atomically checks if a row/family/qualifier value matches the expected value and if it does,<a name="line.336"></a> +<span class="sourceLineNo">337</span> * it performs the mutation. If the passed value is null, the lack of column value<a name="line.337"></a> +<span class="sourceLineNo">338</span> * (ie: non-existence) is used. See checkAndRowMutate to do many checkAndPuts at a time on a<a name="line.338"></a> +<span class="sourceLineNo">339</span> * single row.<a name="line.339"></a> +<span class="sourceLineNo">340</span> * @param row to check<a name="line.340"></a> +<span class="sourceLineNo">341</span> * @param family column family to check<a name="line.341"></a> +<span class="sourceLineNo">342</span> * @param qualifier column qualifier to check<a name="line.342"></a> +<span class="sourceLineNo">343</span> * @param compareOp the comparison operator<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @param comparator<a name="line.344"></a> +<span class="sourceLineNo">345</span> * @param mutation<a name="line.345"></a> +<span class="sourceLineNo">346</span> * @param writeToWAL<a name="line.346"></a> +<span class="sourceLineNo">347</span> * @return true if mutation was applied, false otherwise<a name="line.347"></a> +<span class="sourceLineNo">348</span> * @throws IOException<a name="line.348"></a> +<span class="sourceLineNo">349</span> */<a name="line.349"></a> +<span class="sourceLineNo">350</span> boolean checkAndMutate(byte [] row, byte [] family, byte [] qualifier, CompareOp compareOp,<a name="line.350"></a> +<span class="sourceLineNo">351</span> ByteArrayComparable comparator, Mutation mutation, boolean writeToWAL) throws IOException;<a name="line.351"></a> +<span class="sourceLineNo">352</span><a name="line.352"></a> +<span class="sourceLineNo">353</span> /**<a name="line.353"></a> +<span class="sourceLineNo">354</span> * Atomically checks if a row/family/qualifier value matches the expected values and if it does,<a name="line.354"></a> +<span class="sourceLineNo">355</span> * it performs the row mutations. If the passed value is null, the lack of column value<a name="line.355"></a> +<span class="sourceLineNo">356</span> * (ie: non-existence) is used. Use to do many mutations on a single row. Use checkAndMutate<a name="line.356"></a> +<span class="sourceLineNo">357</span> * to do one checkAndMutate at a time.<a name="line.357"></a> +<span class="sourceLineNo">358</span> * @param row to check<a name="line.358"></a> +<span class="sourceLineNo">359</span> * @param family column family to check<a name="line.359"></a> +<span class="sourceLineNo">360</span> * @param qualifier column qualifier to check<a name="line.360"></a> +<span class="sourceLineNo">361</span> * @param compareOp the comparison operator<a name="line.361"></a> +<span class="sourceLineNo">362</span> * @param comparator<a name="line.362"></a> +<span class="sourceLineNo">363</span> * @param mutations<a name="line.363"></a> +<span class="sourceLineNo">364</span> * @param writeToWAL<a name="line.364"></a> +<span class="sourceLineNo">365</span> * @return true if mutations were applied, false otherwise<a name="line.365"></a> +<span class="sourceLineNo">366</span> * @throws IOException<a name="line.366"></a> +<span class="sourceLineNo">367</span> */<a name="line.367"></a> +<span class="sourceLineNo">368</span> boolean checkAndRowMutate(byte [] row, byte [] family, byte [] qualifier, CompareOp compareOp,<a name="line.368"></a> +<span class="sourceLineNo">369</span> ByteArrayComparable comparator, RowMutations mutations, boolean writeToWAL)<a name="line.369"></a> +<span class="sourceLineNo">370</span> throws IOException;<a name="line.370"></a> +<span class="sourceLineNo">371</span><a name="line.371"></a> +<span class="sourceLineNo">372</span> /**<a name="line.372"></a> +<span class="sourceLineNo">373</span> * Deletes the specified cells/row.<a name="line.373"></a> +<span class="sourceLineNo">374</span> * @param delete<a name="line.374"></a> +<span class="sourceLineNo">375</span> * @throws IOException<a name="line.375"></a> +<span class="sourceLineNo">376</span> */<a name="line.376"></a> +<span class="sourceLineNo">377</span> void delete(Delete delete) throws IOException;<a name="line.377"></a> +<span class="sourceLineNo">378</span><a name="line.378"></a> +<span class="sourceLineNo">379</span> /**<a name="line.379"></a> +<span class="sourceLineNo">380</span> * Do a get based on the get parameter.<a name="line.380"></a> +<span class="sourceLineNo">381</span> * @param get query parameters<a name="line.381"></a> +<span class="sourceLineNo">382</span> * @return result of the operation<a name="line.382"></a> +<span class="sourceLineNo">383</span> */<a name="line.383"></a> +<span class="sourceLineNo">384</span> Result get(Get get) throws IOException;<a name="line.384"></a> +<span class="sourceLineNo">385</span><a name="line.385"></a> +<span class="sourceLineNo">386</span> /**<a name="line.386"></a> +<span class="sourceLineNo">387</span> * Do a get based on the get parameter.<a name="line.387"></a> +<span class="sourceLineNo">388</span> * @param get query parameters<a name="line.388"></a> +<span class="sourceLineNo">389</span> * @param withCoprocessor invoke coprocessor or not. We don't want to<a name="line.389"></a> +<span class="sourceLineNo">390</span> * always invoke cp.<a name="line.390"></a> +<span class="sourceLineNo">391</span> * @return list of cells resulting from the operation<a name="line.391"></a> +<span class="sourceLineNo">392</span> */<a name="line.392"></a> +<span class="sourceLineNo">393</span> List<Cell> get(Get get, boolean withCoprocessor) throws IOException;<a name="line.393"></a> +<span class="sourceLineNo">394</span><a name="line.394"></a> +<span class="sourceLineNo">395</span> /**<a name="line.395"></a> +<span class="sourceLineNo">396</span> * Return an iterator that scans over the HRegion, returning the indicated<a name="line.396"></a> +<span class="sourceLineNo">397</span> * columns and rows specified by the {@link Scan}.<a name="line.397"></a> +<span class="sourceLineNo">398</span> * <p><a name="line.398"></a> +<span class="sourceLineNo">399</span> * This Iterator must be closed by the caller.<a name="line.399"></a> +<span class="sourceLineNo">400</span> *<a name="line.400"></a> +<span class="sourceLineNo">401</span> * @param scan configured {@link Scan}<a name="line.401"></a> +<span class="sourceLineNo">402</span> * @return RegionScanner<a name="line.402"></a> +<span class="sourceLineNo">403</span> * @throws IOException read exceptions<a name="line.403"></a> +<span class="sourceLineNo">404</span> */<a name="line.404"></a> +<span class="sourceLineNo">405</span> RegionScanner getScanner(Scan scan) throws IOException;<a name="line.405"></a> +<span class="sourceLineNo">406</span><a name="line.406"></a> +<span class="sourceLineNo">407</span> /**<a name="line.407"></a> +<span class="sourceLineNo">408</span> * Return an iterator that scans over the HRegion, returning the indicated columns and rows<a name="line.408"></a> +<span class="sourceLineNo">409</span> * specified by the {@link Scan}. The scanner will also include the additional scanners passed<a name="line.409"></a> +<span class="sourceLineNo">410</span> * along with the scanners for the specified Scan instance. Should be careful with the usage to<a name="line.410"></a> +<span class="sourceLineNo">411</span> * pass additional scanners only within this Region<a name="line.411"></a> +<span class="sourceLineNo">412</span> * <p><a name="line.412"></a> +<span class="sourceLineNo">413</span> * This Iterator must be closed by the caller.<a name="line.413"></a> +<span class="sourceLineNo">414</span> *<a name="line.414"></a> +<span class="sourceLineNo">415</span> * @param scan configured {@link Scan}<a name="line.415"></a> +<span class="sourceLineNo">416</span> * @param additionalScanners Any additional scanners to be used<a name="line.416"></a> +<span class="sourceLineNo">417</span> * @return RegionScanner<a name="line.417"></a> +<span class="sourceLineNo">418</span> * @throws IOException read exceptions<a name="line.418"></a> +<span class="sourceLineNo">419</span> */<a name="line.419"></a> +<span class="sourceLineNo">420</span> RegionScanner getScanner(Scan scan, List<KeyValueScanner> additionalScanners) throws IOException;<a name="line.420"></a> <span class="sourceLineNo">421</span><a name="line.421"></a> -<span class="sourceLineNo">422</span> /**<a name="line.422"></a> -<span class="sourceLineNo">423</span> * Perform one or more increment operations on a row.<a name="line.423"></a> -<span class="sourceLineNo">424</span> * @param increment<a name="line.424"></a> -<span class="sourceLineNo">425</span> * @param nonceGroup<a name="line.425"></a> -<span class="sourceLineNo">426</span> * @param nonce<a name="line.426"></a> -<span class="sourceLineNo">427</span> * @return result of the operation<a name="line.427"></a> -<span class="sourceLineNo">428</span> * @throws IOException<a name="line.428"></a> -<span class="sourceLineNo">429</span> */<a name="line.429"></a> -<span class="sourceLineNo">430</span> Result increment(Increment increment, long nonceGroup, long nonce) throws IOException;<a name="line.430"></a> -<span class="sourceLineNo">431</span><a name="line.431"></a> -<span class="sourceLineNo">432</span> /**<a name="line.432"></a> -<span class="sourceLineNo">433</span> * Performs multiple mutations atomically on a single row. Currently<a name="line.433"></a> -<span class="sourceLineNo">434</span> * {@link Put} and {@link Delete} are supported.<a name="line.434"></a> -<span class="sourceLineNo">435</span> *<a name="line.435"></a> -<span class="sourceLineNo">436</span> * @param mutations object that specifies the set of mutations to perform atomically<a name="line.436"></a> -<span class="sourceLineNo">437</span> * @throws IOException<a name="line.437"></a> -<span class="sourceLineNo">438</span> */<a name="line.438"></a> -<span class="sourceLineNo">439</span> void mutateRow(RowMutations mutations) throws IOException;<a name="line.439"></a> -<span class="sourceLineNo">440</span><a name="line.440"></a> -<span class="sourceLineNo">441</span> /**<a name="line.441"></a> -<span class="sourceLineNo">442</span> * Perform atomic mutations within the region.<a name="line.442"></a> -<span class="sourceLineNo">443</span> *<a name="line.443"></a> -<span class="sourceLineNo">444</span> * @param mutations The list of mutations to perform.<a name="line.444"></a> -<span class="sourceLineNo">445</span> * <code>mutations</code> can contain operations for multiple rows.<a name="line.445"></a> -<span class="sourceLineNo">446</span> * Caller has to ensure that all rows are contained in this region.<a name="line.446"></a> -<span class="sourceLineNo">447</span> * @param rowsToLock Rows to lock<a name="line.447"></a> -<span class="sourceLineNo">448</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.448"></a> -<span class="sourceLineNo">449</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.449"></a> -<span class="sourceLineNo">450</span> * If multiple rows are locked care should be taken that<a name="line.450"></a> -<span class="sourceLineNo">451</span> * <code>rowsToLock</code> is sorted in order to avoid deadlocks.<a name="line.451"></a> -<span class="sourceLineNo">452</span> * @throws IOException<a name="line.452"></a> -<span class="sourceLineNo">453</span> */<a name="line.453"></a> -<span class="sourceLineNo">454</span> void mutateRowsWithLocks(Collection<Mutation> mutations, Collection<byte[]> rowsToLock,<a name="line.454"></a> -<span class="sourceLineNo">455</span> long nonceGroup, long nonce) throws IOException;<a name="line.455"></a> -<span class="sourceLineNo">456</span><a name="line.456"></a> -<span class="sourceLineNo">457</span> /**<a name="line.457"></a> -<span class="sourceLineNo">458</span> * Performs atomic multiple reads and writes on a given row.<a name="line.458"></a> -<span class="sourceLineNo">459</span> *<a name="line.459"></a> -<span class="sourceLineNo">460</span> * @param processor The object defines the reads and writes to a row.<a name="line.460"></a> -<span class="sourceLineNo">461</span> */<a name="line.461"></a> -<span class="sourceLineNo">462</span> void processRowsWithLocks(RowProcessor<?,?> processor) throws IOException;<a name="line.462"></a> -<span class="sourceLineNo">463</span><a name="line.463"></a> -<span class="sourceLineNo">464</span> /**<a name="line.464"></a> -<span class="sourceLineNo">465</span> * Performs atomic multiple reads and writes on a given row.<a name="line.465"></a> -<span class="sourceLineNo">466</span> *<a name="line.466"></a> -<span class="sourceLineNo">467</span> * @param processor The object defines the reads and writes to a row.<a name="line.467"></a> -<span class="sourceLineNo">468</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.468"></a> -<span class="sourceLineNo">469</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.469"></a> -<span class="sourceLineNo">470</span> */<a name="line.470"></a> -<span class="sourceLineNo">471</span> void processRowsWithLocks(RowProcessor<?,?> processor, long nonceGroup, long nonce)<a name="line.471"></a> -<span class="sourceLineNo">472</span> throws IOException;<a name="line.472"></a> -<span class="sourceLineNo">473</span><a name="line.473"></a> -<span class="sourceLineNo">474</span> /**<a name="line.474"></a> -<span class="sourceLineNo">475</span> * Performs atomic multiple reads and writes on a given row.<a name="line.475"></a> -<span class="sourceLineNo">476</span> *<a name="line.476"></a> -<span class="sourceLineNo">477</span> * @param processor The object defines the reads and writes to a row.<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @param timeout The timeout of the processor.process() execution<a name="line.478"></a> -<span class="sourceLineNo">479</span> * Use a negative number to switch off the time bound<a name="line.479"></a> -<span class="sourceLineNo">480</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.480"></a> -<span class="sourceLineNo">481</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.481"></a> -<span class="sourceLineNo">482</span> */<a name="line.482"></a> -<span class="sourceLineNo">483</span> void processRowsWithLocks(RowProcessor<?,?> processor, long timeout, long nonceGroup, long nonce)<a name="line.483"></a> -<span class="sourceLineNo">484</span> throws IOException;<a name="line.484"></a> -<span class="sourceLineNo">485</span><a name="line.485"></a> -<span class="sourceLineNo">486</span> /**<a name="line.486"></a> -<span class="sourceLineNo">487</span> * Puts some data in the table.<a name="line.487"></a> -<span class="sourceLineNo">488</span> * @param put<a name="line.488"></a> -<span class="sourceLineNo">489</span> * @throws IOException<a name="line.489"></a> -<span class="sourceLineNo">490</span> */<a name="line.490"></a> -<span class="sourceLineNo">491</span> void put(Put put) throws IOException;<a name="line.491"></a> -<span class="sourceLineNo">492</span><a name="line.492"></a> -<span class="sourceLineNo">493</span> /**<a name="line.493"></a> -<span class="sourceLineNo">494</span> * Listener class to enable callers of<a name="line.494"></a> -<span class="sourceLineNo">495</span> * bulkLoadHFile() to perform any necessary<a name="line.495"></a> -<span class="sourceLineNo">496</span> * pre/post processing of a given bulkload call<a name="line.496"></a> -<span class="sourceLineNo">497</span> */<a name="line.497"></a> -<span class="sourceLineNo">498</span> interface BulkLoadListener {<a name="line.498"></a> -<span class="sourceLineNo">499</span><a name="line.499"></a> -<span class="sourceLineNo">500</span> /**<a name="line.500"></a> -<span class="sourceLineNo">501</span> * Called before an HFile is actually loaded<a name="line.501"></a> -<span class="sourceLineNo">502</span> * @param family family being loaded to<a name="line.502"></a> -<span class="sourceLineNo">503</span> * @param srcPath path of HFile<a name="line.503"></a> -<span class="sourceLineNo">504</span> * @return final path to be used for actual loading<a name="line.504"></a> -<span class="sourceLineNo">505</span> * @throws IOException<a name="line.505"></a> -<span class="sourceLineNo">506</span> */<a name="line.506"></a> -<span class="sourceLineNo">507</span> String prepareBulkLoad(byte[] family, String srcPath) throws IOException;<a name="line.507"></a> -<span class="sourceLineNo">508</span><a name="line.508"></a> -<span class="sourceLineNo">509</span> /**<a name="line.509"></a> -<span class="sourceLineNo">510</span> * Called after a successful HFile load<a name="line.510"></a> -<span class="sourceLineNo">511</span> * @param family family being loaded to<a name="line.511"></a> -<span class="sourceLineNo">512</span> * @param srcPath path of HFile<a name="line.512"></a> -<span class="sourceLineNo">513</span> * @throws IOException<a name="line.513"></a> -<span class="sourceLineNo">514</span> */<a name="line.514"></a> -<span class="sourceLineNo">515</span> void doneBulkLoad(byte[] family, String srcPath) throws IOException;<a name="line.515"></a> -<span class="sourceLineNo">516</span><a name="line.516"></a> -<span class="sourceLineNo">517</span> /**<a name="line.517"></a> -<span class="sourceLineNo">518</span> * Called after a failed HFile load<a name="line.518"></a> -<span class="sourceLineNo">519</span> * @param family family being loaded to<a name="line.519"></a> -<span class="sourceLineNo">520</span> * @param srcPath path of HFile<a name="line.520"></a> -<span class="sourceLineNo">521</span> * @throws IOException<a name="line.521"></a> -<span class="sourceLineNo">522</span> */<a name="line.522"></a> -<span class="sourceLineNo">523</span> void failedBulkLoad(byte[] family, String srcPath) throws IOException;<a name="line.523"></a> -<span class="sourceLineNo">524</span> }<a name="line.524"></a> -<span class="sourceLineNo">525</span><a name="line.525"></a> -<span class="sourceLineNo">526</span> /**<a name="line.526"></a> -<span class="sourceLineNo">527</span> * Attempts to atomically load a group of hfiles. This is critical for loading<a name="line.527"></a> -<span class="sourceLineNo">528</span> * rows with multiple column families atomically.<a name="line.528"></a> -<span class="sourceLineNo">529</span> *<a name="line.529"></a> -<span class="sourceLineNo">530</span> * @param familyPaths List of Pair&lt;byte[] column family, String hfilePath&gt;<a name="line.530"></a> -<span class="sourceLineNo">531</span> * @param bulkLoadListener Internal hooks enabling massaging/preparation of a<a name="line.531"></a> -<span class="sourceLineNo">532</span> * file about to be bulk loaded<a name="line.532"></a> -<span class="sourceLineNo">533</span> * @param assignSeqId<a name="line.533"></a> -<span class="sourceLineNo">534</span> * @return true if successful, false if failed recoverably<a name="line.534"></a> -<span class="sourceLineNo">535</span> * @throws IOException if failed unrecoverably.<a name="line.535"></a> -<span class="sourceLineNo">536</span> */<a name="line.536"></a> -<span class="sourceLineNo">537</span> boolean bulkLoadHFiles(Collection<Pair<byte[], String>> familyPaths, boolean assignSeqId,<a name="line.537"></a> -<span class="sourceLineNo">538</span> BulkLoadListener bulkLoadListener) throws IOException;<a name="line.538"></a> -<span class="sourceLineNo">539</span><a name="line.539"></a> -<span class="sourceLineNo">540</span> ///////////////////////////////////////////////////////////////////////////<a name="line.540"></a> -<span class="sourceLineNo">541</span> // Coprocessors<a name="line.541"></a> +<span class="sourceLineNo">422</span> /** The comparator to be used with the region */<a name="line.422"></a> +<span class="sourceLineNo">423</span> CellComparator getCellCompartor();<a name="line.423"></a> +<span class="sourceLineNo">424</span><a name="line.424"></a> +<span class="sourceLineNo">425</span> /**<a name="line.425"></a> +<span class="sourceLineNo">426</span> * Perform one or more increment operations on a row.<a name="line.426"></a> +<span class="sourceLineNo">427</span> * @param increment<a name="line.427"></a> +<span class="sourceLineNo">428</span> * @param nonceGroup<a name="line.428"></a> +<span class="sourceLineNo">429</span> * @param nonce<a name="line.429"></a> +<span class="sourceLineNo">430</span> * @return result of the operation<a name="line.430"></a> +<span class="sourceLineNo">431</span> * @throws IOException<a name="line.431"></a> +<span class="sourceLineNo">432</span> */<a name="line.432"></a> +<span class="sourceLineNo">433</span> Result increment(Increment increment, long nonceGroup, long nonce) throws IOException;<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> * Performs multiple mutations atomically on a single row. Currently<a name="line.436"></a> +<span class="sourceLineNo">437</span> * {@link Put} and {@link Delete} are supported.<a name="line.437"></a> +<span class="sourceLineNo">438</span> *<a name="line.438"></a> +<span class="sourceLineNo">439</span> * @param mutations object that specifies the set of mutations to perform atomically<a name="line.439"></a> +<span class="sourceLineNo">440</span> * @throws IOException<a name="line.440"></a> +<span class="sourceLineNo">441</span> */<a name="line.441"></a> +<span class="sourceLineNo">442</span> void mutateRow(RowMutations mutations) throws IOException;<a name="line.442"></a> +<span class="sourceLineNo">443</span><a name="line.443"></a> +<span class="sourceLineNo">444</span> /**<a name="line.444"></a> +<span class="sourceLineNo">445</span> * Perform atomic mutations within the region.<a name="line.445"></a> +<span class="sourceLineNo">446</span> *<a name="line.446"></a> +<span class="sourceLineNo">447</span> * @param mutations The list of mutations to perform.<a name="line.447"></a> +<span class="sourceLineNo">448</span> * <code>mutations</code> can contain operations for multiple rows.<a name="line.448"></a> +<span class="sourceLineNo">449</span> * Caller has to ensure that all rows are contained in this region.<a name="line.449"></a> +<span class="sourceLineNo">450</span> * @param rowsToLock Rows to lock<a name="line.450"></a> +<span class="sourceLineNo">451</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.451"></a> +<span class="sourceLineNo">452</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.452"></a> +<span class="sourceLineNo">453</span> * If multiple rows are locked care should be taken that<a name="line.453"></a> +<span class="sourceLineNo">454</span> * <code>rowsToLock</code> is sorted in order to avoid deadlocks.<a name="line.454"></a> +<span class="sourceLineNo">455</span> * @throws IOException<a name="line.455"></a> +<span class="sourceLineNo">456</span> */<a name="line.456"></a> +<span class="sourceLineNo">457</span> void mutateRowsWithLocks(Collection<Mutation> mutations, Collection<byte[]> rowsToLock,<a name="line.457"></a> +<span class="sourceLineNo">458</span> long nonceGroup, long nonce) throws IOException;<a name="line.458"></a> +<span class="sourceLineNo">459</span><a name="line.459"></a> +<span class="sourceLineNo">460</span> /**<a name="line.460"></a> +<span class="sourceLineNo">461</span> * Performs atomic multiple reads and writes on a given row.<a name="line.461"></a> +<span class="sourceLineNo">462</span> *<a name="line.462"></a> +<span class="sourceLineNo">463</span> * @param processor The object defines the reads and writes to a row.<a name="line.463"></a> +<span class="sourceLineNo">464</span> */<a name="line.464"></a> +<span class="sourceLineNo">465</span> void processRowsWithLocks(RowProcessor<?,?> processor) throws IOException;<a name="line.465"></a> +<span class="sourceLineNo">466</span><a name="line.466"></a> +<span class="sourceLineNo">467</span> /**<a name="line.467"></a> +<span class="sourceLineNo">468</span> * Performs atomic multiple reads and writes on a given row.<a name="line.468"></a> +<span class="sourceLineNo">469</span> *<a name="line.469"></a> +<span class="sourceLineNo">470</span> * @param processor The object defines the reads and writes to a row.<a name="line.470"></a> +<span class="sourceLineNo">471</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.471"></a> +<span class="sourceLineNo">472</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.472"></a> +<span class="sourceLineNo">473</span> */<a name="line.473"></a> +<span class="sourceLineNo">474</span> void processRowsWithLocks(RowProcessor<?,?> processor, long nonceGroup, long nonce)<a name="line.474"></a> +<span class="sourceLineNo">475</span> throws IOException;<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> * Performs atomic multiple reads and writes on a given row.<a name="line.478"></a> +<span class="sourceLineNo">479</span> *<a name="line.479"></a> +<span class="sourceLineNo">480</span> * @param processor The object defines the reads and writes to a row.<a name="line.480"></a> +<span class="sourceLineNo">481</span> * @param timeout The timeout of the processor.process() execution<a name="line.481"></a> +<span class="sourceLineNo">482</span> * Use a negative number to switch off the time bound<a name="line.482"></a> +<span class="sourceLineNo">483</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.483"></a> +<span class="sourceLineNo">484</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.484"></a> +<span class="sourceLineNo">485</span> */<a name="line.485"></a> +<span class="sourceLineNo">486</span> void processRowsWithLocks(RowProcessor<?,?> processor, long timeout, long nonceGroup, long nonce)<a name="line.486"></a> +<span class="sourceLineNo">487</span> throws IOException;<a name="line.487"></a> +<span class="sourceLineNo">488</span><a name="line.488"></a> +<span class="sourceLineNo">489</span> /**<a name="line.489"></a> +<span class="sourceLineNo">490</span> * Puts some data in the table.<a name="line.490"></a> +<span class="sourceLineNo">491</span> * @param put<a name="line.491"></a> +<span class="sourceLineNo">492</span> * @throws IOException<a name="line.492"></a> +<span class="sourceLineNo">493</span> */<a name="line.493"></a> +<span class="sourceLineNo">494</span> void put(Put put) throws IOException;<a name="line.494"></a> +<span class="sourceLineNo">495</span><a name="line.495"></a> +<span class="sourceLineNo">496</span> /**<a name="line.496"></a> +<span class="sourceLineNo">497</span> * Listener class to enable callers of<a name="line.497"></a> +<span class="sourceLineNo">498</span> * bulkLoadHFile() to perform any necessary<a name="line.498"></a> +<span class="sourceLineNo">499</span> * pre/post processing of a given bulkload call<a name="line.499"></a> +<span class="sourceLineNo">500</span> */<a name="line.500"></a> +<span class="sourceLineNo">501</span> interface BulkLoadListener {<a name="line.501"></a> +<span class="sourceLineNo">502</span><a name="line.502"></a> +<span class="sourceLineNo">503</span> /**<a name="line.503"></a> +<span class="sourceLineNo">504</span> * Called before an HFile is actually loaded<a name="line.504"></a> +<span class="sourceLineNo">505</span> * @param family family being loaded to<a name="line.505"></a> +<span class="sourceLineNo">506</span> * @param srcPath path of HFile<a name="line.506"></a> +<span class="sourceLineNo">507</span> * @return final path to be used for actual loading<a name="line.507"></a> +<span class="sourceLineNo">508</span> * @throws IOException<a name="line.508"></a> +<span class="sourceLineNo">509</span> */<a name="line.509"></a> +<span class="sourceLineNo">510</span> String prepareBulkLoad(byte[] family, String srcPath) throws IOException;<a name="line.510"></a> +<span class="sourceLineNo">511</span><a name="line.511"></a> +<span class="sourceLineNo">512</span> /**<a name="line.512"></a> +<span class="sourceLineNo">513</span> * Called after a successful HFile load<a name="line.513"></a> +<span class="sourceLineNo">514</span> * @param family family being loaded to<a name="line.514"></a> +<span class="sourceLineNo">515</span> * @param srcPath path of HFile<a name="line.515"></a> +<span class="sourceLineNo">516</span> * @throws IOException<a name="line.516"></a> +<span class="sourceLineNo">517</span> */<a name="line.517"></a> +<span class="sourceLineNo">518</span> void doneBulkLoad(byte[] family, String srcPath) throws IOException;<a name="line.518"></a> +<span class="sourceLineNo">519</span><a name="line.519"></a> +<span class="sourceLineNo">520</span> /**<a name="line.520"></a> +<span class="sourceLineNo">521</span> * Called after a failed HFile load<a name="line.521"></a> +<span class="sourceLineNo">522</span> * @param family family being loaded to<a name="line.522"></a> +<span class="sourceLineNo">523</span> * @param srcPath path of HFile<a name="line.523"></a> +<span class="sourceLineNo">524</span> * @throws IOException<a name="line.524"></a> +<span class="sourceLineNo">525</span> */<a name="line.525"></a> +<span class="sourceLineNo">526</span> void failedBulkLoad(byte[] family, String srcPath) throws IOException;<a name="line.526"></a> +<span class="sourceLineNo">527</span> }<a name="line.527"></a> +<span class="sourceLineNo">528</span><a name="line.528"></a> +<span class="sourceLineNo">529</span> /**<a name="line.529"></a> +<span class="sourceLineNo">530</span> * Attempts to atomically load a group of hfiles. This is critical for loading<a name="line.530"></a> +<span class="sourceLineNo">531</span> * rows with multiple column families atomically.<a name="line.531"></a> +<span class="sourceLineNo">532</span> *<a name="line.532"></a> +<span class="sourceLineNo">533</span> * @param familyPaths List of Pair&lt;byte[] column family, String hfilePath&gt;<a name="line.533"></a> +<span class="sourceLineNo">534</span> * @param bulkLoadListener Internal hooks enabling massaging/preparation of a<a name="line.534"></a> +<span class="sourceLineNo">535</span> * file about to be bulk loaded<a name="line.535"></a> +<span class="sourceLineNo">536</span> * @param assignSeqId<a name="line.536"></a> +<span class="sourceLineNo">537</span> * @return true if successful, false if failed recoverably<a name="line.537"></a> +<span class="sourceLineNo">538</span> * @throws IOException if failed unrecoverably.<a name="line.538"></a> +<span class="sourceLineNo">539</span> */<a name="line.539"></a> +<span class="sourceLineNo">540</span> boolean bulkLoadHFiles(Collection<Pair<byte[], String>> familyPaths, boolean assignSeqId,<a name="line.540"></a> +<span class="sourceLineNo">541</span> BulkLoadListener bulkLoadListener) throws IOException;<a name="line.541"></a> <span class="sourceLineNo">542</span><a name="line.542"></a> -<span class="sourceLineNo">543</span> /** @return the coprocessor host */<a name="line.543"></a> -<span class="sourceLineNo">544</span> RegionCoprocessorHost getCoprocessorHost();<a name="line.544"></a> +<span class="sourceLineNo">543</span> ///////////////////////////////////////////////////////////////////////////<a name="line.543"></a> +<span class="sourceLineNo">544</span> // Coprocessors<a name="line.544"></a> <span class="sourceLineNo">545</span><a name="line.545"></a> -<span class="sourceLineNo">546</span> /**<a name="line.546"></a> -<span class="sourceLineNo">547</span> * Executes a single protocol buffer coprocessor endpoint {@link Service} method using<a name="line.547"></a> -<span class="sourceLineNo">548</span> * the registered protocol handlers. {@link Service} implementations must be registered via the<a name="line.548"></a> -<span class="sourceLineNo">549</span> * {@link Region#registerService(com.google.protobuf.Service)}<a name="line.549"></a> -<span class="sourceLineNo">550</span> * method before they are available.<a name="line.550"></a> -<span class="sourceLineNo">551</span> *<a name="line.551"></a> -<span class="sourceLineNo">552</span> * @param controller an {@code RpcContoller} implementation to pass to the invoked service<a name="line.552"></a> -<span class="sourceLineNo">553</span> * @param call a {@code CoprocessorServiceCall} instance identifying the service, method,<a name="line.553"></a> -<span class="sourceLineNo">554</span> * and parameters for the method invocation<a name="line.554"></a> -<span class="sourceLineNo">555</span> * @return a protocol buffer {@code Message} instance containing the method's result<a name="line.555"></a> -<span class="sourceLineNo">556</span> * @throws IOException if no registered service handler is found or an error<a name="line.556"></a> -<span class="sourceLineNo">557</span> * occurs during the invocation<a name="line.557"></a> -<span class="sourceLineNo">558</span> * @see org.apache.hadoop.hbase.regionserver.Region#registerService(com.google.protobuf.Service)<a name="line.558"></a> -<span class="sourceLineNo">559</span> */<a name="line.559"></a> -<span class="sourceLineNo">560</span> Message execService(RpcController controller, CoprocessorServiceCall call) throws IOException;<a name="line.560"></a> -<span class="sourceLineNo">561</span><a name="line.561"></a> -<span class="sourceLineNo">562</span> /**<a name="line.562"></a> -<span class="sourceLineNo">563</span> * Registers a new protocol buffer {@link Service} subclass as a coprocessor endpoint to<a name="line.563"></a> -<span class="sourceLineNo">564</span> * be available for handling<a name="line.564"></a> -<span class="sourceLineNo">565</span> * {@link Region#execService(com.google.protobuf.RpcController,<a name="line.565"></a> -<span class="sourceLineNo">566</span> * org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceCall)}} calls.<a name="line.566"></a> -<span class="sourceLineNo">567</span> *<a name="line.567"></a> -<span class="sourceLineNo">568</span> * <p><a name="line.568"></a> -<span class="sourceLineNo">569</span> * Only a single instance may be registered per region for a given {@link Service} subclass (the<a name="line.569"></a> -<span class="sourceLineNo">570</span> * instances are keyed on {@link com.google.protobuf.Descriptors.ServiceDescriptor#getFullName()}.<a name="line.570"></a> -<span class="sourceLineNo">571</span> * After the first registration, subsequent calls with the same service name will fail with<a name="line.571"></a> -<span class="sourceLineNo">572</span> * a return value of {@code false}.<a name="line.572"></a> -<span class="sourceLineNo">573</span> * </p><a name="line.573"></a> -<span class="sourceLineNo">574</span> * @param instance the {@code Service} subclass instance to expose as a coprocessor endpoint<a name="line.574"></a> -<span class="sourceLineNo">575</span> * @return {@code true} if the registration was successful, {@code false}<a name="line.575"></a> -<span class="sourceLineNo">576</span> * otherwise<a name="line.576"></a> -<span class="sourceLineNo">577</span> */<a name="line.577"></a> -<span class="sourceLineNo">578</span> boolean registerService(Service instance);<a name="line.578"></a> -<span class="sourceLineNo">579</span><a name="line.579"></a> -<span class="sourceLineNo">580</span> ///////////////////////////////////////////////////////////////////////////<a name="line.580"></a> -<span class="sourceLineNo">581</span> // RowMutation processor support<a name="line.581"></a> +<span class="sourceLineNo">546</span> /** @return the coprocessor host */<a name="line.546"></a> +<span class="sourceLineNo">547</span> RegionCoprocessorHost getCoprocessorHost();<a name="line.547"></a> +<span class="sourceLineNo">548</span><a name="line.548"></a> +<span class="sourceLineNo">549</span> /**<a name="line.549"></a> +<span class="sourceLineNo">550</span> * Executes a single protocol buffer coprocessor endpoint {@link Service} method using<a name="line.550"></a> +<span class="sourceLineNo">551</span> * the registered protocol handlers. {@link Service} implementations must be registered via the<a name="line.551"></a> +<span class="sourceLineNo">552</span> * {@link Region#registerService(com.google.protobuf.Service)}<a name="line.552"></a> +<span class="sourceLineNo">553</span> * method before they are available.<a name="line.553"></a> +<span class="sourceLineNo">554</span> *<a name="line.554"></a> +<span class="sourceLineNo">555</span> * @param controller an {@code RpcContoller} implementation to pass to the invoked service<a name="line.555"></a> +<span class="sourceLineNo">556</span> * @param call a {@code CoprocessorServiceCall} instance identifying the service, method,<a name="line.556"></a> +<span class="sourceLineNo">557</span> * and parameters for the method invocation<a name="line.557"></a> +<span class="sourceLineNo">558</span> * @return a protocol buffer {@code Message} instance containing the method's result<a name="line.558"></a> +<span class="sourceLineNo">559</span> * @throws IOException if no registered service handler is found or an error<a name="line.559"></a> +<span class="sourceLineNo">560</span> * occurs during the invocation<a name="line.560"></a> +<span class="sourceLineNo">561</span> * @see org.apache.hadoop.hbase.regionserver.Region#registerService(com.google.protobuf.Service)<a name="line.561"></a> +<span class="sourceLineNo">562</span> */<a name="line.562"></a> +<span class="sourceLineNo">563</span> Message execService(RpcController controller, CoprocessorServiceCall call) throws IOException;<a name="line.563"></a> +<span class="sourceLineNo">564</span><a name="line.564"></a> +<span class="sourceLineNo">565</span> /**<a name="line.565"></a> +<span class="sourceLineNo">566</span> * Registers a new protocol buffer {@link Service} subclass as a coprocessor endpoint to<a name="line.566"></a> +<span class="sourceLineNo">567</span> * be available for handling<a name="line.567"></a> +<span class="sourceLineNo">568</span> * {@link Region#execService(com.google.protobuf.RpcController,<a name="line.568"></a> +<span class="sourceLineNo">569</span> * org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceCall)}} calls.<a name="line.569"></a> +<span class="sourceLineNo">570</span> *<a name="line.570"></a> +<span class="sourceLineNo">571</span> * <p><a name="line.571"></a> +<span class="sourceLineNo">572</span> * Only a single instance may be registered per region for a given {@link Service} subclass (the<a name="line.572"></a> +<span class="sourceLineNo">573</span> * instances are keyed on {@link com.google.protobuf.Descriptors.ServiceDescriptor#getFullName()}.<a name="line.573"></a> +<span class="sourceLineNo">574</span> * After the first registration, subsequent calls with the same service name will fail with<a name="line.574"></a> +<span class="sourceLineNo">575</span> * a return value of {@code false}.<a name="line.575"></a> +<span class="sourceLineNo">576</span> * </p><a name="line.576"></a> +<span class="sourceLineNo">577</span> * @param instance the {@code Service} subclass instance to expose as a coprocessor endpoint<a name="line.577"></a> +<span class="sourceLineNo">578</span> * @return {@code true} if the registration was successful, {@code false}<a name="line.578"></a> +<span class="sourceLineNo">579</span> * otherwise<a name="line.579"></a> +<span class="sourceLineNo">580</span> */<a name="line.580"></a> +<span class="sourceLineNo">581</span> boolean registerService(Service instance);<a name="line.581"></a> <span class="sourceLineNo">582</span><a name="line.582"></a> -<span class="sourceLineNo">583</span> /**<a name="line.583"></a> -<span class="sourceLineNo">584</span> * Check the collection of families for validity.<a name="line.584"></a> -<span class="sourceLineNo">585</span> * @param families<a name="line.585"></a> -<span class="sourceLineNo">586</span> * @throws NoSuchColumnFamilyException<a name="line.586"></a> -<span class="sourceLineNo">587</span> */<a name="line.587"></a> -<span class="sourceLineNo">588</span> void checkFamilies(Collection<byte[]> families) throws NoSuchColumnFamilyException;<a name="line.588"></a> -<span class="sourceLineNo">589</span><a name="line.589"></a> -<span class="sourceLineNo">590</span> /**<a name="line.590"></a> -<span class="sourceLineNo">591</span> * Check the collection of families for valid timestamps<a name="line.591"></a> -<span class="sourceLineNo">592</span> * @param familyMap<a name="line.592"></a> -<span class="sourceLineNo">593</span> * @param now current timestamp<a name="line.593"></a> -<span class="sourceLineNo">594</span> * @throws FailedSanityCheckException<a name="line.594"></a> -<span class="sourceLineNo">595</span> */<a name="line.595"></a> -<span class="sourceLineNo">596</span> void checkTimestamps(Map<byte[], List<Cell>> familyMap, long now)<a name="line.596"></a> -<span class="sourceLineNo">597</span> throws FailedSanityCheckException;<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> * Prepare a delete for a row mutation processor<a name="line.600"></a> -<span class="sourceLineNo">601</span> * @param delete The passed delete is modified by this method. WARNING!<a name="line.601"></a> -<span class="sourceLineNo">602</span> * @throws IOException<a name="line.602"></a> -<span class="sourceLineNo">603</span> */<a name="line.603"></a> -<span class="sourceLineNo">604</span> void prepareDelete(Delete delete) throws IOException;<a name="line.604"></a> -<span class="sourceLineNo">605</span><a name="line.605"></a> -<span class="sourceLineNo">606</span> /**<a name="line.606"></a> -<span class="sourceLineNo">607</span> * Set up correct timestamps in the KVs in Delete object.<a name="line.607"></a> -<span class="sourceLineNo">608</span> * <p>Caller should have the row and region locks.<a name="line.608"></a> -<span class="sourceLineNo">609</span> * @param mutation<a name="line.609"></a> -<span class="sourceLineNo">610</span> * @param familyCellMap<a name="line.610"></a> -<span class="sourceLineNo">611</span> * @param now<a name="line.611"></a> -<span class="sourceLineNo">612</span> * @throws IOException<a name="line.612"></a> -<span class="sourceLineNo">613</span> */<a name="line.613"></a> -<span class="sourceLineNo">614</span> void prepareDeleteTimestamps(Mutation mutation, Map<byte[], List<Cell>> familyCellMap,<a name="line.614"></a> -<span class="sourceLineNo">615</span> byte[] now) throws IOException;<a name="line.615"></a> -<span class="sourceLineNo">616</span><a name="line.616"></a> -<span class="sourceLineNo">617</span> /**<a name="line.617"></a> -<span class="sourceLineNo">618</span> * Replace any cell timestamps set to {@link org.apache.hadoop.hbase.HConstants#LATEST_TIMESTAMP}<a name="line.618"></a> -<span class="sourceLineNo">619</span> * provided current timestamp.<a name="line.619"></a> -<span class="sourceLineNo">620</span> * @param values<a name="line.620"></a> -<span class="sourceLineNo">621</span> * @param now<a name="line.621"></a> -<span class="sourceLineNo">622</span> */<a name="line.622"></a> -<span class="sourceLineNo">623</span> void updateCellTimestamps(final Iterable<List<Cell>> values, final byte[] now)<a name="line.623"></a> -<span class="sourceLineNo">624</span> throws IOException;<a name="line.624"></a> -<span class="sourceLineNo">625</span><a name="line.625"></a> -<span class="sourceLineNo">626</span> ///////////////////////////////////////////////////////////////////////////<a name="line.626"></a> -<span class="sourceLineNo">627</span> // Flushes, compactions, splits, etc.<a name="line.627"></a> -<span class="sourceLineNo">628</span> // Wizards only, please<a name="line.628"></a> -<span class="sourceLineNo">629</span><a name="line.629"></a> -<span class="sourceLineNo">630</span> interface FlushResult {<a name="line.630"></a> -<span class="sourceLineNo">631</span> enum Result {<a name="line.631"></a> -<span class="sourceLineNo">632</span> FLUSHED_NO_COMPACTION_NEEDED,<a name="line.632"></a> -<span class="sourceLineNo">633</span> FLUSHED_COMPACTION_NEEDED,<a name="line.633"></a> -<span class="sourceLineNo">634</span> // Special case where a flush didn't run because there's nothing in the memstores. Used when<a name="line.634"></a> -<span class="sourceLineNo">635</span> // bulk loading to know when we can still load even if a flush didn't happen.<a name="line.635"></a> -<span class="sourceLineNo">636</span> CANNOT_FLUSH_MEMSTORE_EMPTY,<a name="line.636"></a> -<span class="sourceLineNo">637</span> CANNOT_FLUSH<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> /** @return the detailed result code */<a name="line.640"></a> -<span class="sourceLineNo">641</span> Result getResult();<a name="line.641"></a> +<span class="sourceLineNo">583</span> ///////////////////////////////////////////////////////////////////////////<a name="line.583"></a> +<span class="sourceLineNo">584</span> // RowMutation processor support<a name="line.584"></a> +<span class="sourceLineNo">585</span><a name="line.585"></a> +<span class="sourceLineNo">586</span> /**<a name="line.586"></a> +<span class="sourceLineNo">587</span> * Check the collection of families for validity.<a name="line.587"></a> +<span class="sourceLineNo">588</span> * @param families<a name="line.588"></a> +<span class="sourceLineNo">589</span> * @throws NoSuchColumnFamilyException<a name="line.589"></a> +<span class="sourceLineNo">590</span> */<a name="line.590"></a> +<span class="sourceLineNo">591</span> void checkFamilies(Collection<byte[]> families) throws NoSuchColumnFamilyException;<a name="line.591"></a> +<span class="sourceLineNo">592</span><a name="line.592"></a> +<span class="sourceLineNo">593</span> /**<a name="line.593"></a> +<span class="sourceLineNo">594</span> * Check the collection of families for valid timestamps<a name="line.594"></a> +<span class="sourceLineNo">595</span> * @param familyMap<a name="line.595"></a> +<span class="sourceLineNo">596</span> * @param now current timestamp<a name="line.596"></a> +<span class="sourceLineNo">597</span> * @throws FailedSanityCheckException<a name="line.597"></a> +<span class="sourceLineNo">598</span> */<a name="line.598"></a> +<span class="sourceLineNo">599</span> void checkTimestamps(Map<byte[], List<Cell>> familyMap, long now)<a name="line.599"></a> +<span class="sourceLineNo">600</span> throws FailedSanityCheckException;<a name="line.600"></a> +<span class="sourceLineNo">601</span><a name="line.601"></a> +<span class="sourceLineNo">602</span> /**<a name="line.602"></a> +<span class="sourceLineNo">603</span> * Prepare a delete for a row mutation processor<a name="line.603"></a> +<span class="sourceLineNo">604</span> * @param delete The passed delete is modified by this method. WARNING!<a name="line.604"></a> +<span class="sourceLineNo">605</span> * @throws IOException<a name="line.605"></a> +<span class="sourceLineNo">606</span> */<a name="line.606"></a> +<span class="sourceLineNo">607</span> void prepareDelete(Delete delete) throws IOException;<a name="line.607"></a> +<span class="sourceLineNo">608</span><a name="line.608"></a> +<span class="sourceLineNo">609</span> /**<a name="line.609"></a> +<span class="sourceLineNo">610</span> * Set up correct timestamps in the KVs in Delete object.<a name="line.610"></a> +<span class="sourceLineNo">611</span> * <p>Caller should have the row and region locks.<a name="line.611"></a> +<span class="sourceLineNo">612</span> * @param mutation<a name="line.612"></a> +<span class="sourceLineNo">613</span> * @param familyCellMap<a name="line.613"></a> +<span class="sourceLineNo">614</span> * @param now<a name="line.614"></a> +<span class="sourceLineNo">615</span> * @throws IOException<a name="line.615"></a> +<span class="sourceLineNo">616</span> */<a name="line.616"></a> +<span class="sourceLineNo">617</span> void prepareDeleteTimestamps(Mutation mutation, Map<byte[], List<Cell>> familyCellMap,<a name="line.617"></a> +<span class="sourceLineNo">618</span> byte[] now) throws IOException;<a name="line.618"></a> +<span class="sourceLineNo">619</span><a name="line.619"></a> +<span class="sourceLineNo">620</span> /**<a name="line.620"></a> +<span class="sourceLineNo">621</span> * Replace any cell timestamps set to {@link org.apache.hadoop.hbase.HConstants#LATEST_TIMESTAMP}<a name="line.621"></a> +<span class="sourceLineNo">622</span> * provided current timestamp.<a name="line.622"></a> +<span class="sourceLineNo">623</span> * @param values<a name="line.623"></a> +<span class="sourceLineNo">624</span> * @param now<a name="line.624"></a> +<span class="sourceLineNo">625</span> */<a name="line.625"></a> +<span class="sourceLineNo">626</span> void updateCellTimestamps(final Iterable<List<Cell>> values, final byte[] now)<a name="line.626"></a> +<span class="sourceLineNo">627</span> throws IOException;<a name="line.627"></a> +<span class="sourceLineNo">628</span><a name="line.628"></a> +<span class="sourceLineNo">629</span> ///////////////////////////////////////////////////////////////////////////<a name="line.629"></a> +<span class="sourceLineNo">630</span> // Flushes, compactions, splits, etc.<a name="line.630"></a> +<span class="sourceLineNo">631</span> // Wizards only, please<a name="line.631"></a> +<span class="sourceLineNo">632</span><a name="line.632"></a> +<span class="sourceLineNo">633</span> interface FlushResult {<a name="line.633"></a> +<span class="sourceLineNo">634</span> enum Result {<a name="line.634"></a> +<span class="sourceLineNo">635</span> FLUSHED_NO_COMPACTION_NEEDED,<a name="line.635"></a> +<span class="sourceLineNo">636</span> FLUSHED_COMPACTION_NEEDED,<a name="line.636"></a> +<span class="sourceLineNo">637</span> // Special case where a flush didn't run because there's nothing in the memstores. Used when<a name="line.637"></a> +<span class="sourceLineNo">638</span> // bulk loading to know when we can still load even if a flush didn't happen.<a name="line.638"></a> +<span class="sourceLineNo">639</span> CANNOT_FLUSH_MEMSTORE_EMPTY,<a name="line.639"></a> +<span class="sourceLineNo">640</span> CANNOT_FLUSH<a name="line.640"></a> +<span class="sourceLineNo">641</span> }<a name="line.641"></a> <span class="sourceLineNo">642</span><a name="line.642"></a> -<span class="sourceLineNo">643</span> /** @return true if the memstores were flushed, else false */<a name="line.643"></a> -<span class="sourceLineNo">644</span> boolean isFlushSucceeded();<a name="line.644"></a> +<span class="sourceLineNo">643</sp
<TRUNCATED>
