blob: cc0f339c990423be5e28a27107c4b722e31f07a6 [file] [log] [blame]
<!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: DefaultStoreEngine">
<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 org.apache.hadoop.conf.Configuration;</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.CellComparator;</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.regionserver.compactions.CompactionContext;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.compactions.DefaultCompactor;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.regionserver.compactions.ExploringCompactionPolicy;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.regionserver.compactions.RatioBasedCompactionPolicy;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.regionserver.throttle.ThroughputController;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.util.ReflectionUtils;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35">/**</span>
<span class="source-line-no">036</span><span id="line-36"> * Default StoreEngine creates the default compactor, policy, and store file manager, or their</span>
<span class="source-line-no">037</span><span id="line-37"> * derivatives.</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 class DefaultStoreEngine extends StoreEngine&lt;DefaultStoreFlusher, RatioBasedCompactionPolicy,</span>
<span class="source-line-no">041</span><span id="line-41"> DefaultCompactor, DefaultStoreFileManager&gt; {</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> public static final String DEFAULT_STORE_FLUSHER_CLASS_KEY =</span>
<span class="source-line-no">044</span><span id="line-44"> "hbase.hstore.defaultengine.storeflusher.class";</span>
<span class="source-line-no">045</span><span id="line-45"> public static final String DEFAULT_COMPACTOR_CLASS_KEY =</span>
<span class="source-line-no">046</span><span id="line-46"> "hbase.hstore.defaultengine.compactor.class";</span>
<span class="source-line-no">047</span><span id="line-47"> public static final String DEFAULT_COMPACTION_POLICY_CLASS_KEY =</span>
<span class="source-line-no">048</span><span id="line-48"> "hbase.hstore.defaultengine.compactionpolicy.class";</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> private static final Class&lt;? extends DefaultStoreFlusher&gt; DEFAULT_STORE_FLUSHER_CLASS =</span>
<span class="source-line-no">051</span><span id="line-51"> DefaultStoreFlusher.class;</span>
<span class="source-line-no">052</span><span id="line-52"> private static final Class&lt;? extends DefaultCompactor&gt; DEFAULT_COMPACTOR_CLASS =</span>
<span class="source-line-no">053</span><span id="line-53"> DefaultCompactor.class;</span>
<span class="source-line-no">054</span><span id="line-54"> private static final Class&lt;? extends RatioBasedCompactionPolicy&gt; DEFAULT_COMPACTION_POLICY_CLASS =</span>
<span class="source-line-no">055</span><span id="line-55"> ExploringCompactionPolicy.class;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> @Override</span>
<span class="source-line-no">058</span><span id="line-58"> public boolean needsCompaction(List&lt;HStoreFile&gt; filesCompacting) {</span>
<span class="source-line-no">059</span><span id="line-59"> return compactionPolicy.needsCompaction(this.storeFileManager.getStoreFiles(), filesCompacting);</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"> @Override</span>
<span class="source-line-no">063</span><span id="line-63"> protected void createComponents(Configuration conf, HStore store, CellComparator kvComparator)</span>
<span class="source-line-no">064</span><span id="line-64"> throws IOException {</span>
<span class="source-line-no">065</span><span id="line-65"> createCompactor(conf, store);</span>
<span class="source-line-no">066</span><span id="line-66"> createCompactionPolicy(conf, store);</span>
<span class="source-line-no">067</span><span id="line-67"> createStoreFlusher(conf, store);</span>
<span class="source-line-no">068</span><span id="line-68"> storeFileManager = new DefaultStoreFileManager(kvComparator, StoreFileComparators.SEQ_ID, conf,</span>
<span class="source-line-no">069</span><span id="line-69"> compactionPolicy.getConf());</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"> protected void createCompactor(Configuration conf, HStore store) throws IOException {</span>
<span class="source-line-no">073</span><span id="line-73"> String className = conf.get(DEFAULT_COMPACTOR_CLASS_KEY, DEFAULT_COMPACTOR_CLASS.getName());</span>
<span class="source-line-no">074</span><span id="line-74"> try {</span>
<span class="source-line-no">075</span><span id="line-75"> compactor = ReflectionUtils.instantiateWithCustomCtor(className,</span>
<span class="source-line-no">076</span><span id="line-76"> new Class[] { Configuration.class, HStore.class }, new Object[] { conf, store });</span>
<span class="source-line-no">077</span><span id="line-77"> } catch (Exception e) {</span>
<span class="source-line-no">078</span><span id="line-78"> throw new IOException("Unable to load configured compactor '" + className + "'", e);</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> protected void createCompactionPolicy(Configuration conf, HStore store) throws IOException {</span>
<span class="source-line-no">083</span><span id="line-83"> String className =</span>
<span class="source-line-no">084</span><span id="line-84"> conf.get(DEFAULT_COMPACTION_POLICY_CLASS_KEY, DEFAULT_COMPACTION_POLICY_CLASS.getName());</span>
<span class="source-line-no">085</span><span id="line-85"> try {</span>
<span class="source-line-no">086</span><span id="line-86"> compactionPolicy = ReflectionUtils.instantiateWithCustomCtor(className,</span>
<span class="source-line-no">087</span><span id="line-87"> new Class[] { Configuration.class, StoreConfigInformation.class },</span>
<span class="source-line-no">088</span><span id="line-88"> new Object[] { conf, store });</span>
<span class="source-line-no">089</span><span id="line-89"> } catch (Exception e) {</span>
<span class="source-line-no">090</span><span id="line-90"> throw new IOException("Unable to load configured compaction policy '" + className + "'", e);</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"> protected void createStoreFlusher(Configuration conf, HStore store) throws IOException {</span>
<span class="source-line-no">095</span><span id="line-95"> String className =</span>
<span class="source-line-no">096</span><span id="line-96"> conf.get(DEFAULT_STORE_FLUSHER_CLASS_KEY, DEFAULT_STORE_FLUSHER_CLASS.getName());</span>
<span class="source-line-no">097</span><span id="line-97"> try {</span>
<span class="source-line-no">098</span><span id="line-98"> storeFlusher = ReflectionUtils.instantiateWithCustomCtor(className,</span>
<span class="source-line-no">099</span><span id="line-99"> new Class[] { Configuration.class, HStore.class }, new Object[] { conf, store });</span>
<span class="source-line-no">100</span><span id="line-100"> } catch (Exception e) {</span>
<span class="source-line-no">101</span><span id="line-101"> throw new IOException("Unable to load configured store flusher '" + className + "'", e);</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"> @Override</span>
<span class="source-line-no">106</span><span id="line-106"> public CompactionContext createCompaction() {</span>
<span class="source-line-no">107</span><span id="line-107"> return new DefaultCompactionContext();</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> private class DefaultCompactionContext extends CompactionContext {</span>
<span class="source-line-no">111</span><span id="line-111"> @Override</span>
<span class="source-line-no">112</span><span id="line-112"> public boolean select(List&lt;HStoreFile&gt; filesCompacting, boolean isUserCompaction,</span>
<span class="source-line-no">113</span><span id="line-113"> boolean mayUseOffPeak, boolean forceMajor) throws IOException {</span>
<span class="source-line-no">114</span><span id="line-114"> request = compactionPolicy.selectCompaction(storeFileManager.getStoreFiles(), filesCompacting,</span>
<span class="source-line-no">115</span><span id="line-115"> isUserCompaction, mayUseOffPeak, forceMajor);</span>
<span class="source-line-no">116</span><span id="line-116"> return request != null;</span>
<span class="source-line-no">117</span><span id="line-117"> }</span>
<span class="source-line-no">118</span><span id="line-118"></span>
<span class="source-line-no">119</span><span id="line-119"> @Override</span>
<span class="source-line-no">120</span><span id="line-120"> public List&lt;Path&gt; compact(ThroughputController throughputController, User user)</span>
<span class="source-line-no">121</span><span id="line-121"> throws IOException {</span>
<span class="source-line-no">122</span><span id="line-122"> return compactor.compact(request, throughputController, user);</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"> @Override</span>
<span class="source-line-no">126</span><span id="line-126"> public List&lt;HStoreFile&gt; preSelect(List&lt;HStoreFile&gt; filesCompacting) {</span>
<span class="source-line-no">127</span><span id="line-127"> return compactionPolicy.preSelectCompactionForCoprocessor(storeFileManager.getStoreFiles(),</span>
<span class="source-line-no">128</span><span id="line-128"> filesCompacting);</span>
<span class="source-line-no">129</span><span id="line-129"> }</span>
<span class="source-line-no">130</span><span id="line-130"> }</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132">}</span>
</pre>
</div>
</main>
</body>
</html>