Package org.apache.hadoop.hbase.io.hfile

Class HFileContext

java.lang.Object

org.apache.hadoop.hbase.io.hfile.HFileContext

All Implemented Interfaces:

Cloneable, HeapSize

@Private
public class HFileContext
extends Object
implements HeapSize, Cloneable

Read-only HFile Context Information. Meta data that is used by HFileWriter/Readers and by HFileBlocks. Create one using the HFileContextBuilder (See HFileInfo and the HFile Trailer class).

See Also:

• HFileContextBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private int	blockSize	Number of uncompressed bytes we allow per block.
private int	bytesPerChecksum	the number of bytes per checksum value
private CellComparator	cellComparator
private ChecksumType	checksumType	the checksum type
private byte[]	columnFamily
private Compression.Algorithm	compressAlgo	Compression algorithm used
private boolean	compressTags	Whether tags to be compressed or not
private Encryption.Context	cryptoContext	Encryption algorithm and key used
private Compression.HFileDecompressionContext	decompressionContext	Details used by compression algorithm that are more efficiently loaded once and then reused
private static final int	DEFAULT_BYTES_PER_CHECKSUM
private DataBlockEncoding	encoding
private long	fileCreateTime
static final long	FIXED_OVERHEAD
private String	hfileName
private boolean	includesMvcc	Whether mvcc is to be included in the Read/Write
private boolean	includesTags	Whether tags are to be included in the Read/Write
private IndexBlockEncoding	indexBlockEncoding
private byte[]	tableName
private boolean	usesHBaseChecksum	Whether checksum is enabled or not

Constructor Summary

Constructors

Constructor	Description
HFileContext()
HFileContext(boolean useHBaseChecksum, boolean includesMvcc, boolean includesTags, Compression.Algorithm compressAlgo, Compression.HFileDecompressionContext decompressionContext, boolean compressTags, ChecksumType checksumType, int bytesPerChecksum, int blockSize, DataBlockEncoding encoding, Encryption.Context cryptoContext, long fileCreateTime, String hfileName, byte[] columnFamily, byte[] tableName, CellComparator cellComparator, IndexBlockEncoding indexBlockEncoding)
HFileContext(HFileContext context)	Copy constructor

Method Summary

Modifier and Type	Method	Description
HFileContext	clone()
int	getBlocksize()
int	getBytesPerChecksum()
CellComparator	getCellComparator()
ChecksumType	getChecksumType()
byte[]	getColumnFamily()
Compression.Algorithm	getCompression()
DataBlockEncoding	getDataBlockEncoding()
Compression.HFileDecompressionContext	getDecompressionContext()	Get an object that, if non-null, may be cast into a codec-specific type that exposes some information from the store-file-specific Configuration that is relevant to decompression.
Encryption.Context	getEncryptionContext()
long	getFileCreateTime()
String	getHFileName()
IndexBlockEncoding	getIndexBlockEncoding()
byte[]	getTableName()
long	heapSize()	HeapSize implementation.
boolean	isCompressedOrEncrypted()	Returns true when on-disk blocks are compressed, and/or encrypted; false otherwise.
boolean	isCompressTags()
boolean	isIncludesMvcc()
boolean	isIncludesTags()
boolean	isUseHBaseChecksum()
void	setCompressTags(boolean compressTags)
void	setEncryptionContext(Encryption.Context cryptoContext)
void	setFileCreateTime(long fileCreateTime)
void	setIncludesMvcc(boolean includesMvcc)
void	setIncludesTags(boolean includesTags)
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

FIXED_OVERHEAD

public static final long FIXED_OVERHEAD

DEFAULT_BYTES_PER_CHECKSUM

private static final int DEFAULT_BYTES_PER_CHECKSUM

See Also:

• Constant Field Values

usesHBaseChecksum

private boolean usesHBaseChecksum

Whether checksum is enabled or not

includesMvcc

private boolean includesMvcc

Whether mvcc is to be included in the Read/Write

includesTags

