| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver.querymatcher, interface: ColumnTracker"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver.querymatcher;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.ExtendedCell;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.regionserver.ShipperListener;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher.MatchCode;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25"></span> |
| <span class="source-line-no">026</span><span id="line-26">/**</span> |
| <span class="source-line-no">027</span><span id="line-27"> * Implementing classes of this interface will be used for the tracking and enforcement of columns</span> |
| <span class="source-line-no">028</span><span id="line-28"> * and numbers of versions and timeToLive during the course of a Get or Scan operation.</span> |
| <span class="source-line-no">029</span><span id="line-29"> * <p></span> |
| <span class="source-line-no">030</span><span id="line-30"> * Currently there are two different types of Store/Family-level queries.</span> |
| <span class="source-line-no">031</span><span id="line-31"> * <ul></span> |
| <span class="source-line-no">032</span><span id="line-32"> * <li>{@link ExplicitColumnTracker} is used when the query specifies one or more column qualifiers</span> |
| <span class="source-line-no">033</span><span id="line-33"> * to return in the family.</li></span> |
| <span class="source-line-no">034</span><span id="line-34"> * <li>{@link ScanWildcardColumnTracker} is used when no columns are explicitly specified.</li></span> |
| <span class="source-line-no">035</span><span id="line-35"> * </ul></span> |
| <span class="source-line-no">036</span><span id="line-36"> * <p></span> |
| <span class="source-line-no">037</span><span id="line-37"> * This class is utilized by {@link ScanQueryMatcher} mainly through two methods:</span> |
| <span class="source-line-no">038</span><span id="line-38"> * <ul></span> |
| <span class="source-line-no">039</span><span id="line-39"> * <li>{@link #checkColumn} is called when a Put satisfies all other conditions of the query.</li></span> |
| <span class="source-line-no">040</span><span id="line-40"> * <li>{@link #getNextRowOrNextColumn} is called whenever ScanQueryMatcher believes that the current</span> |
| <span class="source-line-no">041</span><span id="line-41"> * column should be skipped (by timestamp, filter etc.)</li></span> |
| <span class="source-line-no">042</span><span id="line-42"> * </ul></span> |
| <span class="source-line-no">043</span><span id="line-43"> * <p></span> |
| <span class="source-line-no">044</span><span id="line-44"> * These two methods returns a</span> |
| <span class="source-line-no">045</span><span id="line-45"> * {@link org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher.MatchCode} to define</span> |
| <span class="source-line-no">046</span><span id="line-46"> * what action should be taken.</span> |
| <span class="source-line-no">047</span><span id="line-47"> * <p></span> |
| <span class="source-line-no">048</span><span id="line-48"> * This class is NOT thread-safe as queries are never multi-threaded</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50">@InterfaceAudience.Private</span> |
| <span class="source-line-no">051</span><span id="line-51">public interface ColumnTracker extends ShipperListener {</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Checks if the column is present in the list of requested columns by returning the match code</span> |
| <span class="source-line-no">055</span><span id="line-55"> * instance. It does not check against the number of versions for the columns asked for. To do the</span> |
| <span class="source-line-no">056</span><span id="line-56"> * version check, one has to call {@link #checkVersions(ExtendedCell, long, byte, boolean)} method</span> |
| <span class="source-line-no">057</span><span id="line-57"> * based on the return type (INCLUDE) of this method. The values that can be returned by this</span> |
| <span class="source-line-no">058</span><span id="line-58"> * method are {@link MatchCode#INCLUDE}, {@link MatchCode#SEEK_NEXT_COL} and</span> |
| <span class="source-line-no">059</span><span id="line-59"> * {@link MatchCode#SEEK_NEXT_ROW}.</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @param cell a cell with the column to match against</span> |
| <span class="source-line-no">061</span><span id="line-61"> * @param type The type of the Cell</span> |
| <span class="source-line-no">062</span><span id="line-62"> * @return The match code instance.</span> |
| <span class="source-line-no">063</span><span id="line-63"> * @throws IOException in case there is an internal consistency problem caused by a data</span> |
| <span class="source-line-no">064</span><span id="line-64"> * corruption.</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> ScanQueryMatcher.MatchCode checkColumn(ExtendedCell cell, byte type) throws IOException;</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> /**</span> |
| <span class="source-line-no">069</span><span id="line-69"> * Keeps track of the number of versions for the columns asked for. It assumes that the user has</span> |
| <span class="source-line-no">070</span><span id="line-70"> * already checked if the cell needs to be included by calling the</span> |
| <span class="source-line-no">071</span><span id="line-71"> * {@link #checkColumn(ExtendedCell, byte)} method. The enum values returned by this method are</span> |
| <span class="source-line-no">072</span><span id="line-72"> * {@link MatchCode#SKIP}, {@link MatchCode#INCLUDE}, {@link MatchCode#INCLUDE_AND_SEEK_NEXT_COL}</span> |
| <span class="source-line-no">073</span><span id="line-73"> * and {@link MatchCode#INCLUDE_AND_SEEK_NEXT_ROW}. Implementations which include all the columns</span> |
| <span class="source-line-no">074</span><span id="line-74"> * could just return {@link MatchCode#INCLUDE} in the {@link #checkColumn(ExtendedCell, byte)}</span> |
| <span class="source-line-no">075</span><span id="line-75"> * method and perform all the operations in this checkVersions method.</span> |
| <span class="source-line-no">076</span><span id="line-76"> * @param cell a cell with the column to match against</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @param timestamp The timestamp of the cell.</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @param type the type of the key value (Put/Delete)</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param ignoreCount indicates if the KV needs to be excluded while counting (used during</span> |
| <span class="source-line-no">080</span><span id="line-80"> * compactions. We only count KV's that are older than all the scanners' read</span> |
| <span class="source-line-no">081</span><span id="line-81"> * points.)</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @return the scan query matcher match code instance</span> |
| <span class="source-line-no">083</span><span id="line-83"> * @throws IOException in case there is an internal consistency problem caused by a data</span> |
| <span class="source-line-no">084</span><span id="line-84"> * corruption.</span> |
| <span class="source-line-no">085</span><span id="line-85"> */</span> |
| <span class="source-line-no">086</span><span id="line-86"> ScanQueryMatcher.MatchCode checkVersions(ExtendedCell cell, long timestamp, byte type,</span> |
| <span class="source-line-no">087</span><span id="line-87"> boolean ignoreCount) throws IOException;</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> /**</span> |
| <span class="source-line-no">090</span><span id="line-90"> * Resets the Matcher</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> void reset();</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /** Returns <code>true</code> when done. */</span> |
| <span class="source-line-no">095</span><span id="line-95"> boolean done();</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> /**</span> |
| <span class="source-line-no">098</span><span id="line-98"> * Used by matcher and scan/get to get a hint of the next column to seek to after checkColumn()</span> |
| <span class="source-line-no">099</span><span id="line-99"> * returns SKIP. Returns the next interesting column we want, or NULL there is none (wildcard</span> |
| <span class="source-line-no">100</span><span id="line-100"> * scanner). Implementations aren't required to return anything useful unless the most recent call</span> |
| <span class="source-line-no">101</span><span id="line-101"> * was to checkColumn() and the return code was SKIP. This is pretty implementation detail-y, but</span> |
| <span class="source-line-no">102</span><span id="line-102"> * optimizations are like that.</span> |
| <span class="source-line-no">103</span><span id="line-103"> * @return null, or a ColumnCount that we should seek to</span> |
| <span class="source-line-no">104</span><span id="line-104"> */</span> |
| <span class="source-line-no">105</span><span id="line-105"> ColumnCount getColumnHint();</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> /**</span> |
| <span class="source-line-no">108</span><span id="line-108"> * Retrieve the MatchCode for the next row or column</span> |
| <span class="source-line-no">109</span><span id="line-109"> */</span> |
| <span class="source-line-no">110</span><span id="line-110"> MatchCode getNextRowOrNextColumn(ExtendedCell cell);</span> |
| <span class="source-line-no">111</span><span id="line-111"></span> |
| <span class="source-line-no">112</span><span id="line-112"> /**</span> |
| <span class="source-line-no">113</span><span id="line-113"> * Give the tracker a chance to declare it's done based on only the timestamp to allow an early</span> |
| <span class="source-line-no">114</span><span id="line-114"> * out.</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @return <code>true</code> to early out based on timestamp.</span> |
| <span class="source-line-no">116</span><span id="line-116"> */</span> |
| <span class="source-line-no">117</span><span id="line-117"> boolean isDone(long timestamp);</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> /**</span> |
| <span class="source-line-no">120</span><span id="line-120"> * This method is used to inform the column tracker that we are done with this column. We may get</span> |
| <span class="source-line-no">121</span><span id="line-121"> * this information from external filters or timestamp range and we then need to indicate this</span> |
| <span class="source-line-no">122</span><span id="line-122"> * information to tracker. It is currently implemented for ExplicitColumnTracker.</span> |
| <span class="source-line-no">123</span><span id="line-123"> */</span> |
| <span class="source-line-no">124</span><span id="line-124"> default void doneWithColumn(ExtendedCell cell) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
