blob: 7db53eb3b63ae4a1675cedf4cc56db9c9331debe [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.client, class: AbstractTestScanCursor">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.ArrayList;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.CellUtil;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HTestConst;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.KeyValue;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.filter.Filter;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.filter.FilterBase;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.regionserver.StoreScanner;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.util.Threads;</span>
<span class="source-line-no">036</span><span id="line-36">import org.junit.AfterClass;</span>
<span class="source-line-no">037</span><span id="line-37">import org.junit.BeforeClass;</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39">public abstract class AbstractTestScanCursor {</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> protected final static HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> /**</span>
<span class="source-line-no">044</span><span id="line-44"> * Table configuration</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46"> protected static TableName TABLE_NAME = TableName.valueOf("TestScanCursor");</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> protected static int NUM_ROWS = 5;</span>
<span class="source-line-no">049</span><span id="line-49"> protected static byte[] ROW = Bytes.toBytes("testRow");</span>
<span class="source-line-no">050</span><span id="line-50"> protected static byte[][] ROWS = HTestConst.makeNAscii(ROW, NUM_ROWS);</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> protected static int NUM_FAMILIES = 2;</span>
<span class="source-line-no">053</span><span id="line-53"> protected static byte[] FAMILY = Bytes.toBytes("testFamily");</span>
<span class="source-line-no">054</span><span id="line-54"> protected static byte[][] FAMILIES = HTestConst.makeNAscii(FAMILY, NUM_FAMILIES);</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> protected static int NUM_QUALIFIERS = 2;</span>
<span class="source-line-no">057</span><span id="line-57"> protected static byte[] QUALIFIER = Bytes.toBytes("testQualifier");</span>
<span class="source-line-no">058</span><span id="line-58"> protected static byte[][] QUALIFIERS = HTestConst.makeNAscii(QUALIFIER, NUM_QUALIFIERS);</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> protected static int VALUE_SIZE = 10;</span>
<span class="source-line-no">061</span><span id="line-61"> protected static byte[] VALUE = Bytes.createMaxByteArray(VALUE_SIZE);</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> protected static final int TIMEOUT = 4000;</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> @BeforeClass</span>
<span class="source-line-no">066</span><span id="line-66"> public static void setUpBeforeClass() throws Exception {</span>
<span class="source-line-no">067</span><span id="line-67"> Configuration conf = TEST_UTIL.getConfiguration();</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> conf.setInt(HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD, TIMEOUT);</span>
<span class="source-line-no">070</span><span id="line-70"> conf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, TIMEOUT);</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> // Check the timeout condition after every cell</span>
<span class="source-line-no">073</span><span id="line-73"> conf.setLong(StoreScanner.HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK, 1);</span>
<span class="source-line-no">074</span><span id="line-74"> TEST_UTIL.startMiniCluster(1);</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> createTestTable(TABLE_NAME, ROWS, FAMILIES, QUALIFIERS, VALUE);</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> private static void createTestTable(TableName name, byte[][] rows, byte[][] families,</span>
<span class="source-line-no">080</span><span id="line-80"> byte[][] qualifiers, byte[] cellValue) throws IOException {</span>
<span class="source-line-no">081</span><span id="line-81"> TEST_UTIL.createTable(name, families).put(createPuts(rows, families, qualifiers, cellValue));</span>
<span class="source-line-no">082</span><span id="line-82"> }</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> private static List&lt;Put&gt; createPuts(byte[][] rows, byte[][] families, byte[][] qualifiers,</span>
<span class="source-line-no">085</span><span id="line-85"> byte[] value) throws IOException {</span>
<span class="source-line-no">086</span><span id="line-86"> List&lt;Put&gt; puts = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">087</span><span id="line-87"> for (int row = 0; row &lt; rows.length; row++) {</span>
<span class="source-line-no">088</span><span id="line-88"> Put put = new Put(rows[row]);</span>
<span class="source-line-no">089</span><span id="line-89"> for (int fam = 0; fam &lt; families.length; fam++) {</span>
<span class="source-line-no">090</span><span id="line-90"> for (int qual = 0; qual &lt; qualifiers.length; qual++) {</span>
<span class="source-line-no">091</span><span id="line-91"> KeyValue kv = new KeyValue(rows[row], families[fam], qualifiers[qual], qual, value);</span>
<span class="source-line-no">092</span><span id="line-92"> put.add(kv);</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"> puts.add(put);</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"> return puts;</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> @AfterClass</span>
<span class="source-line-no">101</span><span id="line-101"> public static void tearDownAfterClass() throws Exception {</span>
<span class="source-line-no">102</span><span id="line-102"> TEST_UTIL.shutdownMiniCluster();</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"></span>
<span class="source-line-no">105</span><span id="line-105"> public static final class SparseFilter extends FilterBase {</span>
<span class="source-line-no">106</span><span id="line-106"></span>
<span class="source-line-no">107</span><span id="line-107"> private final boolean reversed;</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> public SparseFilter(boolean reversed) {</span>
<span class="source-line-no">110</span><span id="line-110"> this.reversed = reversed;</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> @Override</span>
<span class="source-line-no">114</span><span id="line-114"> public ReturnCode filterCell(final Cell c) throws IOException {</span>
<span class="source-line-no">115</span><span id="line-115"> Threads.sleep(TIMEOUT / 2 + 100);</span>
<span class="source-line-no">116</span><span id="line-116"> return Bytes.equals(CellUtil.cloneRow(c), ROWS[reversed ? 0 : NUM_ROWS - 1])</span>
<span class="source-line-no">117</span><span id="line-117"> ? ReturnCode.INCLUDE</span>
<span class="source-line-no">118</span><span id="line-118"> : ReturnCode.SKIP;</span>
<span class="source-line-no">119</span><span id="line-119"> }</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> @Override</span>
<span class="source-line-no">122</span><span id="line-122"> public byte[] toByteArray() throws IOException {</span>
<span class="source-line-no">123</span><span id="line-123"> return reversed ? new byte[] { 1 } : new byte[] { 0 };</span>
<span class="source-line-no">124</span><span id="line-124"> }</span>
<span class="source-line-no">125</span><span id="line-125"></span>
<span class="source-line-no">126</span><span id="line-126"> public static Filter parseFrom(final byte[] pbBytes) {</span>
<span class="source-line-no">127</span><span id="line-127"> return new SparseFilter(pbBytes[0] != 0);</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"> }</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> protected Scan createScanWithSparseFilter() {</span>
<span class="source-line-no">132</span><span id="line-132"> return new Scan().setMaxResultSize(Long.MAX_VALUE).setCaching(Integer.MAX_VALUE)</span>
<span class="source-line-no">133</span><span id="line-133"> .setNeedCursorResult(true).setAllowPartialResults(true).setFilter(new SparseFilter(false));</span>
<span class="source-line-no">134</span><span id="line-134"> }</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> protected Scan createReversedScanWithSparseFilter() {</span>
<span class="source-line-no">137</span><span id="line-137"> return new Scan().setMaxResultSize(Long.MAX_VALUE).setCaching(Integer.MAX_VALUE)</span>
<span class="source-line-no">138</span><span id="line-138"> .setReversed(true).setNeedCursorResult(true).setAllowPartialResults(true)</span>
<span class="source-line-no">139</span><span id="line-139"> .setFilter(new SparseFilter(true));</span>
<span class="source-line-no">140</span><span id="line-140"> }</span>
<span class="source-line-no">141</span><span id="line-141"></span>
<span class="source-line-no">142</span><span id="line-142"> protected Scan createScanWithSizeLimit() {</span>
<span class="source-line-no">143</span><span id="line-143"> return new Scan().setMaxResultSize(1).setCaching(Integer.MAX_VALUE).setNeedCursorResult(true);</span>
<span class="source-line-no">144</span><span id="line-144"> }</span>
<span class="source-line-no">145</span><span id="line-145">}</span>
</pre>
</div>
</main>
</body>
</html>