| <!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> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.client;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.HashMap;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Map;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.NavigableSet;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.TreeMap;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.TreeSet;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HConstants;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.metrics.ScanMetrics;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.filter.Filter;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.filter.IncompatibleFilterException;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.io.TimeRange;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.security.access.Permission;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.security.visibility.Authorizations;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.slf4j.Logger;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.slf4j.LoggerFactory;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span>/**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Used to perform Scan operations.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <p><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * All operations are identical to {@link Get} with the exception of instantiation. Rather than<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * specifying a single row, an optional startRow and stopRow may be defined. If rows are not<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * specified, the Scanner will iterate over all rows.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * To get all columns from all rows of a Table, create an instance with no constraints; use the<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@link #Scan()} constructor. To constrain the scan to specific column families, call<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * {@link #addFamily(byte[]) addFamily} for each family to retrieve on your Scan instance.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * To get specific columns, call {@link #addColumn(byte[], byte[]) addColumn} for each column to<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * retrieve.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <p><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * To only retrieve columns within a specific range of version timestamps, call<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * {@link #setTimeRange(long, long) setTimeRange}.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <p><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * To only retrieve columns with a specific timestamp, call {@link #setTimestamp(long) setTimestamp}<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * .<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <p><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * To limit the number of versions of each column to be returned, call {@link #readVersions(int)}.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <p><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * To limit the maximum number of values returned for each call to next(), call<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * {@link #setBatch(int) setBatch}.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <p><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * To add a filter, call {@link #setFilter(org.apache.hadoop.hbase.filter.Filter) setFilter}.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <p><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * For small scan, it is deprecated in 2.0.0. Now we have a {@link #setLimit(int)} method in Scan<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * object which is used to tell RS how many rows we want. If the rows return reaches the limit, the<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * RS will close the RegionScanner automatically. And we will also fetch data when openScanner in<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * the new implementation, this means we can also finish a scan operation in one rpc call. And we<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * have also introduced a {@link #setReadType(ReadType)} method. You can use this method to tell RS<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * to use pread explicitly.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <p><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Expert: To explicitly disable server-side block caching for this scan, execute<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * {@link #setCacheBlocks(boolean)}.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <p><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <em>Note:</em> Usage alters Scan instances. Internally, attributes are updated as the Scan runs<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * and if enabled, metrics accumulate in the Scan instance. Be aware this is the case when you go to<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * clone a Scan instance or if you go to reuse a created Scan instance; safer is create a Scan<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * instance per usage.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span>@InterfaceAudience.Public<a name="line.84"></a> |
| <span class="sourceLineNo">085</span>public class Scan extends Query {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> private static final Logger LOG = LoggerFactory.getLogger(Scan.class);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private static final String RAW_ATTR = "_raw_";<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> private byte[] startRow = HConstants.EMPTY_START_ROW;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> private boolean includeStartRow = true;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> private byte[] stopRow = HConstants.EMPTY_END_ROW;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> private boolean includeStopRow = false;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> private int maxVersions = 1;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> private int batch = -1;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Partial {@link Result}s are {@link Result}s must be combined to form a complete {@link Result}.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * The {@link Result}s had to be returned in fragments (i.e. as partials) because the size of the<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * cells in the row exceeded max result size on the server. Typically partial results will be<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * combined client side into complete results before being delivered to the caller. However, if<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * this flag is set, the caller is indicating that they do not mind seeing partial results (i.e.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * they understand that the results returned from the Scanner may only represent part of a<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * particular row). In such a case, any attempt to combine the partials into a complete result on<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * the client side will be skipped, and the caller will be able to see the exact results returned<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * from the server.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> */<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> private boolean allowPartialResults = false;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> private int storeLimit = -1;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> private int storeOffset = 0;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> private static final String SCAN_ATTRIBUTES_METRICS_ENABLE = "scan.attributes.metrics.enable";<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> // If an application wants to use multiple scans over different tables each scan must<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // define this attribute with the appropriate table name by calling<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> // scan.setAttribute(Scan.SCAN_ATTRIBUTES_TABLE_NAME, Bytes.toBytes(tableName))<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> static public final String SCAN_ATTRIBUTES_TABLE_NAME = "scan.attributes.table.name";<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> * -1 means no caching specified and the value of {@link HConstants#HBASE_CLIENT_SCANNER_CACHING}<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * (default to {@link HConstants#DEFAULT_HBASE_CLIENT_SCANNER_CACHING}) will be used<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> private int caching = -1;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> private long maxResultSize = -1;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> private boolean cacheBlocks = true;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> private boolean reversed = false;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> private TimeRange tr = TimeRange.allTime();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> private Map<byte [], NavigableSet<byte []>> familyMap =<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> new TreeMap<byte [], NavigableSet<byte []>>(Bytes.BYTES_COMPARATOR);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> private Boolean asyncPrefetch = null;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> /**<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * Parameter name for client scanner sync/async prefetch toggle.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * When using async scanner, prefetching data from the server is done at the background.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * The parameter currently won't have any effect in the case that the user has set<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * Scan#setSmall or Scan#setReversed<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public static final String HBASE_CLIENT_SCANNER_ASYNC_PREFETCH =<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> "hbase.client.scanner.async.prefetch";<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> /**<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * Default value of {@link #HBASE_CLIENT_SCANNER_ASYNC_PREFETCH}.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> */<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> public static final boolean DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH = false;<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> * The mvcc read point to use when open a scanner. Remember to clear it after switching regions as<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * the mvcc is only valid within region scope.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> */<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> private long mvccReadPoint = -1L;<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> /**<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * The number of rows we want for this scan. We will terminate the scan if the number of return<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * rows reaches this value.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> */<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> private int limit = -1;<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> * Control whether to use pread at server side.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> */<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> private ReadType readType = ReadType.DEFAULT;<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> private boolean needCursorResult = false;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> /**<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Create a Scan operation across all rows.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> */<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> public Scan() {}<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> /**<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * Creates a new instance of this class while copying all values.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> *<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @param scan The scan instance to copy from.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @throws IOException When copying the values fails.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> */<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> public Scan(Scan scan) throws IOException {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> startRow = scan.getStartRow();<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> includeStartRow = scan.includeStartRow();<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> stopRow = scan.getStopRow();<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> includeStopRow = scan.includeStopRow();<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> maxVersions = scan.getMaxVersions();<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> batch = scan.getBatch();<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> storeLimit = scan.getMaxResultsPerColumnFamily();<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> storeOffset = scan.getRowOffsetPerColumnFamily();<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> caching = scan.getCaching();<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> maxResultSize = scan.getMaxResultSize();<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> cacheBlocks = scan.getCacheBlocks();<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> filter = scan.getFilter(); // clone?<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> loadColumnFamiliesOnDemand = scan.getLoadColumnFamiliesOnDemandValue();<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> consistency = scan.getConsistency();<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> this.setIsolationLevel(scan.getIsolationLevel());<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> reversed = scan.isReversed();<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> asyncPrefetch = scan.isAsyncPrefetch();<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> allowPartialResults = scan.getAllowPartialResults();<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> tr = scan.getTimeRange(); // TimeRange is immutable<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> Map<byte[], NavigableSet<byte[]>> fams = scan.getFamilyMap();<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> for (Map.Entry<byte[],NavigableSet<byte[]>> entry : fams.entrySet()) {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> byte [] fam = entry.getKey();<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> NavigableSet<byte[]> cols = entry.getValue();<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (cols != null && cols.size() > 0) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> for (byte[] col : cols) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> addColumn(fam, col);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> } else {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> addFamily(fam);<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> for (Map.Entry<String, byte[]> attr : scan.getAttributesMap().entrySet()) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> setAttribute(attr.getKey(), attr.getValue());<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> for (Map.Entry<byte[], TimeRange> entry : scan.getColumnFamilyTimeRange().entrySet()) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> TimeRange tr = entry.getValue();<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> setColumnFamilyTimeRange(entry.getKey(), tr.getMin(), tr.getMax());<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> this.mvccReadPoint = scan.getMvccReadPoint();<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> this.limit = scan.getLimit();<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> this.needCursorResult = scan.isNeedCursorResult();<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> setPriority(scan.getPriority());<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> readType = scan.getReadType();<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> super.setReplicaId(scan.getReplicaId());<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span> /**<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * Builds a scan object with the same specs as get.<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @param get get to model scan after<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> */<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> public Scan(Get get) {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> this.startRow = get.getRow();<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> this.includeStartRow = true;<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> this.stopRow = get.getRow();<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> this.includeStopRow = true;<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> this.filter = get.getFilter();<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> this.cacheBlocks = get.getCacheBlocks();<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> this.maxVersions = get.getMaxVersions();<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> this.storeLimit = get.getMaxResultsPerColumnFamily();<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> this.storeOffset = get.getRowOffsetPerColumnFamily();<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> this.tr = get.getTimeRange();<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> this.familyMap = get.getFamilyMap();<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> this.asyncPrefetch = false;<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> this.consistency = get.getConsistency();<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> this.setIsolationLevel(get.getIsolationLevel());<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> this.loadColumnFamiliesOnDemand = get.getLoadColumnFamiliesOnDemandValue();<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> for (Map.Entry<String, byte[]> attr : get.getAttributesMap().entrySet()) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> setAttribute(attr.getKey(), attr.getValue());<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> }<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> for (Map.Entry<byte[], TimeRange> entry : get.getColumnFamilyTimeRange().entrySet()) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> TimeRange tr = entry.getValue();<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> setColumnFamilyTimeRange(entry.getKey(), tr.getMin(), tr.getMax());<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> this.mvccReadPoint = -1L;<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> setPriority(get.getPriority());<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> super.setReplicaId(get.getReplicaId());<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> public boolean isGetScan() {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> return includeStartRow && includeStopRow<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> && ClientUtil.areScanStartRowAndStopRowEqual(this.startRow, this.stopRow);<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> /**<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * Get all columns from the specified family.<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * <p><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Overrides previous calls to addColumn for this family.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @param family family name<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @return this<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> */<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> public Scan addFamily(byte [] family) {<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> familyMap.remove(family);<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> familyMap.put(family, null);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> return this;<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> }<a name="line.272"></a> |
| <span class="sourceLineNo">273</span><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> /**<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * Get the column from the specified family with the specified qualifier.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * <p><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * Overrides previous calls to addFamily for this family.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * @param family family name<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * @param qualifier column qualifier<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * @return this<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> */<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> public Scan addColumn(byte [] family, byte [] qualifier) {<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> NavigableSet<byte []> set = familyMap.get(family);<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> if(set == null) {<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> set = new TreeSet<>(Bytes.BYTES_COMPARATOR);<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> familyMap.put(family, set);<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> }<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> if (qualifier == null) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> qualifier = HConstants.EMPTY_BYTE_ARRAY;<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> set.add(qualifier);<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> return this;<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> }<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> /**<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * Get versions of columns only within the specified timestamp range,<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * [minStamp, maxStamp). Note, default maximum versions to return is 1. If<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * your time range spans more than one version and you want all versions<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * returned, up the number of versions beyond the default.<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * @param minStamp minimum timestamp value, inclusive<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * @param maxStamp maximum timestamp value, exclusive<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * @see #readAllVersions()<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * @see #readVersions(int)<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * @return this<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> */<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> public Scan setTimeRange(long minStamp, long maxStamp) throws IOException {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> tr = TimeRange.between(minStamp, maxStamp);<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> return this;<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> /**<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * Get versions of columns with the specified timestamp. Note, default maximum<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * versions to return is 1. If your time range spans more than one version<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * and you want all versions returned, up the number of versions beyond the<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * defaut.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * @param timestamp version timestamp<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * @see #readAllVersions()<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * @see #readVersions(int)<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * @return this<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> */<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> public Scan setTimestamp(long timestamp) {<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> try {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> tr = TimeRange.at(timestamp);<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> } catch(Exception e) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> // This should never happen, unless integer overflow or something extremely wrong...<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> LOG.error("TimeRange failed, likely caused by integer overflow. ", e);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> throw e;<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> return this;<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> }<a name="line.331"></a> |
| <span class="sourceLineNo">332</span><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> @Override public Scan setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> return (Scan) super.setColumnFamilyTimeRange(cf, minStamp, maxStamp);<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> }<a name="line.335"></a> |
| <span class="sourceLineNo">336</span><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> /**<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * Set the start row of the scan.<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * <p><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * If the specified row does not exist, the Scanner will start from the next closest row after the<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * specified row.<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * @param startRow row to start scanner at or after<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * @return this<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * @throws IllegalArgumentException if startRow does not meet criteria for a row key (when length<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> */<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> public Scan withStartRow(byte[] startRow) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> return withStartRow(startRow, true);<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> }<a name="line.349"></a> |
| <span class="sourceLineNo">350</span><a name="line.350"></a> |
| <span class="sourceLineNo">351</span> /**<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * Set the start row of the scan.<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * <p><a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * If the specified row does not exist, or the {@code inclusive} is {@code false}, the Scanner<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * will start from the next closest row after the specified row.<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * <p><a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * <b>Note:</b> When use {@link #setRowPrefixFilter(byte[])}, the result might be unexpected.<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * </p><a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * @param startRow row to start scanner at or after<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * @param inclusive whether we should include the start row when scan<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * @return this<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * @throws IllegalArgumentException if startRow does not meet criteria for a row key (when length<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> */<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> public Scan withStartRow(byte[] startRow, boolean inclusive) {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> if (Bytes.len(startRow) > HConstants.MAX_ROW_LENGTH) {<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> throw new IllegalArgumentException("startRow's length must be less than or equal to "<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> + HConstants.MAX_ROW_LENGTH + " to meet the criteria" + " for a row key.");<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> }<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> this.startRow = startRow;<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> this.includeStartRow = inclusive;<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> return this;<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> }<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> /**<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * Set the stop row of the scan.<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * <p><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * The scan will include rows that are lexicographically less than the provided stopRow.<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * <p><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * <b>Note:</b> When doing a filter for a rowKey <u>Prefix</u> use<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * {@link #setRowPrefixFilter(byte[])}. The 'trailing 0' will not yield the desired result.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * </p><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * @param stopRow row to end at (exclusive)<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * @return this<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * @throws IllegalArgumentException if stopRow does not meet criteria for a row key (when length<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> */<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> public Scan withStopRow(byte[] stopRow) {<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> return withStopRow(stopRow, false);<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> }<a name="line.390"></a> |
| <span class="sourceLineNo">391</span><a name="line.391"></a> |
| <span class="sourceLineNo">392</span> /**<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * Set the stop row of the scan.<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * <p><a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * The scan will include rows that are lexicographically less than (or equal to if<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * {@code inclusive} is {@code true}) the provided stopRow.<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * @param stopRow row to end at<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * @param inclusive whether we should include the stop row when scan<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * @return this<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * @throws IllegalArgumentException if stopRow does not meet criteria for a row key (when length<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * exceeds {@link HConstants#MAX_ROW_LENGTH})<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> */<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> public Scan withStopRow(byte[] stopRow, boolean inclusive) {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> if (Bytes.len(stopRow) > HConstants.MAX_ROW_LENGTH) {<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> throw new IllegalArgumentException("stopRow's length must be less than or equal to "<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> + HConstants.MAX_ROW_LENGTH + " to meet the criteria" + " for a row key.");<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> }<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> this.stopRow = stopRow;<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> this.includeStopRow = inclusive;<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> return this;<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> }<a name="line.411"></a> |
| <span class="sourceLineNo">412</span><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> /**<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * <p>Set a filter (using stopRow and startRow) so the result set only contains rows where the<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * rowKey starts with the specified prefix.</p><a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * <p>This is a utility method that converts the desired rowPrefix into the appropriate values<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * for the startRow and stopRow to achieve the desired result.</p><a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * <p>This can safely be used in combination with setFilter.</p><a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * <p><b>NOTE: Doing a {@link #withStartRow(byte[])} and/or {@link #withStopRow(byte[])}<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * after this method will yield undefined results.</b></p><a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * @param rowPrefix the prefix all rows must start with. (Set <i>null</i> to remove the filter.)<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> * @return this<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> * @deprecated since 3.0.0. The scan result might be unexpected in some cases.<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * e.g. startRow : "112" and rowPrefixFilter : "11"<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * The Result of this scan might contains : "111"<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * This method implements the filter by setting startRow and stopRow,<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * but does not take care of the scenario where startRow has been set.<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> */<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> @Deprecated<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> public Scan setRowPrefixFilter(byte[] rowPrefix) {<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> if (rowPrefix == null) {<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> withStartRow(HConstants.EMPTY_START_ROW);<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> withStopRow(HConstants.EMPTY_END_ROW);<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> } else {<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> this.withStartRow(rowPrefix);<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> this.withStopRow(ClientUtil.calculateTheClosestNextRowKeyForPrefix(rowPrefix));<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> }<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> return this;<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> }<a name="line.439"></a> |
| <span class="sourceLineNo">440</span><a name="line.440"></a> |
| <span class="sourceLineNo">441</span> /**<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> * Get all available versions.<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> * @return this<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> */<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> public Scan readAllVersions() {<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> this.maxVersions = Integer.MAX_VALUE;<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> return this;<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> }<a name="line.448"></a> |
| <span class="sourceLineNo">449</span><a name="line.449"></a> |
| <span class="sourceLineNo">450</span> /**<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> * Get up to the specified number of versions of each column.<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> * @param versions specified number of versions for each column<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> * @return this<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> */<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> public Scan readVersions(int versions) {<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> this.maxVersions = versions;<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> return this;<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> }<a name="line.458"></a> |
| <span class="sourceLineNo">459</span><a name="line.459"></a> |
| <span class="sourceLineNo">460</span> /**<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * Set the maximum number of cells to return for each call to next(). Callers should be aware<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * that this is not equivalent to calling {@link #setAllowPartialResults(boolean)}.<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * If you don't allow partial results, the number of cells in each Result must equal to your<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * batch setting unless it is the last Result for current row. So this method is helpful in paging<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> * queries. If you just want to prevent OOM at client, use setAllowPartialResults(true) is better.<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * @param batch the maximum number of values<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> */<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> public Scan setBatch(int batch) {<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> if (this.hasFilter() && this.filter.hasFilterRow()) {<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> throw new IncompatibleFilterException(<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> "Cannot set batch on a scan using a filter" +<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> " that returns true for filter.hasFilterRow");<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> }<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> this.batch = batch;<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> return this;<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> }<a name="line.477"></a> |
| <span class="sourceLineNo">478</span><a name="line.478"></a> |
| <span class="sourceLineNo">479</span> /**<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * Set the maximum number of values to return per row per Column Family<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @param limit the maximum number of values returned / row / CF<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> */<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> public Scan setMaxResultsPerColumnFamily(int limit) {<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> this.storeLimit = limit;<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> return this;<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> }<a name="line.486"></a> |
| <span class="sourceLineNo">487</span><a name="line.487"></a> |
| <span class="sourceLineNo">488</span> /**<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * Set offset for the row per Column Family.<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * @param offset is the number of kvs that will be skipped.<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> */<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> public Scan setRowOffsetPerColumnFamily(int offset) {<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> this.storeOffset = offset;<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> return this;<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> }<a name="line.495"></a> |
| <span class="sourceLineNo">496</span><a name="line.496"></a> |
| <span class="sourceLineNo">497</span> /**<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * Set the number of rows for caching that will be passed to scanners.<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * If not set, the Configuration setting {@link HConstants#HBASE_CLIENT_SCANNER_CACHING} will<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> * apply.<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * Higher caching values will enable faster scanners but will use more memory.<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * @param caching the number of rows for caching<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> */<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> public Scan setCaching(int caching) {<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> this.caching = caching;<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> return this;<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> }<a name="line.507"></a> |
| <span class="sourceLineNo">508</span><a name="line.508"></a> |
| <span class="sourceLineNo">509</span> /**<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * @return the maximum result size in bytes. See {@link #setMaxResultSize(long)}<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> */<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> public long getMaxResultSize() {<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> return maxResultSize;<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> }<a name="line.514"></a> |
| <span class="sourceLineNo">515</span><a name="line.515"></a> |
| <span class="sourceLineNo">516</span> /**<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> * Set the maximum result size. The default is -1; this means that no specific<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> * maximum result size will be set for this scan, and the global configured<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> * value will be used instead. (Defaults to unlimited).<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> *<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> * @param maxResultSize The maximum result size in bytes.<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> */<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> public Scan setMaxResultSize(long maxResultSize) {<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> this.maxResultSize = maxResultSize;<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> return this;<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> }<a name="line.526"></a> |
| <span class="sourceLineNo">527</span><a name="line.527"></a> |
| <span class="sourceLineNo">528</span> @Override<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> public Scan setFilter(Filter filter) {<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> super.setFilter(filter);<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> return this;<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> }<a name="line.532"></a> |
| <span class="sourceLineNo">533</span><a name="line.533"></a> |
| <span class="sourceLineNo">534</span> /**<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> * Setting the familyMap<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> * @param familyMap map of family to qualifier<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * @return this<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> */<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> public Scan setFamilyMap(Map<byte [], NavigableSet<byte []>> familyMap) {<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> this.familyMap = familyMap;<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> return this;<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> }<a name="line.542"></a> |
| <span class="sourceLineNo">543</span><a name="line.543"></a> |
| <span class="sourceLineNo">544</span> /**<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * Getting the familyMap<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> * @return familyMap<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> */<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> public Map<byte [], NavigableSet<byte []>> getFamilyMap() {<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> return this.familyMap;<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> }<a name="line.550"></a> |
| <span class="sourceLineNo">551</span><a name="line.551"></a> |
| <span class="sourceLineNo">552</span> /**<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> * @return the number of families in familyMap<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> */<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> public int numFamilies() {<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> if(hasFamilies()) {<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> return this.familyMap.size();<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> }<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> return 0;<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> }<a name="line.560"></a> |
| <span class="sourceLineNo">561</span><a name="line.561"></a> |
| <span class="sourceLineNo">562</span> /**<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> * @return true if familyMap is non empty, false otherwise<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> */<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> public boolean hasFamilies() {<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> return !this.familyMap.isEmpty();<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> }<a name="line.567"></a> |
| <span class="sourceLineNo">568</span><a name="line.568"></a> |
| <span class="sourceLineNo">569</span> /**<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> * @return the keys of the familyMap<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> */<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> public byte[][] getFamilies() {<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> if(hasFamilies()) {<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> return this.familyMap.keySet().toArray(new byte[0][0]);<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> }<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> return null;<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> }<a name="line.577"></a> |
| <span class="sourceLineNo">578</span><a name="line.578"></a> |
| <span class="sourceLineNo">579</span> /**<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> * @return the startrow<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> */<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> public byte [] getStartRow() {<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> return this.startRow;<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> }<a name="line.584"></a> |
| <span class="sourceLineNo">585</span><a name="line.585"></a> |
| <span class="sourceLineNo">586</span> /**<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * @return if we should include start row when scan<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> */<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> public boolean includeStartRow() {<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> return includeStartRow;<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> }<a name="line.591"></a> |
| <span class="sourceLineNo">592</span><a name="line.592"></a> |
| <span class="sourceLineNo">593</span> /**<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> * @return the stoprow<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> */<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> public byte[] getStopRow() {<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> return this.stopRow;<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> }<a name="line.598"></a> |
| <span class="sourceLineNo">599</span><a name="line.599"></a> |
| <span class="sourceLineNo">600</span> /**<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> * @return if we should include stop row when scan<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> */<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> public boolean includeStopRow() {<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> return includeStopRow;<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> }<a name="line.605"></a> |
| <span class="sourceLineNo">606</span><a name="line.606"></a> |
| <span class="sourceLineNo">607</span> /**<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> * @return the max number of versions to fetch<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> */<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> public int getMaxVersions() {<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> return this.maxVersions;<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> }<a name="line.612"></a> |
| <span class="sourceLineNo">613</span><a name="line.613"></a> |
| <span class="sourceLineNo">614</span> /**<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> * @return maximum number of values to return for a single call to next()<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> */<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> public int getBatch() {<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> return this.batch;<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> }<a name="line.619"></a> |
| <span class="sourceLineNo">620</span><a name="line.620"></a> |
| <span class="sourceLineNo">621</span> /**<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> * @return maximum number of values to return per row per CF<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> */<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> public int getMaxResultsPerColumnFamily() {<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> return this.storeLimit;<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> }<a name="line.626"></a> |
| <span class="sourceLineNo">627</span><a name="line.627"></a> |
| <span class="sourceLineNo">628</span> /**<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> * Method for retrieving the scan's offset per row per column<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> * family (#kvs to be skipped)<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> * @return row offset<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> */<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> public int getRowOffsetPerColumnFamily() {<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> return this.storeOffset;<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> }<a name="line.635"></a> |
| <span class="sourceLineNo">636</span><a name="line.636"></a> |
| <span class="sourceLineNo">637</span> /**<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * @return caching the number of rows fetched when calling next on a scanner<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> */<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> public int getCaching() {<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> return this.caching;<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> }<a name="line.642"></a> |
| <span class="sourceLineNo">643</span><a name="line.643"></a> |
| <span class="sourceLineNo">644</span> /**<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> * @return TimeRange<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> */<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> public TimeRange getTimeRange() {<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> return this.tr;<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> }<a name="line.649"></a> |
| <span class="sourceLineNo">650</span><a name="line.650"></a> |
| <span class="sourceLineNo">651</span> /**<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> * @return RowFilter<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> */<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> @Override<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> public Filter getFilter() {<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> return filter;<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> }<a name="line.657"></a> |
| <span class="sourceLineNo">658</span><a name="line.658"></a> |
| <span class="sourceLineNo">659</span> /**<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> * @return true is a filter has been specified, false if not<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> */<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> public boolean hasFilter() {<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> return filter != null;<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> }<a name="line.664"></a> |
| <span class="sourceLineNo">665</span><a name="line.665"></a> |
| <span class="sourceLineNo">666</span> /**<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> * Set whether blocks should be cached for this Scan.<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> * <p><a name="line.668"></a> |
| <span class="sourceLineNo">669</span> * This is true by default. When true, default settings of the table and<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> * family are used (this will never override caching blocks if the block<a name="line.670"></a> |
| <span class="sourceLineNo">671</span> * cache is disabled for that family or entirely).<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> *<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * @param cacheBlocks if false, default settings are overridden and blocks<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> * will not be cached<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> */<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> public Scan setCacheBlocks(boolean cacheBlocks) {<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> this.cacheBlocks = cacheBlocks;<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> return this;<a name="line.678"></a> |
| <span class="sourceLineNo">679</span> }<a name="line.679"></a> |
| <span class="sourceLineNo">680</span><a name="line.680"></a> |
| <span class="sourceLineNo">681</span> /**<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> * Get whether blocks should be cached for this Scan.<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> * @return true if default caching should be used, false if blocks should not<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> * be cached<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> */<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> public boolean getCacheBlocks() {<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> return cacheBlocks;<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> }<a name="line.688"></a> |
| <span class="sourceLineNo">689</span><a name="line.689"></a> |
| <span class="sourceLineNo">690</span> /**<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> * Set whether this scan is a reversed one<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> * <p><a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * This is false by default which means forward(normal) scan.<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> *<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> * @param reversed if true, scan will be backward order<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> * @return this<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> */<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> public Scan setReversed(boolean reversed) {<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> this.reversed = reversed;<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> return this;<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> }<a name="line.701"></a> |
| <span class="sourceLineNo">702</span><a name="line.702"></a> |
| <span class="sourceLineNo">703</span> /**<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> * Get whether this scan is a reversed one.<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> * @return true if backward scan, false if forward(default) scan<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> */<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> public boolean isReversed() {<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> return reversed;<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> }<a name="line.709"></a> |
| <span class="sourceLineNo">710</span><a name="line.710"></a> |
| <span class="sourceLineNo">711</span> /**<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> * Setting whether the caller wants to see the partial results when server returns<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> * less-than-expected cells. It is helpful while scanning a huge row to prevent OOM at client.<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> * By default this value is false and the complete results will be assembled client side<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> * before being delivered to the caller.<a name="line.715"></a> |
| <span class="sourceLineNo">716</span> * @param allowPartialResults<a name="line.716"></a> |
| <span class="sourceLineNo">717</span> * @return this<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> * @see #setBatch(int)<a name="line.719"></a> |
| <span class="sourceLineNo">720</span> */<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> public Scan setAllowPartialResults(final boolean allowPartialResults) {<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> this.allowPartialResults = allowPartialResults;<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> return this;<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> }<a name="line.724"></a> |
| <span class="sourceLineNo">725</span><a name="line.725"></a> |
| <span class="sourceLineNo">726</span> /**<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> * @return true when the constructor of this scan understands that the results they will see may<a name="line.727"></a> |
| <span class="sourceLineNo">728</span> * only represent a partial portion of a row. The entire row would be retrieved by<a name="line.728"></a> |
| <span class="sourceLineNo">729</span> * subsequent calls to {@link ResultScanner#next()}<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> */<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> public boolean getAllowPartialResults() {<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> return allowPartialResults;<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> }<a name="line.733"></a> |
| <span class="sourceLineNo">734</span><a name="line.734"></a> |
| <span class="sourceLineNo">735</span> @Override<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> public Scan setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> return (Scan) super.setLoadColumnFamiliesOnDemand(value);<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> }<a name="line.738"></a> |
| <span class="sourceLineNo">739</span><a name="line.739"></a> |
| <span class="sourceLineNo">740</span> /**<a name="line.740"></a> |
| <span class="sourceLineNo">741</span> * Compile the table and column family (i.e. schema) information<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> * into a String. Useful for parsing and aggregation by debugging,<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> * logging, and administration tools.<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> * @return Map<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> */<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> @Override<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> public Map<String, Object> getFingerprint() {<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> Map<String, Object> map = new HashMap<>();<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> List<String> families = new ArrayList<>();<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> if(this.familyMap.isEmpty()) {<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> map.put("families", "ALL");<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> return map;<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> } else {<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> map.put("families", families);<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> }<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> this.familyMap.entrySet()) {<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> families.add(Bytes.toStringBinary(entry.getKey()));<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> }<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> return map;<a name="line.760"></a> |
| <span class="sourceLineNo">761</span> }<a name="line.761"></a> |
| <span class="sourceLineNo">762</span><a name="line.762"></a> |
| <span class="sourceLineNo">763</span> /**<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> * Compile the details beyond the scope of getFingerprint (row, columns,<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> * timestamps, etc.) into a Map along with the fingerprinted information.<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> * Useful for debugging, logging, and administration tools.<a name="line.766"></a> |
| <span class="sourceLineNo">767</span> * @param maxCols a limit on the number of columns output prior to truncation<a name="line.767"></a> |
| <span class="sourceLineNo">768</span> * @return Map<a name="line.768"></a> |
| <span class="sourceLineNo">769</span> */<a name="line.769"></a> |
| <span class="sourceLineNo">770</span> @Override<a name="line.770"></a> |
| <span class="sourceLineNo">771</span> public Map<String, Object> toMap(int maxCols) {<a name="line.771"></a> |
| <span class="sourceLineNo">772</span> // start with the fingerpring map and build on top of it<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> Map<String, Object> map = getFingerprint();<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> // map from families to column list replaces fingerprint's list of families<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> Map<String, List<String>> familyColumns = new HashMap<>();<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> map.put("families", familyColumns);<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> // add scalar information first<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> map.put("startRow", Bytes.toStringBinary(this.startRow));<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> map.put("stopRow", Bytes.toStringBinary(this.stopRow));<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> map.put("maxVersions", this.maxVersions);<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> map.put("batch", this.batch);<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> map.put("caching", this.caching);<a name="line.782"></a> |
| <span class="sourceLineNo">783</span> map.put("maxResultSize", this.maxResultSize);<a name="line.783"></a> |
| <span class="sourceLineNo">784</span> map.put("cacheBlocks", this.cacheBlocks);<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> map.put("loadColumnFamiliesOnDemand", this.loadColumnFamiliesOnDemand);<a name="line.785"></a> |
| <span class="sourceLineNo">786</span> List<Long> timeRange = new ArrayList<>(2);<a name="line.786"></a> |
| <span class="sourceLineNo">787</span> timeRange.add(this.tr.getMin());<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> timeRange.add(this.tr.getMax());<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> map.put("timeRange", timeRange);<a name="line.789"></a> |
| <span class="sourceLineNo">790</span> int colCount = 0;<a name="line.790"></a> |
| <span class="sourceLineNo">791</span> // iterate through affected families and list out up to maxCols columns<a name="line.791"></a> |
| <span class="sourceLineNo">792</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> this.familyMap.entrySet()) {<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> List<String> columns = new ArrayList<>();<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> familyColumns.put(Bytes.toStringBinary(entry.getKey()), columns);<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> if(entry.getValue() == null) {<a name="line.796"></a> |
| <span class="sourceLineNo">797</span> colCount++;<a name="line.797"></a> |
| <span class="sourceLineNo">798</span> --maxCols;<a name="line.798"></a> |
| <span class="sourceLineNo">799</span> columns.add("ALL");<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> } else {<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> colCount += entry.getValue().size();<a name="line.801"></a> |
| <span class="sourceLineNo">802</span> if (maxCols <= 0) {<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> continue;<a name="line.803"></a> |
| <span class="sourceLineNo">804</span> }<a name="line.804"></a> |
| <span class="sourceLineNo">805</span> for (byte [] column : entry.getValue()) {<a name="line.805"></a> |
| <span class="sourceLineNo">806</span> if (--maxCols <= 0) {<a name="line.806"></a> |
| <span class="sourceLineNo">807</span> continue;<a name="line.807"></a> |
| <span class="sourceLineNo">808</span> }<a name="line.808"></a> |
| <span class="sourceLineNo">809</span> columns.add(Bytes.toStringBinary(column));<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> }<a name="line.810"></a> |
| <span class="sourceLineNo">811</span> }<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> }<a name="line.812"></a> |
| <span class="sourceLineNo">813</span> map.put("totalColumns", colCount);<a name="line.813"></a> |
| <span class="sourceLineNo">814</span> if (this.filter != null) {<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> map.put("filter", this.filter.toString());<a name="line.815"></a> |
| <span class="sourceLineNo">816</span> }<a name="line.816"></a> |
| <span class="sourceLineNo">817</span> // add the id if set<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> if (getId() != null) {<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> map.put("id", getId());<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> }<a name="line.820"></a> |
| <span class="sourceLineNo">821</span> return map;<a name="line.821"></a> |
| <span class="sourceLineNo">822</span> }<a name="line.822"></a> |
| <span class="sourceLineNo">823</span><a name="line.823"></a> |
| <span class="sourceLineNo">824</span> /**<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> * Enable/disable "raw" mode for this scan.<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> * If "raw" is enabled the scan will return all<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> * delete marker and deleted rows that have not<a name="line.827"></a> |
| <span class="sourceLineNo">828</span> * been collected, yet.<a name="line.828"></a> |
| <span class="sourceLineNo">829</span> * This is mostly useful for Scan on column families<a name="line.829"></a> |
| <span class="sourceLineNo">830</span> * that have KEEP_DELETED_ROWS enabled.<a name="line.830"></a> |
| <span class="sourceLineNo">831</span> * It is an error to specify any column when "raw" is set.<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> * @param raw True/False to enable/disable "raw" mode.<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> */<a name="line.833"></a> |
| <span class="sourceLineNo">834</span> public Scan setRaw(boolean raw) {<a name="line.834"></a> |
| <span class="sourceLineNo">835</span> setAttribute(RAW_ATTR, Bytes.toBytes(raw));<a name="line.835"></a> |
| <span class="sourceLineNo">836</span> return this;<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> }<a name="line.837"></a> |
| <span class="sourceLineNo">838</span><a name="line.838"></a> |
| <span class="sourceLineNo">839</span> /**<a name="line.839"></a> |
| <span class="sourceLineNo">840</span> * @return True if this Scan is in "raw" mode.<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> */<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> public boolean isRaw() {<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> byte[] attr = getAttribute(RAW_ATTR);<a name="line.843"></a> |
| <span class="sourceLineNo">844</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> }<a name="line.845"></a> |
| <span class="sourceLineNo">846</span><a name="line.846"></a> |
| <span class="sourceLineNo">847</span> @Override<a name="line.847"></a> |
| <span class="sourceLineNo">848</span> public Scan setAttribute(String name, byte[] value) {<a name="line.848"></a> |
| <span class="sourceLineNo">849</span> return (Scan) super.setAttribute(name, value);<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> }<a name="line.850"></a> |
| <span class="sourceLineNo">851</span><a name="line.851"></a> |
| <span class="sourceLineNo">852</span> @Override<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> public Scan setId(String id) {<a name="line.853"></a> |
| <span class="sourceLineNo">854</span> return (Scan) super.setId(id);<a name="line.854"></a> |
| <span class="sourceLineNo">855</span> }<a name="line.855"></a> |
| <span class="sourceLineNo">856</span><a name="line.856"></a> |
| <span class="sourceLineNo">857</span> @Override<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> public Scan setAuthorizations(Authorizations authorizations) {<a name="line.858"></a> |
| <span class="sourceLineNo">859</span> return (Scan) super.setAuthorizations(authorizations);<a name="line.859"></a> |
| <span class="sourceLineNo">860</span> }<a name="line.860"></a> |
| <span class="sourceLineNo">861</span><a name="line.861"></a> |
| <span class="sourceLineNo">862</span> @Override<a name="line.862"></a> |
| <span class="sourceLineNo">863</span> public Scan setACL(Map<String, Permission> perms) {<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> return (Scan) super.setACL(perms);<a name="line.864"></a> |
| <span class="sourceLineNo">865</span> }<a name="line.865"></a> |
| <span class="sourceLineNo">866</span><a name="line.866"></a> |
| <span class="sourceLineNo">867</span> @Override<a name="line.867"></a> |
| <span class="sourceLineNo">868</span> public Scan setACL(String user, Permission perms) {<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> return (Scan) super.setACL(user, perms);<a name="line.869"></a> |
| <span class="sourceLineNo">870</span> }<a name="line.870"></a> |
| <span class="sourceLineNo">871</span><a name="line.871"></a> |
| <span class="sourceLineNo">872</span> @Override<a name="line.872"></a> |
| <span class="sourceLineNo">873</span> public Scan setConsistency(Consistency consistency) {<a name="line.873"></a> |
| <span class="sourceLineNo">874</span> return (Scan) super.setConsistency(consistency);<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> }<a name="line.875"></a> |
| <span class="sourceLineNo">876</span><a name="line.876"></a> |
| <span class="sourceLineNo">877</span> @Override<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> public Scan setReplicaId(int Id) {<a name="line.878"></a> |
| <span class="sourceLineNo">879</span> return (Scan) super.setReplicaId(Id);<a name="line.879"></a> |
| <span class="sourceLineNo">880</span> }<a name="line.880"></a> |
| <span class="sourceLineNo">881</span><a name="line.881"></a> |
| <span class="sourceLineNo">882</span> @Override<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> public Scan setIsolationLevel(IsolationLevel level) {<a name="line.883"></a> |
| <span class="sourceLineNo">884</span> return (Scan) super.setIsolationLevel(level);<a name="line.884"></a> |
| <span class="sourceLineNo">885</span> }<a name="line.885"></a> |
| <span class="sourceLineNo">886</span><a name="line.886"></a> |
| <span class="sourceLineNo">887</span> @Override<a name="line.887"></a> |
| <span class="sourceLineNo">888</span> public Scan setPriority(int priority) {<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> return (Scan) super.setPriority(priority);<a name="line.889"></a> |
| <span class="sourceLineNo">890</span> }<a name="line.890"></a> |
| <span class="sourceLineNo">891</span><a name="line.891"></a> |
| <span class="sourceLineNo">892</span> /**<a name="line.892"></a> |
| <span class="sourceLineNo">893</span> * Enable collection of {@link ScanMetrics}. For advanced users.<a name="line.893"></a> |
| <span class="sourceLineNo">894</span> * @param enabled Set to true to enable accumulating scan metrics<a name="line.894"></a> |
| <span class="sourceLineNo">895</span> */<a name="line.895"></a> |
| <span class="sourceLineNo">896</span> public Scan setScanMetricsEnabled(final boolean enabled) {<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> setAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE, Bytes.toBytes(Boolean.valueOf(enabled)));<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> return this;<a name="line.898"></a> |
| <span class="sourceLineNo">899</span> }<a name="line.899"></a> |
| <span class="sourceLineNo">900</span><a name="line.900"></a> |
| <span class="sourceLineNo">901</span> /**<a name="line.901"></a> |
| <span class="sourceLineNo">902</span> * @return True if collection of scan metrics is enabled. For advanced users.<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> */<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> public boolean isScanMetricsEnabled() {<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> byte[] attr = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE);<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.906"></a> |
| <span class="sourceLineNo">907</span> }<a name="line.907"></a> |
| <span class="sourceLineNo">908</span><a name="line.908"></a> |
| <span class="sourceLineNo">909</span> public Boolean isAsyncPrefetch() {<a name="line.909"></a> |
| <span class="sourceLineNo">910</span> return asyncPrefetch;<a name="line.910"></a> |
| <span class="sourceLineNo">911</span> }<a name="line.911"></a> |
| <span class="sourceLineNo">912</span><a name="line.912"></a> |
| <span class="sourceLineNo">913</span> /**<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> * @deprecated Since 3.0.0, will be removed in 4.0.0. After building sync client upon async<a name="line.914"></a> |
| <span class="sourceLineNo">915</span> * client, the implementation is always 'async prefetch', so this flag is useless now.<a name="line.915"></a> |
| <span class="sourceLineNo">916</span> */<a name="line.916"></a> |
| <span class="sourceLineNo">917</span> @Deprecated<a name="line.917"></a> |
| <span class="sourceLineNo">918</span> public Scan setAsyncPrefetch(boolean asyncPrefetch) {<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> this.asyncPrefetch = asyncPrefetch;<a name="line.919"></a> |
| <span class="sourceLineNo">920</span> return this;<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> }<a name="line.921"></a> |
| <span class="sourceLineNo">922</span><a name="line.922"></a> |
| <span class="sourceLineNo">923</span> /**<a name="line.923"></a> |
| <span class="sourceLineNo">924</span> * @return the limit of rows for this scan<a name="line.924"></a> |
| <span class="sourceLineNo">925</span> */<a name="line.925"></a> |
| <span class="sourceLineNo">926</span> public int getLimit() {<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> return limit;<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> }<a name="line.928"></a> |
| <span class="sourceLineNo">929</span><a name="line.929"></a> |
| <span class="sourceLineNo">930</span> /**<a name="line.930"></a> |
| <span class="sourceLineNo">931</span> * Set the limit of rows for this scan. We will terminate the scan if the number of returned rows<a name="line.931"></a> |
| <span class="sourceLineNo">932</span> * reaches this value.<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> * <p><a name="line.933"></a> |
| <span class="sourceLineNo">934</span> * This condition will be tested at last, after all other conditions such as stopRow, filter, etc.<a name="line.934"></a> |
| <span class="sourceLineNo">935</span> * @param limit the limit of rows for this scan<a name="line.935"></a> |
| <span class="sourceLineNo">936</span> * @return this<a name="line.936"></a> |
| <span class="sourceLineNo">937</span> */<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> public Scan setLimit(int limit) {<a name="line.938"></a> |
| <span class="sourceLineNo">939</span> this.limit = limit;<a name="line.939"></a> |
| <span class="sourceLineNo">940</span> return this;<a name="line.940"></a> |
| <span class="sourceLineNo">941</span> }<a name="line.941"></a> |
| <span class="sourceLineNo">942</span><a name="line.942"></a> |
| <span class="sourceLineNo">943</span> /**<a name="line.943"></a> |
| <span class="sourceLineNo">944</span> * Call this when you only want to get one row. It will set {@code limit} to {@code 1}, and also<a name="line.944"></a> |
| <span class="sourceLineNo">945</span> * set {@code readType} to {@link ReadType#PREAD}.<a name="line.945"></a> |
| <span class="sourceLineNo">946</span> * @return this<a name="line.946"></a> |
| <span class="sourceLineNo">947</span> */<a name="line.947"></a> |
| <span class="sourceLineNo">948</span> public Scan setOneRowLimit() {<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> return setLimit(1).setReadType(ReadType.PREAD);<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> }<a name="line.950"></a> |
| <span class="sourceLineNo">951</span><a name="line.951"></a> |
| <span class="sourceLineNo">952</span> @InterfaceAudience.Public<a name="line.952"></a> |
| <span class="sourceLineNo">953</span> public enum ReadType {<a name="line.953"></a> |
| <span class="sourceLineNo">954</span> DEFAULT, STREAM, PREAD<a name="line.954"></a> |
| <span class="sourceLineNo">955</span> }<a name="line.955"></a> |
| <span class="sourceLineNo">956</span><a name="line.956"></a> |
| <span class="sourceLineNo">957</span> /**<a name="line.957"></a> |
| <span class="sourceLineNo">958</span> * @return the read type for this scan<a name="line.958"></a> |
| <span class="sourceLineNo">959</span> */<a name="line.959"></a> |
| <span class="sourceLineNo">960</span> public ReadType getReadType() {<a name="line.960"></a> |
| <span class="sourceLineNo">961</span> return readType;<a name="line.961"></a> |
| <span class="sourceLineNo">962</span> }<a name="line.962"></a> |
| <span class="sourceLineNo">963</span><a name="line.963"></a> |
| <span class="sourceLineNo">964</span> /**<a name="line.964"></a> |
| <span class="sourceLineNo">965</span> * Set the read type for this scan.<a name="line.965"></a> |
| <span class="sourceLineNo">966</span> * <p><a name="line.966"></a> |
| <span class="sourceLineNo">967</span> * Notice that we may choose to use pread even if you specific {@link ReadType#STREAM} here. For<a name="line.967"></a> |
| <span class="sourceLineNo">968</span> * example, we will always use pread if this is a get scan.<a name="line.968"></a> |
| <span class="sourceLineNo">969</span> * @return this<a name="line.969"></a> |
| <span class="sourceLineNo">970</span> */<a name="line.970"></a> |
| <span class="sourceLineNo">971</span> public Scan setReadType(ReadType readType) {<a name="line.971"></a> |
| <span class="sourceLineNo">972</span> this.readType = readType;<a name="line.972"></a> |
| <span class="sourceLineNo">973</span> return this;<a name="line.973"></a> |
| <span class="sourceLineNo">974</span> }<a name="line.974"></a> |
| <span class="sourceLineNo">975</span><a name="line.975"></a> |
| <span class="sourceLineNo">976</span> /**<a name="line.976"></a> |
| <span class="sourceLineNo">977</span> * Get the mvcc read point used to open a scanner.<a name="line.977"></a> |
| <span class="sourceLineNo">978</span> */<a name="line.978"></a> |
| <span class="sourceLineNo">979</span> long getMvccReadPoint() {<a name="line.979"></a> |
| <span class="sourceLineNo">980</span> return mvccReadPoint;<a name="line.980"></a> |
| <span class="sourceLineNo">981</span> }<a name="line.981"></a> |
| <span class="sourceLineNo">982</span><a name="line.982"></a> |
| <span class="sourceLineNo">983</span> /**<a name="line.983"></a> |
| <span class="sourceLineNo">984</span> * Set the mvcc read point used to open a scanner.<a name="line.984"></a> |
| <span class="sourceLineNo">985</span> */<a name="line.985"></a> |
| <span class="sourceLineNo">986</span> Scan setMvccReadPoint(long mvccReadPoint) {<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> this.mvccReadPoint = mvccReadPoint;<a name="line.987"></a> |
| <span class="sourceLineNo">988</span> return this;<a name="line.988"></a> |
| <span class="sourceLineNo">989</span> }<a name="line.989"></a> |
| <span class="sourceLineNo">990</span><a name="line.990"></a> |
| <span class="sourceLineNo">991</span> /**<a name="line.991"></a> |
| <span class="sourceLineNo">992</span> * Set the mvcc read point to -1 which means do not use it.<a name="line.992"></a> |
| <span class="sourceLineNo">993</span> */<a name="line.993"></a> |
| <span class="sourceLineNo">994</span> Scan resetMvccReadPoint() {<a name="line.994"></a> |
| <span class="sourceLineNo">995</span> return setMvccReadPoint(-1L);<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> }<a name="line.996"></a> |
| <span class="sourceLineNo">997</span><a name="line.997"></a> |
| <span class="sourceLineNo">998</span> /**<a name="line.998"></a> |
| <span class="sourceLineNo">999</span> * When the server is slow or we scan a table with many deleted data or we use a sparse filter,<a name="line.999"></a> |
| <span class="sourceLineNo">1000</span> * the server will response heartbeat to prevent timeout. However the scanner will return a Result<a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span> * only when client can do it. So if there are many heartbeats, the blocking time on<a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> * ResultScanner#next() may be very long, which is not friendly to online services.<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span> *<a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span> * Set this to true then you can get a special Result whose #isCursor() returns true and is not<a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span> * contains any real data. It only tells you where the server has scanned. You can call next<a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> * to continue scanning or open a new scanner with this row key as start row whenever you want.<a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span> *<a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> * Users can get a cursor when and only when there is a response from the server but we can not<a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span> * return a Result to users, for example, this response is a heartbeat or there are partial cells<a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> * but users do not allow partial result.<a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> *<a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> * Now the cursor is in row level which means the special Result will only contains a row key.<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span> * {@link Result#isCursor()}<a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> * {@link Result#getCursor()}<a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span> * {@link Cursor}<a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span> */<a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> public Scan setNeedCursorResult(boolean needCursorResult) {<a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> this.needCursorResult = needCursorResult;<a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> return this;<a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> }<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span><a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> public boolean isNeedCursorResult() {<a name="line.1022"></a> |
| <span class="sourceLineNo">1023</span> return needCursorResult;<a name="line.1023"></a> |
| <span class="sourceLineNo">1024</span> }<a name="line.1024"></a> |
| <span class="sourceLineNo">1025</span><a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> /**<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> * Create a new Scan with a cursor. It only set the position information like start row key.<a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> * The others (like cfs, stop row, limit) should still be filled in by the user.<a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> * {@link Result#isCursor()}<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> * {@link Result#getCursor()}<a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span> * {@link Cursor}<a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> */<a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> public static Scan createScanFromCursor(Cursor cursor) {<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> return new Scan().withStartRow(cursor.getRow());<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span> }<a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span>}<a name="line.1036"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
