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 BlockIndexReader single-level and multi-level block indexes. Examples of how to use the block index writer can be found in CompoundBloomFilterWriter and HFileWriterImpl. Examples of how to use the reader can be found in HFileReaderImpl and org.apache.hadoop.hbase.io.hfile.TestHFileBlockIndex.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HFileBlockIndex.BlockIndexWriter Writes the block index into the output stream.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_CHUNK_SIZE_KEY The maximum size guideline for index blocks (both leaf, intermediate, and root).
protected static int	MID_KEY_METADATA_SIZE The size of a meta-data record used for finding the mid-key in a multi-level index.
static String	MIN_INDEX_NUM_ENTRIES_KEY Minimum number of entries in a single index block.

Constructor Summary

Constructors

Constructor and Description
HFileBlockIndex()

Method Summary

Modifier and Type	Method and Description
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

MID_KEY_METADATA_SIZE

protected static final int MID_KEY_METADATA_SIZE

The size of a meta-data record used for finding the mid-key in a multi-level index. Consists of the middle leaf-level index block offset (long), its on-disk size without header included (int), and the mid-key entry's zero-based index in that leaf index block.

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)