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