| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Collection;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.Append;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.CheckAndMutate;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.CheckAndMutateResult;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.CompactionState;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Delete;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.Get;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.Increment;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.Mutation;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.Put;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.Result;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.RowMutations;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.TableDescriptor;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.conf.ConfigurationObserver;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.coprocessor.RegionCoprocessor;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.filter.ByteArrayComparable;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.filter.Filter;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.io.TimeRange;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span>/**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Region is a subset of HRegion with operations required for the {@link RegionCoprocessor<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Coprocessors}. The operations include ability to do mutations, requesting compaction, getting<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * different counters/sizes, locking rows and getting access to {@linkplain Store}s.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>@InterfaceStability.Evolving<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>public interface Region extends ConfigurationObserver {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> ///////////////////////////////////////////////////////////////////////////<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> // Region state<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /** @return region information for this region */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> RegionInfo getRegionInfo();<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /** @return table descriptor for this region */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> TableDescriptor getTableDescriptor();<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /** @return true if region is available (not closed and not closing) */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> boolean isAvailable();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /** @return true if region is closed */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> boolean isClosed();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /** @return True if closing process has started */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> boolean isClosing();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> /** @return True if region is read only */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> boolean isReadOnly();<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /** @return true if region is splittable */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> boolean isSplittable();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @return true if region is mergeable<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> boolean isMergeable();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * Return the list of Stores managed by this region<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * <p>Use with caution. Exposed for use of fixup utilities.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @return a list of the Stores managed by this region<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> List<? extends Store> getStores();<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Return the Store for the given family<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * <p>Use with caution. Exposed for use of fixup utilities.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @return the Store for the given family<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> Store getStore(byte[] family);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /** @return list of store file names for the given families */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> List<String> getStoreFileList(byte[][] columns);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Check the region's underlying store files, open the files that have not<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * been opened yet, and remove the store file readers for store files no<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * longer available.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @throws IOException<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> boolean refreshStoreFiles() throws IOException;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /** @return the max sequence id of flushed data on this region; no edit in memory will have<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * a sequence id that is less that what is returned here.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> long getMaxFlushedSeqId();<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> /**<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * This can be used to determine the last time all files of this region were major compacted.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param majorCompactionOnly Only consider HFile that are the result of major compaction<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @return the timestamp of the oldest HFile for all stores of this region<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> */<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> long getOldestHfileTs(boolean majorCompactionOnly) throws IOException;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @return map of column family names to max sequence id that was read from storage when this<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * region was opened<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> */<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public Map<byte[], Long> getMaxStoreSeqId();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> /**<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @return The earliest time a store in the region was flushed. All<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * other stores in the region would have been flushed either at, or<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * after this time.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> long getEarliestFlushTimeForAllStores();<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> ///////////////////////////////////////////////////////////////////////////<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> // Metrics<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /** @return read requests count for this region */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> long getReadRequestsCount();<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> /** @return coprocessor requests count for this region */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> long getCpRequestsCount();<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> /** @return filtered read requests count for this region */<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> long getFilteredReadRequestsCount();<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> /** @return write request count for this region */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> long getWriteRequestsCount();<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> /**<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @return memstore size for this region, in bytes. It just accounts data size of cells added to<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * the memstores of this Region. Means size in bytes for key, value and tags within Cells.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * It wont consider any java heap overhead for the cell objects or any other.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> */<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> long getMemStoreDataSize();<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> /**<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @return memstore heap size for this region, in bytes. It accounts data size of cells<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * added to the memstores of this Region, as well as java heap overhead for the cell<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * objects or any other.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> */<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> long getMemStoreHeapSize();<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> /**<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return memstore off-heap size for this region, in bytes. It accounts data size of cells<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * added to the memstores of this Region, as well as overhead for the cell<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * objects or any other that is allocated off-heap.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> */<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> long getMemStoreOffHeapSize();<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> /** @return the number of mutations processed bypassing the WAL */<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> long getNumMutationsWithoutWAL();<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> /** @return the size of data processed bypassing the WAL, in bytes */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> long getDataInMemoryWithoutWAL();<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> /** @return the number of blocked requests */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> long getBlockedRequestsCount();<a name="line.183"></a> |
| <span class="sourceLineNo">184</span><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> /** @return the number of checkAndMutate guards that passed */<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> long getCheckAndMutateChecksPassed();<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> /** @return the number of failed checkAndMutate guards */<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> long getCheckAndMutateChecksFailed();<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> // Locking<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> // Region read locks<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * Operation enum is used in {@link Region#startRegionOperation} and elsewhere to provide<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * context for various checks.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> */<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> enum Operation {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> ANY, GET, PUT, DELETE, SCAN, APPEND, INCREMENT, SPLIT_REGION, MERGE_REGION, BATCH_MUTATE,<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> REPLAY_BATCH_MUTATE, COMPACT_REGION, REPLAY_EVENT, SNAPSHOT, COMPACT_SWITCH<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * This method needs to be called before any public call that reads or<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * modifies data.<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * Acquires a read lock and checks if the region is closing or closed.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * <p>{@link #closeRegionOperation} MUST then always be called after<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * the operation has completed, whether it succeeded or failed.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @throws IOException<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> */<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> // TODO Exposing this and closeRegionOperation() as we have getRowLock() exposed.<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> // Remove if we get rid of exposing getRowLock().<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> void startRegionOperation() throws IOException;<a name="line.215"></a> |
| <span class="sourceLineNo">216</span><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> /**<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * This method needs to be called before any public call that reads or<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * modifies data.<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * Acquires a read lock and checks if the region is closing or closed.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * <p>{@link #closeRegionOperation} MUST then always be called after<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * the operation has completed, whether it succeeded or failed.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @param op The operation is about to be taken on the region<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @throws IOException<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> */<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> void startRegionOperation(Operation op) throws IOException;<a name="line.226"></a> |
| <span class="sourceLineNo">227</span><a name="line.227"></a> |
| <span class="sourceLineNo">228</span> /**<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * Closes the region operation lock.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * @throws IOException<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> */<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> void closeRegionOperation() throws IOException;<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> * Closes the region operation lock. This needs to be called in the finally block corresponding<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * to the try block of {@link #startRegionOperation(Operation)}<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @throws IOException<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> */<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> void closeRegionOperation(Operation op) throws IOException;<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> // Row write locks<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> /**<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * Row lock held by a given thread.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * One thread may acquire multiple locks on the same row simultaneously.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * The locks must be released by calling release() from the same thread.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> */<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> public interface RowLock {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> /**<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * Release the given lock. If there are no remaining locks held by the current thread<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * then unlock the row and allow other threads to acquire the lock.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * @throws IllegalArgumentException if called by a different thread than the lock owning<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * thread<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> */<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> void release();<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> }<a name="line.256"></a> |
| <span class="sourceLineNo">257</span><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> * Get a row lock for the specified row. All locks are reentrant.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> *<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * Before calling this function make sure that a region operation has already been<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * started (the calling thread has already acquired the region-close-guard lock).<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * <p><a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * The obtained locks should be released after use by {@link RowLock#release()}<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * <p><a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * NOTE: the boolean passed here has changed. It used to be a boolean that<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * stated whether or not to wait on the lock. Now it is whether it an exclusive<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * lock is requested.<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> *<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * @param row The row actions will be performed against<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @param readLock is the lock reader or writer. True indicates that a non-exclusive<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * lock is requested<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * @see #startRegionOperation()<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * @see #startRegionOperation(Operation)<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> */<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> // TODO this needs to be exposed as we have RowProcessor now. If RowProcessor is removed, we can<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> // remove this too..<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> RowLock getRowLock(byte[] row, boolean readLock) throws IOException;<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> // Region operations<a name="line.282"></a> |
| <span class="sourceLineNo">283</span><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> /**<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * Perform one or more append operations on a row.<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * @param append<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * @return result of the operation<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * @throws IOException<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> */<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> Result append(Append append) 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> * Perform a batch of mutations.<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * <p><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * Note this supports only Put, Delete, Increment and Append mutations and will ignore other<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * types passed.<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * @param mutations the list of mutations<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * @return an array of OperationStatus which internally contains the<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * OperationStatusCode and the exceptionMessage if any.<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * @throws IOException<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> */<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> OperationStatus[] batchMutate(Mutation[] mutations)<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> throws IOException;<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> /**<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * Atomically checks if a row/family/qualifier value matches the expected value and if it does,<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * it performs the mutation. If the passed value is null, the lack of column value<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * (ie: non-existence) is used. See checkAndRowMutate to do many checkAndPuts at a time on a<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * single row.<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * @param row to check<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * @param family column family to check<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * @param qualifier column qualifier to check<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * @param op the comparison operator<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * @param comparator the expected value<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * @param mutation data to put if check succeeds<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * @return true if mutation was applied, false otherwise<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> *<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> */<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> @Deprecated<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> default boolean checkAndMutate(byte [] row, byte [] family, byte [] qualifier, CompareOperator op,<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> ByteArrayComparable comparator, Mutation mutation) throws IOException {<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> return checkAndMutate(row, family, qualifier, op, comparator, TimeRange.allTime(), mutation);<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> }<a name="line.325"></a> |
| <span class="sourceLineNo">326</span><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> /**<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * Atomically checks if a row/family/qualifier value matches the expected value and if it does,<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * it performs the mutation. If the passed value is null, the lack of column value<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * (ie: non-existence) is used. See checkAndRowMutate to do many checkAndPuts at a time on a<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * single row.<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * @param row to check<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * @param family column family to check<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * @param qualifier column qualifier to check<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @param op the comparison operator<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @param comparator the expected value<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * @param mutation data to put if check succeeds<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * @param timeRange time range to check<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * @return true if mutation was applied, false otherwise<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> *<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> */<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> @Deprecated<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> boolean checkAndMutate(byte [] row, byte [] family, byte [] qualifier, CompareOperator op,<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> ByteArrayComparable comparator, TimeRange timeRange, Mutation mutation) throws IOException;<a name="line.346"></a> |
| <span class="sourceLineNo">347</span><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> /**<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * Atomically checks if a row matches the filter and if it does, it performs the mutation. See<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * checkAndRowMutate to do many checkAndPuts at a time on a single row.<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * @param row to check<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * @param filter the filter<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @param mutation data to put if check succeeds<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * @return true if mutation was applied, false otherwise<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> *<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> */<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> @Deprecated<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> default boolean checkAndMutate(byte [] row, Filter filter, Mutation mutation)<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> throws IOException {<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> return checkAndMutate(row, filter, TimeRange.allTime(), mutation);<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> }<a name="line.363"></a> |
| <span class="sourceLineNo">364</span><a name="line.364"></a> |
| <span class="sourceLineNo">365</span> /**<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * Atomically checks if a row value matches the filter and if it does, it performs the mutation.<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * See checkAndRowMutate to do many checkAndPuts at a time on a single row.<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * @param row to check<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @param filter the filter<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @param mutation data to put if check succeeds<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * @param timeRange time range to check<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * @return true if mutation was applied, false otherwise<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> *<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> */<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> @Deprecated<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> boolean checkAndMutate(byte [] row, Filter filter, TimeRange timeRange, Mutation mutation)<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> throws IOException;<a name="line.379"></a> |
| <span class="sourceLineNo">380</span><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> /**<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * Atomically checks if a row/family/qualifier value matches the expected values and if it does,<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * it performs the row mutations. If the passed value is null, the lack of column value<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * (ie: non-existence) is used. Use to do many mutations on a single row. Use checkAndMutate<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * to do one checkAndMutate at a time.<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * @param row to check<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * @param family column family to check<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * @param qualifier column qualifier to check<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * @param op the comparison operator<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * @param comparator the expected value<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * @param mutations data to put if check succeeds<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * @return true if mutations were applied, false otherwise<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> *<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> */<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> @Deprecated<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> default boolean checkAndRowMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op,<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> ByteArrayComparable comparator, RowMutations mutations) throws IOException {<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> return checkAndRowMutate(row, family, qualifier, op, comparator, TimeRange.allTime(),<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> mutations);<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<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> * Atomically checks if a row/family/qualifier value matches the expected values and if it does,<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> * it performs the row mutations. If the passed value is null, the lack of column value<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * (ie: non-existence) is used. Use to do many mutations on a single row. Use checkAndMutate<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * to do one checkAndMutate at a time.<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * @param row to check<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @param family column family to check<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * @param qualifier column qualifier to check<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * @param op the comparison operator<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * @param comparator the expected value<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * @param mutations data to put if check succeeds<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * @param timeRange time range to check<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * @return true if mutations were applied, false otherwise<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> *<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> */<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> @Deprecated<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> boolean checkAndRowMutate(byte [] row, byte [] family, byte [] qualifier, CompareOperator op,<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> ByteArrayComparable comparator, TimeRange timeRange, RowMutations mutations)<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> throws IOException;<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> /**<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * Atomically checks if a row matches the filter and if it does, it performs the row mutations.<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * Use to do many mutations on a single row. Use checkAndMutate to do one checkAndMutate at a<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> * time.<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * @param row to check<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * @param filter the filter<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * @param mutations data to put if check succeeds<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> * @return true if mutations were applied, false otherwise<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> *<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> */<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> @Deprecated<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> default boolean checkAndRowMutate(byte[] row, Filter filter, RowMutations mutations)<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> throws IOException {<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> return checkAndRowMutate(row, filter, TimeRange.allTime(), mutations);<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> }<a name="line.442"></a> |
| <span class="sourceLineNo">443</span><a name="line.443"></a> |
| <span class="sourceLineNo">444</span> /**<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * Atomically checks if a row matches the filter and if it does, it performs the row mutations.<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * Use to do many mutations on a single row. Use checkAndMutate to do one checkAndMutate at a<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * time.<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * @param row to check<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * @param filter the filter<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> * @param mutations data to put if check succeeds<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> * @param timeRange time range to check<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> * @return true if mutations were applied, false otherwise<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> *<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> * @deprecated since 3.0.0 and will be removed in 4.0.0. Use<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> * {@link #checkAndMutate(CheckAndMutate)} instead.<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> */<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> @Deprecated<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> boolean checkAndRowMutate(byte [] row, Filter filter, TimeRange timeRange,<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> RowMutations mutations) throws IOException;<a name="line.459"></a> |
| <span class="sourceLineNo">460</span><a name="line.460"></a> |
| <span class="sourceLineNo">461</span> /**<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * Atomically checks if a row matches the conditions and if it does, it performs the actions.<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * Use to do many mutations on a single row. Use checkAndMutate to do one checkAndMutate at a<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * time.<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> * @param checkAndMutate the CheckAndMutate object<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * @return true if mutations were applied, false otherwise<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * @throws IOException if an error occurred in this method<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> */<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> CheckAndMutateResult checkAndMutate(CheckAndMutate checkAndMutate) throws IOException;<a name="line.469"></a> |
| <span class="sourceLineNo">470</span><a name="line.470"></a> |
| <span class="sourceLineNo">471</span> /**<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> * Deletes the specified cells/row.<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> * @param delete<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> * @throws IOException<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> */<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> void delete(Delete delete) throws IOException;<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> * Do a get based on the get parameter.<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * @param get query parameters<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @return result of the operation<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> */<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> Result get(Get get) throws IOException;<a name="line.483"></a> |
| <span class="sourceLineNo">484</span><a name="line.484"></a> |
| <span class="sourceLineNo">485</span> /**<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> * Do a get based on the get parameter.<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * @param get query parameters<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * @param withCoprocessor invoke coprocessor or not. We don't want to<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * always invoke cp.<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * @return list of cells resulting from the operation<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> */<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> List<Cell> get(Get get, boolean withCoprocessor) throws IOException;<a name="line.492"></a> |
| <span class="sourceLineNo">493</span><a name="line.493"></a> |
| <span class="sourceLineNo">494</span> /**<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> * Return an iterator that scans over the HRegion, returning the indicated<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * columns and rows specified by the {@link Scan}.<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * <p><a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * This Iterator must be closed by the caller.<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> *<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> * @param scan configured {@link Scan}<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * @return RegionScanner<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * @throws IOException read exceptions<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> */<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> RegionScanner getScanner(Scan scan) throws IOException;<a name="line.504"></a> |
| <span class="sourceLineNo">505</span><a name="line.505"></a> |
| <span class="sourceLineNo">506</span> /**<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * Return an iterator that scans over the HRegion, returning the indicated columns and rows<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * specified by the {@link Scan}. The scanner will also include the additional scanners passed<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> * along with the scanners for the specified Scan instance. Should be careful with the usage to<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * pass additional scanners only within this Region<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * <p><a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * This Iterator must be closed by the caller.<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> *<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> * @param scan configured {@link Scan}<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> * @param additionalScanners Any additional scanners to be used<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> * @return RegionScanner<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> * @throws IOException read exceptions<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> */<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> RegionScanner getScanner(Scan scan, List<KeyValueScanner> additionalScanners) throws IOException;<a name="line.519"></a> |
| <span class="sourceLineNo">520</span><a name="line.520"></a> |
| <span class="sourceLineNo">521</span> /** The comparator to be used with the region */<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> CellComparator getCellComparator();<a name="line.522"></a> |
| <span class="sourceLineNo">523</span><a name="line.523"></a> |
| <span class="sourceLineNo">524</span> /**<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> * Perform one or more increment operations on a row.<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> * @param increment<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> * @return result of the operation<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> * @throws IOException<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> */<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> Result increment(Increment increment) throws IOException;<a name="line.530"></a> |
| <span class="sourceLineNo">531</span><a name="line.531"></a> |
| <span class="sourceLineNo">532</span> /**<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * Performs multiple mutations atomically on a single row. Currently<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> * {@link Put} and {@link Delete} are supported.<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> *<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> * @param mutations object that specifies the set of mutations to perform atomically<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * @throws IOException<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> */<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> void mutateRow(RowMutations mutations) throws IOException;<a name="line.539"></a> |
| <span class="sourceLineNo">540</span><a name="line.540"></a> |
| <span class="sourceLineNo">541</span> /**<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> * Perform atomic mutations within the region.<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> *<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> * @param mutations The list of mutations to perform.<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * <code>mutations</code> can contain operations for multiple rows.<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> * Caller has to ensure that all rows are contained in this region.<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> * @param rowsToLock Rows to lock<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> * If multiple rows are locked care should be taken that<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> * <code>rowsToLock</code> is sorted in order to avoid deadlocks.<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> * @throws IOException<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> */<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> // TODO Should not be exposing with params nonceGroup, nonce. Change when doing the jira for<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> // Changing processRowsWithLocks and RowProcessor<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> void mutateRowsWithLocks(Collection<Mutation> mutations, Collection<byte[]> rowsToLock,<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> long nonceGroup, long nonce) throws IOException;<a name="line.557"></a> |
| <span class="sourceLineNo">558</span><a name="line.558"></a> |
| <span class="sourceLineNo">559</span> /**<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> * Performs atomic multiple reads and writes on a given row.<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> *<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> * @param processor The object defines the reads and writes to a row.<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> * Coprocessors instead.<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> */<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> @Deprecated<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> void processRowsWithLocks(RowProcessor<?,?> processor) throws IOException;<a name="line.567"></a> |
| <span class="sourceLineNo">568</span><a name="line.568"></a> |
| <span class="sourceLineNo">569</span> /**<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> * Performs atomic multiple reads and writes on a given row.<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> *<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> * @param processor The object defines the reads and writes to a row.<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> * Coprocessors instead.<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> */<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> // TODO Should not be exposing with params nonceGroup, nonce. Change when doing the jira for<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> // Changing processRowsWithLocks and RowProcessor<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> @Deprecated<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> void processRowsWithLocks(RowProcessor<?,?> processor, long nonceGroup, long nonce)<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> throws IOException;<a name="line.582"></a> |
| <span class="sourceLineNo">583</span><a name="line.583"></a> |
| <span class="sourceLineNo">584</span> /**<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> * Performs atomic multiple reads and writes on a given row.<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> *<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * @param processor The object defines the reads and writes to a row.<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> * @param timeout The timeout of the processor.process() execution<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> * Use a negative number to switch off the time bound<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> * @param nonceGroup Optional nonce group of the operation (client Id)<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> * @param nonce Optional nonce of the operation (unique random id to ensure "more idempotence")<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. For customization, use<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> * Coprocessors instead.<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> */<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> // TODO Should not be exposing with params nonceGroup, nonce. Change when doing the jira for<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> // Changing processRowsWithLocks and RowProcessor<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> @Deprecated<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> void processRowsWithLocks(RowProcessor<?,?> processor, long timeout, long nonceGroup, long nonce)<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> throws IOException;<a name="line.599"></a> |
| <span class="sourceLineNo">600</span><a name="line.600"></a> |
| <span class="sourceLineNo">601</span> /**<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> * Puts some data in the table.<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> * @param put<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> * @throws IOException<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> */<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> void put(Put put) throws IOException;<a name="line.606"></a> |
| <span class="sourceLineNo">607</span><a name="line.607"></a> |
| <span class="sourceLineNo">608</span> ///////////////////////////////////////////////////////////////////////////<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> // Flushes, compactions, splits, etc.<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> // Wizards only, please<a name="line.610"></a> |
| <span class="sourceLineNo">611</span><a name="line.611"></a> |
| <span class="sourceLineNo">612</span> /**<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> * @return if a given region is in compaction now.<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> */<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> CompactionState getCompactionState();<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> * Request compaction on this region.<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> */<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> void requestCompaction(String why, int priority, boolean major,<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> CompactionLifeCycleTracker tracker) throws IOException;<a name="line.621"></a> |
| <span class="sourceLineNo">622</span><a name="line.622"></a> |
| <span class="sourceLineNo">623</span> /**<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> * Request compaction for the given family<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> */<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> void requestCompaction(byte[] family, String why, int priority, boolean major,<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> CompactionLifeCycleTracker tracker) 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> * Request flush on this region.<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> */<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> void requestFlush(FlushLifeCycleTracker tracker) throws IOException;<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> * Wait for all current flushes of the region to complete<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> *<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> * @param timeout The maximum time to wait in milliseconds.<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * @return False when timeout elapsed but flushes are not over. True when flushes are over within<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> * max wait time period.<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> */<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> boolean waitForFlushes(long timeout);<a name="line.641"></a> |
| <span class="sourceLineNo">642</span>}<a name="line.642"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
