| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.util, class: ServerRegionReplicaUtil"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.util;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.Admin;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.RegionReplicaUtil;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.io.HFileLink;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.io.Reference;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.regionserver.HRegion;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.regionserver.StoreFileInfo;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * Similar to {@link RegionReplicaUtil} but for the server side</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span> |
| <span class="source-line-no">038</span><span id="line-38">public class ServerRegionReplicaUtil extends RegionReplicaUtil {</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40"> /**</span> |
| <span class="source-line-no">041</span><span id="line-41"> * Whether asynchronous WAL replication to the secondary region replicas is enabled or not. If</span> |
| <span class="source-line-no">042</span><span id="line-42"> * this is enabled, a replication peer named "region_replica_replication" will be created which</span> |
| <span class="source-line-no">043</span><span id="line-43"> * will tail the logs and replicate the mutatations to region replicas for tables that have region</span> |
| <span class="source-line-no">044</span><span id="line-44"> * replication &gt; 1. If this is enabled once, disabling this replication also requires disabling</span> |
| <span class="source-line-no">045</span><span id="line-45"> * the replication peer using shell or {@link Admin} java class. Replication to secondary region</span> |
| <span class="source-line-no">046</span><span id="line-46"> * replicas works over standard inter-cluster replication.ยท</span> |
| <span class="source-line-no">047</span><span id="line-47"> */</span> |
| <span class="source-line-no">048</span><span id="line-48"> public static final String REGION_REPLICA_REPLICATION_CONF_KEY =</span> |
| <span class="source-line-no">049</span><span id="line-49"> "hbase.region.replica.replication.enabled";</span> |
| <span class="source-line-no">050</span><span id="line-50"> private static final boolean DEFAULT_REGION_REPLICA_REPLICATION = false;</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> /**</span> |
| <span class="source-line-no">053</span><span id="line-53"> * @deprecated Since 3.0.0, leave here only for implementing compatibility code.</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> @Deprecated</span> |
| <span class="source-line-no">056</span><span id="line-56"> public static final String REGION_REPLICA_REPLICATION_PEER = "region_replica_replication";</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Same as for {@link #REGION_REPLICA_REPLICATION_CONF_KEY} but for catalog replication.</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> public static final String REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY =</span> |
| <span class="source-line-no">062</span><span id="line-62"> "hbase.region.replica.replication.catalog.enabled";</span> |
| <span class="source-line-no">063</span><span id="line-63"> private static final boolean DEFAULT_REGION_REPLICA_REPLICATION_CATALOG = false;</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> /**</span> |
| <span class="source-line-no">066</span><span id="line-66"> * Enables or disables refreshing store files of secondary region replicas when the memory is</span> |
| <span class="source-line-no">067</span><span id="line-67"> * above the global memstore lower limit. Refreshing the store files means that we will do a file</span> |
| <span class="source-line-no">068</span><span id="line-68"> * list of the primary regions store files, and pick up new files. Also depending on the store</span> |
| <span class="source-line-no">069</span><span id="line-69"> * files, we can drop some memstore contents which will free up memory.</span> |
| <span class="source-line-no">070</span><span id="line-70"> */</span> |
| <span class="source-line-no">071</span><span id="line-71"> public static final String REGION_REPLICA_STORE_FILE_REFRESH =</span> |
| <span class="source-line-no">072</span><span id="line-72"> "hbase.region.replica.storefile.refresh";</span> |
| <span class="source-line-no">073</span><span id="line-73"> private static final boolean DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH = true;</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> /**</span> |
| <span class="source-line-no">076</span><span id="line-76"> * The multiplier to use when we want to refresh a secondary region instead of flushing a primary</span> |
| <span class="source-line-no">077</span><span id="line-77"> * region. Default value assumes that for doing the file refresh, the biggest secondary should be</span> |
| <span class="source-line-no">078</span><span id="line-78"> * 4 times bigger than the biggest primary.</span> |
| <span class="source-line-no">079</span><span id="line-79"> */</span> |
| <span class="source-line-no">080</span><span id="line-80"> public static final String REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER =</span> |
| <span class="source-line-no">081</span><span id="line-81"> "hbase.region.replica.storefile.refresh.memstore.multiplier";</span> |
| <span class="source-line-no">082</span><span id="line-82"> private static final double DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER = 4;</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * Returns the regionInfo object to use for interacting with the file system.</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @return An RegionInfo object to interact with the filesystem</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> public static RegionInfo getRegionInfoForFs(RegionInfo regionInfo) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> if (regionInfo == null) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> return null;</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"> return RegionReplicaUtil.getRegionInfoForDefaultReplica(regionInfo);</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Returns whether this region replica can accept writes.</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @param region the HRegion object</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @return whether the replica is read only</span> |
| <span class="source-line-no">099</span><span id="line-99"> */</span> |
| <span class="source-line-no">100</span><span id="line-100"> public static boolean isReadOnly(HRegion region) {</span> |
| <span class="source-line-no">101</span><span id="line-101"> return region.getTableDescriptor().isReadOnly() || !isDefaultReplica(region.getRegionInfo());</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> /**</span> |
| <span class="source-line-no">105</span><span id="line-105"> * Returns whether to replay the recovered edits to flush the results. Currently secondary region</span> |
| <span class="source-line-no">106</span><span id="line-106"> * replicas do not replay the edits, since it would cause flushes which might affect the primary</span> |
| <span class="source-line-no">107</span><span id="line-107"> * region. Primary regions even opened in read only mode should replay the edits.</span> |
| <span class="source-line-no">108</span><span id="line-108"> * @param region the HRegion object</span> |
| <span class="source-line-no">109</span><span id="line-109"> * @return whether recovered edits should be replayed.</span> |
| <span class="source-line-no">110</span><span id="line-110"> */</span> |
| <span class="source-line-no">111</span><span id="line-111"> public static boolean shouldReplayRecoveredEdits(HRegion region) {</span> |
| <span class="source-line-no">112</span><span id="line-112"> return isDefaultReplica(region.getRegionInfo());</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * Returns a StoreFileInfo from the given FileStatus. Secondary replicas refer to the files of the</span> |
| <span class="source-line-no">117</span><span id="line-117"> * primary region, so an HFileLink is used to construct the StoreFileInfo. This way ensures that</span> |
| <span class="source-line-no">118</span><span id="line-118"> * the secondary will be able to continue reading the store files even if they are moved to</span> |
| <span class="source-line-no">119</span><span id="line-119"> * archive after compaction</span> |
| <span class="source-line-no">120</span><span id="line-120"> */</span> |
| <span class="source-line-no">121</span><span id="line-121"> public static StoreFileInfo getStoreFileInfo(Configuration conf, FileSystem fs,</span> |
| <span class="source-line-no">122</span><span id="line-122"> RegionInfo regionInfo, RegionInfo regionInfoForFs, String familyName, Path path)</span> |
| <span class="source-line-no">123</span><span id="line-123"> throws IOException {</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> // if this is a primary region, just return the StoreFileInfo constructed from path</span> |
| <span class="source-line-no">126</span><span id="line-126"> if (RegionInfo.COMPARATOR.compare(regionInfo, regionInfoForFs) == 0) {</span> |
| <span class="source-line-no">127</span><span id="line-127"> return new StoreFileInfo(conf, fs, path, true);</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> // else create a store file link. The link file does not exists on filesystem though.</span> |
| <span class="source-line-no">131</span><span id="line-131"> if (HFileLink.isHFileLink(path) || StoreFileInfo.isHFile(path)) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> HFileLink link = HFileLink.build(conf, regionInfoForFs.getTable(),</span> |
| <span class="source-line-no">133</span><span id="line-133"> regionInfoForFs.getEncodedName(), familyName, path.getName());</span> |
| <span class="source-line-no">134</span><span id="line-134"> return new StoreFileInfo(conf, fs, link.getFileStatus(fs), link);</span> |
| <span class="source-line-no">135</span><span id="line-135"> } else if (StoreFileInfo.isReference(path)) {</span> |
| <span class="source-line-no">136</span><span id="line-136"> Reference reference = Reference.read(fs, path);</span> |
| <span class="source-line-no">137</span><span id="line-137"> Path referencePath = StoreFileInfo.getReferredToFile(path);</span> |
| <span class="source-line-no">138</span><span id="line-138"> if (HFileLink.isHFileLink(referencePath)) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> // HFileLink Reference</span> |
| <span class="source-line-no">140</span><span id="line-140"> HFileLink link = HFileLink.buildFromHFileLinkPattern(conf, referencePath);</span> |
| <span class="source-line-no">141</span><span id="line-141"> return new StoreFileInfo(conf, fs, link.getFileStatus(fs), reference, link);</span> |
| <span class="source-line-no">142</span><span id="line-142"> } else {</span> |
| <span class="source-line-no">143</span><span id="line-143"> // Reference</span> |
| <span class="source-line-no">144</span><span id="line-144"> HFileLink link = HFileLink.build(conf, regionInfoForFs.getTable(),</span> |
| <span class="source-line-no">145</span><span id="line-145"> regionInfoForFs.getEncodedName(), familyName, path.getName());</span> |
| <span class="source-line-no">146</span><span id="line-146"> return new StoreFileInfo(conf, fs, link.getFileStatus(fs), reference);</span> |
| <span class="source-line-no">147</span><span id="line-147"> }</span> |
| <span class="source-line-no">148</span><span id="line-148"> } else {</span> |
| <span class="source-line-no">149</span><span id="line-149"> throw new IOException("path=" + path + " doesn't look like a valid StoreFile");</span> |
| <span class="source-line-no">150</span><span id="line-150"> }</span> |
| <span class="source-line-no">151</span><span id="line-151"> }</span> |
| <span class="source-line-no">152</span><span id="line-152"></span> |
| <span class="source-line-no">153</span><span id="line-153"> /**</span> |
| <span class="source-line-no">154</span><span id="line-154"> * @return True if Region Read Replica is enabled for <code>tn</code> (whether hbase:meta or</span> |
| <span class="source-line-no">155</span><span id="line-155"> * user-space tables).</span> |
| <span class="source-line-no">156</span><span id="line-156"> */</span> |
| <span class="source-line-no">157</span><span id="line-157"> public static boolean isRegionReplicaReplicationEnabled(Configuration conf, TableName tn) {</span> |
| <span class="source-line-no">158</span><span id="line-158"> return isMetaRegionReplicaReplicationEnabled(conf, tn)</span> |
| <span class="source-line-no">159</span><span id="line-159"> || isRegionReplicaReplicationEnabled(conf);</span> |
| <span class="source-line-no">160</span><span id="line-160"> }</span> |
| <span class="source-line-no">161</span><span id="line-161"></span> |
| <span class="source-line-no">162</span><span id="line-162"> /** Returns True if Region Read Replica is enabled for user-space tables. */</span> |
| <span class="source-line-no">163</span><span id="line-163"> private static boolean isRegionReplicaReplicationEnabled(Configuration conf) {</span> |
| <span class="source-line-no">164</span><span id="line-164"> return conf.getBoolean(REGION_REPLICA_REPLICATION_CONF_KEY, DEFAULT_REGION_REPLICA_REPLICATION);</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"></span> |
| <span class="source-line-no">167</span><span id="line-167"> /** Returns True if hbase:meta Region Read Replica is enabled. */</span> |
| <span class="source-line-no">168</span><span id="line-168"> public static boolean isMetaRegionReplicaReplicationEnabled(Configuration conf, TableName tn) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> return TableName.isMetaTableName(tn) && conf.getBoolean(</span> |
| <span class="source-line-no">170</span><span id="line-170"> REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY, DEFAULT_REGION_REPLICA_REPLICATION_CATALOG);</span> |
| <span class="source-line-no">171</span><span id="line-171"> }</span> |
| <span class="source-line-no">172</span><span id="line-172"></span> |
| <span class="source-line-no">173</span><span id="line-173"> /** Returns True if wait for primary to flush is enabled for user-space tables. */</span> |
| <span class="source-line-no">174</span><span id="line-174"> public static boolean isRegionReplicaWaitForPrimaryFlushEnabled(Configuration conf) {</span> |
| <span class="source-line-no">175</span><span id="line-175"> return conf.getBoolean(REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY,</span> |
| <span class="source-line-no">176</span><span id="line-176"> DEFAULT_REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH);</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"></span> |
| <span class="source-line-no">179</span><span id="line-179"> /** Returns True if we are to refresh user-space hfiles in Region Read Replicas. */</span> |
| <span class="source-line-no">180</span><span id="line-180"> public static boolean isRegionReplicaStoreFileRefreshEnabled(Configuration conf) {</span> |
| <span class="source-line-no">181</span><span id="line-181"> return conf.getBoolean(REGION_REPLICA_STORE_FILE_REFRESH,</span> |
| <span class="source-line-no">182</span><span id="line-182"> DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH);</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> public static double getRegionReplicaStoreFileRefreshMultiplier(Configuration conf) {</span> |
| <span class="source-line-no">186</span><span id="line-186"> return conf.getDouble(REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER,</span> |
| <span class="source-line-no">187</span><span id="line-187"> DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER);</span> |
| <span class="source-line-no">188</span><span id="line-188"> }</span> |
| <span class="source-line-no">189</span><span id="line-189"></span> |
| <span class="source-line-no">190</span><span id="line-190">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
