devapidocs/src-html/org/apache/hadoop/hbase/regionserver/MemStoreCompactionStrategy.Action.html - hbase-site - Git at Google

 <!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: MemStoreCompactionStrategy, enum: Action">
 <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 org.apache.hadoop.conf.Configuration;</span>
 <span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
 <span class="source-line-no">022</span><span id="line-22">import org.slf4j.Logger;</span>
 <span class="source-line-no">023</span><span id="line-23">import org.slf4j.LoggerFactory;</span>
 <span class="source-line-no">024</span><span id="line-24"></span>
 <span class="source-line-no">025</span><span id="line-25">/**</span>
 <span class="source-line-no">026</span><span id="line-26"> * MemStoreCompactionStrategy is the root of a class hierarchy which defines the strategy for</span>
 <span class="source-line-no">027</span><span id="line-27"> * choosing the next action to apply in an (in-memory) memstore compaction. Possible action are: -</span>
 <span class="source-line-no">028</span><span id="line-28"> * No-op - do nothing - Flatten - to change the segment's index from CSLM to a flat representation -</span>
 <span class="source-line-no">029</span><span id="line-29"> * Merge - to merge the indices of the segments in the pipeline - Compact - to merge the indices</span>
 <span class="source-line-no">030</span><span id="line-30"> * while removing data redundancies In addition while applying flat/merge actions it is possible to</span>
 <span class="source-line-no">031</span><span id="line-31"> * count the number of unique keys in the result segment.</span>
 <span class="source-line-no">032</span><span id="line-32"> */</span>
 <span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span>
 <span class="source-line-no">034</span><span id="line-34">public abstract class MemStoreCompactionStrategy {</span>
 <span class="source-line-no">035</span><span id="line-35"></span>
 <span class="source-line-no">036</span><span id="line-36">  protected static final Logger LOG = LoggerFactory.getLogger(MemStoreCompactionStrategy.class);</span>
 <span class="source-line-no">037</span><span id="line-37">  // The upper bound for the number of segments we store in the pipeline prior to merging.</span>
 <span class="source-line-no">038</span><span id="line-38">  public static final String COMPACTING_MEMSTORE_THRESHOLD_KEY =</span>
 <span class="source-line-no">039</span><span id="line-39">    "hbase.hregion.compacting.pipeline.segments.limit";</span>
 <span class="source-line-no">040</span><span id="line-40">  public static final int COMPACTING_MEMSTORE_THRESHOLD_DEFAULT = 2;</span>
 <span class="source-line-no">041</span><span id="line-41"></span>
 <span class="source-line-no">042</span><span id="line-42">  /**</span>
 <span class="source-line-no">043</span><span id="line-43">   * Types of actions to be done on the pipeline upon MemStoreCompaction invocation. Note that every</span>
 <span class="source-line-no">044</span><span id="line-44">   * value covers the previous ones, i.e. if MERGE is the action it implies that the youngest</span>
 <span class="source-line-no">045</span><span id="line-45">   * segment is going to be flatten anyway.</span>
 <span class="source-line-no">046</span><span id="line-46">   */</span>
 <span class="source-line-no">047</span><span id="line-47">  public enum Action {</span>
 <span class="source-line-no">048</span><span id="line-48">    NOOP,</span>
 <span class="source-line-no">049</span><span id="line-49">    FLATTEN, // flatten a segment in the pipeline</span>
 <span class="source-line-no">050</span><span id="line-50">    FLATTEN_COUNT_UNIQUE_KEYS, // flatten a segment in the pipeline and count its unique keys</span>
 <span class="source-line-no">051</span><span id="line-51">    MERGE, // merge all the segments in the pipeline into one</span>
 <span class="source-line-no">052</span><span id="line-52">    MERGE_COUNT_UNIQUE_KEYS, // merge all pipeline segments into one and count its unique keys</span>
 <span class="source-line-no">053</span><span id="line-53">    COMPACT // compact the data of all pipeline segments</span>
 <span class="source-line-no">054</span><span id="line-54">  }</span>
 <span class="source-line-no">055</span><span id="line-55"></span>
 <span class="source-line-no">056</span><span id="line-56">  protected final String cfName;</span>
 <span class="source-line-no">057</span><span id="line-57">  // The limit on the number of the segments in the pipeline</span>
 <span class="source-line-no">058</span><span id="line-58">  protected final int pipelineThreshold;</span>
 <span class="source-line-no">059</span><span id="line-59"></span>
 <span class="source-line-no">060</span><span id="line-60">  public MemStoreCompactionStrategy(Configuration conf, String cfName) {</span>
 <span class="source-line-no">061</span><span id="line-61">    this.cfName = cfName;</span>
 <span class="source-line-no">062</span><span id="line-62">    if (conf == null) {</span>
 <span class="source-line-no">063</span><span id="line-63">      pipelineThreshold = COMPACTING_MEMSTORE_THRESHOLD_DEFAULT;</span>
 <span class="source-line-no">064</span><span id="line-64">    } else {</span>
 <span class="source-line-no">065</span><span id="line-65">      pipelineThreshold = // get the limit on the number of the segments in the pipeline</span>
 <span class="source-line-no">066</span><span id="line-66">        conf.getInt(COMPACTING_MEMSTORE_THRESHOLD_KEY, COMPACTING_MEMSTORE_THRESHOLD_DEFAULT);</span>
 <span class="source-line-no">067</span><span id="line-67">    }</span>
 <span class="source-line-no">068</span><span id="line-68">  }</span>
 <span class="source-line-no">069</span><span id="line-69"></span>
 <span class="source-line-no">070</span><span id="line-70">  @Override</span>
 <span class="source-line-no">071</span><span id="line-71">  public String toString() {</span>
 <span class="source-line-no">072</span><span id="line-72">    return getName() + ", pipelineThreshold=" + this.pipelineThreshold;</span>
 <span class="source-line-no">073</span><span id="line-73">  }</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 abstract String getName();</span>
 <span class="source-line-no">076</span><span id="line-76"></span>
 <span class="source-line-no">077</span><span id="line-77">  // get next compaction action to apply on compaction pipeline</span>
 <span class="source-line-no">078</span><span id="line-78">  public abstract Action getAction(VersionedSegmentsList versionedList);</span>
 <span class="source-line-no">079</span><span id="line-79"></span>
 <span class="source-line-no">080</span><span id="line-80">  // update policy stats based on the segment that replaced previous versioned list (in</span>
 <span class="source-line-no">081</span><span id="line-81">  // compaction pipeline)</span>
 <span class="source-line-no">082</span><span id="line-82">  public void updateStats(Segment replacement) {</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">  // resets policy stats</span>
 <span class="source-line-no">086</span><span id="line-86">  public void resetStats() {</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">  protected Action simpleMergeOrFlatten(VersionedSegmentsList versionedList, String strategy) {</span>
 <span class="source-line-no">090</span><span id="line-90">    int numOfSegments = versionedList.getNumOfSegments();</span>
 <span class="source-line-no">091</span><span id="line-91">    if (numOfSegments &gt; pipelineThreshold) {</span>
 <span class="source-line-no">092</span><span id="line-92">      // to avoid too many segments, merge now</span>
 <span class="source-line-no">093</span><span id="line-93">      LOG.trace("Strategy={}, store={}; merging {} segments", strategy, cfName, numOfSegments);</span>
 <span class="source-line-no">094</span><span id="line-94">      return getMergingAction();</span>
 <span class="source-line-no">095</span><span id="line-95">    }</span>
 <span class="source-line-no">096</span><span id="line-96"></span>
 <span class="source-line-no">097</span><span id="line-97">    // just flatten a segment</span>
 <span class="source-line-no">098</span><span id="line-98">    LOG.trace("Strategy={}, store={}; flattening a segment", strategy, cfName);</span>
 <span class="source-line-no">099</span><span id="line-99">    return getFlattenAction();</span>
 <span class="source-line-no">100</span><span id="line-100">  }</span>
 <span class="source-line-no">101</span><span id="line-101"></span>
 <span class="source-line-no">102</span><span id="line-102">  protected Action getMergingAction() {</span>
 <span class="source-line-no">103</span><span id="line-103">    return Action.MERGE;</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">  protected Action getFlattenAction() {</span>
 <span class="source-line-no">107</span><span id="line-107">    return Action.FLATTEN;</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">  protected Action compact(VersionedSegmentsList versionedList, String strategyInfo) {</span>
 <span class="source-line-no">111</span><span id="line-111">    int numOfSegments = versionedList.getNumOfSegments();</span>
 <span class="source-line-no">112</span><span id="line-112">    LOG.trace("{} in-memory compaction for store={} compacting {} segments", strategyInfo, cfName,</span>
 <span class="source-line-no">113</span><span id="line-113">      numOfSegments);</span>
 <span class="source-line-no">114</span><span id="line-114">    return Action.COMPACT;</span>
 <span class="source-line-no">115</span><span id="line-115">  }</span>
 <span class="source-line-no">116</span><span id="line-116">}</span>


 </pre>
 </div>
 </main>
 </body>
 </html>
	<!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: MemStoreCompactionStrategy, enum: Action">
	<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 org.apache.hadoop.conf.Configuration;</span>
	<span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
	<span class="source-line-no">022</span><span id="line-22">import org.slf4j.Logger;</span>
	<span class="source-line-no">023</span><span id="line-23">import org.slf4j.LoggerFactory;</span>
	<span class="source-line-no">024</span><span id="line-24"></span>
	<span class="source-line-no">025</span><span id="line-25">/**</span>
	<span class="source-line-no">026</span><span id="line-26"> * MemStoreCompactionStrategy is the root of a class hierarchy which defines the strategy for</span>
	<span class="source-line-no">027</span><span id="line-27"> * choosing the next action to apply in an (in-memory) memstore compaction. Possible action are: -</span>
	<span class="source-line-no">028</span><span id="line-28"> * No-op - do nothing - Flatten - to change the segment's index from CSLM to a flat representation -</span>
	<span class="source-line-no">029</span><span id="line-29"> * Merge - to merge the indices of the segments in the pipeline - Compact - to merge the indices</span>
	<span class="source-line-no">030</span><span id="line-30"> * while removing data redundancies In addition while applying flat/merge actions it is possible to</span>
	<span class="source-line-no">031</span><span id="line-31"> * count the number of unique keys in the result segment.</span>
	<span class="source-line-no">032</span><span id="line-32"> */</span>
	<span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span>
	<span class="source-line-no">034</span><span id="line-34">public abstract class MemStoreCompactionStrategy {</span>
	<span class="source-line-no">035</span><span id="line-35"></span>
	<span class="source-line-no">036</span><span id="line-36"> protected static final Logger LOG = LoggerFactory.getLogger(MemStoreCompactionStrategy.class);</span>
	<span class="source-line-no">037</span><span id="line-37"> // The upper bound for the number of segments we store in the pipeline prior to merging.</span>
	<span class="source-line-no">038</span><span id="line-38"> public static final String COMPACTING_MEMSTORE_THRESHOLD_KEY =</span>
	<span class="source-line-no">039</span><span id="line-39"> "hbase.hregion.compacting.pipeline.segments.limit";</span>
	<span class="source-line-no">040</span><span id="line-40"> public static final int COMPACTING_MEMSTORE_THRESHOLD_DEFAULT = 2;</span>
	<span class="source-line-no">041</span><span id="line-41"></span>
	<span class="source-line-no">042</span><span id="line-42"> /**</span>
	<span class="source-line-no">043</span><span id="line-43"> * Types of actions to be done on the pipeline upon MemStoreCompaction invocation. Note that every</span>
	<span class="source-line-no">044</span><span id="line-44"> * value covers the previous ones, i.e. if MERGE is the action it implies that the youngest</span>
	<span class="source-line-no">045</span><span id="line-45"> * segment is going to be flatten anyway.</span>
	<span class="source-line-no">046</span><span id="line-46"> */</span>
	<span class="source-line-no">047</span><span id="line-47"> public enum Action {</span>
	<span class="source-line-no">048</span><span id="line-48"> NOOP,</span>
	<span class="source-line-no">049</span><span id="line-49"> FLATTEN, // flatten a segment in the pipeline</span>
	<span class="source-line-no">050</span><span id="line-50"> FLATTEN_COUNT_UNIQUE_KEYS, // flatten a segment in the pipeline and count its unique keys</span>
	<span class="source-line-no">051</span><span id="line-51"> MERGE, // merge all the segments in the pipeline into one</span>
	<span class="source-line-no">052</span><span id="line-52"> MERGE_COUNT_UNIQUE_KEYS, // merge all pipeline segments into one and count its unique keys</span>
	<span class="source-line-no">053</span><span id="line-53"> COMPACT // compact the data of all pipeline segments</span>
	<span class="source-line-no">054</span><span id="line-54"> }</span>
	<span class="source-line-no">055</span><span id="line-55"></span>
	<span class="source-line-no">056</span><span id="line-56"> protected final String cfName;</span>
	<span class="source-line-no">057</span><span id="line-57"> // The limit on the number of the segments in the pipeline</span>
	<span class="source-line-no">058</span><span id="line-58"> protected final int pipelineThreshold;</span>
	<span class="source-line-no">059</span><span id="line-59"></span>
	<span class="source-line-no">060</span><span id="line-60"> public MemStoreCompactionStrategy(Configuration conf, String cfName) {</span>
	<span class="source-line-no">061</span><span id="line-61"> this.cfName = cfName;</span>
	<span class="source-line-no">062</span><span id="line-62"> if (conf == null) {</span>
	<span class="source-line-no">063</span><span id="line-63"> pipelineThreshold = COMPACTING_MEMSTORE_THRESHOLD_DEFAULT;</span>
	<span class="source-line-no">064</span><span id="line-64"> } else {</span>
	<span class="source-line-no">065</span><span id="line-65"> pipelineThreshold = // get the limit on the number of the segments in the pipeline</span>
	<span class="source-line-no">066</span><span id="line-66"> conf.getInt(COMPACTING_MEMSTORE_THRESHOLD_KEY, COMPACTING_MEMSTORE_THRESHOLD_DEFAULT);</span>
	<span class="source-line-no">067</span><span id="line-67"> }</span>
	<span class="source-line-no">068</span><span id="line-68"> }</span>
	<span class="source-line-no">069</span><span id="line-69"></span>
	<span class="source-line-no">070</span><span id="line-70"> @Override</span>
	<span class="source-line-no">071</span><span id="line-71"> public String toString() {</span>
	<span class="source-line-no">072</span><span id="line-72"> return getName() + ", pipelineThreshold=" + this.pipelineThreshold;</span>
	<span class="source-line-no">073</span><span id="line-73"> }</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 abstract String getName();</span>
	<span class="source-line-no">076</span><span id="line-76"></span>
	<span class="source-line-no">077</span><span id="line-77"> // get next compaction action to apply on compaction pipeline</span>
	<span class="source-line-no">078</span><span id="line-78"> public abstract Action getAction(VersionedSegmentsList versionedList);</span>
	<span class="source-line-no">079</span><span id="line-79"></span>
	<span class="source-line-no">080</span><span id="line-80"> // update policy stats based on the segment that replaced previous versioned list (in</span>
	<span class="source-line-no">081</span><span id="line-81"> // compaction pipeline)</span>
	<span class="source-line-no">082</span><span id="line-82"> public void updateStats(Segment replacement) {</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"> // resets policy stats</span>
	<span class="source-line-no">086</span><span id="line-86"> public void resetStats() {</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"> protected Action simpleMergeOrFlatten(VersionedSegmentsList versionedList, String strategy) {</span>
	<span class="source-line-no">090</span><span id="line-90"> int numOfSegments = versionedList.getNumOfSegments();</span>
	<span class="source-line-no">091</span><span id="line-91"> if (numOfSegments > pipelineThreshold) {</span>
	<span class="source-line-no">092</span><span id="line-92"> // to avoid too many segments, merge now</span>
	<span class="source-line-no">093</span><span id="line-93"> LOG.trace("Strategy={}, store={}; merging {} segments", strategy, cfName, numOfSegments);</span>
	<span class="source-line-no">094</span><span id="line-94"> return getMergingAction();</span>
	<span class="source-line-no">095</span><span id="line-95"> }</span>
	<span class="source-line-no">096</span><span id="line-96"></span>
	<span class="source-line-no">097</span><span id="line-97"> // just flatten a segment</span>
	<span class="source-line-no">098</span><span id="line-98"> LOG.trace("Strategy={}, store={}; flattening a segment", strategy, cfName);</span>
	<span class="source-line-no">099</span><span id="line-99"> return getFlattenAction();</span>
	<span class="source-line-no">100</span><span id="line-100"> }</span>
	<span class="source-line-no">101</span><span id="line-101"></span>
	<span class="source-line-no">102</span><span id="line-102"> protected Action getMergingAction() {</span>
	<span class="source-line-no">103</span><span id="line-103"> return Action.MERGE;</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"> protected Action getFlattenAction() {</span>
	<span class="source-line-no">107</span><span id="line-107"> return Action.FLATTEN;</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"> protected Action compact(VersionedSegmentsList versionedList, String strategyInfo) {</span>
	<span class="source-line-no">111</span><span id="line-111"> int numOfSegments = versionedList.getNumOfSegments();</span>
	<span class="source-line-no">112</span><span id="line-112"> LOG.trace("{} in-memory compaction for store={} compacting {} segments", strategyInfo, cfName,</span>
	<span class="source-line-no">113</span><span id="line-113"> numOfSegments);</span>
	<span class="source-line-no">114</span><span id="line-114"> return Action.COMPACT;</span>
	<span class="source-line-no">115</span><span id="line-115"> }</span>
	<span class="source-line-no">116</span><span id="line-116">}</span>




























































	</pre>
	</div>
	</main>
	</body>
	</html>