| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.KeepDeletedCells;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceStability;<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> * This class gives you the ability to change the max versions and TTL options before opening a<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * scanner for a Store. And also gives you some information for the scan.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <p><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Changing max versions, min versins, KeepDeletedCells, and TTL are usually safe even<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * for flush/compaction, so here we provide a way to do it for you. If you want to do other<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * complicated operations such as filtering, please wrap<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * the {@link InternalScanner} in the {@code preCompact} and {@code preFlush} methods in<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * {@link org.apache.hadoop.hbase.coprocessor.RegionObserver}.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <p><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * For user scans, we also provide this class as a parameter in the {@code preStoreScannerOpen}<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * method in {@link org.apache.hadoop.hbase.coprocessor.RegionObserver}. You can use it to change<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * the inherent properties for a Store. For example, even if you use {@code Scan.readAllVersions},<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * you still can not read two versions if the max versions property of the Store is one. You need to<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * set the max versions to a value greater than two in {@code preStoreScannerOpen}.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @see org.apache.hadoop.hbase.coprocessor.RegionObserver#preFlushScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext,<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Store, ScanOptions, FlushLifeCycleTracker)<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @see org.apache.hadoop.hbase.coprocessor.RegionObserver#preCompactScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext,<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Store, ScanType, ScanOptions,<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker,<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest)<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @see org.apache.hadoop.hbase.coprocessor.RegionObserver#preStoreScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext,<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Store, ScanOptions)<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>@InterfaceStability.Evolving<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>public interface ScanOptions {<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> int getMaxVersions();<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> void setMaxVersions(int maxVersions);<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> default void readAllVersions() {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> setMaxVersions(Integer.MAX_VALUE);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> long getTTL();<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> void setTTL(long ttl);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> void setKeepDeletedCells(KeepDeletedCells keepDeletedCells);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> KeepDeletedCells getKeepDeletedCells();<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> int getMinVersions();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> void setMinVersions(int minVersions);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> long getTimeToPurgeDeletes();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> void setTimeToPurgeDeletes(long ttl);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Returns a copy of the Scan object. Modifying it will have no effect.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> Scan getScan();<a name="line.81"></a> |
| <span class="sourceLineNo">082</span>}<a name="line.82"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
