| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import com.google.errorprone.annotations.RestrictedApi;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Comparator;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Iterator;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Optional;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.Cell;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableCollection;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>/**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Manages the store files and basic metadata about that that determines the logical structure (e.g.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * what files to return for scan, how to determine split point, and such). Does NOT affect the<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * physical structure of files in HDFS. Example alternative structures - the default list of files<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * by seqNum; levelDB one sorted by level and seqNum.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p/><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Notice that, all the states are only in memory, we do not persist anything here. The only place<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * where we throw an {@link IOException} is the {@link #getSplitPoint()} method, where we need to<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * read startKey, endKey etc, which may lead to an {@link IOException}.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p/><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Implementations are assumed to be not thread safe.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>@InterfaceAudience.Private<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>public interface StoreFileManager {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Loads the initial store files into empty StoreFileManager.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param storeFiles The files to load.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> void loadFiles(List<HStoreFile> storeFiles) throws IOException;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Adds new files, either for from MemStore flush or bulk insert, into the structure.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param sfs New store files.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> void insertNewFiles(Collection<HStoreFile> sfs) throws IOException;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Adds only the new compaction results into the structure.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param compactedFiles The input files for the compaction.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param results The resulting files for the compaction.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> void addCompactionResults(Collection<HStoreFile> compactedFiles, Collection<HStoreFile> results)<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> throws IOException;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /**<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Remove the compacted files<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @param compactedFiles the list of compacted files<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @RestrictedApi(explanation = "Should only be called in StoreEngine", link = "",<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> allowedOnPath = ".*(/org/apache/hadoop/hbase/regionserver/StoreEngine.java|/src/test/.*)")<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> void removeCompactedFiles(Collection<HStoreFile> compactedFiles);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * Clears all the files currently in use and returns them.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @return The files previously in use.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> ImmutableCollection<HStoreFile> clearFiles();<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Clears all the compacted files and returns them. This method is expected to be accessed single<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * threaded.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return The files compacted previously.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> Collection<HStoreFile> clearCompactedFiles();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> /**<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * Gets the snapshot of the store files currently in use. Can be used for things like metrics and<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * checks; should not assume anything about relations between store files in the list.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @return The list of StoreFiles.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> Collection<HStoreFile> getStoreFiles();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> /**<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * List of compacted files inside this store that needs to be excluded in reads because further<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * new reads will be using only the newly created files out of compaction. These compacted files<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * will be deleted/cleared once all the existing readers on these compacted files are done.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @return the list of compacted files<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> */<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> Collection<HStoreFile> getCompactedfiles();<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> /**<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * Returns the number of files currently in use.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @return The number of files.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> int getStorefileCount();<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /**<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * Returns the number of compacted files.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @return The number of files.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> int getCompactedFilesCount();<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> /**<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * Gets the store files to scan for a Scan or Get request.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @param startRow Start row of the request.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param stopRow Stop row of the request.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @param onlyLatestVersion Scan only latest live version cells.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @return The list of files that are to be read for this request.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> Collection<HStoreFile> getFilesForScan(byte[] startRow, boolean includeStartRow, byte[] stopRow,<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> boolean includeStopRow, boolean onlyLatestVersion);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> /**<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * Gets initial, full list of candidate store files to check for row-key-before.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param targetKey The key that is the basis of the search.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @return The files that may have the key less than or equal to targetKey, in reverse order of<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * new-ness, and preference for target key.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> */<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> Iterator<HStoreFile> getCandidateFilesForRowKeyBefore(KeyValue targetKey);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Updates the candidate list for finding row key before. Based on the list of candidates<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * remaining to check from getCandidateFilesForRowKeyBefore, targetKey and current candidate, may<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * trim and reorder the list to remove the files where a better candidate cannot be found.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param candidateFiles The candidate files not yet checked for better candidates - return value<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * from {@link #getCandidateFilesForRowKeyBefore(KeyValue)}, with some files<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * already removed.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @param targetKey The key to search for.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @param candidate The current best candidate found.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @return The list to replace candidateFiles.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> */<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> Iterator<HStoreFile> updateCandidateFilesForRowKeyBefore(Iterator<HStoreFile> candidateFiles,<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> KeyValue targetKey, Cell candidate);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> /**<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * Gets the split point for the split of this set of store files (approx. middle).<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @return The mid-point if possible.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> */<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> Optional<byte[]> getSplitPoint() throws IOException;<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> /** Returns The store compaction priority. */<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> int getStoreCompactionPriority();<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> /**<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @param maxTs Maximum expired timestamp.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @param filesCompacting Files that are currently compacting.<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * @return The files which don't have any necessary data according to TTL and other criteria.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> */<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> Collection<HStoreFile> getUnneededFiles(long maxTs, List<HStoreFile> filesCompacting);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> /**<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return the compaction pressure used for compaction throughput tuning.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @see HStore#getCompactionPressure()<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> */<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> double getCompactionPressure();<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> /**<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @return the comparator used to sort storefiles. Usually, the<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * {@link HStoreFile#getMaxSequenceId()} is the first priority.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> */<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> Comparator<HStoreFile> getStoreFileComparator();<a name="line.179"></a> |
| <span class="sourceLineNo">180</span>}<a name="line.180"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
