org.apache.hadoop.hbase.io.hfile

Interface HFile.Writer

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractHFileWriter, HFileWriterV2, HFileWriterV3

Enclosing class:

HFile

public static interface HFile.Writer
extends Closeable

API required to write an HFile

Method Summary

Methods

Modifier and Type	Method and 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	append(Cell cell)
void	appendFileInfo(byte[] key, byte[] value) Add an element to the file info map.
void	appendMetaBlock(String bloomFilterMetaKey, org.apache.hadoop.io.Writable metaWriter)
HFileContext	getFileContext() Return the file context for the HFile this writer belongs to
org.apache.hadoop.fs.Path	getPath()

Methods inherited from interface java.io.Closeable

close

Method Detail

appendFileInfo

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

Add an element to the file info map.

Throws:

IOException

append

void append(Cell cell)
            throws IOException

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