Google Git
Sign in
apache / hbase-site / 2c46013158a253c8fb93c7b7bef94eb5bfdc9a3f / . / devapidocs / org / apache / hadoop / hbase / util / RegionSplitter.SplitAlgorithm.html
blob: 8824a4059ad9bb864c7a5342894307bca1216616 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RegionSplitter.SplitAlgorithm (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.hadoop.hbase.util, class: RegionSplitter, interface: SplitAlgorithm">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/RegionSplitter.SplitAlgorithm.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.util</a></div>
<h1 title="Interface RegionSplitter.SplitAlgorithm" class="title">Interface RegionSplitter.SplitAlgorithm</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="RegionSplitter.DecimalStringSplit.html" title="class in org.apache.hadoop.hbase.util">RegionSplitter.DecimalStringSplit</a></code>, <code><a href="RegionSplitter.HexStringSplit.html" title="class in org.apache.hadoop.hbase.util">RegionSplitter.HexStringSplit</a></code>, <code><a href="RegionSplitter.NumberStringSplit.html" title="class in org.apache.hadoop.hbase.util">RegionSplitter.NumberStringSplit</a></code>, <code><a href="RegionSplitter.UniformSplit.html" title="class in org.apache.hadoop.hbase.util">RegionSplitter.UniformSplit</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="RegionSplitter.html" title="class in org.apache.hadoop.hbase.util">RegionSplitter</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.html#line-146">RegionSplitter.SplitAlgorithm</a></span></div>
<div class="block">A generic interface for the RegionSplitter code to use for all it's functionality. Note that
the original authors of this code use <a href="RegionSplitter.HexStringSplit.html" title="class in org.apache.hadoop.hbase.util"><code>RegionSplitter.HexStringSplit</code></a> to partition their table and set
it as default, but provided this for your custom algorithm. To use, create a new derived class
from this interface and call <a href="RegionSplitter.html#createPresplitTable(org.apache.hadoop.hbase.TableName,org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm,java.lang.String%5B%5D,org.apache.hadoop.conf.Configuration)"><code>RegionSplitter.createPresplitTable(org.apache.hadoop.hbase.TableName, org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm, java.lang.String[], org.apache.hadoop.conf.Configuration)</code></a> or
RegionSplitter#rollingSplit(TableName, SplitAlgorithm, Configuration) with the argument
splitClassName giving the name of your class.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#firstRow()" class="member-name-link">firstRow</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">In HBase, the first row is represented by an empty byte array.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#lastRow()" class="member-name-link">lastRow</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">In HBase, the last row is represented by an empty byte array.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rowToStr(byte%5B%5D)" class="member-name-link">rowToStr</a><wbr>(byte[]&nbsp;row)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">byte array representing a row in HBase</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#separator()" class="member-name-link">separator</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the separator character to use when storing / printing the row</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setFirstRow(byte%5B%5D)" class="member-name-link">setFirstRow</a><wbr>(byte[]&nbsp;userInput)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the first row</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setFirstRow(java.lang.String)" class="member-name-link">setFirstRow</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;userInput)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">In HBase, the last row is represented by an empty byte array.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLastRow(byte%5B%5D)" class="member-name-link">setLastRow</a><wbr>(byte[]&nbsp;userInput)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the last row</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLastRow(java.lang.String)" class="member-name-link">setLastRow</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;userInput)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">In HBase, the last row is represented by an empty byte array.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#split(byte%5B%5D,byte%5B%5D)" class="member-name-link">split</a><wbr>(byte[]&nbsp;start,
byte[]&nbsp;end)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Split a pre-existing region into 2 regions.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[][]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#split(byte%5B%5D,byte%5B%5D,int,boolean)" class="member-name-link">split</a><wbr>(byte[]&nbsp;start,
byte[]&nbsp;end,
int&nbsp;numSplits,
boolean&nbsp;inclusive)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Some MapReduce jobs may want to run multiple mappers per region, this is intended for such
usecase.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[][]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#split(int)" class="member-name-link">split</a><wbr>(int&nbsp;numRegions)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Split an entire table.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#strToRow(java.lang.String)" class="member-name-link">strToRow</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">user or file input for row</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="split(byte[],byte[])">
<h3>split</h3>
<div class="member-signature"><span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-151">split</a></span><wbr><span class="parameters">(byte[]&nbsp;start,
byte[]&nbsp;end)</span></div>
<div class="block">Split a pre-existing region into 2 regions. first row (inclusive) last row (exclusive)</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the split row to use</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="split(int)">
<h3>split</h3>
<div class="member-signature"><span class="return-type">byte[][]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-159">split</a></span><wbr><span class="parameters">(int&nbsp;numRegions)</span></div>
<div class="block">Split an entire table. number of regions to split the table into user input is validated at
this time. may throw a runtime exception in response to a parse failure</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>array of split keys for the initial regions of the table. The length of the returned
array should be numRegions-1.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="split(byte[],byte[],int,boolean)">
<h3>split</h3>
<div class="member-signature"><span class="return-type">byte[][]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-169">split</a></span><wbr><span class="parameters">(byte[]&nbsp;start,
byte[]&nbsp;end,
int&nbsp;numSplits,
boolean&nbsp;inclusive)</span></div>
<div class="block">Some MapReduce jobs may want to run multiple mappers per region, this is intended for such
usecase.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>start</code> - first row (inclusive)</dd>
<dd><code>end</code> - last row (exclusive)</dd>
<dd><code>numSplits</code> - number of splits to generate</dd>
<dd><code>inclusive</code> - whether start and end are returned as split points</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="firstRow()">
<h3>firstRow</h3>
<div class="member-signature"><span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-177">firstRow</a></span>()</div>
<div class="block">In HBase, the first row is represented by an empty byte array. This might cause problems with
your split algorithm or row printing. All your APIs will be passed firstRow() instead of
empty array.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>your representation of your first row</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="lastRow()">
<h3>lastRow</h3>
<div class="member-signature"><span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-185">lastRow</a></span>()</div>
<div class="block">In HBase, the last row is represented by an empty byte array. This might cause problems with
your split algorithm or row printing. All your APIs will be passed firstRow() instead of
empty array.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>your representation of your last row</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setFirstRow(java.lang.String)">
<h3>setFirstRow</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-192">setFirstRow</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;userInput)</span></div>
<div class="block">In HBase, the last row is represented by an empty byte array. Set this value to help the
split code understand how to evenly divide the first region. raw user input (may throw
RuntimeException on parse failure)</div>
</section>
</li>
<li>
<section class="detail" id="setLastRow(java.lang.String)">
<h3>setLastRow</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-200">setLastRow</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;userInput)</span></div>
<div class="block">In HBase, the last row is represented by an empty byte array. Set this value to help the
split code understand how to evenly divide the last region. Note that this last row is
inclusive for all rows sharing the same prefix. raw user input (may throw RuntimeException on
parse failure)</div>
</section>
</li>
<li>
<section class="detail" id="strToRow(java.lang.String)">
<h3>strToRow</h3>
<div class="member-signature"><span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-206">strToRow</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input)</span></div>
<div class="block">user or file input for row</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>byte array representation of this row for HBase</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="rowToStr(byte[])">
<h3>rowToStr</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-212">rowToStr</a></span><wbr><span class="parameters">(byte[]&nbsp;row)</span></div>
<div class="block">byte array representing a row in HBase</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>String to use for debug &amp; file printing</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="separator()">
<h3>separator</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-215">separator</a></span>()</div>
<div class="block">Returns the separator character to use when storing / printing the row</div>
</section>
</li>
<li>
<section class="detail" id="setFirstRow(byte[])">
<h3>setFirstRow</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-221">setFirstRow</a></span><wbr><span class="parameters">(byte[]&nbsp;userInput)</span></div>
<div class="block">Set the first row</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>userInput</code> - byte array of the row key.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setLastRow(byte[])">
<h3>setLastRow</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/RegionSplitter.SplitAlgorithm.html#line-227">setLastRow</a></span><wbr><span class="parameters">(byte[]&nbsp;userInput)</span></div>
<div class="block">Set the last row</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>userInput</code> - byte array of the row key.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>