Google Git
Sign in
apache / hbase-site / 5a6938ba8875b19a3d96e84a37f1016c53778aec / . / devapidocs / src-html / org / apache / hadoop / hbase / regionserver / ScanInfo.html
blob: aae9d701a3239d361785605710bc0497ee9a57ea [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.regionserver, class: ScanInfo">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import org.apache.commons.lang3.builder.ToStringBuilder;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.CellComparator;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.KeepDeletedCells;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.ClassSize;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">/**</span>
<span class="source-line-no">031</span><span id="line-31"> * Immutable information for scans over a store.</span>
<span class="source-line-no">032</span><span id="line-32"> */</span>
<span class="source-line-no">033</span><span id="line-33">// Has to be public for PartitionedMobCompactor to access; ditto on tests making use of a few of</span>
<span class="source-line-no">034</span><span id="line-34">// the accessors below. Shutdown access. TODO</span>
<span class="source-line-no">035</span><span id="line-35">@InterfaceAudience.Private</span>
<span class="source-line-no">036</span><span id="line-36">public class ScanInfo {</span>
<span class="source-line-no">037</span><span id="line-37"> private byte[] family;</span>
<span class="source-line-no">038</span><span id="line-38"> private int minVersions;</span>
<span class="source-line-no">039</span><span id="line-39"> private int maxVersions;</span>
<span class="source-line-no">040</span><span id="line-40"> private long ttl;</span>
<span class="source-line-no">041</span><span id="line-41"> private KeepDeletedCells keepDeletedCells;</span>
<span class="source-line-no">042</span><span id="line-42"> private long timeToPurgeDeletes;</span>
<span class="source-line-no">043</span><span id="line-43"> private CellComparator comparator;</span>
<span class="source-line-no">044</span><span id="line-44"> private long tableMaxRowSize;</span>
<span class="source-line-no">045</span><span id="line-45"> private boolean usePread;</span>
<span class="source-line-no">046</span><span id="line-46"> private long cellsPerTimeoutCheck;</span>
<span class="source-line-no">047</span><span id="line-47"> private boolean parallelSeekEnabled;</span>
<span class="source-line-no">048</span><span id="line-48"> private final long preadMaxBytes;</span>
<span class="source-line-no">049</span><span id="line-49"> private final boolean newVersionBehavior;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> public static final long FIXED_OVERHEAD =</span>
<span class="source-line-no">052</span><span id="line-52"> ClassSize.align(ClassSize.OBJECT + (2 * ClassSize.REFERENCE) + (2 * Bytes.SIZEOF_INT)</span>
<span class="source-line-no">053</span><span id="line-53"> + (4 * Bytes.SIZEOF_LONG) + (4 * Bytes.SIZEOF_BOOLEAN));</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> /**</span>
<span class="source-line-no">056</span><span id="line-56"> * @param family {@link ColumnFamilyDescriptor} describing the column family</span>
<span class="source-line-no">057</span><span id="line-57"> * @param ttl Store's TTL (in ms)</span>
<span class="source-line-no">058</span><span id="line-58"> * @param timeToPurgeDeletes duration in ms after which a delete marker can be purged during a</span>
<span class="source-line-no">059</span><span id="line-59"> * major compaction.</span>
<span class="source-line-no">060</span><span id="line-60"> * @param comparator The store's comparator</span>
<span class="source-line-no">061</span><span id="line-61"> */</span>
<span class="source-line-no">062</span><span id="line-62"> public ScanInfo(Configuration conf, ColumnFamilyDescriptor family, long ttl,</span>
<span class="source-line-no">063</span><span id="line-63"> long timeToPurgeDeletes, CellComparator comparator) {</span>
<span class="source-line-no">064</span><span id="line-64"> this(conf, family.getName(), family.getMinVersions(), family.getMaxVersions(), ttl,</span>
<span class="source-line-no">065</span><span id="line-65"> family.getKeepDeletedCells(), family.getBlocksize(), timeToPurgeDeletes, comparator,</span>
<span class="source-line-no">066</span><span id="line-66"> family.isNewVersionBehavior());</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> private static long getCellsPerTimeoutCheck(Configuration conf) {</span>
<span class="source-line-no">070</span><span id="line-70"> long perHeartbeat = conf.getLong(StoreScanner.HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK,</span>
<span class="source-line-no">071</span><span id="line-71"> StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK);</span>
<span class="source-line-no">072</span><span id="line-72"> return perHeartbeat &gt; 0</span>
<span class="source-line-no">073</span><span id="line-73"> ? perHeartbeat</span>
<span class="source-line-no">074</span><span id="line-74"> : StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK;</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> /**</span>
<span class="source-line-no">078</span><span id="line-78"> * @param family Name of this store's column family</span>
<span class="source-line-no">079</span><span id="line-79"> * @param minVersions Store's MIN_VERSIONS setting</span>
<span class="source-line-no">080</span><span id="line-80"> * @param maxVersions Store's VERSIONS setting</span>
<span class="source-line-no">081</span><span id="line-81"> * @param ttl Store's TTL (in ms)</span>
<span class="source-line-no">082</span><span id="line-82"> * @param blockSize Store's block size</span>
<span class="source-line-no">083</span><span id="line-83"> * @param timeToPurgeDeletes duration in ms after which a delete marker can be purged during a</span>
<span class="source-line-no">084</span><span id="line-84"> * major compaction.</span>
<span class="source-line-no">085</span><span id="line-85"> * @param keepDeletedCells Store's keepDeletedCells setting</span>
<span class="source-line-no">086</span><span id="line-86"> * @param comparator The store's comparator</span>
<span class="source-line-no">087</span><span id="line-87"> */</span>
<span class="source-line-no">088</span><span id="line-88"> public ScanInfo(Configuration conf, byte[] family, int minVersions, int maxVersions, long ttl,</span>
<span class="source-line-no">089</span><span id="line-89"> KeepDeletedCells keepDeletedCells, long blockSize, long timeToPurgeDeletes,</span>
<span class="source-line-no">090</span><span id="line-90"> CellComparator comparator, boolean newVersionBehavior) {</span>
<span class="source-line-no">091</span><span id="line-91"> this(family, minVersions, maxVersions, ttl, keepDeletedCells, timeToPurgeDeletes, comparator,</span>
<span class="source-line-no">092</span><span id="line-92"> conf.getLong(HConstants.TABLE_MAX_ROWSIZE_KEY, HConstants.TABLE_MAX_ROWSIZE_DEFAULT),</span>
<span class="source-line-no">093</span><span id="line-93"> conf.getBoolean("hbase.storescanner.use.pread", false), getCellsPerTimeoutCheck(conf),</span>
<span class="source-line-no">094</span><span id="line-94"> conf.getBoolean(StoreScanner.STORESCANNER_PARALLEL_SEEK_ENABLE, false),</span>
<span class="source-line-no">095</span><span id="line-95"> conf.getLong(StoreScanner.STORESCANNER_PREAD_MAX_BYTES, 4 * blockSize), newVersionBehavior);</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> private ScanInfo(byte[] family, int minVersions, int maxVersions, long ttl,</span>
<span class="source-line-no">099</span><span id="line-99"> KeepDeletedCells keepDeletedCells, long timeToPurgeDeletes, CellComparator comparator,</span>
<span class="source-line-no">100</span><span id="line-100"> long tableMaxRowSize, boolean usePread, long cellsPerTimeoutCheck, boolean parallelSeekEnabled,</span>
<span class="source-line-no">101</span><span id="line-101"> long preadMaxBytes, boolean newVersionBehavior) {</span>
<span class="source-line-no">102</span><span id="line-102"> this.family = family;</span>
<span class="source-line-no">103</span><span id="line-103"> this.minVersions = minVersions;</span>
<span class="source-line-no">104</span><span id="line-104"> this.maxVersions = maxVersions;</span>
<span class="source-line-no">105</span><span id="line-105"> this.ttl = ttl;</span>
<span class="source-line-no">106</span><span id="line-106"> this.keepDeletedCells = keepDeletedCells;</span>
<span class="source-line-no">107</span><span id="line-107"> this.timeToPurgeDeletes = timeToPurgeDeletes;</span>
<span class="source-line-no">108</span><span id="line-108"> this.comparator = comparator;</span>
<span class="source-line-no">109</span><span id="line-109"> this.tableMaxRowSize = tableMaxRowSize;</span>
<span class="source-line-no">110</span><span id="line-110"> this.usePread = usePread;</span>
<span class="source-line-no">111</span><span id="line-111"> this.cellsPerTimeoutCheck = cellsPerTimeoutCheck;</span>
<span class="source-line-no">112</span><span id="line-112"> this.parallelSeekEnabled = parallelSeekEnabled;</span>
<span class="source-line-no">113</span><span id="line-113"> this.preadMaxBytes = preadMaxBytes;</span>
<span class="source-line-no">114</span><span id="line-114"> this.newVersionBehavior = newVersionBehavior;</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> long getTableMaxRowSize() {</span>
<span class="source-line-no">118</span><span id="line-118"> return this.tableMaxRowSize;</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"> boolean isUsePread() {</span>
<span class="source-line-no">122</span><span id="line-122"> return this.usePread;</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> long getCellsPerTimeoutCheck() {</span>
<span class="source-line-no">126</span><span id="line-126"> return this.cellsPerTimeoutCheck;</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> boolean isParallelSeekEnabled() {</span>
<span class="source-line-no">130</span><span id="line-130"> return this.parallelSeekEnabled;</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"></span>
<span class="source-line-no">133</span><span id="line-133"> public byte[] getFamily() {</span>
<span class="source-line-no">134</span><span id="line-134"> return family;</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"></span>
<span class="source-line-no">137</span><span id="line-137"> public int getMinVersions() {</span>
<span class="source-line-no">138</span><span id="line-138"> return minVersions;</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> public int getMaxVersions() {</span>
<span class="source-line-no">142</span><span id="line-142"> return maxVersions;</span>
<span class="source-line-no">143</span><span id="line-143"> }</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> public long getTtl() {</span>
<span class="source-line-no">146</span><span id="line-146"> return ttl;</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> public KeepDeletedCells getKeepDeletedCells() {</span>
<span class="source-line-no">150</span><span id="line-150"> return keepDeletedCells;</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> public long getTimeToPurgeDeletes() {</span>
<span class="source-line-no">154</span><span id="line-154"> return timeToPurgeDeletes;</span>
<span class="source-line-no">155</span><span id="line-155"> }</span>
<span class="source-line-no">156</span><span id="line-156"></span>
<span class="source-line-no">157</span><span id="line-157"> public CellComparator getComparator() {</span>
<span class="source-line-no">158</span><span id="line-158"> return comparator;</span>
<span class="source-line-no">159</span><span id="line-159"> }</span>
<span class="source-line-no">160</span><span id="line-160"></span>
<span class="source-line-no">161</span><span id="line-161"> long getPreadMaxBytes() {</span>
<span class="source-line-no">162</span><span id="line-162"> return preadMaxBytes;</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> public boolean isNewVersionBehavior() {</span>
<span class="source-line-no">166</span><span id="line-166"> return newVersionBehavior;</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> /**</span>
<span class="source-line-no">170</span><span id="line-170"> * Used by CP users for customizing max versions, ttl and keepDeletedCells.</span>
<span class="source-line-no">171</span><span id="line-171"> */</span>
<span class="source-line-no">172</span><span id="line-172"> ScanInfo customize(int maxVersions, long ttl, KeepDeletedCells keepDeletedCells) {</span>
<span class="source-line-no">173</span><span id="line-173"> return customize(maxVersions, ttl, keepDeletedCells, minVersions, timeToPurgeDeletes);</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"></span>
<span class="source-line-no">176</span><span id="line-176"> /**</span>
<span class="source-line-no">177</span><span id="line-177"> * Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions, and time to</span>
<span class="source-line-no">178</span><span id="line-178"> * purge deletes.</span>
<span class="source-line-no">179</span><span id="line-179"> */</span>
<span class="source-line-no">180</span><span id="line-180"> ScanInfo customize(int maxVersions, long ttl, KeepDeletedCells keepDeletedCells, int minVersions,</span>
<span class="source-line-no">181</span><span id="line-181"> long timeToPurgeDeletes) {</span>
<span class="source-line-no">182</span><span id="line-182"> return new ScanInfo(family, minVersions, maxVersions, ttl, keepDeletedCells, timeToPurgeDeletes,</span>
<span class="source-line-no">183</span><span id="line-183"> comparator, tableMaxRowSize, usePread, cellsPerTimeoutCheck, parallelSeekEnabled,</span>
<span class="source-line-no">184</span><span id="line-184"> preadMaxBytes, newVersionBehavior);</span>
<span class="source-line-no">185</span><span id="line-185"> }</span>
<span class="source-line-no">186</span><span id="line-186"></span>
<span class="source-line-no">187</span><span id="line-187"> @Override</span>
<span class="source-line-no">188</span><span id="line-188"> public String toString() {</span>
<span class="source-line-no">189</span><span id="line-189"> return new ToStringBuilder(this).append("family", Bytes.toStringBinary(family))</span>
<span class="source-line-no">190</span><span id="line-190"> .append("minVersions", minVersions).append("maxVersions", maxVersions).append("ttl", ttl)</span>
<span class="source-line-no">191</span><span id="line-191"> .append("keepDeletedCells", keepDeletedCells).append("timeToPurgeDeletes", timeToPurgeDeletes)</span>
<span class="source-line-no">192</span><span id="line-192"> .append("tableMaxRowSize", tableMaxRowSize).append("usePread", usePread)</span>
<span class="source-line-no">193</span><span id="line-193"> .append("cellsPerTimeoutCheck", cellsPerTimeoutCheck)</span>
<span class="source-line-no">194</span><span id="line-194"> .append("parallelSeekEnabled", parallelSeekEnabled).append("preadMaxBytes", preadMaxBytes)</span>
<span class="source-line-no">195</span><span id="line-195"> .append("newVersionBehavior", newVersionBehavior).toString();</span>
<span class="source-line-no">196</span><span id="line-196"> }</span>
<span class="source-line-no">197</span><span id="line-197">}</span>
</pre>
</div>
</main>
</body>
</html>