| <!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.querymatcher;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.Cell;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.regionserver.ShipperListener;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher.MatchCode;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>/**<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Implementing classes of this interface will be used for the tracking and enforcement of columns<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * and numbers of versions and timeToLive during the course of a Get or Scan operation.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <p><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Currently there are two different types of Store/Family-level queries.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <ul><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <li>{@link ExplicitColumnTracker} is used when the query specifies one or more column qualifiers<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * to return in the family.</li><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <li>{@link ScanWildcardColumnTracker} is used when no columns are explicitly specified.</li><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * </ul><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <p><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * This class is utilized by {@link ScanQueryMatcher} mainly through two methods:<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <ul><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <li>{@link #checkColumn} is called when a Put satisfies all other conditions of the query.</li><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li>{@link #getNextRowOrNextColumn} is called whenever ScanQueryMatcher believes that the current<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * column should be skipped (by timestamp, filter etc.)</li><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * </ul><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * These two methods returns a<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * {@link org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher.MatchCode} to define<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * what action should be taken.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * This class is NOT thread-safe as queries are never multi-threaded<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@InterfaceAudience.Private<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public interface ColumnTracker extends ShipperListener {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Checks if the column is present in the list of requested columns by returning the match code<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * instance. It does not check against the number of versions for the columns asked for. To do the<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * version check, one has to call {@link #checkVersions(Cell, long, byte, boolean)} method based<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * on the return type (INCLUDE) of this method. The values that can be returned by this method are<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * {@link MatchCode#INCLUDE}, {@link MatchCode#SEEK_NEXT_COL} and {@link MatchCode#SEEK_NEXT_ROW}.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param cell a cell with the column to match against<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @param type The type of the Cell<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @return The match code instance.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @throws IOException in case there is an internal consistency problem caused by a data<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * corruption.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> ScanQueryMatcher.MatchCode checkColumn(Cell cell, byte type) throws IOException;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * Keeps track of the number of versions for the columns asked for. It assumes that the user has<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * already checked if the cell needs to be included by calling the<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * {@link #checkColumn(Cell, byte)} method. The enum values returned by this method are<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * {@link MatchCode#SKIP}, {@link MatchCode#INCLUDE}, {@link MatchCode#INCLUDE_AND_SEEK_NEXT_COL}<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * and {@link MatchCode#INCLUDE_AND_SEEK_NEXT_ROW}. Implementations which include all the columns<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * could just return {@link MatchCode#INCLUDE} in the {@link #checkColumn(Cell, byte)} method and<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * perform all the operations in this checkVersions method.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @param cell a cell with the column to match against<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param timestamp The timestamp of the cell.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param type the type of the key value (Put/Delete)<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param ignoreCount indicates if the KV needs to be excluded while counting (used during<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * compactions. We only count KV's that are older than all the scanners' read<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * points.)<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @return the scan query matcher match code instance<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @throws IOException in case there is an internal consistency problem caused by a data<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * corruption.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> ScanQueryMatcher.MatchCode checkVersions(Cell cell, long timestamp, byte type,<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> boolean ignoreCount) throws IOException;<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> * Resets the Matcher<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> void reset();<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /** Returns <code>true</code> when done. */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> boolean done();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Used by matcher and scan/get to get a hint of the next column to seek to after checkColumn()<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * returns SKIP. Returns the next interesting column we want, or NULL there is none (wildcard<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * scanner). Implementations aren't required to return anything useful unless the most recent call<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * was to checkColumn() and the return code was SKIP. This is pretty implementation detail-y, but<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * optimizations are like that.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @return null, or a ColumnCount that we should seek to<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> ColumnCount getColumnHint();<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Retrieve the MatchCode for the next row or column n<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> MatchCode getNextRowOrNextColumn(Cell cell);<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> * Give the tracker a chance to declare it's done based on only the timestamp to allow an early<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * out. n * @return <code>true</code> to early out based on timestamp.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> */<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> boolean isDone(long timestamp);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> /**<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * This method is used to inform the column tracker that we are done with this column. We may get<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * this information from external filters or timestamp range and we then need to indicate this<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * information to tracker. It is currently implemented for ExplicitColumnTracker. n<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> */<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> default void doneWithColumn(Cell cell) {<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
