HFileWriterV2 (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.io.hfile.AbstractHFileWriter
- - org.apache.hadoop.hbase.io.hfile.HFileWriterV2

All Implemented Interfaces:

Closeable, AutoCloseable, HFile.Writer

Direct Known Subclasses:

HFileWriterV3
```
@InterfaceAudience.Private
public class HFileWriterV2
extends AbstractHFileWriter
```
Writes HFile format version 2.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class HFileWriterV2.WriterFactoryV2

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`HFileWriterV2.WriterFactoryV2`

Field Summary

Fields
Modifier and Type	Field and Description
`private List<HFileBlock.BlockWritable>`	`additionalLoadOnOpenData` Additional data items to be written to the "load-on-open" section.
`private HFileBlockIndex.BlockIndexWriter`	`dataBlockIndexWriter`
`private long`	`firstDataBlockOffset` The offset of the first data block or -1 if the file is empty.
`protected HFileBlock.Writer`	`fsBlockWriter` Unified version 2 block writer
`private List<InlineBlockWriter>`	`inlineBlockWriters` Inline block writers for multi-level block index and compound Blooms.
`static int`	`KEY_VALUE_VER_WITH_MEMSTORE` Version for KeyValue which includes memstore timestamp
`static byte[]`	`KEY_VALUE_VERSION` KeyValue version in FileInfo
`private Cell`	`lastCellOfPreviousBlock` The last(stop) Cell of the previous data block.
`protected long`	`lastDataBlockOffset` The offset of the last data block or 0 if the file is empty.
`(package private) static org.apache.commons.logging.Log`	`LOG`
`static byte[]`	`MAX_MEMSTORE_TS_KEY` Max memstore (mvcc) timestamp in FileInfo
`protected long`	`maxMemstoreTS`
`private HFileBlockIndex.BlockIndexWriter`	`metaBlockIndexWriter`
`private static boolean`	`WARN_CELL_WITH_TAGS` warn on cell with tags

Fields inherited from class org.apache.hadoop.hbase.io.hfile.AbstractHFileWriter
blockEncoder, cacheConf, closeOutputStream, comparator, entryCount, fileInfo, firstCellInBlock, hFileContext, lastCell, metaData, metaNames, name, outputStream, path, totalKeyLength, totalUncompressedBytes, totalValueLength

Constructor Summary

Constructors
Constructor and Description
`HFileWriterV2(org.apache.hadoop.conf.Configuration conf, CacheConfig cacheConf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, org.apache.hadoop.fs.FSDataOutputStream ostream, KeyValue.KVComparator comparator, HFileContext context)` Constructor that takes a path, creates and closes the output stream.

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`addBloomFilter(BloomFilterWriter bfw, BlockType blockType)`
`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 ibw)` Adds an inline block writer such as a multi-level block index writer or a compound Bloom filter writer.
`void`	`append(Cell cell)` Add key/value to file.
`void`	`appendMetaBlock(String metaBlockName, org.apache.hadoop.io.Writable content)` Add a meta block to the end of the file.
`protected void`	`checkBlockBoundary()` At a block boundary, write all the inline blocks and opens new block.
`void`	`close()`
`private void`	`doCacheOnWrite(long offset)` Caches the last written HFile block.
`private void`	`finishBlock()` Clean up the current data block
`protected void`	`finishInit(org.apache.hadoop.conf.Configuration conf)` Additional initialization steps
`HFileContext`	`getFileContext()` Return the file context for the HFile this writer belongs to
`protected int`	`getMajorVersion()`
`protected int`	`getMinorVersion()`
`protected void`	`newBlock()` Ready a new block for writing.
`private void`	`writeInlineBlocks(boolean closing)` Gives inline block writers an opportunity to contribute blocks.

Methods inherited from class org.apache.hadoop.hbase.io.hfile.AbstractHFileWriter
appendFileInfo, checkKey, checkValue, compressionByName, createOutputStream, finishClose, finishFileInfo, getPath, toString, writeFileInfo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
static final org.apache.commons.logging.Log LOG
```
  - MAX_MEMSTORE_TS_KEY
```
public static final byte[] MAX_MEMSTORE_TS_KEY
```
    Max memstore (mvcc) timestamp in FileInfo
  - KEY_VALUE_VERSION
```
public static final byte[] KEY_VALUE_VERSION
```
    KeyValue version in FileInfo
  - KEY_VALUE_VER_WITH_MEMSTORE
```
public static final int KEY_VALUE_VER_WITH_MEMSTORE
```
    Version for KeyValue which includes memstore timestamp
    
    See Also:
    Constant Field Values
  - inlineBlockWriters
```
private List<InlineBlockWriter> inlineBlockWriters
```
    Inline block writers for multi-level block index and compound Blooms.
  - fsBlockWriter
```
protected HFileBlock.Writer fsBlockWriter
```
    Unified version 2 block writer
  - dataBlockIndexWriter
```
private HFileBlockIndex.BlockIndexWriter dataBlockIndexWriter
```
  - metaBlockIndexWriter
```
private HFileBlockIndex.BlockIndexWriter metaBlockIndexWriter
```
  - firstDataBlockOffset
```
private long firstDataBlockOffset
```
    The offset of the first data block or -1 if the file is empty.
  - lastDataBlockOffset
```
protected long lastDataBlockOffset
```
    The offset of the last data block or 0 if the file is empty.
  - lastCellOfPreviousBlock
```
private Cell lastCellOfPreviousBlock
```
    The last(stop) Cell of the previous data block. This reference should be short-lived since we write hfiles in a burst.
  - additionalLoadOnOpenData
```
private List<HFileBlock.BlockWritable> additionalLoadOnOpenData
```
    Additional data items to be written to the "load-on-open" section.
  - maxMemstoreTS
```
protected long maxMemstoreTS
```
  - WARN_CELL_WITH_TAGS
```
private static boolean WARN_CELL_WITH_TAGS
```
    warn on cell with tags
- Constructor Detail
  - HFileWriterV2
```
public HFileWriterV2(org.apache.hadoop.conf.Configuration conf,
             CacheConfig cacheConf,
             org.apache.hadoop.fs.FileSystem fs,
             org.apache.hadoop.fs.Path path,
             org.apache.hadoop.fs.FSDataOutputStream ostream,
             KeyValue.KVComparator comparator,
             HFileContext context)
              throws IOException
```
    Constructor that takes a path, creates and closes the output stream.
    
    Throws:
    
    IOException
- Method Detail
  - finishInit
```
protected void finishInit(org.apache.hadoop.conf.Configuration conf)
```
    Additional initialization steps
  - checkBlockBoundary
```
protected void checkBlockBoundary()
                           throws IOException
```
    At a block boundary, write all the inline blocks and opens new block.
    
    Throws:
    
    IOException
  - finishBlock
```
private void finishBlock()
                  throws IOException
```
    Clean up the current data block
    
    Throws:
    
    IOException
  - writeInlineBlocks
```
private void writeInlineBlocks(boolean closing)
                        throws IOException
```
    Gives inline block writers an opportunity to contribute blocks.
    
    Throws:
    
    IOException
  - doCacheOnWrite
```
private void doCacheOnWrite(long offset)
```
    Caches the last written HFile block.
    
    Parameters:
    offset - the offset of the block we want to cache. Used to determine the cache key.
  - newBlock
```
protected void newBlock()
                 throws IOException
```
    Ready a new block for writing.
    
    Throws:
    
    IOException
  - appendMetaBlock
```
public void appendMetaBlock(String metaBlockName,
                   org.apache.hadoop.io.Writable content)
```
    Add a meta block to the end of the file. Call before close(). Metadata blocks are expensive. Fill one with a bunch of serialized data rather than do a metadata block per metadata instance. If metadata is small, consider adding to file info using AbstractHFileWriter.appendFileInfo(byte[], byte[])
    
    Parameters:
    metaBlockName - name of the block
    content - will call readFields to get data later (DO NOT REUSE)
  - append
```
public void append(Cell cell)
            throws IOException
```
    Add key/value to file. Keys must be added in an order that agrees with the Comparator passed on construction.
    
    Parameters:
    cell - Cell to add. Cannot be empty nor null.
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Throws:
    
    IOException
  - addInlineBlockWriter
```
public void addInlineBlockWriter(InlineBlockWriter ibw)
```
    Description copied from interface: HFile.Writer
    
    Adds an inline block writer such as a multi-level block index writer or a compound Bloom filter writer.
  - addGeneralBloomFilter
```
public void addGeneralBloomFilter(BloomFilterWriter bfw)
```
    Description copied from interface: HFile.Writer
    
    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
```
public void addDeleteFamilyBloomFilter(BloomFilterWriter bfw)
```
    Description copied from interface: HFile.Writer
    
    Store delete family Bloom filter in the file, which is only supported in HFile V2.
  - addBloomFilter
```
private void addBloomFilter(BloomFilterWriter bfw,
                  BlockType blockType)
```
  - getMajorVersion
```
protected int getMajorVersion()
```
  - getMinorVersion
```
protected int getMinorVersion()
```
  - getFileContext
```
public HFileContext getFileContext()
```
    Description copied from interface: HFile.Writer
    
    Return the file context for the HFile this writer belongs to

Class HFileWriterV2

Nested Class Summary

Field Summary

Fields inherited from class org.apache.hadoop.hbase.io.hfile.AbstractHFileWriter

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.io.hfile.AbstractHFileWriter

Methods inherited from class java.lang.Object

Field Detail

LOG

MAX_MEMSTORE_TS_KEY

KEY_VALUE_VERSION

KEY_VALUE_VER_WITH_MEMSTORE

inlineBlockWriters

fsBlockWriter

dataBlockIndexWriter

metaBlockIndexWriter

firstDataBlockOffset

lastDataBlockOffset

lastCellOfPreviousBlock

additionalLoadOnOpenData

maxMemstoreTS

WARN_CELL_WITH_TAGS

Constructor Detail

HFileWriterV2

Method Detail

finishInit

checkBlockBoundary

finishBlock

writeInlineBlocks

doCacheOnWrite

newBlock

appendMetaBlock

append

close

addInlineBlockWriter

addGeneralBloomFilter

addDeleteFamilyBloomFilter

addBloomFilter

getMajorVersion

getMinorVersion

getFileContext