Package org.apache.hadoop.hbase.io.hfile

Interface HFile.Writer

All Superinterfaces:

AutoCloseable, CellSink, Closeable, ShipperListener

All Known Implementing Classes:

HFileWriterImpl

Enclosing class:

HFile

public static interface HFile.Writer
extends Closeable, CellSink, ShipperListener

API required to write an HFile

Field Summary

Fields

Modifier and Type	Field	Description
static final byte[]	MAX_MEMSTORE_TS_KEY	Max memstore (mvcc) timestamp in FileInfo

Method Summary

Modifier and Type	Method	Description
void	addDeleteFamilyBloomFilter(BloomFilterWriter bfw)	Store delete family Bloom filter in the file, which is only supported in HFile V2.
void	addGeneralBloomFilter(BloomFilterWriter bfw)	Store general Bloom filter in the file.
void	addInlineBlockWriter(InlineBlockWriter bloomWriter)	Adds an inline block writer such as a multi-level block index writer or a compound Bloom filter writer.
void	appendCustomCellTimestampsToMetadata(TimeRangeTracker timeRangeTracker)	Add Custom cell timestamp to Metadata
void	appendFileInfo(byte[] key, byte[] value)	Add an element to the file info map.
void	appendMetaBlock(String bloomFilterMetaKey, org.apache.hadoop.io.Writable metaWriter)
void	appendTrackedTimestampsToMetadata()	Add TimestampRange and earliest put timestamp to Metadata
HFileContext	getFileContext()	Return the file context for the HFile this writer belongs to
org.apache.hadoop.fs.Path	getPath()	Returns the path to this HFile

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

append, appendAll

Methods inherited from interface java.io.Closeable

close

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

beforeShipped

Field Details

MAX_MEMSTORE_TS_KEY

static final byte[] MAX_MEMSTORE_TS_KEY

Max memstore (mvcc) timestamp in FileInfo

Method Details

appendFileInfo

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

Add an element to the file info map.

Throws:

IOException

appendTrackedTimestampsToMetadata

void appendTrackedTimestampsToMetadata()
                                throws IOException

Add TimestampRange and earliest put timestamp to Metadata

Throws:

IOException

appendCustomCellTimestampsToMetadata

void appendCustomCellTimestampsToMetadata(TimeRangeTracker timeRangeTracker)
                                   throws IOException

Add Custom cell timestamp to Metadata

Throws:

IOException

getPath

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

Returns the path to this HFile

addInlineBlockWriter

void addInlineBlockWriter(InlineBlockWriter bloomWriter)

Adds an inline block writer such as a multi-level block index writer or a compound Bloom filter writer.

appendMetaBlock

void appendMetaBlock(String bloomFilterMetaKey,
 org.apache.hadoop.io.Writable metaWriter)

addGeneralBloomFilter

void addGeneralBloomFilter(BloomFilterWriter bfw)

Store general Bloom filter in the file. This does not deal with Bloom filter internals but is necessary, since Bloom filters are stored differently in HFile version 1 and version 2.

addDeleteFamilyBloomFilter

void addDeleteFamilyBloomFilter(BloomFilterWriter bfw)
                         throws IOException

Store delete family Bloom filter in the file, which is only supported in HFile V2.

Throws:

IOException

getFileContext

HFileContext getFileContext()

Return the file context for the HFile this writer belongs to