private boolean includesTags

Whether tags are to be included in the Read/Write

compressAlgo

private Compression.Algorithm compressAlgo

Compression algorithm used

decompressionContext

@Nullable
private Compression.HFileDecompressionContext decompressionContext

Details used by compression algorithm that are more efficiently loaded once and then reused

compressTags

private boolean compressTags

Whether tags to be compressed or not

checksumType

private ChecksumType checksumType

the checksum type

bytesPerChecksum

private int bytesPerChecksum

the number of bytes per checksum value

blockSize

private int blockSize

Number of uncompressed bytes we allow per block.

encoding

private DataBlockEncoding encoding

indexBlockEncoding

private IndexBlockEncoding indexBlockEncoding

cryptoContext

private Encryption.Context cryptoContext

Encryption algorithm and key used

fileCreateTime

private long fileCreateTime

hfileName

private String hfileName

columnFamily

private byte[] columnFamily

tableName

private byte[] tableName

cellComparator

private CellComparator cellComparator

Constructor Details

HFileContext

public HFileContext()

HFileContext

public HFileContext(HFileContext context)

Copy constructor

HFileContext

HFileContext(boolean useHBaseChecksum,
 boolean includesMvcc,
 boolean includesTags,
 Compression.Algorithm compressAlgo,
 Compression.HFileDecompressionContext decompressionContext,
 boolean compressTags,
 ChecksumType checksumType,
 int bytesPerChecksum,
 int blockSize,
 DataBlockEncoding encoding,
 Encryption.Context cryptoContext,
 long fileCreateTime,
 String hfileName,
 byte[] columnFamily,
 byte[] tableName,
 CellComparator cellComparator,
 IndexBlockEncoding indexBlockEncoding)

Method Details

isCompressedOrEncrypted

public boolean isCompressedOrEncrypted()

Returns true when on-disk blocks are compressed, and/or encrypted; false otherwise.

getCompression

public Compression.Algorithm getCompression()

getDecompressionContext

@Nullable
public Compression.HFileDecompressionContext getDecompressionContext()

Get an object that, if non-null, may be cast into a codec-specific type that exposes some information from the store-file-specific Configuration that is relevant to decompression. For example, ZSTD tables can have "hbase.io.compress.zstd.dictionary" on their table descriptor, and decompressions of blocks in that table must use that dictionary. It's cheaper for HBase to load these settings into an object of their own once and check this upon each block decompression, than it is to call into Configuration.get(String) on each block decompression.

isUseHBaseChecksum

public boolean isUseHBaseChecksum()

isIncludesMvcc

public boolean isIncludesMvcc()

setIncludesMvcc

public void setIncludesMvcc(boolean includesMvcc)

isIncludesTags

public boolean isIncludesTags()

setIncludesTags

public void setIncludesTags(boolean includesTags)

setFileCreateTime

public void setFileCreateTime(long fileCreateTime)

isCompressTags

public boolean isCompressTags()

setCompressTags

public void setCompressTags(boolean compressTags)

getChecksumType

public ChecksumType getChecksumType()

getBytesPerChecksum

public int getBytesPerChecksum()

getBlocksize

public int getBlocksize()

getFileCreateTime

public long getFileCreateTime()

getDataBlockEncoding

public DataBlockEncoding getDataBlockEncoding()

getIndexBlockEncoding

public IndexBlockEncoding getIndexBlockEncoding()

getEncryptionContext

public Encryption.Context getEncryptionContext()

setEncryptionContext

public void setEncryptionContext(Encryption.Context cryptoContext)

getHFileName

public String getHFileName()

getColumnFamily

public byte[] getColumnFamily()

getTableName

public byte[] getTableName()

getCellComparator

public CellComparator getCellComparator()

heapSize

public long heapSize()

HeapSize implementation. NOTE : The heap size should be altered when new state variable are added.

Specified by:

heapSize in interface HeapSize

Returns:

heap size of the HFileContext

clone

public HFileContext clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object