org.apache.hadoop.hbase.io.hfile

Interface HFile.Reader

All Superinterfaces:

AutoCloseable, Closeable, HFile.CachingBlockReader

All Known Implementing Classes:

HFilePreadReader, HFileReaderImpl, HFileStreamReader

Enclosing class:

HFile

public static interface HFile.Reader
extends 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
CellComparator	getComparator()
ReaderContext	getContext()
DataBlockEncoding	getDataBlockEncoding()
HFileBlockIndex.CellBasedKeyBlockIndexReader	getDataBlockIndexReader()
DataInput	getDeleteBloomFilterMetadata() Retrieves delete family Bloom filter metadata as appropriate for each HFile version.
DataBlockEncoding	getEffectiveEncodingInCache(boolean isCompaction)
long	getEntries()
HFileContext	getFileContext() Return the file context of the HFile this reader belongs to
Optional<Cell>	getFirstKey()
Optional<byte[]>	getFirstRowKey()
DataInput	getGeneralBloomFilterMetadata() Retrieves general Bloom filter metadata as appropriate for each HFile version.
HFileInfo	getHFileInfo()
Optional<Cell>	getLastKey()
Optional<byte[]>	getLastRowKey()
HFileBlock	getMetaBlock(String metaBlockName, boolean cacheBlock)
HFileBlockIndex.ByteArrayKeyBlockIndexReader	getMetaBlockIndexReader()
String	getName() Returns this reader's "name".
org.apache.hadoop.fs.Path	getPath()
HFileScanner	getScanner(org.apache.hadoop.conf.Configuration conf, boolean cacheBlocks, boolean pread)
HFileScanner	getScanner(org.apache.hadoop.conf.Configuration conf, boolean cacheBlocks, boolean pread, boolean isCompaction)
FixedFileTrailer	getTrailer()
HFileBlock.FSReader	getUncachedBlockReader()
boolean	hasMVCCInfo()
long	indexSize()
boolean	isPrimaryReplicaReader()
long	length()
Optional<Cell>	midKey()
boolean	prefetchComplete()
void	setDataBlockEncoder(HFileDataBlockEncoder dataBlockEncoder)
void	setDataBlockIndexReader(HFileBlockIndex.CellBasedKeyBlockIndexReader reader)
void	setMetaBlockIndexReader(HFileBlockIndex.ByteArrayKeyBlockIndexReader reader)
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

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

CellComparator getComparator()

getScanner

HFileScanner getScanner(org.apache.hadoop.conf.Configuration conf,
                        boolean cacheBlocks,
                        boolean pread,
                        boolean isCompaction)

getMetaBlock

HFileBlock getMetaBlock(String metaBlockName,
                        boolean cacheBlock)
                 throws IOException

Throws:

IOException

getLastKey

Optional<Cell> getLastKey()

midKey

Optional<Cell> midKey()
               throws IOException

Throws:

IOException

length

long length()

getEntries

long getEntries()

getFirstKey

Optional<Cell> getFirstKey()

indexSize

long indexSize()

getFirstRowKey

Optional<byte[]> getFirstRowKey()

getLastRowKey

Optional<byte[]> getLastRowKey()

getTrailer

FixedFileTrailer getTrailer()

setDataBlockIndexReader

void setDataBlockIndexReader(HFileBlockIndex.CellBasedKeyBlockIndexReader reader)

getDataBlockIndexReader

HFileBlockIndex.CellBasedKeyBlockIndexReader getDataBlockIndexReader()

setMetaBlockIndexReader

void setMetaBlockIndexReader(HFileBlockIndex.ByteArrayKeyBlockIndexReader reader)

getMetaBlockIndexReader

HFileBlockIndex.ByteArrayKeyBlockIndexReader getMetaBlockIndexReader()

getScanner

HFileScanner getScanner(org.apache.hadoop.conf.Configuration conf,
                        boolean cacheBlocks,
                        boolean pread)

getGeneralBloomFilterMetadata

DataInput getGeneralBloomFilterMetadata()
                                 throws IOException

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

Throws:

IOException

getDeleteBloomFilterMetadata

DataInput getDeleteBloomFilterMetadata()
                                throws IOException

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

Throws:

IOException

getPath

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

close

void close(boolean evictOnClose)
    throws IOException

Close method with optional evictOnClose

Throws:

IOException

getDataBlockEncoding

DataBlockEncoding getDataBlockEncoding()

hasMVCCInfo

boolean hasMVCCInfo()

getFileContext

HFileContext getFileContext()

Return the file context of the HFile this reader belongs to

isPrimaryReplicaReader

boolean isPrimaryReplicaReader()

getEffectiveEncodingInCache

DataBlockEncoding getEffectiveEncodingInCache(boolean isCompaction)

getUncachedBlockReader

HFileBlock.FSReader getUncachedBlockReader()

prefetchComplete

boolean prefetchComplete()

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.

getContext

ReaderContext getContext()

getHFileInfo

HFileInfo getHFileInfo()

setDataBlockEncoder

void setDataBlockEncoder(HFileDataBlockEncoder dataBlockEncoder)