org.apache.hadoop.hbase.regionserver

Interface StoreFile

All Known Implementing Classes:

HStoreFile

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Evolving
public interface StoreFile

An interface to describe a store data file.

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	BLOOM_FILTER_TYPE_KEY Bloom filter Type in FileInfo
static byte[]	BULKLOAD_TASK_KEY Meta key set when store file is a result of a bulk load
static byte[]	BULKLOAD_TIME_KEY
static byte[]	DELETE_FAMILY_COUNT Delete Family Count in FileInfo
static byte[]	EARLIEST_PUT_TS Key for timestamp of earliest-put in metadata
static byte[]	EXCLUDE_FROM_MINOR_COMPACTION_KEY Minor compaction flag in FileInfo
static byte[]	LAST_BLOOM_KEY Last Bloom filter key in FileInfo
static byte[]	MAJOR_COMPACTION_KEY Major compaction flag in FileInfo
static byte[]	MAX_SEQ_ID_KEY Max Sequence ID in FileInfo
static byte[]	MOB_CELLS_COUNT Key for the number of mob cells in metadata
static byte[]	SKIP_RESET_SEQ_ID Key for skipping resetting sequence id in metadata.
static String	STORE_FILE_READER_NO_READAHEAD
static byte[]	TIMERANGE_KEY Key for Timerange information in metadata

Method Summary

Modifier and Type	Method and Description
void	closeReader(boolean evictOnClose)
void	deleteReader() Delete this file
boolean	excludeFromMinorCompaction()
OptionalLong	getBulkLoadTimestamp() Return the timestamp at which this bulk load file was generated.
CacheConfig	getCacheConf()
Comparator<Cell>	getComparator()
StoreFileInfo	getFileInfo()
Cell	getFirstKey()
HDFSBlocksDistribution	getHDFSBlockDistribution()
Cell	getLastKey()
OptionalLong	getMaximumTimestamp()
long	getMaxMemstoreTS()
long	getMaxSequenceId()
byte[]	getMetadataValue(byte[] key) Only used by the Striped Compaction Policy
OptionalLong	getMinimumTimestamp()
long	getModificationTimeStamp()
org.apache.hadoop.fs.Path	getPath()
StoreFileScanner	getPreadScanner(boolean cacheBlocks, long readPt, long scannerOrder, boolean canOptimizeForNonNullColumn) Must be called after initReader.
org.apache.hadoop.fs.Path	getQualifiedPath()
StoreFileReader	getReader()
StoreFileScanner	getStreamScanner(boolean canUseDropBehind, boolean cacheBlocks, boolean isCompaction, long readPt, long scannerOrder, boolean canOptimizeForNonNullColumn)
void	initReader() Initialize the reader used for pread.
boolean	isBulkLoadResult() Check if this storefile was created by bulk load.
boolean	isCompactedAway()
boolean	isHFile()
boolean	isMajorCompactionResult()
boolean	isReference()
boolean	isReferencedInReads()
void	markCompactedAway() Marks the status of the file as compactedAway.
String	toStringDetailed()

Field Detail

STORE_FILE_READER_NO_READAHEAD

static final String STORE_FILE_READER_NO_READAHEAD

See Also:

Constant Field Values

MAX_SEQ_ID_KEY

static final byte[] MAX_SEQ_ID_KEY

Max Sequence ID in FileInfo

MAJOR_COMPACTION_KEY

static final byte[] MAJOR_COMPACTION_KEY

Major compaction flag in FileInfo

EXCLUDE_FROM_MINOR_COMPACTION_KEY

static final byte[] EXCLUDE_FROM_MINOR_COMPACTION_KEY

Minor compaction flag in FileInfo

BLOOM_FILTER_TYPE_KEY

static final byte[] BLOOM_FILTER_TYPE_KEY

Bloom filter Type in FileInfo

DELETE_FAMILY_COUNT

static final byte[] DELETE_FAMILY_COUNT

Delete Family Count in FileInfo

LAST_BLOOM_KEY

static final byte[] LAST_BLOOM_KEY

Last Bloom filter key in FileInfo

TIMERANGE_KEY

static final byte[] TIMERANGE_KEY

Key for Timerange information in metadata

EARLIEST_PUT_TS

static final byte[] EARLIEST_PUT_TS

Key for timestamp of earliest-put in metadata

