http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1241ee85/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/KeyValueScanner.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/KeyValueScanner.html b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/KeyValueScanner.html index cc7046c..b0c7b40 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/KeyValueScanner.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/KeyValueScanner.html @@ -30,158 +30,165 @@ <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> <span class="sourceLineNo">023</span><a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span>/**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * Scanner that returns the next KeyValue.<a name="line.30"></a> -<span class="sourceLineNo">031</span> */<a name="line.31"></a> -<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a> -<span class="sourceLineNo">033</span>// TODO: Change name from KeyValueScanner to CellScanner only we already have a simple CellScanner<a name="line.33"></a> -<span class="sourceLineNo">034</span>// so this should be something else altogether, a decoration on our base CellScanner. TODO.<a name="line.34"></a> -<span class="sourceLineNo">035</span>// This class shows in CPs so do it all in one swell swoop. HBase-2.0.0.<a name="line.35"></a> -<span class="sourceLineNo">036</span>public interface KeyValueScanner extends Shipper, Closeable {<a name="line.36"></a> -<span class="sourceLineNo">037</span> /**<a name="line.37"></a> -<span class="sourceLineNo">038</span> * The byte array represents for NO_NEXT_INDEXED_KEY;<a name="line.38"></a> -<span class="sourceLineNo">039</span> * The actual value is irrelevant because this is always compared by reference.<a name="line.39"></a> -<span class="sourceLineNo">040</span> */<a name="line.40"></a> -<span class="sourceLineNo">041</span> public static final Cell NO_NEXT_INDEXED_KEY = new KeyValue();<a name="line.41"></a> -<span class="sourceLineNo">042</span><a name="line.42"></a> -<span class="sourceLineNo">043</span> /**<a name="line.43"></a> -<span class="sourceLineNo">044</span> * Look at the next Cell in this scanner, but do not iterate scanner.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * NOTICE: The returned cell has not been passed into ScanQueryMatcher. So it may not be what the<a name="line.45"></a> -<span class="sourceLineNo">046</span> * user need.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * @return the next Cell<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span> Cell peek();<a name="line.49"></a> -<span class="sourceLineNo">050</span><a name="line.50"></a> -<span class="sourceLineNo">051</span> /**<a name="line.51"></a> -<span class="sourceLineNo">052</span> * Return the next Cell in this scanner, iterating the scanner<a name="line.52"></a> -<span class="sourceLineNo">053</span> * @return the next Cell<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> Cell next() throws IOException;<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> /**<a name="line.57"></a> -<span class="sourceLineNo">058</span> * Seek the scanner at or after the specified KeyValue.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param key seek value<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @return true if scanner has values left, false if end of scanner<a name="line.60"></a> -<span class="sourceLineNo">061</span> */<a name="line.61"></a> -<span class="sourceLineNo">062</span> boolean seek(Cell key) throws IOException;<a name="line.62"></a> -<span class="sourceLineNo">063</span><a name="line.63"></a> -<span class="sourceLineNo">064</span> /**<a name="line.64"></a> -<span class="sourceLineNo">065</span> * Reseek the scanner at or after the specified KeyValue.<a name="line.65"></a> -<span class="sourceLineNo">066</span> * This method is guaranteed to seek at or after the required key only if the<a name="line.66"></a> -<span class="sourceLineNo">067</span> * key comes after the current position of the scanner. Should not be used<a name="line.67"></a> -<span class="sourceLineNo">068</span> * to seek to a key which may come before the current position.<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @param key seek value (should be non-null)<a name="line.69"></a> -<span class="sourceLineNo">070</span> * @return true if scanner has values left, false if end of scanner<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> boolean reseek(Cell key) throws IOException;<a name="line.72"></a> -<span class="sourceLineNo">073</span><a name="line.73"></a> -<span class="sourceLineNo">074</span> /**<a name="line.74"></a> -<span class="sourceLineNo">075</span> * Get the order of this KeyValueScanner. This is only relevant for StoreFileScanners and<a name="line.75"></a> -<span class="sourceLineNo">076</span> * MemStoreScanners (other scanners simply return 0). This is required for comparing multiple<a name="line.76"></a> -<span class="sourceLineNo">077</span> * files to find out which one has the latest data. StoreFileScanners are ordered from 0<a name="line.77"></a> -<span class="sourceLineNo">078</span> * (oldest) to newest in increasing order. MemStoreScanner gets LONG.max since it always<a name="line.78"></a> -<span class="sourceLineNo">079</span> * contains freshest data.<a name="line.79"></a> -<span class="sourceLineNo">080</span> */<a name="line.80"></a> -<span class="sourceLineNo">081</span> long getScannerOrder();<a name="line.81"></a> -<span class="sourceLineNo">082</span><a name="line.82"></a> -<span class="sourceLineNo">083</span> /**<a name="line.83"></a> -<span class="sourceLineNo">084</span> * Close the KeyValue scanner.<a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> void close();<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * Allows to filter out scanners (both StoreFile and memstore) that we don't<a name="line.89"></a> -<span class="sourceLineNo">090</span> * want to use based on criteria such as Bloom filters and timestamp ranges.<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @param scan the scan that we are selecting scanners for<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @param store the store we are performing the scan on.<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @param oldestUnexpiredTS the oldest timestamp we are interested in for<a name="line.93"></a> -<span class="sourceLineNo">094</span> * this query, based on TTL<a name="line.94"></a> -<span class="sourceLineNo">095</span> * @return true if the scanner should be included in the query<a name="line.95"></a> -<span class="sourceLineNo">096</span> */<a name="line.96"></a> -<span class="sourceLineNo">097</span> boolean shouldUseScanner(Scan scan, Store store, long oldestUnexpiredTS);<a name="line.97"></a> -<span class="sourceLineNo">098</span><a name="line.98"></a> -<span class="sourceLineNo">099</span> // "Lazy scanner" optimizations<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> * Similar to {@link #seek} (or {@link #reseek} if forward is true) but only<a name="line.102"></a> -<span class="sourceLineNo">103</span> * does a seek operation after checking that it is really necessary for the<a name="line.103"></a> -<span class="sourceLineNo">104</span> * row/column combination specified by the kv parameter. This function was<a name="line.104"></a> -<span class="sourceLineNo">105</span> * added to avoid unnecessary disk seeks by checking row-column Bloom filters<a name="line.105"></a> -<span class="sourceLineNo">106</span> * before a seek on multi-column get/scan queries, and to optimize by looking<a name="line.106"></a> -<span class="sourceLineNo">107</span> * up more recent files first.<a name="line.107"></a> -<span class="sourceLineNo">108</span> * @param forward do a forward-only "reseek" instead of a random-access seek<a name="line.108"></a> -<span class="sourceLineNo">109</span> * @param useBloom whether to enable multi-column Bloom filter optimization<a name="line.109"></a> -<span class="sourceLineNo">110</span> */<a name="line.110"></a> -<span class="sourceLineNo">111</span> boolean requestSeek(Cell kv, boolean forward, boolean useBloom)<a name="line.111"></a> -<span class="sourceLineNo">112</span> throws IOException;<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * We optimize our store scanners by checking the most recent store file<a name="line.115"></a> -<span class="sourceLineNo">116</span> * first, so we sometimes pretend we have done a seek but delay it until the<a name="line.116"></a> -<span class="sourceLineNo">117</span> * store scanner bubbles up to the top of the key-value heap. This method is<a name="line.117"></a> -<span class="sourceLineNo">118</span> * then used to ensure the top store file scanner has done a seek operation.<a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span> boolean realSeekDone();<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> /**<a name="line.122"></a> -<span class="sourceLineNo">123</span> * Does the real seek operation in case it was skipped by<a name="line.123"></a> -<span class="sourceLineNo">124</span> * seekToRowCol(KeyValue, boolean) (TODO: Whats this?). Note that this function should<a name="line.124"></a> -<span class="sourceLineNo">125</span> * be never called on scanners that always do real seek operations (i.e. most<a name="line.125"></a> -<span class="sourceLineNo">126</span> * of the scanners). The easiest way to achieve this is to call<a name="line.126"></a> -<span class="sourceLineNo">127</span> * {@link #realSeekDone()} first.<a name="line.127"></a> -<span class="sourceLineNo">128</span> */<a name="line.128"></a> -<span class="sourceLineNo">129</span> void enforceSeek() throws IOException;<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> * @return true if this is a file scanner. Otherwise a memory scanner is<a name="line.132"></a> -<span class="sourceLineNo">133</span> * assumed.<a name="line.133"></a> -<span class="sourceLineNo">134</span> */<a name="line.134"></a> -<span class="sourceLineNo">135</span> boolean isFileScanner();<a name="line.135"></a> -<span class="sourceLineNo">136</span><a name="line.136"></a> -<span class="sourceLineNo">137</span> // Support for "Reversed Scanner"<a name="line.137"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.fs.Path;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Cell;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.28"></a> +<span class="sourceLineNo">029</span><a name="line.29"></a> +<span class="sourceLineNo">030</span>/**<a name="line.30"></a> +<span class="sourceLineNo">031</span> * Scanner that returns the next KeyValue.<a name="line.31"></a> +<span class="sourceLineNo">032</span> */<a name="line.32"></a> +<span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a> +<span class="sourceLineNo">034</span>// TODO: Change name from KeyValueScanner to CellScanner only we already have a simple CellScanner<a name="line.34"></a> +<span class="sourceLineNo">035</span>// so this should be something else altogether, a decoration on our base CellScanner. TODO.<a name="line.35"></a> +<span class="sourceLineNo">036</span>// This class shows in CPs so do it all in one swell swoop. HBase-2.0.0.<a name="line.36"></a> +<span class="sourceLineNo">037</span>public interface KeyValueScanner extends Shipper, Closeable {<a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * The byte array represents for NO_NEXT_INDEXED_KEY;<a name="line.39"></a> +<span class="sourceLineNo">040</span> * The actual value is irrelevant because this is always compared by reference.<a name="line.40"></a> +<span class="sourceLineNo">041</span> */<a name="line.41"></a> +<span class="sourceLineNo">042</span> public static final Cell NO_NEXT_INDEXED_KEY = new KeyValue();<a name="line.42"></a> +<span class="sourceLineNo">043</span><a name="line.43"></a> +<span class="sourceLineNo">044</span> /**<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Look at the next Cell in this scanner, but do not iterate scanner.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * NOTICE: The returned cell has not been passed into ScanQueryMatcher. So it may not be what the<a name="line.46"></a> +<span class="sourceLineNo">047</span> * user need.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * @return the next Cell<a name="line.48"></a> +<span class="sourceLineNo">049</span> */<a name="line.49"></a> +<span class="sourceLineNo">050</span> Cell peek();<a name="line.50"></a> +<span class="sourceLineNo">051</span><a name="line.51"></a> +<span class="sourceLineNo">052</span> /**<a name="line.52"></a> +<span class="sourceLineNo">053</span> * Return the next Cell in this scanner, iterating the scanner<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @return the next Cell<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> Cell next() throws IOException;<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * Seek the scanner at or after the specified KeyValue.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param key seek value<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @return true if scanner has values left, false if end of scanner<a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> boolean seek(Cell key) throws IOException;<a name="line.63"></a> +<span class="sourceLineNo">064</span><a name="line.64"></a> +<span class="sourceLineNo">065</span> /**<a name="line.65"></a> +<span class="sourceLineNo">066</span> * Reseek the scanner at or after the specified KeyValue.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * This method is guaranteed to seek at or after the required key only if the<a name="line.67"></a> +<span class="sourceLineNo">068</span> * key comes after the current position of the scanner. Should not be used<a name="line.68"></a> +<span class="sourceLineNo">069</span> * to seek to a key which may come before the current position.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @param key seek value (should be non-null)<a name="line.70"></a> +<span class="sourceLineNo">071</span> * @return true if scanner has values left, false if end of scanner<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> boolean reseek(Cell key) throws IOException;<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> /**<a name="line.75"></a> +<span class="sourceLineNo">076</span> * Get the order of this KeyValueScanner. This is only relevant for StoreFileScanners and<a name="line.76"></a> +<span class="sourceLineNo">077</span> * MemStoreScanners (other scanners simply return 0). This is required for comparing multiple<a name="line.77"></a> +<span class="sourceLineNo">078</span> * files to find out which one has the latest data. StoreFileScanners are ordered from 0<a name="line.78"></a> +<span class="sourceLineNo">079</span> * (oldest) to newest in increasing order. MemStoreScanner gets LONG.max since it always<a name="line.79"></a> +<span class="sourceLineNo">080</span> * contains freshest data.<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> long getScannerOrder();<a name="line.82"></a> +<span class="sourceLineNo">083</span><a name="line.83"></a> +<span class="sourceLineNo">084</span> /**<a name="line.84"></a> +<span class="sourceLineNo">085</span> * Close the KeyValue scanner.<a name="line.85"></a> +<span class="sourceLineNo">086</span> */<a name="line.86"></a> +<span class="sourceLineNo">087</span> void close();<a name="line.87"></a> +<span class="sourceLineNo">088</span><a name="line.88"></a> +<span class="sourceLineNo">089</span> /**<a name="line.89"></a> +<span class="sourceLineNo">090</span> * Allows to filter out scanners (both StoreFile and memstore) that we don't<a name="line.90"></a> +<span class="sourceLineNo">091</span> * want to use based on criteria such as Bloom filters and timestamp ranges.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @param scan the scan that we are selecting scanners for<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @param store the store we are performing the scan on.<a name="line.93"></a> +<span class="sourceLineNo">094</span> * @param oldestUnexpiredTS the oldest timestamp we are interested in for<a name="line.94"></a> +<span class="sourceLineNo">095</span> * this query, based on TTL<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @return true if the scanner should be included in the query<a name="line.96"></a> +<span class="sourceLineNo">097</span> */<a name="line.97"></a> +<span class="sourceLineNo">098</span> boolean shouldUseScanner(Scan scan, Store store, long oldestUnexpiredTS);<a name="line.98"></a> +<span class="sourceLineNo">099</span><a name="line.99"></a> +<span class="sourceLineNo">100</span> // "Lazy scanner" optimizations<a name="line.100"></a> +<span class="sourceLineNo">101</span><a name="line.101"></a> +<span class="sourceLineNo">102</span> /**<a name="line.102"></a> +<span class="sourceLineNo">103</span> * Similar to {@link #seek} (or {@link #reseek} if forward is true) but only<a name="line.103"></a> +<span class="sourceLineNo">104</span> * does a seek operation after checking that it is really necessary for the<a name="line.104"></a> +<span class="sourceLineNo">105</span> * row/column combination specified by the kv parameter. This function was<a name="line.105"></a> +<span class="sourceLineNo">106</span> * added to avoid unnecessary disk seeks by checking row-column Bloom filters<a name="line.106"></a> +<span class="sourceLineNo">107</span> * before a seek on multi-column get/scan queries, and to optimize by looking<a name="line.107"></a> +<span class="sourceLineNo">108</span> * up more recent files first.<a name="line.108"></a> +<span class="sourceLineNo">109</span> * @param forward do a forward-only "reseek" instead of a random-access seek<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @param useBloom whether to enable multi-column Bloom filter optimization<a name="line.110"></a> +<span class="sourceLineNo">111</span> */<a name="line.111"></a> +<span class="sourceLineNo">112</span> boolean requestSeek(Cell kv, boolean forward, boolean useBloom)<a name="line.112"></a> +<span class="sourceLineNo">113</span> throws IOException;<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> * We optimize our store scanners by checking the most recent store file<a name="line.116"></a> +<span class="sourceLineNo">117</span> * first, so we sometimes pretend we have done a seek but delay it until the<a name="line.117"></a> +<span class="sourceLineNo">118</span> * store scanner bubbles up to the top of the key-value heap. This method is<a name="line.118"></a> +<span class="sourceLineNo">119</span> * then used to ensure the top store file scanner has done a seek operation.<a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> boolean realSeekDone();<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> /**<a name="line.123"></a> +<span class="sourceLineNo">124</span> * Does the real seek operation in case it was skipped by<a name="line.124"></a> +<span class="sourceLineNo">125</span> * seekToRowCol(KeyValue, boolean) (TODO: Whats this?). Note that this function should<a name="line.125"></a> +<span class="sourceLineNo">126</span> * be never called on scanners that always do real seek operations (i.e. most<a name="line.126"></a> +<span class="sourceLineNo">127</span> * of the scanners). The easiest way to achieve this is to call<a name="line.127"></a> +<span class="sourceLineNo">128</span> * {@link #realSeekDone()} first.<a name="line.128"></a> +<span class="sourceLineNo">129</span> */<a name="line.129"></a> +<span class="sourceLineNo">130</span> void enforceSeek() throws IOException;<a name="line.130"></a> +<span class="sourceLineNo">131</span><a name="line.131"></a> +<span class="sourceLineNo">132</span> /**<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @return true if this is a file scanner. Otherwise a memory scanner is<a name="line.133"></a> +<span class="sourceLineNo">134</span> * assumed.<a name="line.134"></a> +<span class="sourceLineNo">135</span> */<a name="line.135"></a> +<span class="sourceLineNo">136</span> boolean isFileScanner();<a name="line.136"></a> +<span class="sourceLineNo">137</span><a name="line.137"></a> <span class="sourceLineNo">138</span> /**<a name="line.138"></a> -<span class="sourceLineNo">139</span> * Seek the scanner at or before the row of specified Cell, it firstly<a name="line.139"></a> -<span class="sourceLineNo">140</span> * tries to seek the scanner at or after the specified Cell, return if<a name="line.140"></a> -<span class="sourceLineNo">141</span> * peek KeyValue of scanner has the same row with specified Cell,<a name="line.141"></a> -<span class="sourceLineNo">142</span> * otherwise seek the scanner at the first Cell of the row which is the<a name="line.142"></a> -<span class="sourceLineNo">143</span> * previous row of specified KeyValue<a name="line.143"></a> -<span class="sourceLineNo">144</span> *<a name="line.144"></a> -<span class="sourceLineNo">145</span> * @param key seek KeyValue<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @return true if the scanner is at the valid KeyValue, false if such<a name="line.146"></a> -<span class="sourceLineNo">147</span> * KeyValue does not exist<a name="line.147"></a> -<span class="sourceLineNo">148</span> *<a name="line.148"></a> -<span class="sourceLineNo">149</span> */<a name="line.149"></a> -<span class="sourceLineNo">150</span> public boolean backwardSeek(Cell key) throws IOException;<a name="line.150"></a> -<span class="sourceLineNo">151</span><a name="line.151"></a> -<span class="sourceLineNo">152</span> /**<a name="line.152"></a> -<span class="sourceLineNo">153</span> * Seek the scanner at the first Cell of the row which is the previous row<a name="line.153"></a> -<span class="sourceLineNo">154</span> * of specified key<a name="line.154"></a> -<span class="sourceLineNo">155</span> * @param key seek value<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @return true if the scanner at the first valid Cell of previous row,<a name="line.156"></a> -<span class="sourceLineNo">157</span> * false if not existing such Cell<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> public boolean seekToPreviousRow(Cell key) throws IOException;<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * Seek the scanner at the first KeyValue of last row<a name="line.162"></a> -<span class="sourceLineNo">163</span> *<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @return true if scanner has values left, false if the underlying data is<a name="line.164"></a> -<span class="sourceLineNo">165</span> * empty<a name="line.165"></a> -<span class="sourceLineNo">166</span> * @throws IOException<a name="line.166"></a> -<span class="sourceLineNo">167</span> */<a name="line.167"></a> -<span class="sourceLineNo">168</span> public boolean seekToLastRow() throws IOException;<a name="line.168"></a> -<span class="sourceLineNo">169</span><a name="line.169"></a> -<span class="sourceLineNo">170</span> /**<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @return the next key in the index, usually the first key of next block OR a key that falls<a name="line.171"></a> -<span class="sourceLineNo">172</span> * between last key of current block and first key of next block..<a name="line.172"></a> -<span class="sourceLineNo">173</span> * see HFileWriterImpl#getMidpoint, or null if not known.<a name="line.173"></a> +<span class="sourceLineNo">139</span> * @return the file path if this is a file scanner, otherwise null.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * @see #isFileScanner()<a name="line.140"></a> +<span class="sourceLineNo">141</span> */<a name="line.141"></a> +<span class="sourceLineNo">142</span> Path getFilePath();<a name="line.142"></a> +<span class="sourceLineNo">143</span><a name="line.143"></a> +<span class="sourceLineNo">144</span> // Support for "Reversed Scanner"<a name="line.144"></a> +<span class="sourceLineNo">145</span> /**<a name="line.145"></a> +<span class="sourceLineNo">146</span> * Seek the scanner at or before the row of specified Cell, it firstly<a name="line.146"></a> +<span class="sourceLineNo">147</span> * tries to seek the scanner at or after the specified Cell, return if<a name="line.147"></a> +<span class="sourceLineNo">148</span> * peek KeyValue of scanner has the same row with specified Cell,<a name="line.148"></a> +<span class="sourceLineNo">149</span> * otherwise seek the scanner at the first Cell of the row which is the<a name="line.149"></a> +<span class="sourceLineNo">150</span> * previous row of specified KeyValue<a name="line.150"></a> +<span class="sourceLineNo">151</span> *<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param key seek KeyValue<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @return true if the scanner is at the valid KeyValue, false if such<a name="line.153"></a> +<span class="sourceLineNo">154</span> * KeyValue does not exist<a name="line.154"></a> +<span class="sourceLineNo">155</span> *<a name="line.155"></a> +<span class="sourceLineNo">156</span> */<a name="line.156"></a> +<span class="sourceLineNo">157</span> public boolean backwardSeek(Cell key) throws IOException;<a name="line.157"></a> +<span class="sourceLineNo">158</span><a name="line.158"></a> +<span class="sourceLineNo">159</span> /**<a name="line.159"></a> +<span class="sourceLineNo">160</span> * Seek the scanner at the first Cell of the row which is the previous row<a name="line.160"></a> +<span class="sourceLineNo">161</span> * of specified key<a name="line.161"></a> +<span class="sourceLineNo">162</span> * @param key seek value<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @return true if the scanner at the first valid Cell of previous row,<a name="line.163"></a> +<span class="sourceLineNo">164</span> * false if not existing such Cell<a name="line.164"></a> +<span class="sourceLineNo">165</span> */<a name="line.165"></a> +<span class="sourceLineNo">166</span> public boolean seekToPreviousRow(Cell key) throws IOException;<a name="line.166"></a> +<span class="sourceLineNo">167</span><a name="line.167"></a> +<span class="sourceLineNo">168</span> /**<a name="line.168"></a> +<span class="sourceLineNo">169</span> * Seek the scanner at the first KeyValue of last row<a name="line.169"></a> +<span class="sourceLineNo">170</span> *<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @return true if scanner has values left, false if the underlying data is<a name="line.171"></a> +<span class="sourceLineNo">172</span> * empty<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @throws IOException<a name="line.173"></a> <span class="sourceLineNo">174</span> */<a name="line.174"></a> -<span class="sourceLineNo">175</span> public Cell getNextIndexedKey();<a name="line.175"></a> -<span class="sourceLineNo">176</span>}<a name="line.176"></a> +<span class="sourceLineNo">175</span> public boolean seekToLastRow() throws IOException;<a name="line.175"></a> +<span class="sourceLineNo">176</span><a name="line.176"></a> +<span class="sourceLineNo">177</span> /**<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @return the next key in the index, usually the first key of next block OR a key that falls<a name="line.178"></a> +<span class="sourceLineNo">179</span> * between last key of current block and first key of next block..<a name="line.179"></a> +<span class="sourceLineNo">180</span> * see HFileWriterImpl#getMidpoint, or null if not known.<a name="line.180"></a> +<span class="sourceLineNo">181</span> */<a name="line.181"></a> +<span class="sourceLineNo">182</span> public Cell getNextIndexedKey();<a name="line.182"></a> +<span class="sourceLineNo">183</span>}<a name="line.183"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1241ee85/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/NonLazyKeyValueScanner.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/NonLazyKeyValueScanner.html b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/NonLazyKeyValueScanner.html index 8cb9d03..da6519a 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/NonLazyKeyValueScanner.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/NonLazyKeyValueScanner.html @@ -30,59 +30,68 @@ <span class="sourceLineNo">022</span><a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.commons.lang.NotImplementedException;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.26"></a> -<span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span>/**<a name="line.28"></a> -<span class="sourceLineNo">029</span> * A "non-lazy" scanner which always does a real seek operation. Most scanners<a name="line.29"></a> -<span class="sourceLineNo">030</span> * are inherited from this class.<a name="line.30"></a> -<span class="sourceLineNo">031</span> */<a name="line.31"></a> -<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a> -<span class="sourceLineNo">033</span>public abstract class NonLazyKeyValueScanner implements KeyValueScanner {<a name="line.33"></a> -<span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span> @Override<a name="line.35"></a> -<span class="sourceLineNo">036</span> public boolean requestSeek(Cell kv, boolean forward, boolean useBloom)<a name="line.36"></a> -<span class="sourceLineNo">037</span> throws IOException {<a name="line.37"></a> -<span class="sourceLineNo">038</span> return doRealSeek(this, kv, forward);<a name="line.38"></a> -<span class="sourceLineNo">039</span> }<a name="line.39"></a> -<span class="sourceLineNo">040</span><a name="line.40"></a> -<span class="sourceLineNo">041</span> @Override<a name="line.41"></a> -<span class="sourceLineNo">042</span> public boolean realSeekDone() {<a name="line.42"></a> -<span class="sourceLineNo">043</span> return true;<a name="line.43"></a> -<span class="sourceLineNo">044</span> }<a name="line.44"></a> -<span class="sourceLineNo">045</span><a name="line.45"></a> -<span class="sourceLineNo">046</span> @Override<a name="line.46"></a> -<span class="sourceLineNo">047</span> public void enforceSeek() throws IOException {<a name="line.47"></a> -<span class="sourceLineNo">048</span> throw new NotImplementedException("enforceSeek must not be called on a " +<a name="line.48"></a> -<span class="sourceLineNo">049</span> "non-lazy scanner");<a name="line.49"></a> -<span class="sourceLineNo">050</span> }<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> public static boolean doRealSeek(KeyValueScanner scanner,<a name="line.52"></a> -<span class="sourceLineNo">053</span> Cell kv, boolean forward) throws IOException {<a name="line.53"></a> -<span class="sourceLineNo">054</span> return forward ? scanner.reseek(kv) : scanner.seek(kv);<a name="line.54"></a> -<span class="sourceLineNo">055</span> }<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> @Override<a name="line.57"></a> -<span class="sourceLineNo">058</span> public boolean shouldUseScanner(Scan scan, Store store, long oldestUnexpiredTS) {<a name="line.58"></a> -<span class="sourceLineNo">059</span> // No optimizations implemented by default.<a name="line.59"></a> -<span class="sourceLineNo">060</span> return true;<a name="line.60"></a> -<span class="sourceLineNo">061</span> }<a name="line.61"></a> -<span class="sourceLineNo">062</span><a name="line.62"></a> -<span class="sourceLineNo">063</span> @Override<a name="line.63"></a> -<span class="sourceLineNo">064</span> public boolean isFileScanner() {<a name="line.64"></a> -<span class="sourceLineNo">065</span> // Not a file by default.<a name="line.65"></a> -<span class="sourceLineNo">066</span> return false;<a name="line.66"></a> -<span class="sourceLineNo">067</span> }<a name="line.67"></a> -<span class="sourceLineNo">068</span> @Override<a name="line.68"></a> -<span class="sourceLineNo">069</span> public Cell getNextIndexedKey() {<a name="line.69"></a> -<span class="sourceLineNo">070</span> return null;<a name="line.70"></a> -<span class="sourceLineNo">071</span> }<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> @Override<a name="line.73"></a> -<span class="sourceLineNo">074</span> public void shipped() throws IOException {<a name="line.74"></a> -<span class="sourceLineNo">075</span> // do nothing<a name="line.75"></a> -<span class="sourceLineNo">076</span> }<a name="line.76"></a> -<span class="sourceLineNo">077</span>}<a name="line.77"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.fs.Path;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Cell;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span>/**<a name="line.29"></a> +<span class="sourceLineNo">030</span> * A "non-lazy" scanner which always does a real seek operation. Most scanners<a name="line.30"></a> +<span class="sourceLineNo">031</span> * are inherited from this class.<a name="line.31"></a> +<span class="sourceLineNo">032</span> */<a name="line.32"></a> +<span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a> +<span class="sourceLineNo">034</span>public abstract class NonLazyKeyValueScanner implements KeyValueScanner {<a name="line.34"></a> +<span class="sourceLineNo">035</span><a name="line.35"></a> +<span class="sourceLineNo">036</span> @Override<a name="line.36"></a> +<span class="sourceLineNo">037</span> public boolean requestSeek(Cell kv, boolean forward, boolean useBloom)<a name="line.37"></a> +<span class="sourceLineNo">038</span> throws IOException {<a name="line.38"></a> +<span class="sourceLineNo">039</span> return doRealSeek(this, kv, forward);<a name="line.39"></a> +<span class="sourceLineNo">040</span> }<a name="line.40"></a> +<span class="sourceLineNo">041</span><a name="line.41"></a> +<span class="sourceLineNo">042</span> @Override<a name="line.42"></a> +<span class="sourceLineNo">043</span> public boolean realSeekDone() {<a name="line.43"></a> +<span class="sourceLineNo">044</span> return true;<a name="line.44"></a> +<span class="sourceLineNo">045</span> }<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> @Override<a name="line.47"></a> +<span class="sourceLineNo">048</span> public void enforceSeek() throws IOException {<a name="line.48"></a> +<span class="sourceLineNo">049</span> throw new NotImplementedException("enforceSeek must not be called on a " +<a name="line.49"></a> +<span class="sourceLineNo">050</span> "non-lazy scanner");<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> public static boolean doRealSeek(KeyValueScanner scanner,<a name="line.53"></a> +<span class="sourceLineNo">054</span> Cell kv, boolean forward) throws IOException {<a name="line.54"></a> +<span class="sourceLineNo">055</span> return forward ? scanner.reseek(kv) : scanner.seek(kv);<a name="line.55"></a> +<span class="sourceLineNo">056</span> }<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> @Override<a name="line.58"></a> +<span class="sourceLineNo">059</span> public boolean shouldUseScanner(Scan scan, Store store, long oldestUnexpiredTS) {<a name="line.59"></a> +<span class="sourceLineNo">060</span> // No optimizations implemented by default.<a name="line.60"></a> +<span class="sourceLineNo">061</span> return true;<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> @Override<a name="line.64"></a> +<span class="sourceLineNo">065</span> public boolean isFileScanner() {<a name="line.65"></a> +<span class="sourceLineNo">066</span> // Not a file by default.<a name="line.66"></a> +<span class="sourceLineNo">067</span> return false;<a name="line.67"></a> +<span class="sourceLineNo">068</span> }<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> @Override<a name="line.71"></a> +<span class="sourceLineNo">072</span> public Path getFilePath() {<a name="line.72"></a> +<span class="sourceLineNo">073</span> // Not a file by default.<a name="line.73"></a> +<span class="sourceLineNo">074</span> return null;<a name="line.74"></a> +<span class="sourceLineNo">075</span> }<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> @Override<a name="line.77"></a> +<span class="sourceLineNo">078</span> public Cell getNextIndexedKey() {<a name="line.78"></a> +<span class="sourceLineNo">079</span> return null;<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> @Override<a name="line.82"></a> +<span class="sourceLineNo">083</span> public void shipped() throws IOException {<a name="line.83"></a> +<span class="sourceLineNo">084</span> // do nothing<a name="line.84"></a> +<span class="sourceLineNo">085</span> }<a name="line.85"></a> +<span class="sourceLineNo">086</span>}<a name="line.86"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1241ee85/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ReversedStoreScanner.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ReversedStoreScanner.html b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ReversedStoreScanner.html index a4e33c3..927ac5c 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ReversedStoreScanner.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ReversedStoreScanner.html @@ -131,18 +131,20 @@ <span class="sourceLineNo">123</span><a name="line.123"></a> <span class="sourceLineNo">124</span> @Override<a name="line.124"></a> <span class="sourceLineNo">125</span> public boolean seekToPreviousRow(Cell key) throws IOException {<a name="line.125"></a> -<span class="sourceLineNo">126</span> boolean flushed = checkFlushed();<a name="line.126"></a> -<span class="sourceLineNo">127</span> checkReseek(flushed);<a name="line.127"></a> -<span class="sourceLineNo">128</span> return this.heap.seekToPreviousRow(key);<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span> <a name="line.130"></a> -<span class="sourceLineNo">131</span> @Override<a name="line.131"></a> -<span class="sourceLineNo">132</span> public boolean backwardSeek(Cell key) throws IOException {<a name="line.132"></a> -<span class="sourceLineNo">133</span> boolean flushed = checkFlushed();<a name="line.133"></a> -<span class="sourceLineNo">134</span> checkReseek(flushed);<a name="line.134"></a> -<span class="sourceLineNo">135</span> return this.heap.backwardSeek(key);<a name="line.135"></a> -<span class="sourceLineNo">136</span> }<a name="line.136"></a> -<span class="sourceLineNo">137</span>}<a name="line.137"></a> +<span class="sourceLineNo">126</span> if (checkFlushed()) {<a name="line.126"></a> +<span class="sourceLineNo">127</span> reopenAfterFlush();<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span> return this.heap.seekToPreviousRow(key);<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> @Override<a name="line.132"></a> +<span class="sourceLineNo">133</span> public boolean backwardSeek(Cell key) throws IOException {<a name="line.133"></a> +<span class="sourceLineNo">134</span> if (checkFlushed()) {<a name="line.134"></a> +<span class="sourceLineNo">135</span> reopenAfterFlush();<a name="line.135"></a> +<span class="sourceLineNo">136</span> }<a name="line.136"></a> +<span class="sourceLineNo">137</span> return this.heap.backwardSeek(key);<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> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1241ee85/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html index 57b3ba8..bd0bb11 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html @@ -56,108 +56,115 @@ <span class="sourceLineNo">048</span> private boolean usePread;<a name="line.48"></a> <span class="sourceLineNo">049</span> private long cellsPerTimeoutCheck;<a name="line.49"></a> <span class="sourceLineNo">050</span> private boolean parallelSeekEnabled;<a name="line.50"></a> -<span class="sourceLineNo">051</span> private final Configuration conf;<a name="line.51"></a> -<span class="sourceLineNo">052</span><a name="line.52"></a> -<span class="sourceLineNo">053</span> public static final long FIXED_OVERHEAD = ClassSize.align(ClassSize.OBJECT<a name="line.53"></a> -<span class="sourceLineNo">054</span> + (2 * ClassSize.REFERENCE) + (2 * Bytes.SIZEOF_INT)<a name="line.54"></a> -<span class="sourceLineNo">055</span> + (4 * Bytes.SIZEOF_LONG) + (3 * Bytes.SIZEOF_BOOLEAN));<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> /**<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param conf<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param family {@link HColumnDescriptor} describing the column family<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @param ttl Store's TTL (in ms)<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @param timeToPurgeDeletes duration in ms after which a delete marker can<a name="line.61"></a> -<span class="sourceLineNo">062</span> * be purged during a major compaction.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @param comparator The store's comparator<a name="line.63"></a> -<span class="sourceLineNo">064</span> */<a name="line.64"></a> -<span class="sourceLineNo">065</span> public ScanInfo(final Configuration conf, final HColumnDescriptor family, final long ttl,<a name="line.65"></a> -<span class="sourceLineNo">066</span> final long timeToPurgeDeletes, final CellComparator comparator) {<a name="line.66"></a> -<span class="sourceLineNo">067</span> this(conf, family.getName(), family.getMinVersions(), family.getMaxVersions(), ttl, family<a name="line.67"></a> -<span class="sourceLineNo">068</span> .getKeepDeletedCells(), timeToPurgeDeletes, comparator);<a name="line.68"></a> -<span class="sourceLineNo">069</span> }<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /**<a name="line.71"></a> -<span class="sourceLineNo">072</span> * @param conf<a name="line.72"></a> -<span class="sourceLineNo">073</span> * @param family Name of this store's column family<a name="line.73"></a> -<span class="sourceLineNo">074</span> * @param minVersions Store's MIN_VERSIONS setting<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @param maxVersions Store's VERSIONS setting<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param ttl Store's TTL (in ms)<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @param timeToPurgeDeletes duration in ms after which a delete marker can<a name="line.77"></a> -<span class="sourceLineNo">078</span> * be purged during a major compaction.<a name="line.78"></a> -<span class="sourceLineNo">079</span> * @param keepDeletedCells Store's keepDeletedCells setting<a name="line.79"></a> -<span class="sourceLineNo">080</span> * @param comparator The store's comparator<a name="line.80"></a> -<span class="sourceLineNo">081</span> */<a name="line.81"></a> -<span class="sourceLineNo">082</span> public ScanInfo(final Configuration conf, final byte[] family, final int minVersions,<a name="line.82"></a> -<span class="sourceLineNo">083</span> final int maxVersions, final long ttl, final KeepDeletedCells keepDeletedCells,<a name="line.83"></a> -<span class="sourceLineNo">084</span> final long timeToPurgeDeletes, final CellComparator comparator) {<a name="line.84"></a> -<span class="sourceLineNo">085</span> this.family = family;<a name="line.85"></a> -<span class="sourceLineNo">086</span> this.minVersions = minVersions;<a name="line.86"></a> -<span class="sourceLineNo">087</span> this.maxVersions = maxVersions;<a name="line.87"></a> -<span class="sourceLineNo">088</span> this.ttl = ttl;<a name="line.88"></a> -<span class="sourceLineNo">089</span> this.keepDeletedCells = keepDeletedCells;<a name="line.89"></a> -<span class="sourceLineNo">090</span> this.timeToPurgeDeletes = timeToPurgeDeletes;<a name="line.90"></a> -<span class="sourceLineNo">091</span> this.comparator = comparator;<a name="line.91"></a> -<span class="sourceLineNo">092</span> this.tableMaxRowSize =<a name="line.92"></a> -<span class="sourceLineNo">093</span> conf.getLong(HConstants.TABLE_MAX_ROWSIZE_KEY, HConstants.TABLE_MAX_ROWSIZE_DEFAULT);<a name="line.93"></a> -<span class="sourceLineNo">094</span> this.usePread = conf.getBoolean("hbase.storescanner.use.pread", false);<a name="line.94"></a> -<span class="sourceLineNo">095</span> long perHeartbeat =<a name="line.95"></a> -<span class="sourceLineNo">096</span> conf.getLong(StoreScanner.HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK,<a name="line.96"></a> -<span class="sourceLineNo">097</span> StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK);<a name="line.97"></a> -<span class="sourceLineNo">098</span> this.cellsPerTimeoutCheck = perHeartbeat > 0?<a name="line.98"></a> -<span class="sourceLineNo">099</span> perHeartbeat: StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK;<a name="line.99"></a> -<span class="sourceLineNo">100</span> this.parallelSeekEnabled =<a name="line.100"></a> -<span class="sourceLineNo">101</span> conf.getBoolean(StoreScanner.STORESCANNER_PARALLEL_SEEK_ENABLE, false);<a name="line.101"></a> -<span class="sourceLineNo">102</span> this.conf = conf;<a name="line.102"></a> -<span class="sourceLineNo">103</span> }<a name="line.103"></a> -<span class="sourceLineNo">104</span><a name="line.104"></a> -<span class="sourceLineNo">105</span> public Configuration getConfiguration() {<a name="line.105"></a> -<span class="sourceLineNo">106</span> return this.conf;<a name="line.106"></a> -<span class="sourceLineNo">107</span> }<a name="line.107"></a> -<span class="sourceLineNo">108</span><a name="line.108"></a> -<span class="sourceLineNo">109</span> long getTableMaxRowSize() {<a name="line.109"></a> -<span class="sourceLineNo">110</span> return this.tableMaxRowSize;<a name="line.110"></a> -<span class="sourceLineNo">111</span> }<a name="line.111"></a> -<span class="sourceLineNo">112</span><a name="line.112"></a> -<span class="sourceLineNo">113</span> boolean isUsePread() {<a name="line.113"></a> -<span class="sourceLineNo">114</span> return this.usePread;<a name="line.114"></a> -<span class="sourceLineNo">115</span> }<a name="line.115"></a> -<span class="sourceLineNo">116</span><a name="line.116"></a> -<span class="sourceLineNo">117</span> long getCellsPerTimeoutCheck() {<a name="line.117"></a> -<span class="sourceLineNo">118</span> return this.cellsPerTimeoutCheck;<a name="line.118"></a> -<span class="sourceLineNo">119</span> }<a name="line.119"></a> -<span class="sourceLineNo">120</span><a name="line.120"></a> -<span class="sourceLineNo">121</span> boolean isParallelSeekEnabled() {<a name="line.121"></a> -<span class="sourceLineNo">122</span> return this.parallelSeekEnabled;<a name="line.122"></a> -<span class="sourceLineNo">123</span> }<a name="line.123"></a> -<span class="sourceLineNo">124</span><a name="line.124"></a> -<span class="sourceLineNo">125</span> public byte[] getFamily() {<a name="line.125"></a> -<span class="sourceLineNo">126</span> return family;<a name="line.126"></a> -<span class="sourceLineNo">127</span> }<a name="line.127"></a> -<span class="sourceLineNo">128</span><a name="line.128"></a> -<span class="sourceLineNo">129</span> public int getMinVersions() {<a name="line.129"></a> -<span class="sourceLineNo">130</span> return minVersions;<a name="line.130"></a> -<span class="sourceLineNo">131</span> }<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> public int getMaxVersions() {<a name="line.133"></a> -<span class="sourceLineNo">134</span> return maxVersions;<a name="line.134"></a> -<span class="sourceLineNo">135</span> }<a name="line.135"></a> -<span class="sourceLineNo">136</span><a name="line.136"></a> -<span class="sourceLineNo">137</span> public long getTtl() {<a name="line.137"></a> -<span class="sourceLineNo">138</span> return ttl;<a name="line.138"></a> -<span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span><a name="line.140"></a> -<span class="sourceLineNo">141</span> public KeepDeletedCells getKeepDeletedCells() {<a name="line.141"></a> -<span class="sourceLineNo">142</span> return keepDeletedCells;<a name="line.142"></a> -<span class="sourceLineNo">143</span> }<a name="line.143"></a> -<span class="sourceLineNo">144</span><a name="line.144"></a> -<span class="sourceLineNo">145</span> public long getTimeToPurgeDeletes() {<a name="line.145"></a> -<span class="sourceLineNo">146</span> return timeToPurgeDeletes;<a name="line.146"></a> -<span class="sourceLineNo">147</span> }<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> public CellComparator getComparator() {<a name="line.149"></a> -<span class="sourceLineNo">150</span> return comparator;<a name="line.150"></a> -<span class="sourceLineNo">151</span> }<a name="line.151"></a> -<span class="sourceLineNo">152</span>}<a name="line.152"></a> +<span class="sourceLineNo">051</span> private final long preadMaxBytes;<a name="line.51"></a> +<span class="sourceLineNo">052</span> private final Configuration conf;<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> public static final long FIXED_OVERHEAD = ClassSize.align(ClassSize.OBJECT<a name="line.54"></a> +<span class="sourceLineNo">055</span> + (2 * ClassSize.REFERENCE) + (2 * Bytes.SIZEOF_INT)<a name="line.55"></a> +<span class="sourceLineNo">056</span> + (4 * Bytes.SIZEOF_LONG) + (3 * Bytes.SIZEOF_BOOLEAN));<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param conf<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param family {@link HColumnDescriptor} describing the column family<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param ttl Store's TTL (in ms)<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param timeToPurgeDeletes duration in ms after which a delete marker can be purged during a<a name="line.62"></a> +<span class="sourceLineNo">063</span> * major compaction.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @param comparator The store's comparator<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span> public ScanInfo(final Configuration conf, final HColumnDescriptor family, final long ttl,<a name="line.66"></a> +<span class="sourceLineNo">067</span> final long timeToPurgeDeletes, final CellComparator comparator) {<a name="line.67"></a> +<span class="sourceLineNo">068</span> this(conf, family.getName(), family.getMinVersions(), family.getMaxVersions(), ttl,<a name="line.68"></a> +<span class="sourceLineNo">069</span> family.getKeepDeletedCells(), family.getBlocksize(), timeToPurgeDeletes, comparator);<a name="line.69"></a> +<span class="sourceLineNo">070</span> }<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> /**<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param conf<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @param family Name of this store's column family<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @param minVersions Store's MIN_VERSIONS setting<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @param maxVersions Store's VERSIONS setting<a name="line.76"></a> +<span class="sourceLineNo">077</span> * @param ttl Store's TTL (in ms)<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @param blockSize Store's block size<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @param timeToPurgeDeletes duration in ms after which a delete marker can<a name="line.79"></a> +<span class="sourceLineNo">080</span> * be purged during a major compaction.<a name="line.80"></a> +<span class="sourceLineNo">081</span> * @param keepDeletedCells Store's keepDeletedCells setting<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @param comparator The store's comparator<a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span> public ScanInfo(final Configuration conf, final byte[] family, final int minVersions,<a name="line.84"></a> +<span class="sourceLineNo">085</span> final int maxVersions, final long ttl, final KeepDeletedCells keepDeletedCells,<a name="line.85"></a> +<span class="sourceLineNo">086</span> final long blockSize, final long timeToPurgeDeletes, final CellComparator comparator) {<a name="line.86"></a> +<span class="sourceLineNo">087</span> this.family = family;<a name="line.87"></a> +<span class="sourceLineNo">088</span> this.minVersions = minVersions;<a name="line.88"></a> +<span class="sourceLineNo">089</span> this.maxVersions = maxVersions;<a name="line.89"></a> +<span class="sourceLineNo">090</span> this.ttl = ttl;<a name="line.90"></a> +<span class="sourceLineNo">091</span> this.keepDeletedCells = keepDeletedCells;<a name="line.91"></a> +<span class="sourceLineNo">092</span> this.timeToPurgeDeletes = timeToPurgeDeletes;<a name="line.92"></a> +<span class="sourceLineNo">093</span> this.comparator = comparator;<a name="line.93"></a> +<span class="sourceLineNo">094</span> this.tableMaxRowSize =<a name="line.94"></a> +<span class="sourceLineNo">095</span> conf.getLong(HConstants.TABLE_MAX_ROWSIZE_KEY, HConstants.TABLE_MAX_ROWSIZE_DEFAULT);<a name="line.95"></a> +<span class="sourceLineNo">096</span> this.usePread = conf.getBoolean("hbase.storescanner.use.pread", false);<a name="line.96"></a> +<span class="sourceLineNo">097</span> long perHeartbeat =<a name="line.97"></a> +<span class="sourceLineNo">098</span> conf.getLong(StoreScanner.HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK,<a name="line.98"></a> +<span class="sourceLineNo">099</span> StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK);<a name="line.99"></a> +<span class="sourceLineNo">100</span> this.cellsPerTimeoutCheck = perHeartbeat > 0?<a name="line.100"></a> +<span class="sourceLineNo">101</span> perHeartbeat: StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK;<a name="line.101"></a> +<span class="sourceLineNo">102</span> this.parallelSeekEnabled =<a name="line.102"></a> +<span class="sourceLineNo">103</span> conf.getBoolean(StoreScanner.STORESCANNER_PARALLEL_SEEK_ENABLE, false);<a name="line.103"></a> +<span class="sourceLineNo">104</span> this.preadMaxBytes = conf.getLong(StoreScanner.STORESCANNER_PREAD_MAX_BYTES, 4 * blockSize);<a name="line.104"></a> +<span class="sourceLineNo">105</span> this.conf = conf;<a name="line.105"></a> +<span class="sourceLineNo">106</span> }<a name="line.106"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> public Configuration getConfiguration() {<a name="line.108"></a> +<span class="sourceLineNo">109</span> return this.conf;<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> long getTableMaxRowSize() {<a name="line.112"></a> +<span class="sourceLineNo">113</span> return this.tableMaxRowSize;<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> boolean isUsePread() {<a name="line.116"></a> +<span class="sourceLineNo">117</span> return this.usePread;<a name="line.117"></a> +<span class="sourceLineNo">118</span> }<a name="line.118"></a> +<span class="sourceLineNo">119</span><a name="line.119"></a> +<span class="sourceLineNo">120</span> long getCellsPerTimeoutCheck() {<a name="line.120"></a> +<span class="sourceLineNo">121</span> return this.cellsPerTimeoutCheck;<a name="line.121"></a> +<span class="sourceLineNo">122</span> }<a name="line.122"></a> +<span class="sourceLineNo">123</span><a name="line.123"></a> +<span class="sourceLineNo">124</span> boolean isParallelSeekEnabled() {<a name="line.124"></a> +<span class="sourceLineNo">125</span> return this.parallelSeekEnabled;<a name="line.125"></a> +<span class="sourceLineNo">126</span> }<a name="line.126"></a> +<span class="sourceLineNo">127</span><a name="line.127"></a> +<span class="sourceLineNo">128</span> public byte[] getFamily() {<a name="line.128"></a> +<span class="sourceLineNo">129</span> return family;<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> public int getMinVersions() {<a name="line.132"></a> +<span class="sourceLineNo">133</span> return minVersions;<a name="line.133"></a> +<span class="sourceLineNo">134</span> }<a name="line.134"></a> +<span class="sourceLineNo">135</span><a name="line.135"></a> +<span class="sourceLineNo">136</span> public int getMaxVersions() {<a name="line.136"></a> +<span class="sourceLineNo">137</span> return maxVersions;<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> public long getTtl() {<a name="line.140"></a> +<span class="sourceLineNo">141</span> return ttl;<a name="line.141"></a> +<span class="sourceLineNo">142</span> }<a name="line.142"></a> +<span class="sourceLineNo">143</span><a name="line.143"></a> +<span class="sourceLineNo">144</span> public KeepDeletedCells getKeepDeletedCells() {<a name="line.144"></a> +<span class="sourceLineNo">145</span> return keepDeletedCells;<a name="line.145"></a> +<span class="sourceLineNo">146</span> }<a name="line.146"></a> +<span class="sourceLineNo">147</span><a name="line.147"></a> +<span class="sourceLineNo">148</span> public long getTimeToPurgeDeletes() {<a name="line.148"></a> +<span class="sourceLineNo">149</span> return timeToPurgeDeletes;<a name="line.149"></a> +<span class="sourceLineNo">150</span> }<a name="line.150"></a> +<span class="sourceLineNo">151</span><a name="line.151"></a> +<span class="sourceLineNo">152</span> public CellComparator getComparator() {<a name="line.152"></a> +<span class="sourceLineNo">153</span> return comparator;<a name="line.153"></a> +<span class="sourceLineNo">154</span> }<a name="line.154"></a> +<span class="sourceLineNo">155</span><a name="line.155"></a> +<span class="sourceLineNo">156</span> long getPreadMaxBytes() {<a name="line.156"></a> +<span class="sourceLineNo">157</span> return preadMaxBytes;<a name="line.157"></a> +<span class="sourceLineNo">158</span> }<a name="line.158"></a> +<span class="sourceLineNo">159</span>}<a name="line.159"></a>
