| <!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: AbstractMultiFileWriter"> |
| <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.ArrayList;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Collection;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Collections;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.List;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.Path;</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">import org.slf4j.Logger;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">/**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * Base class for cell sink that separates the provided cells into multiple files.</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 AbstractMultiFileWriter implements CellSink, ShipperListener {</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36"> private static final Logger LOG = LoggerFactory.getLogger(AbstractMultiFileWriter.class);</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> /** Factory that is used to produce single StoreFile.Writer-s */</span> |
| <span class="source-line-no">039</span><span id="line-39"> protected WriterFactory writerFactory;</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> /** Source scanner that is tracking KV count; may be null if source is not StoreScanner */</span> |
| <span class="source-line-no">042</span><span id="line-42"> protected StoreScanner sourceScanner;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> public interface WriterFactory {</span> |
| <span class="source-line-no">045</span><span id="line-45"> public StoreFileWriter createWriter() throws IOException;</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> default StoreFileWriter createWriterWithStoragePolicy(String fileStoragePolicy)</span> |
| <span class="source-line-no">048</span><span id="line-48"> throws IOException {</span> |
| <span class="source-line-no">049</span><span id="line-49"> return createWriter();</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"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Initializes multi-writer before usage.</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @param sourceScanner Optional store scanner to obtain the information about read progress.</span> |
| <span class="source-line-no">056</span><span id="line-56"> * @param factory Factory used to produce individual file writers.</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> public void init(StoreScanner sourceScanner, WriterFactory factory) {</span> |
| <span class="source-line-no">059</span><span id="line-59"> this.writerFactory = factory;</span> |
| <span class="source-line-no">060</span><span id="line-60"> this.sourceScanner = sourceScanner;</span> |
| <span class="source-line-no">061</span><span id="line-61"> }</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"> * Commit all writers.</span> |
| <span class="source-line-no">065</span><span id="line-65"> * <p></span> |
| <span class="source-line-no">066</span><span id="line-66"> * Notice that here we use the same <code>maxSeqId</code> for all output files since we haven't</span> |
| <span class="source-line-no">067</span><span id="line-67"> * found an easy to find enough sequence ids for different output files in some corner cases. See</span> |
| <span class="source-line-no">068</span><span id="line-68"> * comments in HBASE-15400 for more details.</span> |
| <span class="source-line-no">069</span><span id="line-69"> */</span> |
| <span class="source-line-no">070</span><span id="line-70"> public List<Path> commitWriters(long maxSeqId, boolean majorCompaction) throws IOException {</span> |
| <span class="source-line-no">071</span><span id="line-71"> return commitWriters(maxSeqId, majorCompaction, Collections.emptyList());</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"> public List<Path> commitWriters(long maxSeqId, boolean majorCompaction,</span> |
| <span class="source-line-no">075</span><span id="line-75"> Collection<HStoreFile> storeFiles) throws IOException {</span> |
| <span class="source-line-no">076</span><span id="line-76"> preCommitWriters();</span> |
| <span class="source-line-no">077</span><span id="line-77"> Collection<StoreFileWriter> writers = this.writers();</span> |
| <span class="source-line-no">078</span><span id="line-78"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">079</span><span id="line-79"> LOG.debug("Commit " + writers.size() + " writers, maxSeqId=" + maxSeqId + ", majorCompaction="</span> |
| <span class="source-line-no">080</span><span id="line-80"> + majorCompaction);</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"> List<Path> paths = new ArrayList<>();</span> |
| <span class="source-line-no">083</span><span id="line-83"> for (StoreFileWriter writer : writers) {</span> |
| <span class="source-line-no">084</span><span id="line-84"> if (writer == null) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> continue;</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"> writer.appendMetadata(maxSeqId, majorCompaction, storeFiles);</span> |
| <span class="source-line-no">088</span><span id="line-88"> preCloseWriter(writer);</span> |
| <span class="source-line-no">089</span><span id="line-89"> paths.add(writer.getPath());</span> |
| <span class="source-line-no">090</span><span id="line-90"> writer.close();</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"> return paths;</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Close all writers without throwing any exceptions. This is used when compaction failed usually.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> public List<Path> abortWriters() {</span> |
| <span class="source-line-no">099</span><span id="line-99"> List<Path> paths = new ArrayList<>();</span> |
| <span class="source-line-no">100</span><span id="line-100"> for (StoreFileWriter writer : writers()) {</span> |
| <span class="source-line-no">101</span><span id="line-101"> try {</span> |
| <span class="source-line-no">102</span><span id="line-102"> if (writer != null) {</span> |
| <span class="source-line-no">103</span><span id="line-103"> paths.add(writer.getPath());</span> |
| <span class="source-line-no">104</span><span id="line-104"> writer.close();</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"> } catch (Exception ex) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> LOG.error("Failed to close the writer after an unfinished compaction.", ex);</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"> return paths;</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> protected abstract Collection<StoreFileWriter> writers();</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * Subclasses override this method to be called at the end of a successful sequence of append; all</span> |
| <span class="source-line-no">117</span><span id="line-117"> * appends are processed before this method is called.</span> |
| <span class="source-line-no">118</span><span id="line-118"> */</span> |
| <span class="source-line-no">119</span><span id="line-119"> protected void preCommitWriters() throws IOException {</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</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"> * Subclasses override this method to be called before we close the give writer. Usually you can</span> |
| <span class="source-line-no">124</span><span id="line-124"> * append extra metadata to the writer.</span> |
| <span class="source-line-no">125</span><span id="line-125"> */</span> |
| <span class="source-line-no">126</span><span id="line-126"> protected void preCloseWriter(StoreFileWriter writer) throws IOException {</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> @Override</span> |
| <span class="source-line-no">130</span><span id="line-130"> public void beforeShipped() throws IOException {</span> |
| <span class="source-line-no">131</span><span id="line-131"> Collection<StoreFileWriter> writers = writers();</span> |
| <span class="source-line-no">132</span><span id="line-132"> if (writers != null) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> for (StoreFileWriter writer : writers) {</span> |
| <span class="source-line-no">134</span><span id="line-134"> if (writer != null) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> writer.beforeShipped();</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"> }</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
