blob: 5d19d23f720b4dad4bf3f8419b5190ac13d32c9f [file] [log] [blame]
<!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: Store">
<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.OptionalDouble;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.OptionalLong;</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.fs.FileSystem;</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.HBaseInterfaceAudience;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.client.RegionInfo;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34">/**</span>
<span class="source-line-no">035</span><span id="line-35"> * Interface for objects that hold a column family in a Region. Its a memstore and a set of zero or</span>
<span class="source-line-no">036</span><span id="line-36"> * more StoreFiles, which stretch backwards over time.</span>
<span class="source-line-no">037</span><span id="line-37"> */</span>
<span class="source-line-no">038</span><span id="line-38">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span>
<span class="source-line-no">039</span><span id="line-39">@InterfaceStability.Evolving</span>
<span class="source-line-no">040</span><span id="line-40">public interface Store {</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> /**</span>
<span class="source-line-no">043</span><span id="line-43"> * The default priority for user-specified compaction requests. The user gets top priority unless</span>
<span class="source-line-no">044</span><span id="line-44"> * we have blocking compactions. (Pri &lt;= 0)</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46"> int PRIORITY_USER = 1;</span>
<span class="source-line-no">047</span><span id="line-47"> int NO_PRIORITY = Integer.MIN_VALUE;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> // General Accessors</span>
<span class="source-line-no">050</span><span id="line-50"> CellComparator getComparator();</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> Collection&lt;? extends StoreFile&gt; getStorefiles();</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> Collection&lt;? extends StoreFile&gt; getCompactedFiles();</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> /**</span>
<span class="source-line-no">057</span><span id="line-57"> * When was the last edit done in the memstore</span>
<span class="source-line-no">058</span><span id="line-58"> */</span>
<span class="source-line-no">059</span><span id="line-59"> long timeOfOldestEdit();</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> FileSystem getFileSystem();</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> /**</span>
<span class="source-line-no">064</span><span id="line-64"> * Tests whether we should run a major compaction. For example, if the configured major compaction</span>
<span class="source-line-no">065</span><span id="line-65"> * interval is reached.</span>
<span class="source-line-no">066</span><span id="line-66"> * @return true if we should run a major compaction.</span>
<span class="source-line-no">067</span><span id="line-67"> */</span>
<span class="source-line-no">068</span><span id="line-68"> boolean shouldPerformMajorCompaction() throws IOException;</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> /**</span>
<span class="source-line-no">071</span><span id="line-71"> * See if there's too much store files in this store</span>
<span class="source-line-no">072</span><span id="line-72"> * @return &lt;code&gt;true&lt;/code&gt; if number of store files is greater than the number defined in</span>
<span class="source-line-no">073</span><span id="line-73"> * minFilesToCompact</span>
<span class="source-line-no">074</span><span id="line-74"> */</span>
<span class="source-line-no">075</span><span id="line-75"> boolean needsCompaction();</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> int getCompactPriority();</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> /**</span>
<span class="source-line-no">080</span><span id="line-80"> * Returns whether this store is splittable, i.e., no reference file in this store.</span>
<span class="source-line-no">081</span><span id="line-81"> */</span>
<span class="source-line-no">082</span><span id="line-82"> boolean canSplit();</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> /** Returns &lt;code&gt;true&lt;/code&gt; if the store has any underlying reference files to older HFiles */</span>
<span class="source-line-no">085</span><span id="line-85"> boolean hasReferences();</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> /** Returns The size of this store's memstore. */</span>
<span class="source-line-no">088</span><span id="line-88"> MemStoreSize getMemStoreSize();</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> /**</span>
<span class="source-line-no">091</span><span id="line-91"> * @return The amount of memory we could flush from this memstore; usually this is equal to</span>
<span class="source-line-no">092</span><span id="line-92"> * {@link #getMemStoreSize()} unless we are carrying snapshots and then it will be the</span>
<span class="source-line-no">093</span><span id="line-93"> * size of outstanding snapshots.</span>
<span class="source-line-no">094</span><span id="line-94"> */</span>
<span class="source-line-no">095</span><span id="line-95"> MemStoreSize getFlushableSize();</span>
<span class="source-line-no">096</span><span id="line-96"></span>
<span class="source-line-no">097</span><span id="line-97"> /** Returns size of the memstore snapshot */</span>
<span class="source-line-no">098</span><span id="line-98"> MemStoreSize getSnapshotSize();</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> ColumnFamilyDescriptor getColumnFamilyDescriptor();</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> /** Returns The maximum sequence id in all store files. */</span>
<span class="source-line-no">103</span><span id="line-103"> OptionalLong getMaxSequenceId();</span>
<span class="source-line-no">104</span><span id="line-104"></span>
<span class="source-line-no">105</span><span id="line-105"> /** Returns The maximum memstoreTS in all store files. */</span>
<span class="source-line-no">106</span><span id="line-106"> OptionalLong getMaxMemStoreTS();</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> /** Returns aggregate size of all HStores used in the last compaction */</span>
<span class="source-line-no">109</span><span id="line-109"> long getLastCompactSize();</span>
<span class="source-line-no">110</span><span id="line-110"></span>
<span class="source-line-no">111</span><span id="line-111"> /** Returns aggregate size of HStore */</span>
<span class="source-line-no">112</span><span id="line-112"> long getSize();</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> /** Returns Count of store files */</span>
<span class="source-line-no">115</span><span id="line-115"> int getStorefilesCount();</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> /** Returns Count of compacted store files */</span>
<span class="source-line-no">118</span><span id="line-118"> int getCompactedFilesCount();</span>
<span class="source-line-no">119</span><span id="line-119"></span>
<span class="source-line-no">120</span><span id="line-120"> /** Returns Max age of store files in this store */</span>
<span class="source-line-no">121</span><span id="line-121"> OptionalLong getMaxStoreFileAge();</span>
<span class="source-line-no">122</span><span id="line-122"></span>
<span class="source-line-no">123</span><span id="line-123"> /** Returns Min age of store files in this store */</span>
<span class="source-line-no">124</span><span id="line-124"> OptionalLong getMinStoreFileAge();</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> /** Returns Average age of store files in this store */</span>
<span class="source-line-no">127</span><span id="line-127"> OptionalDouble getAvgStoreFileAge();</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> /** Returns Number of reference files in this store */</span>
<span class="source-line-no">130</span><span id="line-130"> long getNumReferenceFiles();</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> /** Returns Number of HFiles in this store */</span>
<span class="source-line-no">133</span><span id="line-133"> long getNumHFiles();</span>
<span class="source-line-no">134</span><span id="line-134"></span>
<span class="source-line-no">135</span><span id="line-135"> /** Returns The size of the store files, in bytes, uncompressed. */</span>
<span class="source-line-no">136</span><span id="line-136"> long getStoreSizeUncompressed();</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> /** Returns The size of the store files, in bytes. */</span>
<span class="source-line-no">139</span><span id="line-139"> long getStorefilesSize();</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 The size of only the store files which are HFiles, in bytes. */</span>
<span class="source-line-no">142</span><span id="line-142"> long getHFilesSize();</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 The size of the store file root-level indexes, in bytes. */</span>
<span class="source-line-no">145</span><span id="line-145"> long getStorefilesRootLevelIndexSize();</span>
<span class="source-line-no">146</span><span id="line-146"></span>
<span class="source-line-no">147</span><span id="line-147"> /**</span>
<span class="source-line-no">148</span><span id="line-148"> * Returns the total size of all index blocks in the data block indexes, including the root level,</span>
<span class="source-line-no">149</span><span id="line-149"> * intermediate levels, and the leaf level for multi-level indexes, or just the root level for</span>
<span class="source-line-no">150</span><span id="line-150"> * single-level indexes.</span>
<span class="source-line-no">151</span><span id="line-151"> * @return the total size of block indexes in the store</span>
<span class="source-line-no">152</span><span id="line-152"> */</span>
<span class="source-line-no">153</span><span id="line-153"> long getTotalStaticIndexSize();</span>
<span class="source-line-no">154</span><span id="line-154"></span>
<span class="source-line-no">155</span><span id="line-155"> /**</span>
<span class="source-line-no">156</span><span id="line-156"> * Returns the total byte size of all Bloom filter bit arrays. For compound Bloom filters even the</span>
<span class="source-line-no">157</span><span id="line-157"> * Bloom blocks currently not loaded into the block cache are counted.</span>
<span class="source-line-no">158</span><span id="line-158"> * @return the total size of all Bloom filters in the store</span>
<span class="source-line-no">159</span><span id="line-159"> */</span>
<span class="source-line-no">160</span><span id="line-160"> long getTotalStaticBloomSize();</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> /** Returns the parent region info hosting this store */</span>
<span class="source-line-no">163</span><span id="line-163"> RegionInfo getRegionInfo();</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> boolean areWritesEnabled();</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 The smallest mvcc readPoint across all the scanners in this region. Writes older than</span>
<span class="source-line-no">169</span><span id="line-169"> * this readPoint, are included in every read operation.</span>
<span class="source-line-no">170</span><span id="line-170"> */</span>
<span class="source-line-no">171</span><span id="line-171"> long getSmallestReadPoint();</span>
<span class="source-line-no">172</span><span id="line-172"></span>
<span class="source-line-no">173</span><span id="line-173"> String getColumnFamilyName();</span>
<span class="source-line-no">174</span><span id="line-174"></span>
<span class="source-line-no">175</span><span id="line-175"> TableName getTableName();</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 number of cells flushed to disk */</span>
<span class="source-line-no">178</span><span id="line-178"> long getFlushedCellsCount();</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 total size of data flushed to disk, in bytes */</span>
<span class="source-line-no">181</span><span id="line-181"> long getFlushedCellsSize();</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 total size of out output files on disk, in bytes */</span>
<span class="source-line-no">184</span><span id="line-184"> long getFlushedOutputFileSize();</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 cells processed during minor compactions */</span>
<span class="source-line-no">187</span><span id="line-187"> long getCompactedCellsCount();</span>
<span class="source-line-no">188</span><span id="line-188"></span>
<span class="source-line-no">189</span><span id="line-189"> /** Returns The total amount of data processed during minor compactions, in bytes */</span>
<span class="source-line-no">190</span><span id="line-190"> long getCompactedCellsSize();</span>
<span class="source-line-no">191</span><span id="line-191"></span>
<span class="source-line-no">192</span><span id="line-192"> /** Returns The number of cells processed during major compactions */</span>
<span class="source-line-no">193</span><span id="line-193"> long getMajorCompactedCellsCount();</span>
<span class="source-line-no">194</span><span id="line-194"></span>
<span class="source-line-no">195</span><span id="line-195"> /** Returns The total amount of data processed during major compactions, in bytes */</span>
<span class="source-line-no">196</span><span id="line-196"> long getMajorCompactedCellsSize();</span>
<span class="source-line-no">197</span><span id="line-197"></span>
<span class="source-line-no">198</span><span id="line-198"> /** Returns Whether this store has too many store files. */</span>
<span class="source-line-no">199</span><span id="line-199"> boolean hasTooManyStoreFiles();</span>
<span class="source-line-no">200</span><span id="line-200"></span>
<span class="source-line-no">201</span><span id="line-201"> /**</span>
<span class="source-line-no">202</span><span id="line-202"> * Checks the underlying store files, and opens the files that have not been opened, and removes</span>
<span class="source-line-no">203</span><span id="line-203"> * the store file readers for store files no longer available. Mainly used by secondary region</span>
<span class="source-line-no">204</span><span id="line-204"> * replicas to keep up to date with the primary region files.</span>
<span class="source-line-no">205</span><span id="line-205"> */</span>
<span class="source-line-no">206</span><span id="line-206"> void refreshStoreFiles() throws IOException;</span>
<span class="source-line-no">207</span><span id="line-207"></span>
<span class="source-line-no">208</span><span id="line-208"> /**</span>
<span class="source-line-no">209</span><span id="line-209"> * This value can represent the degree of emergency of compaction for this store. It should be</span>
<span class="source-line-no">210</span><span id="line-210"> * greater than or equal to 0.0, any value greater than 1.0 means we have too many store files.</span>
<span class="source-line-no">211</span><span id="line-211"> * &lt;ul&gt;</span>
<span class="source-line-no">212</span><span id="line-212"> * &lt;li&gt;if getStorefilesCount &amp;lt;= getMinFilesToCompact, return 0.0&lt;/li&gt;</span>
<span class="source-line-no">213</span><span id="line-213"> * &lt;li&gt;return (getStorefilesCount - getMinFilesToCompact) / (blockingFileCount -</span>
<span class="source-line-no">214</span><span id="line-214"> * getMinFilesToCompact)&lt;/li&gt;</span>
<span class="source-line-no">215</span><span id="line-215"> * &lt;/ul&gt;</span>
<span class="source-line-no">216</span><span id="line-216"> * &lt;p&gt;</span>
<span class="source-line-no">217</span><span id="line-217"> * And for striped stores, we should calculate this value by the files in each stripe separately</span>
<span class="source-line-no">218</span><span id="line-218"> * and return the maximum value.</span>
<span class="source-line-no">219</span><span id="line-219"> * &lt;p&gt;</span>
<span class="source-line-no">220</span><span id="line-220"> * It is similar to {@link #getCompactPriority()} except that it is more suitable to use in a</span>
<span class="source-line-no">221</span><span id="line-221"> * linear formula.</span>
<span class="source-line-no">222</span><span id="line-222"> */</span>
<span class="source-line-no">223</span><span id="line-223"> double getCompactionPressure();</span>
<span class="source-line-no">224</span><span id="line-224"></span>
<span class="source-line-no">225</span><span id="line-225"> boolean isPrimaryReplicaStore();</span>
<span class="source-line-no">226</span><span id="line-226"></span>
<span class="source-line-no">227</span><span id="line-227"> /** Returns true if the memstore may need some extra memory space */</span>
<span class="source-line-no">228</span><span id="line-228"> boolean isSloppyMemStore();</span>
<span class="source-line-no">229</span><span id="line-229"></span>
<span class="source-line-no">230</span><span id="line-230"> int getCurrentParallelPutCount();</span>
<span class="source-line-no">231</span><span id="line-231"></span>
<span class="source-line-no">232</span><span id="line-232"> /** Returns the number of read requests purely from the memstore. */</span>
<span class="source-line-no">233</span><span id="line-233"> long getMemstoreOnlyRowReadsCount();</span>
<span class="source-line-no">234</span><span id="line-234"></span>
<span class="source-line-no">235</span><span id="line-235"> /** Returns the number of read requests from the files under this store. */</span>
<span class="source-line-no">236</span><span id="line-236"> long getMixedRowReadsCount();</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"> * @return a read only configuration of this store; throws {@link UnsupportedOperationException}</span>
<span class="source-line-no">240</span><span id="line-240"> * if you try to set a configuration.</span>
<span class="source-line-no">241</span><span id="line-241"> */</span>
<span class="source-line-no">242</span><span id="line-242"> Configuration getReadOnlyConfiguration();</span>
<span class="source-line-no">243</span><span id="line-243"></span>
<span class="source-line-no">244</span><span id="line-244"> /** Returns count of bloom filter results for this store. */</span>
<span class="source-line-no">245</span><span id="line-245"> long getBloomFilterRequestsCount();</span>
<span class="source-line-no">246</span><span id="line-246"></span>
<span class="source-line-no">247</span><span id="line-247"> /** Returns count of negative results for bloom filter requests for this store. */</span>
<span class="source-line-no">248</span><span id="line-248"> long getBloomFilterNegativeResultsCount();</span>
<span class="source-line-no">249</span><span id="line-249"></span>
<span class="source-line-no">250</span><span id="line-250"> /**</span>
<span class="source-line-no">251</span><span id="line-251"> * Returns count of requests which could have used bloom filters, but they weren't configured or</span>
<span class="source-line-no">252</span><span id="line-252"> * loaded.</span>
<span class="source-line-no">253</span><span id="line-253"> */</span>
<span class="source-line-no">254</span><span id="line-254"> long getBloomFilterEligibleRequestsCount();</span>
<span class="source-line-no">255</span><span id="line-255">}</span>
</pre>
</div>
</main>
</body>
</html>