| <!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, interface: RegionScanner"> |
| <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;</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 java.util.List;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.ExtendedCell;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * RegionScanner describes iterators over rows in an HRegion.</span> |
| <span class="source-line-no">030</span><span id="line-30"> */</span> |
| <span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span> |
| <span class="source-line-no">032</span><span id="line-32">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">033</span><span id="line-33">public interface RegionScanner extends InternalScanner {</span> |
| <span class="source-line-no">034</span><span id="line-34"> /** Returns The RegionInfo for this scanner. */</span> |
| <span class="source-line-no">035</span><span id="line-35"> RegionInfo getRegionInfo();</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> /**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @return True if a filter indicates that this scanner will return no further rows.</span> |
| <span class="source-line-no">039</span><span id="line-39"> * @throws IOException in case of I/O failure on a filter.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41"> boolean isFilterDone() throws IOException;</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> /**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * Do a reseek to the required row. Should not be used to seek to a key which may come before the</span> |
| <span class="source-line-no">045</span><span id="line-45"> * current position. Always seeks to the beginning of a row boundary. if row is null</span> |
| <span class="source-line-no">046</span><span id="line-46"> */</span> |
| <span class="source-line-no">047</span><span id="line-47"> boolean reseek(byte[] row) throws IOException;</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> /**</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @return The preferred max buffersize. See</span> |
| <span class="source-line-no">051</span><span id="line-51"> * {@link org.apache.hadoop.hbase.client.Scan#setMaxResultSize(long)}</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53"> long getMaxResultSize();</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> /** Returns The Scanner's MVCC readPt see {@link MultiVersionConcurrencyControl} */</span> |
| <span class="source-line-no">056</span><span id="line-56"> long getMvccReadPoint();</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @return The limit on the number of cells to retrieve on each call to next(). See</span> |
| <span class="source-line-no">060</span><span id="line-60"> * {@link org.apache.hadoop.hbase.client.Scan#setBatch(int)}</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62"> int getBatch();</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @return The Scanner's {@link org.apache.hadoop.hbase.client.Scan#ID_ATRIBUTE} value, or null if</span> |
| <span class="source-line-no">066</span><span id="line-66"> * not set.</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> default String getOperationId() {</span> |
| <span class="source-line-no">069</span><span id="line-69"> return null;</span> |
| <span class="source-line-no">070</span><span id="line-70"> }</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * Grab the next row's worth of values. This is a special internal method to be called from</span> |
| <span class="source-line-no">074</span><span id="line-74"> * coprocessor hooks to avoid expensive setup. Caller must set the thread's readpoint, start and</span> |
| <span class="source-line-no">075</span><span id="line-75"> * close a region operation, an synchronize on the scanner object. Caller should maintain and</span> |
| <span class="source-line-no">076</span><span id="line-76"> * update metrics. See {@link #nextRaw(List, ScannerContext)}</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @param result return output array</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @return true if more rows exist after this one, false if scanner is done</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @throws IOException e</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> boolean nextRaw(List<? super ExtendedCell> result) throws IOException;</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> /**</span> |
| <span class="source-line-no">084</span><span id="line-84"> * Grab the next row's worth of values. The {@link ScannerContext} is used to enforce and track</span> |
| <span class="source-line-no">085</span><span id="line-85"> * any limits associated with this call. Any progress that exists in the {@link ScannerContext}</span> |
| <span class="source-line-no">086</span><span id="line-86"> * prior to calling this method will be LOST if {@link ScannerContext#getKeepProgress()} is false.</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Upon returning from this method, the {@link ScannerContext} will contain information about the</span> |
| <span class="source-line-no">088</span><span id="line-88"> * progress made towards the limits. This is a special internal method to be called from</span> |
| <span class="source-line-no">089</span><span id="line-89"> * coprocessor hooks to avoid expensive setup. Caller must set the thread's readpoint, start and</span> |
| <span class="source-line-no">090</span><span id="line-90"> * close a region operation, an synchronize on the scanner object. Example: <code></span> |
| <span class="source-line-no">091</span><span id="line-91"> * HRegion region = ...;</span> |
| <span class="source-line-no">092</span><span id="line-92"> * RegionScanner scanner = ...</span> |
| <span class="source-line-no">093</span><span id="line-93"> * MultiVersionConcurrencyControl.setThreadReadPoint(scanner.getMvccReadPoint());</span> |
| <span class="source-line-no">094</span><span id="line-94"> * region.startRegionOperation();</span> |
| <span class="source-line-no">095</span><span id="line-95"> * try {</span> |
| <span class="source-line-no">096</span><span id="line-96"> * synchronized(scanner) {</span> |
| <span class="source-line-no">097</span><span id="line-97"> * ...</span> |
| <span class="source-line-no">098</span><span id="line-98"> * boolean moreRows = scanner.nextRaw(values);</span> |
| <span class="source-line-no">099</span><span id="line-99"> * ...</span> |
| <span class="source-line-no">100</span><span id="line-100"> * }</span> |
| <span class="source-line-no">101</span><span id="line-101"> * } finally {</span> |
| <span class="source-line-no">102</span><span id="line-102"> * region.closeRegionOperation();</span> |
| <span class="source-line-no">103</span><span id="line-103"> * }</span> |
| <span class="source-line-no">104</span><span id="line-104"> * </code></span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param result return output array</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @param scannerContext The {@link ScannerContext} instance encapsulating all limits that should</span> |
| <span class="source-line-no">107</span><span id="line-107"> * be tracked during calls to this method. The progress towards these limits</span> |
| <span class="source-line-no">108</span><span id="line-108"> * can be tracked within this instance.</span> |
| <span class="source-line-no">109</span><span id="line-109"> * @return true if more rows exist after this one, false if scanner is done</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @throws IOException e</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> boolean nextRaw(List<? super ExtendedCell> result, ScannerContext scannerContext)</span> |
| <span class="source-line-no">113</span><span id="line-113"> throws IOException;</span> |
| <span class="source-line-no">114</span><span id="line-114">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
