org.apache.hadoop.hbase.io.hfile
Class HFileBlockIndex

java.lang.Object
  org.apache.hadoop.hbase.io.hfile.HFileBlockIndex

@InterfaceAudience.Private
public class HFileBlockIndex
extends Object

Provides functionality to write (HFileBlockIndex.BlockIndexWriter) and read (HFileBlockIndex.BlockIndexReader) single-level and multi-level block indexes. Examples of how to use the block index writer can be found in CompoundBloomFilterWriter and HFileWriterV2. Examples of how to use the reader can be found in HFileReaderV2 and TestHFileBlockIndex.

Nested Class Summary

static class	HFileBlockIndex.BlockIndexReader The reader will always hold the root level index in the memory.
static class	HFileBlockIndex.BlockIndexWriter Writes the block index into the output stream.

Field Summary

static String	MAX_CHUNK_SIZE_KEY The maximum size guideline for index blocks (both leaf, intermediate, and root).
static String	MIN_INDEX_NUM_ENTRIES_KEY Minimum number of entries in a single index block.

Constructor Summary

HFileBlockIndex()

Method Summary

static int	getMaxChunkSize(org.apache.hadoop.conf.Configuration conf)
static int	getMinIndexNumEntries(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

MAX_CHUNK_SIZE_KEY

public static final String MAX_CHUNK_SIZE_KEY

The maximum size guideline for index blocks (both leaf, intermediate, and root). If not specified, DEFAULT_MAX_CHUNK_SIZE is used.

See Also:

Constant Field Values

MIN_INDEX_NUM_ENTRIES_KEY

public static final String MIN_INDEX_NUM_ENTRIES_KEY

Minimum number of entries in a single index block. Even if we are above the hfile.index.block.max.size we will keep writing to the same block unless we have that many entries. We should have at least a few entries so that we don't have too many levels in the multi-level index. This should be at least 2 to make sure there is no infinite recursion.

See Also:

Constant Field Values

Constructor Detail

HFileBlockIndex

public HFileBlockIndex()

Method Detail

getMaxChunkSize

public static int getMaxChunkSize(org.apache.hadoop.conf.Configuration conf)

getMinIndexNumEntries

public static int getMinIndexNumEntries(org.apache.hadoop.conf.Configuration conf)