| <!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: RegionSplitRestriction"> |
| <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 org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.client.TableDescriptor;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.slf4j.Logger;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * A split restriction that restricts the pattern of the split point.</span> |
| <span class="source-line-no">029</span><span id="line-29"> * <p></span> |
| <span class="source-line-no">030</span><span id="line-30"> * The difference between {@link RegionSplitPolicy} and RegionSplitRestriction is that</span> |
| <span class="source-line-no">031</span><span id="line-31"> * RegionSplitRestriction defines how to split while {@link RegionSplitPolicy} defines when we need</span> |
| <span class="source-line-no">032</span><span id="line-32"> * to split.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <p></span> |
| <span class="source-line-no">034</span><span id="line-34"> * We can specify a split restriction, "KeyPrefix" or "DelimitedKeyPrefix", to a table with the</span> |
| <span class="source-line-no">035</span><span id="line-35"> * "hbase.regionserver.region.split_restriction.type" property. The "KeyPrefix" split restriction</span> |
| <span class="source-line-no">036</span><span id="line-36"> * groups rows by a prefix of the row-key. And the "DelimitedKeyPrefix" split restriction groups</span> |
| <span class="source-line-no">037</span><span id="line-37"> * rows by a prefix of the row-key with a delimiter. For example:</span> |
| <span class="source-line-no">038</span><span id="line-38"> *</span> |
| <span class="source-line-no">039</span><span id="line-39"> * <pre></span> |
| <span class="source-line-no">040</span><span id="line-40"> * <code></span> |
| <span class="source-line-no">041</span><span id="line-41"> * # Create a table with a "KeyPrefix" split restriction, where the prefix length is 2 bytes</span> |
| <span class="source-line-no">042</span><span id="line-42"> * hbase> create 'tbl1', 'fam',</span> |
| <span class="source-line-no">043</span><span id="line-43"> * {CONFIGURATION => {'hbase.regionserver.region.split_restriction.type' => 'KeyPrefix',</span> |
| <span class="source-line-no">044</span><span id="line-44"> * 'hbase.regionserver.region.split_restriction.prefix_length' => '2'}}</span> |
| <span class="source-line-no">045</span><span id="line-45"> *</span> |
| <span class="source-line-no">046</span><span id="line-46"> * # Create a table with a "DelimitedKeyPrefix" split restriction, where the delimiter is a comma</span> |
| <span class="source-line-no">047</span><span id="line-47"> * hbase> create 'tbl2', 'fam',</span> |
| <span class="source-line-no">048</span><span id="line-48"> * {CONFIGURATION => {'hbase.regionserver.region.split_restriction.type' => 'DelimitedKeyPrefix',</span> |
| <span class="source-line-no">049</span><span id="line-49"> * 'hbase.regionserver.region.split_restriction.delimiter' => ','}}</span> |
| <span class="source-line-no">050</span><span id="line-50"> * </code></span> |
| <span class="source-line-no">051</span><span id="line-51"> * </pre></span> |
| <span class="source-line-no">052</span><span id="line-52"> *</span> |
| <span class="source-line-no">053</span><span id="line-53"> * Instead of specifying a split restriction to a table directly, we can also set the properties in</span> |
| <span class="source-line-no">054</span><span id="line-54"> * hbase-site.xml. In this case, the specified split restriction is applied for all the tables.</span> |
| <span class="source-line-no">055</span><span id="line-55"> * <p></span> |
| <span class="source-line-no">056</span><span id="line-56"> * Note that the split restriction is also applied to a user-specified split point so that we don't</span> |
| <span class="source-line-no">057</span><span id="line-57"> * allow users to break the restriction.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @see NoRegionSplitRestriction</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @see KeyPrefixRegionSplitRestriction</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @see DelimitedKeyPrefixRegionSplitRestriction</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62">@InterfaceAudience.Private</span> |
| <span class="source-line-no">063</span><span id="line-63">public abstract class RegionSplitRestriction {</span> |
| <span class="source-line-no">064</span><span id="line-64"> private static final Logger LOG = LoggerFactory.getLogger(RegionSplitRestriction.class);</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> public static final String RESTRICTION_TYPE_KEY =</span> |
| <span class="source-line-no">067</span><span id="line-67"> "hbase.regionserver.region.split_restriction.type";</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> public static final String RESTRICTION_TYPE_NONE = "None";</span> |
| <span class="source-line-no">070</span><span id="line-70"> public static final String RESTRICTION_TYPE_KEY_PREFIX = "KeyPrefix";</span> |
| <span class="source-line-no">071</span><span id="line-71"> public static final String RESTRICTION_TYPE_DELIMITED_KEY_PREFIX = "DelimitedKeyPrefix";</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> /**</span> |
| <span class="source-line-no">074</span><span id="line-74"> * Create the RegionSplitRestriction configured for the given table.</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param tableDescriptor the table descriptor</span> |
| <span class="source-line-no">076</span><span id="line-76"> * @param conf the configuration</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @return a RegionSplitRestriction instance</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @throws IOException if an error occurs</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 RegionSplitRestriction create(TableDescriptor tableDescriptor, Configuration conf)</span> |
| <span class="source-line-no">081</span><span id="line-81"> throws IOException {</span> |
| <span class="source-line-no">082</span><span id="line-82"> String type = tableDescriptor.getValue(RESTRICTION_TYPE_KEY);</span> |
| <span class="source-line-no">083</span><span id="line-83"> if (type == null) {</span> |
| <span class="source-line-no">084</span><span id="line-84"> type = conf.get(RESTRICTION_TYPE_KEY, RESTRICTION_TYPE_NONE);</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> RegionSplitRestriction ret;</span> |
| <span class="source-line-no">088</span><span id="line-88"> switch (type) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> case RESTRICTION_TYPE_NONE:</span> |
| <span class="source-line-no">090</span><span id="line-90"> ret = new NoRegionSplitRestriction();</span> |
| <span class="source-line-no">091</span><span id="line-91"> break;</span> |
| <span class="source-line-no">092</span><span id="line-92"> case RESTRICTION_TYPE_KEY_PREFIX:</span> |
| <span class="source-line-no">093</span><span id="line-93"> ret = new KeyPrefixRegionSplitRestriction();</span> |
| <span class="source-line-no">094</span><span id="line-94"> break;</span> |
| <span class="source-line-no">095</span><span id="line-95"> case RESTRICTION_TYPE_DELIMITED_KEY_PREFIX:</span> |
| <span class="source-line-no">096</span><span id="line-96"> ret = new DelimitedKeyPrefixRegionSplitRestriction();</span> |
| <span class="source-line-no">097</span><span id="line-97"> break;</span> |
| <span class="source-line-no">098</span><span id="line-98"> default:</span> |
| <span class="source-line-no">099</span><span id="line-99"> LOG.warn("Invalid RegionSplitRestriction type specified: {}. "</span> |
| <span class="source-line-no">100</span><span id="line-100"> + "Using the default RegionSplitRestriction", type);</span> |
| <span class="source-line-no">101</span><span id="line-101"> ret = new NoRegionSplitRestriction();</span> |
| <span class="source-line-no">102</span><span id="line-102"> break;</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"> ret.initialize(tableDescriptor, conf);</span> |
| <span class="source-line-no">105</span><span id="line-105"> return ret;</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /**</span> |
| <span class="source-line-no">109</span><span id="line-109"> * Initialize the RegionSplitRestriction instance</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @param tableDescriptor the table descriptor</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @param conf the configuration</span> |
| <span class="source-line-no">112</span><span id="line-112"> * @throws IOException if an error occurs</span> |
| <span class="source-line-no">113</span><span id="line-113"> */</span> |
| <span class="source-line-no">114</span><span id="line-114"> public abstract void initialize(TableDescriptor tableDescriptor, Configuration conf)</span> |
| <span class="source-line-no">115</span><span id="line-115"> throws IOException;</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /**</span> |
| <span class="source-line-no">118</span><span id="line-118"> * Returns a restricted split point.</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @param splitPoint the split point determined by {@link RegionSplitPolicy} or specified by a</span> |
| <span class="source-line-no">120</span><span id="line-120"> * user manually</span> |
| <span class="source-line-no">121</span><span id="line-121"> * @return the restricted split point</span> |
| <span class="source-line-no">122</span><span id="line-122"> */</span> |
| <span class="source-line-no">123</span><span id="line-123"> public abstract byte[] getRestrictedSplitPoint(byte[] splitPoint);</span> |
| <span class="source-line-no">124</span><span id="line-124">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
