| <!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.compactions, class: CompactionContext"> |
| <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.compactions;</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.fs.Path;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.regionserver.HStoreFile;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.regionserver.throttle.ThroughputController;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.security.User;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * This class holds all "physical" details necessary to run a compaction, and abstracts away the</span> |
| <span class="source-line-no">030</span><span id="line-30"> * details specific to a particular compaction. It also has compaction request with all the logical</span> |
| <span class="source-line-no">031</span><span id="line-31"> * details. Hence, this class is basically the compaction.</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 CompactionContext {</span> |
| <span class="source-line-no">035</span><span id="line-35"> protected CompactionRequestImpl request = null;</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> /**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * Called before coprocessor preCompactSelection and should filter the candidates for coprocessor;</span> |
| <span class="source-line-no">039</span><span id="line-39"> * i.e. exclude the files that definitely cannot be compacted at this time.</span> |
| <span class="source-line-no">040</span><span id="line-40"> * @param filesCompacting files currently compacting</span> |
| <span class="source-line-no">041</span><span id="line-41"> * @return the list of files that can theoretically be compacted.</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 abstract List<HStoreFile> preSelect(List<HStoreFile> filesCompacting);</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> /**</span> |
| <span class="source-line-no">046</span><span id="line-46"> * Called to select files for compaction. Must fill in the request field if successful.</span> |
| <span class="source-line-no">047</span><span id="line-47"> * @param filesCompacting Files currently being compacted by other compactions.</span> |
| <span class="source-line-no">048</span><span id="line-48"> * @param isUserCompaction Whether this is a user compaction.</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @param mayUseOffPeak Whether the underlying policy may assume it's off-peak hours.</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @param forceMajor Whether to force major compaction.</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @return Whether the selection succeeded. Selection may be empty and lead to no compaction.</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53"> public abstract boolean select(List<HStoreFile> filesCompacting, boolean isUserCompaction,</span> |
| <span class="source-line-no">054</span><span id="line-54"> boolean mayUseOffPeak, boolean forceMajor) throws IOException;</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> /**</span> |
| <span class="source-line-no">057</span><span id="line-57"> * Forces external selection to be applied for this compaction.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param request The pre-cooked request with selection and other settings.</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 void forceSelect(CompactionRequestImpl request) {</span> |
| <span class="source-line-no">061</span><span id="line-61"> this.request = request;</span> |
| <span class="source-line-no">062</span><span id="line-62"> }</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> public abstract List<Path> compact(ThroughputController throughputController, User user)</span> |
| <span class="source-line-no">065</span><span id="line-65"> throws IOException;</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> public CompactionRequestImpl getRequest() {</span> |
| <span class="source-line-no">068</span><span id="line-68"> assert hasSelection();</span> |
| <span class="source-line-no">069</span><span id="line-69"> return this.request;</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"> public boolean hasSelection() {</span> |
| <span class="source-line-no">073</span><span id="line-73"> return this.request != null;</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
