org.apache.hadoop.hbase.regionserver

Class StoreFileWriter

java.lang.Object

org.apache.hadoop.hbase.regionserver.StoreFileWriter

All Implemented Interfaces:

CellSink, ShipperListener

@InterfaceAudience.Private
public class StoreFileWriter
extends Object
implements CellSink, ShipperListener

A StoreFile writer. Use this to read/write HBase Store Files. It is package local because it is an implementation detail of the HBase regionserver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StoreFileWriter.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLE_HISTORICAL_COMPACTION_FILES
static String	ENABLE_HISTORICAL_COMPACTION_FILES

Method Summary

Modifier and Type	Method and Description
void	append(Cell cell) Append the given cell
void	appendAll(List<Cell> cellList) Append the given (possibly partial) list of cells of a row
void	appendFileInfo(byte[] key, byte[] value)
void	appendMetadata(long maxSequenceId, boolean majorCompaction) Writes meta data.
void	appendMetadata(long maxSequenceId, boolean majorCompaction, Collection<HStoreFile> storeFiles) Writes meta data.
void	appendMetadata(long maxSequenceId, boolean majorCompaction, long mobCellsCount) Writes meta data.
void	appendMobMetadata(org.apache.hbase.thirdparty.com.google.common.collect.SetMultimap<TableName,String> mobRefSet) Appends MOB - specific metadata (even if it is empty)
void	appendTrackedTimestampsToMetadata() Add TimestampRange and earliest put timestamp to Metadata
void	beforeShipped() The action that needs to be performed before Shipper.shipped() is performed
void	close()
org.apache.hadoop.fs.Path	getPath()
List<org.apache.hadoop.fs.Path>	getPaths()
long	getPos()
static org.apache.hadoop.fs.Path	getUniqueFile(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path dir)
boolean	hasGeneralBloom()
static boolean	shouldEnableHistoricalCompactionFiles(org.apache.hadoop.conf.Configuration conf)

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE_HISTORICAL_COMPACTION_FILES

public static final String ENABLE_HISTORICAL_COMPACTION_FILES

See Also:

Constant Field Values

DEFAULT_ENABLE_HISTORICAL_COMPACTION_FILES

public static final boolean DEFAULT_ENABLE_HISTORICAL_COMPACTION_FILES

See Also:

Constant Field Values

Method Detail

shouldEnableHistoricalCompactionFiles

public static boolean shouldEnableHistoricalCompactionFiles(org.apache.hadoop.conf.Configuration conf)

getPos

public long getPos()
            throws IOException

Throws:

IOException

appendMetadata

public void appendMetadata(long maxSequenceId,
                           boolean majorCompaction)
                    throws IOException

Writes meta data. Call before close() since its written as meta data to this file.

Parameters:

maxSequenceId - Maximum sequence id.

majorCompaction - True if this file is product of a major compaction

Throws:

IOException - problem writing to FS

appendMetadata

public void appendMetadata(long maxSequenceId,
                           boolean majorCompaction,
                           Collection<HStoreFile> storeFiles)
                    throws IOException

Writes meta data. Call before close() since its written as meta data to this file.

Parameters:

maxSequenceId - Maximum sequence id.

majorCompaction - True if this file is product of a major compaction

storeFiles - The compacted store files to generate this new file

Throws:

IOException - problem writing to FS

appendMetadata

public void appendMetadata(long maxSequenceId,
                           boolean majorCompaction,
                           long mobCellsCount)
                    throws IOException

Writes meta data. Call before close() since its written as meta data to this file.

Parameters:

maxSequenceId - Maximum sequence id.

majorCompaction - True if this file is product of a major compaction

mobCellsCount - The number of mob cells.

Throws:

IOException - problem writing to FS

appendMobMetadata

public void appendMobMetadata(org.apache.hbase.thirdparty.com.google.common.collect.SetMultimap<TableName,String> mobRefSet)
                       throws IOException

Appends MOB - specific metadata (even if it is empty)

Parameters:

mobRefSet - - original table -> set of MOB file names

Throws:

IOException - problem writing to FS

appendTrackedTimestampsToMetadata

public void appendTrackedTimestampsToMetadata()
                                       throws IOException

Add TimestampRange and earliest put timestamp to Metadata

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

getPath

public org.apache.hadoop.fs.Path getPath()

getPaths

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

hasGeneralBloom

public boolean hasGeneralBloom()

close

public void close()
           throws IOException

Throws:

IOException

appendFileInfo

public void appendFileInfo(byte[] key,
                           byte[] value)
                    throws IOException

Throws:

IOException

getUniqueFile

public static org.apache.hadoop.fs.Path getUniqueFile(org.apache.hadoop.fs.FileSystem fs,
                                                      org.apache.hadoop.fs.Path dir)
                                               throws IOException

Parameters:

dir - Directory to create file in.

Returns:

random filename inside passed dir

Throws:

IOException

appendAll

public void appendAll(List<Cell> cellList)
               throws IOException

Description copied from interface: CellSink

Append the given (possibly partial) list of cells of a row

Specified by:

appendAll in interface CellSink

Parameters:

cellList - the cell list to be added

Throws:

IOException

append

public void append(Cell cell)
            throws IOException

Description copied from interface: CellSink

Append the given cell

Specified by:

append in interface CellSink

Parameters:

cell - the cell to be added

Throws:

IOException