blob: 673f1920d84c9645e779734f6fc39c95b973f9de [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DataBlockEncodingTool (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataBlockEncodingTool (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":9,"i9":10,"i10":9,"i11":9,"i12":9,"i13":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataBlockEncodingTool.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/CreateRandomStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.Manipulation.html" title="enum in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html" target="_top">Frames</a></li>
<li><a href="DataBlockEncodingTool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.regionserver</div>
<h2 title="Class DataBlockEncodingTool" class="title">Class DataBlockEncodingTool</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.65">DataBlockEncodingTool</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Tests various algorithms for key compression on an existing HFile. Useful
for testing, debugging and benchmarking.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.Manipulation.html" title="enum in org.apache.hadoop.hbase.regionserver">DataBlockEncodingTool.Manipulation</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#benchmarkNOmit">benchmarkNOmit</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#benchmarkNTimes">benchmarkNTimes</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#BYTES_IN_MB">BYTES_IN_MB</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.hbase.io.encoding.EncodedDataBlock&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#codecs">codecs</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private org.apache.hadoop.hbase.io.compress.Compression.Algorithm</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#compressionAlgorithm">compressionAlgorithm</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#compressionAlgorithmName">compressionAlgorithmName</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private org.apache.hadoop.io.compress.Compressor</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#compressor">compressor</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private org.apache.hadoop.io.compress.Decompressor</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#decompressor">decompressor</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#DEFAULT_BENCHMARK_N_OMIT">DEFAULT_BENCHMARK_N_OMIT</a></span></code>
<div class="block">How many first runs should not be included in the benchmark.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#DEFAULT_BENCHMARK_N_TIMES">DEFAULT_BENCHMARK_N_TIMES</a></span></code>
<div class="block">How many times to run the benchmark.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static org.apache.hadoop.hbase.io.compress.Compression.Algorithm</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#DEFAULT_COMPRESSION">DEFAULT_COMPRESSION</a></span></code>
<div class="block">Compression algorithm to use if not specified on the command line</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text">DecimalFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#DELIMITED_DECIMAL_FORMAT">DELIMITED_DECIMAL_FORMAT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#includesMemstoreTS">includesMemstoreTS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#INT_FORMAT">INT_FORMAT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#MB_SEC_COEF">MB_SEC_COEF</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#NS_IN_SEC">NS_IN_SEC</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#OPT_BENCHMARK_N_OMIT">OPT_BENCHMARK_N_OMIT</a></span></code>
<div class="block">Number of first runs of every benchmark to omit from statistics</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#OPT_BENCHMARK_N_TIMES">OPT_BENCHMARK_N_TIMES</a></span></code>
<div class="block">Number of times to run each benchmark</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#OPT_COMPRESSION_ALGORITHM">OPT_COMPRESSION_ALGORITHM</a></span></code>
<div class="block">What compression algorithm to test</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#OPT_HFILE_NAME">OPT_HFILE_NAME</a></span></code>
<div class="block">HFile name to be used in benchmark</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#OPT_KV_LIMIT">OPT_KV_LIMIT</a></span></code>
<div class="block">Maximum number of key/value pairs to process in a single benchmark run</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#OPT_MEASURE_THROUGHPUT">OPT_MEASURE_THROUGHPUT</a></span></code>
<div class="block">Whether to run a benchmark to measure read throughput</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#OPT_OMIT_CORRECTNESS_TEST">OPT_OMIT_CORRECTNESS_TEST</a></span></code>
<div class="block">If this is specified, no correctness testing will be done</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#PCT_FORMAT">PCT_FORMAT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#rawKVs">rawKVs</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#totalCFLength">totalCFLength</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#totalKeyLength">totalKeyLength</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#totalKeyRedundancyLength">totalKeyRedundancyLength</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#totalPrefixLength">totalPrefixLength</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#totalValueLength">totalValueLength</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#USE_TAG">USE_TAG</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#useHBaseChecksum">useHBaseChecksum</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#DataBlockEncodingTool-java.lang.String-">DataBlockEncodingTool</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;compressionAlgorithmName)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#benchmarkAlgorithm-org.apache.hadoop.hbase.io.compress.Compression.Algorithm-java.lang.String-byte:A-int-int-">benchmarkAlgorithm</a></span>(org.apache.hadoop.hbase.io.compress.Compression.Algorithm&nbsp;algorithm,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)</code>
<div class="block">Check decompress performance of a given algorithm and print it.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#benchmarkCodecs--">benchmarkCodecs</a></span>()</code>
<div class="block">Benchmark codec's speed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#benchmarkDefaultCompression-int-byte:A-">benchmarkDefaultCompression</a></span>(int&nbsp;totalSize,
byte[]&nbsp;rawBuffer)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#benchmarkEncoder-int-org.apache.hadoop.hbase.io.encoding.EncodedDataBlock-">benchmarkEncoder</a></span>(int&nbsp;previousTotalSize,
org.apache.hadoop.hbase.io.encoding.EncodedDataBlock&nbsp;codec)</code>
<div class="block">Benchmark compression/decompression throughput.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#checkStatistics-org.apache.hadoop.hbase.regionserver.KeyValueScanner-int-">checkStatistics</a></span>(org.apache.hadoop.hbase.regionserver.KeyValueScanner&nbsp;scanner,
int&nbsp;kvLimit)</code>
<div class="block">Check statistics for given HFile for different data block encoders.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#displayStatistics--">displayStatistics</a></span>()</code>
<div class="block">Display statistics of different compression algorithms.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#main-java.lang.String:A-">main</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block">A command line interface to benchmarks.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#outputSavings-java.lang.String-long-long-">outputSavings</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;caption,
long&nbsp;part,
long&nbsp;whole)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>private static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#outputTuple-java.lang.String-java.lang.String-java.lang.Object...-">outputTuple</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;caption,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;format,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;values)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#outputTuplePct-java.lang.String-long-">outputTuplePct</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;caption,
long&nbsp;size)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>private static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#printBenchmarkResult-int-java.util.List-org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.Manipulation-">printBenchmarkResult</a></span>(int&nbsp;totalSize,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;durationsInNanoSec,
<a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.Manipulation.html" title="enum in org.apache.hadoop.hbase.regionserver">DataBlockEncodingTool.Manipulation</a>&nbsp;manipulation)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>private static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#printUsage-org.apache.hbase.thirdparty.org.apache.commons.cli.Options-">printUsage</a></span>(org.apache.hbase.thirdparty.org.apache.commons.cli.Options&nbsp;options)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#testCodecs-org.apache.hadoop.conf.Configuration-int-java.lang.String-java.lang.String-boolean-boolean-">testCodecs</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
int&nbsp;kvLimit,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hfilePath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;compressionName,
boolean&nbsp;doBenchmark,
boolean&nbsp;doVerify)</code>
<div class="block">Test a data block encoder on the given HFile.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#verifyCodecs-org.apache.hadoop.hbase.regionserver.KeyValueScanner-int-">verifyCodecs</a></span>(org.apache.hadoop.hbase.regionserver.KeyValueScanner&nbsp;scanner,
int&nbsp;kvLimit)</code>
<div class="block">Verify if all data block encoders are working properly.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="LOG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG</h4>
<pre>private static final&nbsp;org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.66">LOG</a></pre>
</li>
</ul>
<a name="includesMemstoreTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includesMemstoreTS</h4>
<pre>private static final&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.69">includesMemstoreTS</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.includesMemstoreTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_BENCHMARK_N_TIMES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_BENCHMARK_N_TIMES</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.76">DEFAULT_BENCHMARK_N_TIMES</a></pre>
<div class="block">How many times to run the benchmark. More times means better data in terms
of statistics but slower execution. Has to be strictly larger than
<a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#DEFAULT_BENCHMARK_N_OMIT"><code>DEFAULT_BENCHMARK_N_OMIT</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.DEFAULT_BENCHMARK_N_TIMES">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_BENCHMARK_N_OMIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_BENCHMARK_N_OMIT</h4>
<pre>private static final&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.82">DEFAULT_BENCHMARK_N_OMIT</a></pre>
<div class="block">How many first runs should not be included in the benchmark. Done in order
to exclude setup cost.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.DEFAULT_BENCHMARK_N_OMIT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPT_HFILE_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPT_HFILE_NAME</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.85">OPT_HFILE_NAME</a></pre>
<div class="block">HFile name to be used in benchmark</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.OPT_HFILE_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPT_KV_LIMIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPT_KV_LIMIT</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.88">OPT_KV_LIMIT</a></pre>
<div class="block">Maximum number of key/value pairs to process in a single benchmark run</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.OPT_KV_LIMIT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPT_MEASURE_THROUGHPUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPT_MEASURE_THROUGHPUT</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.91">OPT_MEASURE_THROUGHPUT</a></pre>
<div class="block">Whether to run a benchmark to measure read throughput</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.OPT_MEASURE_THROUGHPUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPT_OMIT_CORRECTNESS_TEST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPT_OMIT_CORRECTNESS_TEST</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.94">OPT_OMIT_CORRECTNESS_TEST</a></pre>
<div class="block">If this is specified, no correctness testing will be done</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.OPT_OMIT_CORRECTNESS_TEST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPT_COMPRESSION_ALGORITHM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPT_COMPRESSION_ALGORITHM</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.97">OPT_COMPRESSION_ALGORITHM</a></pre>
<div class="block">What compression algorithm to test</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.OPT_COMPRESSION_ALGORITHM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPT_BENCHMARK_N_TIMES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPT_BENCHMARK_N_TIMES</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.100">OPT_BENCHMARK_N_TIMES</a></pre>
<div class="block">Number of times to run each benchmark</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.OPT_BENCHMARK_N_TIMES">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OPT_BENCHMARK_N_OMIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPT_BENCHMARK_N_OMIT</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.103">OPT_BENCHMARK_N_OMIT</a></pre>
<div class="block">Number of first runs of every benchmark to omit from statistics</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.OPT_BENCHMARK_N_OMIT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_COMPRESSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_COMPRESSION</h4>
<pre>private static final&nbsp;org.apache.hadoop.hbase.io.compress.Compression.Algorithm <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.106">DEFAULT_COMPRESSION</a></pre>
<div class="block">Compression algorithm to use if not specified on the command line</div>
</li>
</ul>
<a name="DELIMITED_DECIMAL_FORMAT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELIMITED_DECIMAL_FORMAT</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text">DecimalFormat</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.109">DELIMITED_DECIMAL_FORMAT</a></pre>
</li>
</ul>
<a name="PCT_FORMAT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PCT_FORMAT</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.116">PCT_FORMAT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.PCT_FORMAT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INT_FORMAT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INT_FORMAT</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.117">INT_FORMAT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.INT_FORMAT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="benchmarkNTimes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>benchmarkNTimes</h4>
<pre>private static&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.119">benchmarkNTimes</a></pre>
</li>
</ul>
<a name="benchmarkNOmit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>benchmarkNOmit</h4>
<pre>private static&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.120">benchmarkNOmit</a></pre>
</li>
</ul>
<a name="codecs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>codecs</h4>
<pre>private&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.hbase.io.encoding.EncodedDataBlock&gt; <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.122">codecs</a></pre>
</li>
</ul>
<a name="totalPrefixLength">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>totalPrefixLength</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.123">totalPrefixLength</a></pre>
</li>
</ul>
<a name="totalKeyLength">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>totalKeyLength</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.124">totalKeyLength</a></pre>
</li>
</ul>
<a name="totalValueLength">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>totalValueLength</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.125">totalValueLength</a></pre>
</li>
</ul>
<a name="totalKeyRedundancyLength">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>totalKeyRedundancyLength</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.126">totalKeyRedundancyLength</a></pre>
</li>
</ul>
<a name="totalCFLength">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>totalCFLength</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.127">totalCFLength</a></pre>
</li>
</ul>
<a name="rawKVs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rawKVs</h4>
<pre>private&nbsp;byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.129">rawKVs</a></pre>
</li>
</ul>
<a name="useHBaseChecksum">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useHBaseChecksum</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.130">useHBaseChecksum</a></pre>
</li>
</ul>
<a name="compressionAlgorithmName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compressionAlgorithmName</h4>
<pre>private final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.132">compressionAlgorithmName</a></pre>
</li>
</ul>
<a name="compressionAlgorithm">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compressionAlgorithm</h4>
<pre>private final&nbsp;org.apache.hadoop.hbase.io.compress.Compression.Algorithm <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.133">compressionAlgorithm</a></pre>
</li>
</ul>
<a name="compressor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compressor</h4>
<pre>private final&nbsp;org.apache.hadoop.io.compress.Compressor <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.134">compressor</a></pre>
</li>
</ul>
<a name="decompressor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decompressor</h4>
<pre>private final&nbsp;org.apache.hadoop.io.compress.Decompressor <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.135">decompressor</a></pre>
</li>
</ul>
<a name="USE_TAG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USE_TAG</h4>
<pre>private static&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.138">USE_TAG</a></pre>
</li>
</ul>
<a name="BYTES_IN_MB">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BYTES_IN_MB</h4>
<pre>private static final&nbsp;double <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.494">BYTES_IN_MB</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.BYTES_IN_MB">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="NS_IN_SEC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NS_IN_SEC</h4>
<pre>private static final&nbsp;double <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.495">NS_IN_SEC</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.NS_IN_SEC">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MB_SEC_COEF">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MB_SEC_COEF</h4>
<pre>private static final&nbsp;double <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.496">MB_SEC_COEF</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.MB_SEC_COEF">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DataBlockEncodingTool-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataBlockEncodingTool</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.160">DataBlockEncodingTool</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;compressionAlgorithmName)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>compressionAlgorithmName</code> - What kind of algorithm should be used
as baseline for comparison (e.g. lzo, gz).</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="checkStatistics-org.apache.hadoop.hbase.regionserver.KeyValueScanner-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkStatistics</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.174">checkStatistics</a>(org.apache.hadoop.hbase.regionserver.KeyValueScanner&nbsp;scanner,
int&nbsp;kvLimit)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Check statistics for given HFile for different data block encoders.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scanner</code> - Of file which will be compressed.</dd>
<dd><code>kvLimit</code> - Maximal count of KeyValue which will be processed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if scanner is invalid</dd>
</dl>
</li>
</ul>
<a name="verifyCodecs-org.apache.hadoop.hbase.regionserver.KeyValueScanner-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyCodecs</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.257">verifyCodecs</a>(org.apache.hadoop.hbase.regionserver.KeyValueScanner&nbsp;scanner,
int&nbsp;kvLimit)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Verify if all data block encoders are working properly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scanner</code> - Of file which was compressed.</dd>
<dd><code>kvLimit</code> - Maximal count of KeyValue which will be processed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if all data block encoders compressed/decompressed correctly.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if scanner is invalid</dd>
</dl>
</li>
</ul>
<a name="benchmarkCodecs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>benchmarkCodecs</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.329">benchmarkCodecs</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Benchmark codec's speed.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="benchmarkEncoder-int-org.apache.hadoop.hbase.io.encoding.EncodedDataBlock-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>benchmarkEncoder</h4>
<pre>private&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.346">benchmarkEncoder</a>(int&nbsp;previousTotalSize,
org.apache.hadoop.hbase.io.encoding.EncodedDataBlock&nbsp;codec)</pre>
<div class="block">Benchmark compression/decompression throughput.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>previousTotalSize</code> - Total size used for verification. Use -1 if
unknown.</dd>
<dd><code>codec</code> - Tested encoder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Size of uncompressed data.</dd>
</dl>
</li>
</ul>
<a name="benchmarkDefaultCompression-int-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>benchmarkDefaultCompression</h4>
<pre>private&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.395">benchmarkDefaultCompression</a>(int&nbsp;totalSize,
byte[]&nbsp;rawBuffer)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="benchmarkAlgorithm-org.apache.hadoop.hbase.io.compress.Compression.Algorithm-java.lang.String-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>benchmarkAlgorithm</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.410">benchmarkAlgorithm</a>(org.apache.hadoop.hbase.io.compress.Compression.Algorithm&nbsp;algorithm,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Check decompress performance of a given algorithm and print it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithm</code> - Compression algorithm.</dd>
<dd><code>name</code> - Name of algorithm.</dd>
<dd><code>buffer</code> - Buffer to be compressed.</dd>
<dd><code>offset</code> - Position of the beginning of the data.</dd>
<dd><code>length</code> - Length of data in buffer.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="printBenchmarkResult-int-java.util.List-org.apache.hadoop.hbase.regionserver.DataBlockEncodingTool.Manipulation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printBenchmarkResult</h4>
<pre>private static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.498">printBenchmarkResult</a>(int&nbsp;totalSize,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;durationsInNanoSec,
<a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.Manipulation.html" title="enum in org.apache.hadoop.hbase.regionserver">DataBlockEncodingTool.Manipulation</a>&nbsp;manipulation)</pre>
</li>
</ul>
<a name="outputTuple-java.lang.String-java.lang.String-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputTuple</h4>
<pre>private static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.522">outputTuple</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;caption,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;format,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;values)</pre>
</li>
</ul>
<a name="displayStatistics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>displayStatistics</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.547">displayStatistics</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Display statistics of different compression algorithms.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="outputTuplePct-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputTuplePct</h4>
<pre>private&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.586">outputTuplePct</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;caption,
long&nbsp;size)</pre>
</li>
</ul>
<a name="outputSavings-java.lang.String-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputSavings</h4>
<pre>private&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.591">outputSavings</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;caption,
long&nbsp;part,
long&nbsp;whole)</pre>
</li>
</ul>
<a name="testCodecs-org.apache.hadoop.conf.Configuration-int-java.lang.String-java.lang.String-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>testCodecs</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.607">testCodecs</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
int&nbsp;kvLimit,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hfilePath,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;compressionName,
boolean&nbsp;doBenchmark,
boolean&nbsp;doVerify)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Test a data block encoder on the given HFile. Output results to console.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>kvLimit</code> - The limit of KeyValue which will be analyzed.</dd>
<dd><code>hfilePath</code> - an HFile path on the file system.</dd>
<dd><code>compressionName</code> - Compression algorithm used for comparison.</dd>
<dd><code>doBenchmark</code> - Run performance benchmarks.</dd>
<dd><code>doVerify</code> - Verify correctness.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When pathName is incorrect.</dd>
</dl>
</li>
</ul>
<a name="printUsage-org.apache.hbase.thirdparty.org.apache.commons.cli.Options-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printUsage</h4>
<pre>private static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.641">printUsage</a>(org.apache.hbase.thirdparty.org.apache.commons.cli.Options&nbsp;options)</pre>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html#line.664">main</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">A command line interface to benchmarks. Parses command-line arguments and
runs the appropriate benchmarks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - Should have length at least 1 and holds the file path to HFile.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If you specified the wrong file.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataBlockEncodingTool.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/CreateRandomStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.Manipulation.html" title="enum in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/regionserver/DataBlockEncodingTool.html" target="_top">Frames</a></li>
<li><a href="DataBlockEncodingTool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>