| <!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: StoreFileManager"> |
| <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 com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Collection;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Comparator;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Iterator;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.List;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.Optional;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.Cell;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.KeyValue;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableCollection;</span> |
| <span class="source-line-no">032</span><span id="line-32"></span> |
| <span class="source-line-no">033</span><span id="line-33">/**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * Manages the store files and basic metadata about that that determines the logical structure (e.g.</span> |
| <span class="source-line-no">035</span><span id="line-35"> * what files to return for scan, how to determine split point, and such). Does NOT affect the</span> |
| <span class="source-line-no">036</span><span id="line-36"> * physical structure of files in HDFS. Example alternative structures - the default list of files</span> |
| <span class="source-line-no">037</span><span id="line-37"> * by seqNum; levelDB one sorted by level and seqNum.</span> |
| <span class="source-line-no">038</span><span id="line-38"> * <p/></span> |
| <span class="source-line-no">039</span><span id="line-39"> * Notice that, all the states are only in memory, we do not persist anything here. The only place</span> |
| <span class="source-line-no">040</span><span id="line-40"> * where we throw an {@link IOException} is the {@link #getSplitPoint()} method, where we need to</span> |
| <span class="source-line-no">041</span><span id="line-41"> * read startKey, endKey etc, which may lead to an {@link IOException}.</span> |
| <span class="source-line-no">042</span><span id="line-42"> * <p/></span> |
| <span class="source-line-no">043</span><span id="line-43"> * Implementations are assumed to be not thread safe.</span> |
| <span class="source-line-no">044</span><span id="line-44"> */</span> |
| <span class="source-line-no">045</span><span id="line-45">@InterfaceAudience.Private</span> |
| <span class="source-line-no">046</span><span id="line-46">public interface StoreFileManager {</span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Loads the initial store files into empty StoreFileManager.</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @param storeFiles The files to load.</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51"> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",</span> |
| <span class="source-line-no">052</span><span id="line-52"> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")</span> |
| <span class="source-line-no">053</span><span id="line-53"> void loadFiles(List<HStoreFile> storeFiles) throws IOException;</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> /**</span> |
| <span class="source-line-no">056</span><span id="line-56"> * Adds new files, either for from MemStore flush or bulk insert, into the structure.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * @param sfs New store files.</span> |
| <span class="source-line-no">058</span><span id="line-58"> */</span> |
| <span class="source-line-no">059</span><span id="line-59"> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",</span> |
| <span class="source-line-no">060</span><span id="line-60"> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")</span> |
| <span class="source-line-no">061</span><span id="line-61"> void insertNewFiles(Collection<HStoreFile> sfs) throws IOException;</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"> * Adds only the new compaction results into the structure.</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @param compactedFiles The input files for the compaction.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @param results The resulting files for the 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"> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",</span> |
| <span class="source-line-no">069</span><span id="line-69"> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")</span> |
| <span class="source-line-no">070</span><span id="line-70"> void addCompactionResults(Collection<HStoreFile> compactedFiles, Collection<HStoreFile> results)</span> |
| <span class="source-line-no">071</span><span id="line-71"> throws IOException;</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> /**</span> |
| <span class="source-line-no">074</span><span id="line-74"> * Remove the compacted files</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param compactedFiles the list of compacted files</span> |
| <span class="source-line-no">076</span><span id="line-76"> */</span> |
| <span class="source-line-no">077</span><span id="line-77"> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",</span> |
| <span class="source-line-no">078</span><span id="line-78"> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")</span> |
| <span class="source-line-no">079</span><span id="line-79"> void removeCompactedFiles(Collection<HStoreFile> compactedFiles);</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /**</span> |
| <span class="source-line-no">082</span><span id="line-82"> * Clears all the files currently in use and returns them.</span> |
| <span class="source-line-no">083</span><span id="line-83"> * @return The files previously in use.</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> ImmutableCollection<HStoreFile> clearFiles();</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * Clears all the compacted files and returns them. This method is expected to be accessed single</span> |
| <span class="source-line-no">089</span><span id="line-89"> * threaded.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @return The files compacted previously.</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> Collection<HStoreFile> clearCompactedFiles();</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /**</span> |
| <span class="source-line-no">095</span><span id="line-95"> * Gets the snapshot of the store files currently in use. Can be used for things like metrics and</span> |
| <span class="source-line-no">096</span><span id="line-96"> * checks; should not assume anything about relations between store files in the list.</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @return The list of StoreFiles.</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> Collection<HStoreFile> getStoreFiles();</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> /**</span> |
| <span class="source-line-no">102</span><span id="line-102"> * List of compacted files inside this store that needs to be excluded in reads because further</span> |
| <span class="source-line-no">103</span><span id="line-103"> * new reads will be using only the newly created files out of compaction. These compacted files</span> |
| <span class="source-line-no">104</span><span id="line-104"> * will be deleted/cleared once all the existing readers on these compacted files are done.</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @return the list of compacted files</span> |
| <span class="source-line-no">106</span><span id="line-106"> */</span> |
| <span class="source-line-no">107</span><span id="line-107"> Collection<HStoreFile> getCompactedfiles();</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> /**</span> |
| <span class="source-line-no">110</span><span id="line-110"> * Returns the number of files currently in use.</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @return The number of files.</span> |
| <span class="source-line-no">112</span><span id="line-112"> */</span> |
| <span class="source-line-no">113</span><span id="line-113"> int getStorefileCount();</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * Returns the number of compacted files.</span> |
| <span class="source-line-no">117</span><span id="line-117"> * @return The number of files.</span> |
| <span class="source-line-no">118</span><span id="line-118"> */</span> |
| <span class="source-line-no">119</span><span id="line-119"> int getCompactedFilesCount();</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> /**</span> |
| <span class="source-line-no">122</span><span id="line-122"> * Gets the store files to scan for a Scan or Get request.</span> |
| <span class="source-line-no">123</span><span id="line-123"> * @param startRow Start row of the request.</span> |
| <span class="source-line-no">124</span><span id="line-124"> * @param stopRow Stop row of the request.</span> |
| <span class="source-line-no">125</span><span id="line-125"> * @param onlyLatestVersion Scan only latest live version cells.</span> |
| <span class="source-line-no">126</span><span id="line-126"> * @return The list of files that are to be read for this request.</span> |
| <span class="source-line-no">127</span><span id="line-127"> */</span> |
| <span class="source-line-no">128</span><span id="line-128"> Collection<HStoreFile> getFilesForScan(byte[] startRow, boolean includeStartRow, byte[] stopRow,</span> |
| <span class="source-line-no">129</span><span id="line-129"> boolean includeStopRow, boolean onlyLatestVersion);</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> /**</span> |
| <span class="source-line-no">132</span><span id="line-132"> * Gets initial, full list of candidate store files to check for row-key-before.</span> |
| <span class="source-line-no">133</span><span id="line-133"> * @param targetKey The key that is the basis of the search.</span> |
| <span class="source-line-no">134</span><span id="line-134"> * @return The files that may have the key less than or equal to targetKey, in reverse order of</span> |
| <span class="source-line-no">135</span><span id="line-135"> * new-ness, and preference for target key.</span> |
| <span class="source-line-no">136</span><span id="line-136"> */</span> |
| <span class="source-line-no">137</span><span id="line-137"> Iterator<HStoreFile> getCandidateFilesForRowKeyBefore(KeyValue targetKey);</span> |
| <span class="source-line-no">138</span><span id="line-138"></span> |
| <span class="source-line-no">139</span><span id="line-139"> /**</span> |
| <span class="source-line-no">140</span><span id="line-140"> * Updates the candidate list for finding row key before. Based on the list of candidates</span> |
| <span class="source-line-no">141</span><span id="line-141"> * remaining to check from getCandidateFilesForRowKeyBefore, targetKey and current candidate, may</span> |
| <span class="source-line-no">142</span><span id="line-142"> * trim and reorder the list to remove the files where a better candidate cannot be found.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * @param candidateFiles The candidate files not yet checked for better candidates - return value</span> |
| <span class="source-line-no">144</span><span id="line-144"> * from {@link #getCandidateFilesForRowKeyBefore(KeyValue)}, with some files</span> |
| <span class="source-line-no">145</span><span id="line-145"> * already removed.</span> |
| <span class="source-line-no">146</span><span id="line-146"> * @param targetKey The key to search for.</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @param candidate The current best candidate found.</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @return The list to replace candidateFiles.</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> Iterator<HStoreFile> updateCandidateFilesForRowKeyBefore(Iterator<HStoreFile> candidateFiles,</span> |
| <span class="source-line-no">151</span><span id="line-151"> KeyValue targetKey, Cell candidate);</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"> * Gets the split point for the split of this set of store files (approx. middle).</span> |
| <span class="source-line-no">155</span><span id="line-155"> * @return The mid-point if possible.</span> |
| <span class="source-line-no">156</span><span id="line-156"> */</span> |
| <span class="source-line-no">157</span><span id="line-157"> Optional<byte[]> getSplitPoint() throws IOException;</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> /** Returns The store compaction priority. */</span> |
| <span class="source-line-no">160</span><span id="line-160"> int getStoreCompactionPriority();</span> |
| <span class="source-line-no">161</span><span id="line-161"></span> |
| <span class="source-line-no">162</span><span id="line-162"> /**</span> |
| <span class="source-line-no">163</span><span id="line-163"> * @param maxTs Maximum expired timestamp.</span> |
| <span class="source-line-no">164</span><span id="line-164"> * @param filesCompacting Files that are currently compacting.</span> |
| <span class="source-line-no">165</span><span id="line-165"> * @return The files which don't have any necessary data according to TTL and other criteria.</span> |
| <span class="source-line-no">166</span><span id="line-166"> */</span> |
| <span class="source-line-no">167</span><span id="line-167"> Collection<HStoreFile> getUnneededFiles(long maxTs, List<HStoreFile> filesCompacting);</span> |
| <span class="source-line-no">168</span><span id="line-168"></span> |
| <span class="source-line-no">169</span><span id="line-169"> /**</span> |
| <span class="source-line-no">170</span><span id="line-170"> * @return the compaction pressure used for compaction throughput tuning.</span> |
| <span class="source-line-no">171</span><span id="line-171"> * @see HStore#getCompactionPressure()</span> |
| <span class="source-line-no">172</span><span id="line-172"> */</span> |
| <span class="source-line-no">173</span><span id="line-173"> double getCompactionPressure();</span> |
| <span class="source-line-no">174</span><span id="line-174"></span> |
| <span class="source-line-no">175</span><span id="line-175"> /**</span> |
| <span class="source-line-no">176</span><span id="line-176"> * @return the comparator used to sort storefiles. Usually, the</span> |
| <span class="source-line-no">177</span><span id="line-177"> * {@link HStoreFile#getMaxSequenceId()} is the first priority.</span> |
| <span class="source-line-no">178</span><span id="line-178"> */</span> |
| <span class="source-line-no">179</span><span id="line-179"> Comparator<HStoreFile> getStoreFileComparator();</span> |
| <span class="source-line-no">180</span><span id="line-180">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
