Package org.apache.hadoop.hbase.regionserver

Class AbstractMultiFileWriter

java.lang.Object

org.apache.hadoop.hbase.regionserver.AbstractMultiFileWriter

All Implemented Interfaces:

CellSink, ShipperListener

Direct Known Subclasses:

DateTieredMultiFileWriter, StripeMultiFileWriter

@Private
public abstract class AbstractMultiFileWriter
extends Object
implements CellSink, ShipperListener

Base class for cell sink that separates the provided cells into multiple files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractMultiFileWriter.WriterFactory

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG
protected StoreScanner	sourceScanner	Source scanner that is tracking KV count; may be null if source is not StoreScanner
protected AbstractMultiFileWriter.WriterFactory	writerFactory	Factory that is used to produce single StoreFile.Writer-s

Constructor Summary

Constructors

Constructor	Description
AbstractMultiFileWriter()

Method Summary

Modifier and Type	Method	Description
List<org.apache.hadoop.fs.Path>	abortWriters()	Close all writers without throwing any exceptions.
void	beforeShipped()	The action that needs to be performed before Shipper.shipped() is performed
List<org.apache.hadoop.fs.Path>	commitWriters(long maxSeqId, boolean majorCompaction)	Commit all writers.
List<org.apache.hadoop.fs.Path>	commitWriters(long maxSeqId, boolean majorCompaction, Collection<HStoreFile> storeFiles)
void	init(StoreScanner sourceScanner, AbstractMultiFileWriter.WriterFactory factory)	Initializes multi-writer before usage.
protected void	preCloseWriter(StoreFileWriter writer)	Subclasses override this method to be called before we close the give writer.
protected void	preCommitWriters()	Subclasses override this method to be called at the end of a successful sequence of append; all appends are processed before this method is called.
protected abstract Collection<StoreFileWriter>	writers()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.regionserver.CellSink

append, appendAll

Field Details

LOG

private static final org.slf4j.Logger LOG

writerFactory

protected AbstractMultiFileWriter.WriterFactory writerFactory

Factory that is used to produce single StoreFile.Writer-s

sourceScanner

protected StoreScanner sourceScanner

Source scanner that is tracking KV count; may be null if source is not StoreScanner

Constructor Details

AbstractMultiFileWriter

public AbstractMultiFileWriter()

Method Details

init

public void init(StoreScanner sourceScanner,
 AbstractMultiFileWriter.WriterFactory factory)

Initializes multi-writer before usage.

Parameters:

sourceScanner - Optional store scanner to obtain the information about read progress.

factory - Factory used to produce individual file writers.

commitWriters

public List<org.apache.hadoop.fs.Path> commitWriters(long maxSeqId,
 boolean majorCompaction)
                                              throws IOException

Commit all writers.

Notice that here we use the same maxSeqId for all output files since we haven't found an easy to find enough sequence ids for different output files in some corner cases. See comments in HBASE-15400 for more details.

Throws:

IOException

commitWriters

public List<org.apache.hadoop.fs.Path> commitWriters(long maxSeqId,
 boolean majorCompaction,
 Collection<HStoreFile> storeFiles)
                                              throws IOException

Throws:

IOException

abortWriters

public List<org.apache.hadoop.fs.Path> abortWriters()

Close all writers without throwing any exceptions. This is used when compaction failed usually.

writers

protected abstract Collection<StoreFileWriter> writers()

preCommitWriters

protected void preCommitWriters()
                         throws IOException

Subclasses override this method to be called at the end of a successful sequence of append; all appends are processed before this method is called.

Throws:

IOException

preCloseWriter

protected void preCloseWriter(StoreFileWriter writer)
                       throws IOException

Subclasses override this method to be called before we close the give writer. Usually you can append extra metadata to the writer.

Throws:

IOException

beforeShipped

public void beforeShipped()
                   throws IOException

Description copied from interface: ShipperListener

The action that needs to be performed before Shipper.shipped() is performed

Specified by:

beforeShipped in interface ShipperListener

Throws:

IOException