org.apache.hadoop.hbase.io.hfile

Interface HFile.Reader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, HFile.CachingBlockReader

All Known Implementing Classes:

AbstractHFileReader, HFileReaderV2, HFileReaderV3

Enclosing class:

HFile

public static interface HFile.Reader
extends java.io.Closeable, HFile.CachingBlockReader

An interface used by clients to open and iterate an HFile.

Method Summary

Modifier and Type	Method and Description
void	close(boolean evictOnClose) Close method with optional evictOnClose
KeyValue.KVComparator	getComparator()
Compression.Algorithm	getCompressionAlgorithm()
DataBlockEncoding	getDataBlockEncoding()
HFileBlockIndex.BlockIndexReader	getDataBlockIndexReader()
java.io.DataInput	getDeleteBloomFilterMetadata() Retrieves delete family Bloom filter metadata as appropriate for each HFile version.
long	getEntries()
HFileContext	getFileContext() Return the file context of the HFile this reader belongs to
byte[]	getFirstKey()
byte[]	getFirstRowKey()
java.io.DataInput	getGeneralBloomFilterMetadata() Retrieves general Bloom filter metadata as appropriate for each HFile version.
byte[]	getLastKey()
byte[]	getLastRowKey()
java.nio.ByteBuffer	getMetaBlock(java.lang.String metaBlockName, boolean cacheBlock)
java.lang.String	getName() Returns this reader's "name".
Path	getPath()
HFileScanner	getScanner(boolean cacheBlocks, boolean pread)
HFileScanner	getScanner(boolean cacheBlocks, boolean pread, boolean isCompaction)
FixedFileTrailer	getTrailer()
boolean	hasMVCCInfo()
long	indexSize()
boolean	isPrimaryReplicaReader()
long	length()
java.util.Map<byte[],byte[]>	loadFileInfo()
byte[]	midkey()
void	setPrimaryReplicaReader(boolean isPrimaryReplicaReader)
void	unbufferStream() To close the stream's socket.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader

readBlock

Method Detail

getName

java.lang.String getName()

Returns this reader's "name". Usually the last component of the path. Needs to be constant as the file is being moved to support caching on write.

getComparator

KeyValue.KVComparator getComparator()

getScanner

HFileScanner getScanner(boolean cacheBlocks,
                        boolean pread,
                        boolean isCompaction)

getMetaBlock

java.nio.ByteBuffer getMetaBlock(java.lang.String metaBlockName,
                                 boolean cacheBlock)
                          throws java.io.IOException

Throws:

java.io.IOException

loadFileInfo

java.util.Map<byte[],byte[]> loadFileInfo()
                                   throws java.io.IOException

Throws:

java.io.IOException

getLastKey

byte[] getLastKey()

midkey

byte[] midkey()
       throws java.io.IOException

Throws:

java.io.IOException

length

long length()

getEntries

long getEntries()

getFirstKey

byte[] getFirstKey()

indexSize

long indexSize()

getFirstRowKey

byte[] getFirstRowKey()

getLastRowKey

byte[] getLastRowKey()

getTrailer

FixedFileTrailer getTrailer()

getDataBlockIndexReader

HFileBlockIndex.BlockIndexReader getDataBlockIndexReader()

getScanner

HFileScanner getScanner(boolean cacheBlocks,
                        boolean pread)

getCompressionAlgorithm

Compression.Algorithm getCompressionAlgorithm()

getGeneralBloomFilterMetadata

java.io.DataInput getGeneralBloomFilterMetadata()
                                         throws java.io.IOException

Retrieves general Bloom filter metadata as appropriate for each HFile version. Knows nothing about how that metadata is structured.

Throws:

java.io.IOException

getDeleteBloomFilterMetadata

java.io.DataInput getDeleteBloomFilterMetadata()
                                        throws java.io.IOException

Retrieves delete family Bloom filter metadata as appropriate for each HFile version. Knows nothing about how that metadata is structured.

Throws:

java.io.IOException

getPath

Path getPath()

close

void close(boolean evictOnClose)
    throws java.io.IOException

Close method with optional evictOnClose

Throws:

java.io.IOException

getDataBlockEncoding

DataBlockEncoding getDataBlockEncoding()

hasMVCCInfo

boolean hasMVCCInfo()

getFileContext

HFileContext getFileContext()

Return the file context of the HFile this reader belongs to

isPrimaryReplicaReader

boolean isPrimaryReplicaReader()

setPrimaryReplicaReader

void setPrimaryReplicaReader(boolean isPrimaryReplicaReader)

unbufferStream

void unbufferStream()

To close the stream's socket. Note: This can be concurrently called from multiple threads and implementation should take care of thread safety.