| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ServerRegionReplicaUtil (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: ServerRegionReplicaUtil"> |
| <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/ServerRegionReplicaUtil.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.hadoop.hbase.util</a></div> |
| <h1 title="Class ServerRegionReplicaUtil" class="title">Class ServerRegionReplicaUtil</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../client/RegionReplicaUtil.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.RegionReplicaUtil</a> |
| <div class="inheritance">org.apache.hadoop.hbase.util.ServerRegionReplicaUtil</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-37">ServerRegionReplicaUtil</a></span> |
| <span class="extends-implements">extends <a href="../client/RegionReplicaUtil.html" title="class in org.apache.hadoop.hbase.client">RegionReplicaUtil</a></span></div> |
| <div class="block">Similar to <a href="../client/RegionReplicaUtil.html" title="class in org.apache.hadoop.hbase.client"><code>RegionReplicaUtil</code></a> but for the server side</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_REGION_REPLICA_REPLICATION" class="member-name-link">DEFAULT_REGION_REPLICA_REPLICATION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_REGION_REPLICA_REPLICATION_CATALOG" class="member-name-link">DEFAULT_REGION_REPLICA_REPLICATION_CATALOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH" class="member-name-link">DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final double</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER" class="member-name-link">DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <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"><code><a href="#REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY" class="member-name-link">REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Same as for <a href="#REGION_REPLICA_REPLICATION_CONF_KEY"><code>REGION_REPLICA_REPLICATION_CONF_KEY</code></a> but for catalog replication.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <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"><code><a href="#REGION_REPLICA_REPLICATION_CONF_KEY" class="member-name-link">REGION_REPLICA_REPLICATION_CONF_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether asynchronous WAL replication to the secondary region replicas is enabled or not.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <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"><code><a href="#REGION_REPLICA_REPLICATION_PEER" class="member-name-link">REGION_REPLICA_REPLICATION_PEER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, leave here only for implementing compatibility code.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <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"><code><a href="#REGION_REPLICA_STORE_FILE_REFRESH" class="member-name-link">REGION_REPLICA_STORE_FILE_REFRESH</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Enables or disables refreshing store files of secondary region replicas when the memory is |
| above the global memstore lower limit.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <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"><code><a href="#REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER" class="member-name-link">REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The multiplier to use when we want to refresh a secondary region instead of flushing a primary |
| region.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.client.RegionReplicaUtil">Fields inherited from class org.apache.hadoop.hbase.client.<a href="../client/RegionReplicaUtil.html" title="class in org.apache.hadoop.hbase.client">RegionReplicaUtil</a></h3> |
| <code><a href="../client/RegionReplicaUtil.html#DEFAULT_REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH">DEFAULT_REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH</a>, <a href="../client/RegionReplicaUtil.html#REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY">REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ServerRegionReplicaUtil</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab1 method-summary-table-tab4"><code>static <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionInfoForFs(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">getRegionInfoForFs</a><wbr>(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the regionInfo object to use for interacting with the file system.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionReplicaStoreFileRefreshMultiplier(org.apache.hadoop.conf.Configuration)" class="member-name-link">getRegionReplicaStoreFileRefreshMultiplier</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../regionserver/StoreFileInfo.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStoreFileInfo(org.apache.hadoop.conf.Configuration,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.client.RegionInfo,java.lang.String,org.apache.hadoop.fs.Path)" class="member-name-link">getStoreFileInfo</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfoForFs, |
| <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> familyName, |
| org.apache.hadoop.fs.Path path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a StoreFileInfo from the given FileStatus.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isMetaRegionReplicaReplicationEnabled(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName)" class="member-name-link">isMetaRegionReplicaReplicationEnabled</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns True if hbase:meta Region Read Replica is enabled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isReadOnly(org.apache.hadoop.hbase.regionserver.HRegion)" class="member-name-link">isReadOnly</a><wbr>(<a href="../regionserver/HRegion.html" title="class in org.apache.hadoop.hbase.regionserver">HRegion</a> region)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether this region replica can accept writes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isRegionReplicaReplicationEnabled(org.apache.hadoop.conf.Configuration)" class="member-name-link">isRegionReplicaReplicationEnabled</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns True if Region Read Replica is enabled for user-space tables.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isRegionReplicaReplicationEnabled(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName)" class="member-name-link">isRegionReplicaReplicationEnabled</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isRegionReplicaStoreFileRefreshEnabled(org.apache.hadoop.conf.Configuration)" class="member-name-link">isRegionReplicaStoreFileRefreshEnabled</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns True if we are to refresh user-space hfiles in Region Read Replicas.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isRegionReplicaWaitForPrimaryFlushEnabled(org.apache.hadoop.conf.Configuration)" class="member-name-link">isRegionReplicaWaitForPrimaryFlushEnabled</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns True if wait for primary to flush is enabled for user-space tables.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#shouldReplayRecoveredEdits(org.apache.hadoop.hbase.regionserver.HRegion)" class="member-name-link">shouldReplayRecoveredEdits</a><wbr>(<a href="../regionserver/HRegion.html" title="class in org.apache.hadoop.hbase.regionserver">HRegion</a> region)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether to replay the recovered edits to flush the results.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.client.RegionReplicaUtil">Methods inherited from class org.apache.hadoop.hbase.client.<a href="../client/RegionReplicaUtil.html" title="class in org.apache.hadoop.hbase.client">RegionReplicaUtil</a></h3> |
| <code><a href="../client/RegionReplicaUtil.html#addReplicas(java.util.List,int,int)">addReplicas</a>, <a href="../client/RegionReplicaUtil.html#getRegionInfoForDefaultReplica(org.apache.hadoop.hbase.client.RegionInfo)">getRegionInfoForDefaultReplica</a>, <a href="../client/RegionReplicaUtil.html#getRegionInfoForReplica(org.apache.hadoop.hbase.client.RegionInfo,int)">getRegionInfoForReplica</a>, <a href="../client/RegionReplicaUtil.html#isDefaultReplica(int)">isDefaultReplica</a>, <a href="../client/RegionReplicaUtil.html#isDefaultReplica(org.apache.hadoop.hbase.client.RegionInfo)">isDefaultReplica</a>, <a href="../client/RegionReplicaUtil.html#isReplicasForSameRegion(org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.client.RegionInfo)">isReplicasForSameRegion</a>, <a href="../client/RegionReplicaUtil.html#removeNonDefaultRegions(java.util.Collection)">removeNonDefaultRegions</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="REGION_REPLICA_REPLICATION_CONF_KEY"> |
| <h3>REGION_REPLICA_REPLICATION_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-48">REGION_REPLICA_REPLICATION_CONF_KEY</a></span></div> |
| <div class="block">Whether asynchronous WAL replication to the secondary region replicas is enabled or not. If |
| this is enabled, a replication peer named "region_replica_replication" will be created which |
| will tail the logs and replicate the mutatations to region replicas for tables that have region |
| replication > 1. If this is enabled once, disabling this replication also requires disabling |
| the replication peer using shell or <a href="../client/Admin.html" title="interface in org.apache.hadoop.hbase.client"><code>Admin</code></a> java class. Replication to secondary region |
| replicas works over standard inter-cluster replication.·</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.REGION_REPLICA_REPLICATION_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_REGION_REPLICA_REPLICATION"> |
| <h3>DEFAULT_REGION_REPLICA_REPLICATION</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-50">DEFAULT_REGION_REPLICA_REPLICATION</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.DEFAULT_REGION_REPLICA_REPLICATION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REGION_REPLICA_REPLICATION_PEER"> |
| <h3>REGION_REPLICA_REPLICATION_PEER</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <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> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-55">REGION_REPLICA_REPLICATION_PEER</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, leave here only for implementing compatibility code.</div> |
| </div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.REGION_REPLICA_REPLICATION_PEER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY"> |
| <h3>REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-61">REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY</a></span></div> |
| <div class="block">Same as for <a href="#REGION_REPLICA_REPLICATION_CONF_KEY"><code>REGION_REPLICA_REPLICATION_CONF_KEY</code></a> but for catalog replication.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_REGION_REPLICA_REPLICATION_CATALOG"> |
| <h3>DEFAULT_REGION_REPLICA_REPLICATION_CATALOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-63">DEFAULT_REGION_REPLICA_REPLICATION_CATALOG</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.DEFAULT_REGION_REPLICA_REPLICATION_CATALOG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REGION_REPLICA_STORE_FILE_REFRESH"> |
| <h3>REGION_REPLICA_STORE_FILE_REFRESH</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-71">REGION_REPLICA_STORE_FILE_REFRESH</a></span></div> |
| <div class="block">Enables or disables refreshing store files of secondary region replicas when the memory is |
| above the global memstore lower limit. Refreshing the store files means that we will do a file |
| list of the primary regions store files, and pick up new files. Also depending on the store |
| files, we can drop some memstore contents which will free up memory.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.REGION_REPLICA_STORE_FILE_REFRESH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH"> |
| <h3>DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-73">DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER"> |
| <h3>REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <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> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-80">REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER</a></span></div> |
| <div class="block">The multiplier to use when we want to refresh a secondary region instead of flushing a primary |
| region. Default value assumes that for doing the file refresh, the biggest secondary should be |
| 4 times bigger than the biggest primary.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER"> |
| <h3>DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">double</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-82">DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ServerRegionReplicaUtil.DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ServerRegionReplicaUtil</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-38">ServerRegionReplicaUtil</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getRegionInfoForFs(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>getRegionInfoForFs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-88">getRegionInfoForFs</a></span><wbr><span class="parameters">(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo)</span></div> |
| <div class="block">Returns the regionInfo object to use for interacting with the file system.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>An RegionInfo object to interact with the filesystem</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isReadOnly(org.apache.hadoop.hbase.regionserver.HRegion)"> |
| <h3>isReadOnly</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-100">isReadOnly</a></span><wbr><span class="parameters">(<a href="../regionserver/HRegion.html" title="class in org.apache.hadoop.hbase.regionserver">HRegion</a> region)</span></div> |
| <div class="block">Returns whether this region replica can accept writes.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>region</code> - the HRegion object</dd> |
| <dt>Returns:</dt> |
| <dd>whether the replica is read only</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldReplayRecoveredEdits(org.apache.hadoop.hbase.regionserver.HRegion)"> |
| <h3>shouldReplayRecoveredEdits</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-111">shouldReplayRecoveredEdits</a></span><wbr><span class="parameters">(<a href="../regionserver/HRegion.html" title="class in org.apache.hadoop.hbase.regionserver">HRegion</a> region)</span></div> |
| <div class="block">Returns whether to replay the recovered edits to flush the results. Currently secondary region |
| replicas do not replay the edits, since it would cause flushes which might affect the primary |
| region. Primary regions even opened in read only mode should replay the edits.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>region</code> - the HRegion object</dd> |
| <dt>Returns:</dt> |
| <dd>whether recovered edits should be replayed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStoreFileInfo(org.apache.hadoop.conf.Configuration,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.client.RegionInfo,java.lang.String,org.apache.hadoop.fs.Path)"> |
| <h3>getStoreFileInfo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../regionserver/StoreFileInfo.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-121">getStoreFileInfo</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfoForFs, |
| <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> familyName, |
| org.apache.hadoop.fs.Path path)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Returns a StoreFileInfo from the given FileStatus. Secondary replicas refer to the files of the |
| primary region, so an HFileLink is used to construct the StoreFileInfo. This way ensures that |
| the secondary will be able to continue reading the store files even if they are moved to |
| archive after compaction</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRegionReplicaReplicationEnabled(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName)"> |
| <h3>isRegionReplicaReplicationEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-157">isRegionReplicaReplicationEnabled</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</span></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if Region Read Replica is enabled for <code>tn</code> (whether hbase:meta or |
| user-space tables).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRegionReplicaReplicationEnabled(org.apache.hadoop.conf.Configuration)"> |
| <h3>isRegionReplicaReplicationEnabled</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-163">isRegionReplicaReplicationEnabled</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Returns True if Region Read Replica is enabled for user-space tables.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMetaRegionReplicaReplicationEnabled(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName)"> |
| <h3>isMetaRegionReplicaReplicationEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-168">isMetaRegionReplicaReplicationEnabled</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</span></div> |
| <div class="block">Returns True if hbase:meta Region Read Replica is enabled.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRegionReplicaWaitForPrimaryFlushEnabled(org.apache.hadoop.conf.Configuration)"> |
| <h3>isRegionReplicaWaitForPrimaryFlushEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-174">isRegionReplicaWaitForPrimaryFlushEnabled</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Returns True if wait for primary to flush is enabled for user-space tables.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRegionReplicaStoreFileRefreshEnabled(org.apache.hadoop.conf.Configuration)"> |
| <h3>isRegionReplicaStoreFileRefreshEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-180">isRegionReplicaStoreFileRefreshEnabled</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Returns True if we are to refresh user-space hfiles in Region Read Replicas.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionReplicaStoreFileRefreshMultiplier(org.apache.hadoop.conf.Configuration)"> |
| <h3>getRegionReplicaStoreFileRefreshMultiplier</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ServerRegionReplicaUtil.html#line-185">getRegionReplicaStoreFileRefreshMultiplier</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
