| <!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>org.apache.hadoop.hbase.master.normalizer (Apache HBase 3.0.0-alpha-2-SNAPSHOT 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="org.apache.hadoop.hbase.master.normalizer (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/master/locking/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/master/procedure/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/master/normalizer/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.hadoop.hbase.master.normalizer</h1> |
| <div class="docSummary"> |
| <div class="block">The Region Normalizer subsystem is responsible for coaxing all the regions in a table toward |
| a "normal" size, according to their storefile size.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/NormalizationPlan.html" title="interface in org.apache.hadoop.hbase.master.normalizer">NormalizationPlan</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/NormalizationPlan.html" title="interface in org.apache.hadoop.hbase.master.normalizer"><code>NormalizationPlan</code></a> describes some modification to region split points as identified |
| by an instance of <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizer.html" title="interface in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizer</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizer.html" title="interface in org.apache.hadoop.hbase.master.normalizer">RegionNormalizer</a></td> |
| <td class="colLast"> |
| <div class="block">Performs "normalization" of regions of a table, making sure that suboptimal |
| choice of split keys doesn't leave cluster in a situation when some regions are |
| substantially larger than others for considerable amount of time.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/MergeNormalizationPlan.html" title="class in org.apache.hadoop.hbase.master.normalizer">MergeNormalizationPlan</a></td> |
| <td class="colLast"> |
| <div class="block">Normalization plan to merge adjacent regions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/MergeNormalizationPlan.Builder.html" title="class in org.apache.hadoop.hbase.master.normalizer">MergeNormalizationPlan.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">A helper for constructing instances of <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/MergeNormalizationPlan.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>MergeNormalizationPlan</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/NormalizationTarget.html" title="class in org.apache.hadoop.hbase.master.normalizer">NormalizationTarget</a></td> |
| <td class="colLast"> |
| <div class="block">A POJO that caries details about a region selected for normalization through the pipeline.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerChore.html" title="class in org.apache.hadoop.hbase.master.normalizer">RegionNormalizerChore</a></td> |
| <td class="colLast"> |
| <div class="block">Chore that will periodically call |
| <a href="../../../../../../org/apache/hadoop/hbase/master/HMaster.html#normalizeRegions-org.apache.hadoop.hbase.client.NormalizeTableFilterParams-boolean-"><code>HMaster.normalizeRegions(NormalizeTableFilterParams, boolean)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerFactory.html" title="class in org.apache.hadoop.hbase.master.normalizer">RegionNormalizerFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory to create instance of <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizer.html" title="interface in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizer</code></a> as configured.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerManager.html" title="class in org.apache.hadoop.hbase.master.normalizer">RegionNormalizerManager</a></td> |
| <td class="colLast"> |
| <div class="block">This class encapsulates the details of the <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizer.html" title="interface in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizer</code></a> subsystem.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerWorker.html" title="class in org.apache.hadoop.hbase.master.normalizer">RegionNormalizerWorker</a></td> |
| <td class="colLast"> |
| <div class="block">Consumes normalization request targets (<a href="../../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase"><code>TableName</code></a>s) off the |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerWorkQueue.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerWorkQueue</code></a>, dispatches them to the <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizer.html" title="interface in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizer</code></a>, |
| and executes the resulting <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/NormalizationPlan.html" title="interface in org.apache.hadoop.hbase.master.normalizer"><code>NormalizationPlan</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerWorkQueue.html" title="class in org.apache.hadoop.hbase.master.normalizer">RegionNormalizerWorkQueue</a><E></td> |
| <td class="colLast"> |
| <div class="block">A specialized collection that holds pending work for the <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerWorker.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerWorker</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html" title="class in org.apache.hadoop.hbase.master.normalizer">SimpleRegionNormalizer</a></td> |
| <td class="colLast"> |
| <div class="block">Simple implementation of region normalizer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.NormalizerConfiguration.html" title="class in org.apache.hadoop.hbase.master.normalizer">SimpleRegionNormalizer.NormalizerConfiguration</a></td> |
| <td class="colLast"> |
| <div class="block">Holds the configuration values read from <code>Configuration</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SplitNormalizationPlan.html" title="class in org.apache.hadoop.hbase.master.normalizer">SplitNormalizationPlan</a></td> |
| <td class="colLast"> |
| <div class="block">Normalization plan to split a region.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/NormalizationPlan.PlanType.html" title="enum in org.apache.hadoop.hbase.master.normalizer">NormalizationPlan.PlanType</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.hadoop.hbase.master.normalizer Description">Package org.apache.hadoop.hbase.master.normalizer Description</h2> |
| <div class="block">The Region Normalizer subsystem is responsible for coaxing all the regions in a table toward |
| a "normal" size, according to their storefile size. It does this by splitting regions that |
| are significantly larger than the norm, and merging regions that are significantly smaller than |
| the norm. |
| </p> |
| The public interface to the Region Normalizer subsystem is limited to the following classes: |
| <ul> |
| <li> |
| The <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerFactory.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerFactory</code></a> provides an |
| entry point for creating an instance of the |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerManager.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerManager</code></a>. |
| </li> |
| <li> |
| The <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerManager.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerManager</code></a> encapsulates |
| the whole Region Normalizer subsystem. You'll find one of these hanging off of the |
| <a href="../../../../../../org/apache/hadoop/hbase/master/HMaster.html" title="class in org.apache.hadoop.hbase.master"><code>HMaster</code></a>, which uses it to delegate API calls. There |
| is usually only a single instance of this class. |
| </li> |
| <li> |
| Various configuration points that share the common prefix of <code>hbase.normalizer</code>. |
| <ul> |
| <li>Whether to split a region as part of normalization. Configuration: |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#SPLIT_ENABLED_KEY">"hbase.normalizer.split.enabled"</a>, |
| default: <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#DEFAULT_SPLIT_ENABLED">true</a>. |
| </li> |
| <li>Whether to merge a region as part of normalization. Configuration: |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#MERGE_ENABLED_KEY">"hbase.normalizer.merge.enabled"</a>, |
| default: <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#DEFAULT_MERGE_ENABLED">true</a>. |
| </li> |
| <li>The minimum number of regions in a table to consider it for merge normalization. |
| Configuration: <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#MERGE_MIN_REGION_COUNT_KEY">"hbase.normalizer.merge.min.region.count"</a>, |
| default: <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#DEFAULT_MERGE_MIN_REGION_COUNT">3</a>. |
| </li> |
| <li>The minimum age for a region to be considered for a merge, in days. Configuration: |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#MERGE_MIN_REGION_AGE_DAYS_KEY">"hbase.normalizer.merge.min_region_age.days"</a>, |
| default: <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#DEFAULT_MERGE_MIN_REGION_AGE_DAYS">3</a>. |
| </li> |
| <li>The minimum size for a region to be considered for a merge, in whole MBs. Configuration: |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#MERGE_MIN_REGION_SIZE_MB_KEY">"hbase.normalizer.merge.min_region_size.mb"</a>, |
| default: <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html#DEFAULT_MERGE_MIN_REGION_SIZE_MB">0</a>. |
| </li> |
| <li>The limit on total throughput of the Region Normalizer's actions, in whole MBs. Configuration: |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerWorker.html#RATE_LIMIT_BYTES_PER_SEC_KEY">"hbase.normalizer.throughput.max_bytes_per_sec"</a>, |
| default: unlimited. |
| </li> |
| </ul> |
| <p> |
| To see detailed logging of the application of these configuration values, set the log |
| level for this package to <code>TRACE</code>. |
| </p> |
| </li> |
| </ul> |
| The Region Normalizer subsystem is composed of a handful of related classes: |
| <ul> |
| <li> |
| The <a href="../../../../../../org/apache/hadoop/hbase/zookeeper/RegionNormalizerTracker.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>RegionNormalizerTracker</code></a> provides a system by |
| which the Normalizer can be disabled at runtime. It currently does this by managing a znode, |
| but this is an implementation detail. |
| </li> |
| <li> |
| The <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerWorkQueue.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerWorkQueue</code></a> is a |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><code>Set</code></a>-like <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util"><code>Queue</code></a> that permits a single copy of a given |
| work item to exist in the queue at one time. It also provides a facility for a producer to |
| add an item to the front of the line. Consumers are blocked waiting for new work. |
| </li> |
| <li> |
| The <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerChore.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerChore</code></a> wakes up |
| periodically and schedules new normalization work, adding targets to the queue. |
| </li> |
| <li> |
| The <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/RegionNormalizerWorker.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>RegionNormalizerWorker</code></a> runs in a |
| daemon thread, grabbing work off the queue as is it becomes available. |
| </li> |
| <li> |
| The <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.html" title="class in org.apache.hadoop.hbase.master.normalizer"><code>SimpleRegionNormalizer</code></a> implements the |
| logic for calculating target region sizes and emitting a list of corresponding |
| <a href="../../../../../../org/apache/hadoop/hbase/master/normalizer/NormalizationPlan.html" title="interface in org.apache.hadoop.hbase.master.normalizer"><code>NormalizationPlan</code></a> objects. |
| </li> |
| </ul></div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/master/locking/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/master/procedure/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/master/normalizer/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