MOB_CELLS_COUNT

static final byte[] MOB_CELLS_COUNT

Key for the number of mob cells in metadata

BULKLOAD_TASK_KEY

static final byte[] BULKLOAD_TASK_KEY

Meta key set when store file is a result of a bulk load

BULKLOAD_TIME_KEY

static final byte[] BULKLOAD_TIME_KEY

SKIP_RESET_SEQ_ID

static final byte[] SKIP_RESET_SEQ_ID

Key for skipping resetting sequence id in metadata. For bulk loaded hfiles, the scanner resets the cell seqId with the latest one, if this metadata is set as true, the reset is skipped.

Method Detail

getCacheConf

CacheConfig getCacheConf()

getFirstKey

Cell getFirstKey()

getLastKey

Cell getLastKey()

getComparator

Comparator<Cell> getComparator()

getMaxMemstoreTS

long getMaxMemstoreTS()

getFileInfo

StoreFileInfo getFileInfo()

Returns:

the StoreFile object associated to this StoreFile. null if the StoreFile is not a reference.

getPath

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

Returns:

Path or null if this StoreFile was made with a Stream.

getQualifiedPath

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

Returns:

Returns the qualified path of this StoreFile

isReference

boolean isReference()

Returns:

True if this is a StoreFile Reference.

isHFile

boolean isHFile()

Returns:

True if this is HFile.

isMajorCompactionResult

boolean isMajorCompactionResult()

Returns:

True if this file was made by a major compaction.

excludeFromMinorCompaction

boolean excludeFromMinorCompaction()

Returns:

True if this file should not be part of a minor compaction.

getMaxSequenceId

long getMaxSequenceId()

Returns:

This files maximum edit sequence id.

getModificationTimeStamp

long getModificationTimeStamp()
                       throws IOException

Throws:

IOException

getMetadataValue

byte[] getMetadataValue(byte[] key)

Only used by the Striped Compaction Policy

Parameters:

key -

Returns:

value associated with the metadata key

isBulkLoadResult

boolean isBulkLoadResult()

Check if this storefile was created by bulk load. When a hfile is bulk loaded into HBase, we append '_SeqId_<id-when-loaded>' to the hfile name, unless "hbase.mapreduce.bulkload.assign.sequenceNumbers" is explicitly turned off. If "hbase.mapreduce.bulkload.assign.sequenceNumbers" is turned off, fall back to BULKLOAD_TIME_KEY.

Returns:

true if this storefile was created by bulk load.

isCompactedAway

boolean isCompactedAway()

isReferencedInReads

boolean isReferencedInReads()

Returns:

true if the file is still used in reads

getBulkLoadTimestamp

OptionalLong getBulkLoadTimestamp()

Return the timestamp at which this bulk load file was generated.

getHDFSBlockDistribution

HDFSBlocksDistribution getHDFSBlockDistribution()

Returns:

the cached value of HDFS blocks distribution. The cached value is calculated when store file is opened.

initReader

void initReader()
         throws IOException

Initialize the reader used for pread.

Throws:

IOException

getPreadScanner

StoreFileScanner getPreadScanner(boolean cacheBlocks,
                                 long readPt,
                                 long scannerOrder,
                                 boolean canOptimizeForNonNullColumn)

Must be called after initReader.

getStreamScanner

StoreFileScanner getStreamScanner(boolean canUseDropBehind,
                                  boolean cacheBlocks,
                                  boolean isCompaction,
                                  long readPt,
                                  long scannerOrder,
                                  boolean canOptimizeForNonNullColumn)
                           throws IOException

Throws:

IOException

getReader

StoreFileReader getReader()

Returns:

Current reader. Must call initReader first else returns null.

See Also:

initReader()

closeReader

void closeReader(boolean evictOnClose)
          throws IOException

Parameters:

evictOnClose - whether to evict blocks belonging to this file

Throws:

IOException

markCompactedAway

void markCompactedAway()

Marks the status of the file as compactedAway.

deleteReader

void deleteReader()
           throws IOException

Delete this file

Throws:

IOException

toStringDetailed

String toStringDetailed()

Returns:

a length description of this StoreFile, suitable for debug output

getMinimumTimestamp

OptionalLong getMinimumTimestamp()

getMaximumTimestamp

OptionalLong getMaximumTimestamp()