| <!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.regionserver, class: RegionSplitPolicy"> |
| <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.regionserver;</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 java.util.List;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Optional;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configured;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.TableDescriptor;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.util.ReflectionUtils;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">032</span><span id="line-32"></span> |
| <span class="source-line-no">033</span><span id="line-33">/**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * A split policy determines when a Region should be split.</span> |
| <span class="source-line-no">035</span><span id="line-35"> * @see SteppingSplitPolicy Default split policy since 2.0.0</span> |
| <span class="source-line-no">036</span><span id="line-36"> * @see IncreasingToUpperBoundRegionSplitPolicy Default split policy since 0.94.0</span> |
| <span class="source-line-no">037</span><span id="line-37"> * @see ConstantSizeRegionSplitPolicy Default split policy before 0.94.0</span> |
| <span class="source-line-no">038</span><span id="line-38"> */</span> |
| <span class="source-line-no">039</span><span id="line-39">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)</span> |
| <span class="source-line-no">040</span><span id="line-40">public abstract class RegionSplitPolicy extends Configured {</span> |
| <span class="source-line-no">041</span><span id="line-41"> private static final Class<? extends RegionSplitPolicy> DEFAULT_SPLIT_POLICY_CLASS =</span> |
| <span class="source-line-no">042</span><span id="line-42"> SteppingSplitPolicy.class;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> /**</span> |
| <span class="source-line-no">045</span><span id="line-45"> * The region configured for this split policy. As of hbase-2.0.0, RegionSplitPolicy can be</span> |
| <span class="source-line-no">046</span><span id="line-46"> * instantiated on the Master-side so the Phoenix local-indexer can block default hbase behavior.</span> |
| <span class="source-line-no">047</span><span id="line-47"> * This is an exotic usage. Should not trouble any other users of RegionSplitPolicy.</span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49"> protected HRegion region;</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Upon construction, this method will be called with the region to be governed. It will be called</span> |
| <span class="source-line-no">053</span><span id="line-53"> * once and only once.</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> protected void configureForRegion(HRegion region) {</span> |
| <span class="source-line-no">056</span><span id="line-56"> Preconditions.checkState(this.region == null, "Policy already configured for region {}",</span> |
| <span class="source-line-no">057</span><span id="line-57"> this.region);</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> this.region = region;</span> |
| <span class="source-line-no">060</span><span id="line-60"> }</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /** Returns true if the specified region should be split. */</span> |
| <span class="source-line-no">063</span><span id="line-63"> protected abstract boolean shouldSplit();</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> /** Returns {@code true} if the specified region can be split. */</span> |
| <span class="source-line-no">066</span><span id="line-66"> protected boolean canSplit() {</span> |
| <span class="source-line-no">067</span><span id="line-67"> return !region.getRegionInfo().isMetaRegion() && region.isAvailable()</span> |
| <span class="source-line-no">068</span><span id="line-68"> && region.getStores().stream().allMatch(HStore::canSplit);</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @return the key at which the region should be split, or null if it cannot be split. This will</span> |
| <span class="source-line-no">073</span><span id="line-73"> * only be called if shouldSplit previously returned 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"> protected byte[] getSplitPoint() {</span> |
| <span class="source-line-no">076</span><span id="line-76"> List<HStore> stores = region.getStores();</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> byte[] splitPointFromLargestStore = null;</span> |
| <span class="source-line-no">079</span><span id="line-79"> long largestStoreSize = 0;</span> |
| <span class="source-line-no">080</span><span id="line-80"> for (HStore s : stores) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> Optional<byte[]> splitPoint = s.getSplitPoint();</span> |
| <span class="source-line-no">082</span><span id="line-82"> // Store also returns null if it has references as way of indicating it is not splittable</span> |
| <span class="source-line-no">083</span><span id="line-83"> long storeSize = s.getSize();</span> |
| <span class="source-line-no">084</span><span id="line-84"> if (splitPoint.isPresent() && largestStoreSize < storeSize) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> splitPointFromLargestStore = splitPoint.get();</span> |
| <span class="source-line-no">086</span><span id="line-86"> largestStoreSize = storeSize;</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> return splitPointFromLargestStore;</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /**</span> |
| <span class="source-line-no">094</span><span id="line-94"> * Create the RegionSplitPolicy configured for the given table.</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @return a RegionSplitPolicy</span> |
| <span class="source-line-no">096</span><span id="line-96"> */</span> |
| <span class="source-line-no">097</span><span id="line-97"> public static RegionSplitPolicy create(HRegion region, Configuration conf) throws IOException {</span> |
| <span class="source-line-no">098</span><span id="line-98"> Preconditions.checkNotNull(region, "Region should not be null.");</span> |
| <span class="source-line-no">099</span><span id="line-99"> Class<? extends RegionSplitPolicy> clazz =</span> |
| <span class="source-line-no">100</span><span id="line-100"> getSplitPolicyClass(region.getTableDescriptor(), conf);</span> |
| <span class="source-line-no">101</span><span id="line-101"> RegionSplitPolicy policy = ReflectionUtils.newInstance(clazz, conf);</span> |
| <span class="source-line-no">102</span><span id="line-102"> policy.configureForRegion(region);</span> |
| <span class="source-line-no">103</span><span id="line-103"> return policy;</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> public static Class<? extends RegionSplitPolicy> getSplitPolicyClass(TableDescriptor htd,</span> |
| <span class="source-line-no">107</span><span id="line-107"> Configuration conf) throws IOException {</span> |
| <span class="source-line-no">108</span><span id="line-108"> String className = htd.getRegionSplitPolicyClassName();</span> |
| <span class="source-line-no">109</span><span id="line-109"> if (className == null) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> className =</span> |
| <span class="source-line-no">111</span><span id="line-111"> conf.get(HConstants.HBASE_REGION_SPLIT_POLICY_KEY, DEFAULT_SPLIT_POLICY_CLASS.getName());</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> try {</span> |
| <span class="source-line-no">115</span><span id="line-115"> Class<? extends RegionSplitPolicy> clazz =</span> |
| <span class="source-line-no">116</span><span id="line-116"> Class.forName(className).asSubclass(RegionSplitPolicy.class);</span> |
| <span class="source-line-no">117</span><span id="line-117"> return clazz;</span> |
| <span class="source-line-no">118</span><span id="line-118"> } catch (Exception e) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> throw new IOException("Unable to load configured region split policy '" + className</span> |
| <span class="source-line-no">120</span><span id="line-120"> + "' for table '" + htd.getTableName() + "'", e);</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> /**</span> |
| <span class="source-line-no">125</span><span id="line-125"> * In</span> |
| <span class="source-line-no">126</span><span id="line-126"> * {@link HRegionFileSystem#splitStoreFile(org.apache.hadoop.hbase.client.RegionInfo, String, HStoreFile, byte[], boolean, RegionSplitPolicy)}</span> |
| <span class="source-line-no">127</span><span id="line-127"> * we are not creating the split reference if split row does not lie inside the StoreFile range.</span> |
| <span class="source-line-no">128</span><span id="line-128"> * But in some use cases we may need to create the split reference even when the split row does</span> |
| <span class="source-line-no">129</span><span id="line-129"> * not lie inside the StoreFile range. This method can be used to decide, whether to skip the the</span> |
| <span class="source-line-no">130</span><span id="line-130"> * StoreFile range check or not.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * <p></span> |
| <span class="source-line-no">132</span><span id="line-132"> * This method is not for general use. It is a mechanism put in place by Phoenix local indexing to</span> |
| <span class="source-line-no">133</span><span id="line-133"> * defeat standard hbase behaviors. Phoenix local indices are very likely the only folks who would</span> |
| <span class="source-line-no">134</span><span id="line-134"> * make use of this method. On the Master-side, we will instantiate a RegionSplitPolicy instance</span> |
| <span class="source-line-no">135</span><span id="line-135"> * and run this method ONLY... none of the others make sense on the Master-side.</span> |
| <span class="source-line-no">136</span><span id="line-136"> * </p></span> |
| <span class="source-line-no">137</span><span id="line-137"> * TODO: Shutdown this phoenix specialization or do it via some other means.</span> |
| <span class="source-line-no">138</span><span id="line-138"> * @return whether to skip the StoreFile range check or not</span> |
| <span class="source-line-no">139</span><span id="line-139"> */</span> |
| <span class="source-line-no">140</span><span id="line-140"> protected boolean skipStoreFileRangeCheck(String familyName) {</span> |
| <span class="source-line-no">141</span><span id="line-141"> return false;</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
