org.apache.hadoop.hbase.io.hfile

Class HFileInfo

java.lang.Object

org.apache.hadoop.hbase.io.hfile.HFileInfo

All Implemented Interfaces:

Map<byte[],byte[]>, SortedMap<byte[],byte[]>

@InterfaceAudience.Private
public class HFileInfo
extends Object
implements SortedMap<byte[],byte[]>

Metadata Map of attributes for HFile written out as HFile Trailer. Created by the Writer and added to the tail of the file just before close. Metadata includes core attributes such as last key seen, comparator used writing the file, etc. Clients can add their own attributes via append(byte[], byte[], boolean) and they'll be persisted and available at read time. Reader creates the HFileInfo on open by reading the tail of the HFile. The parse of the HFile trailer also creates a HFileContext, a read-only data structure that includes bulk of the HFileInfo and extras that is safe to pass around when working on HFiles.

See Also:

HFileContext

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	MAX_TAGS_LEN

Constructor Summary

Constructors

Constructor and Description
HFileInfo()
HFileInfo(ReaderContext context, org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
HFileInfo	append(byte[] k, byte[] v, boolean checkPrefix) Append the given key/value pair to the file info, optionally checking the key prefix.
void	clear()
void	close()
Comparator<? super byte[]>	comparator()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<byte[],byte[]>>	entrySet()
boolean	equals(Object o)
byte[]	firstKey()
byte[]	get(Object key)
int	getAvgKeyLen()
int	getAvgValueLen()
org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.CellBasedKeyBlockIndexReader	getDataBlockIndexReader()
HFileContext	getHFileContext()
Cell	getLastKeyCell()
List<HFileBlock>	getLoadOnOpenBlocks()
int	getMajorVersion()
org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.ByteArrayKeyBlockIndexReader	getMetaBlockIndexReader()
FixedFileTrailer	getTrailer()
int	hashCode()
SortedMap<byte[],byte[]>	headMap(byte[] toKey)
void	initMetaAndIndex(HFile.Reader reader) should be called after initTrailerAndContext
void	initTrailerAndContext(ReaderContext context, org.apache.hadoop.conf.Configuration conf)
boolean	isDecodeMemstoreTS()
boolean	isEmpty()
static boolean	isReservedFileInfoKey(byte[] key) Return true if the given file info key is reserved for internal use.
Set<byte[]>	keySet()
byte[]	lastKey()
byte[]	put(byte[] key, byte[] value)
void	putAll(Map<? extends byte[],? extends byte[]> m)
byte[]	remove(Object key)
void	setTrailer(FixedFileTrailer trailer)
boolean	shouldIncludeMemStoreTS()
int	size()
SortedMap<byte[],byte[]>	subMap(byte[] fromKey, byte[] toKey)
SortedMap<byte[],byte[]>	tailMap(byte[] fromKey)
Collection<byte[]>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

MAX_TAGS_LEN

public static final byte[] MAX_TAGS_LEN

Constructor Detail

HFileInfo

public HFileInfo()

HFileInfo

public HFileInfo(ReaderContext context,
                 org.apache.hadoop.conf.Configuration conf)
          throws IOException

Throws:

IOException

Method Detail

append

public HFileInfo append(byte[] k,
                        byte[] v,
                        boolean checkPrefix)
                 throws IOException

Append the given key/value pair to the file info, optionally checking the key prefix.

Parameters:

k - key to add

v - value to add

checkPrefix - whether to check that the provided key does not start with the reserved prefix

Returns:

this file info object

Throws:

IOException - if the key or value is invalid

isReservedFileInfoKey

public static boolean isReservedFileInfoKey(byte[] key)

Return true if the given file info key is reserved for internal use.

clear

public void clear()

Specified by:

clear in interface Map<byte[],byte[]>

comparator

public Comparator<? super byte[]> comparator()

Specified by:

comparator in interface SortedMap<byte[],byte[]>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<byte[],byte[]>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<byte[],byte[]>

entrySet

public Set<Map.Entry<byte[],byte[]>> entrySet()

Specified by:

entrySet in interface Map<byte[],byte[]>

Specified by:

entrySet in interface SortedMap<byte[],byte[]>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<byte[],byte[]>

Overrides:

equals in class Object

firstKey

public byte[] firstKey()

Specified by:

firstKey in interface SortedMap<byte[],byte[]>

get

public byte[] get(Object key)

Specified by:

get in interface Map<byte[],byte[]>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<byte[],byte[]>

Overrides:

hashCode in class Object

headMap

public SortedMap<byte[],byte[]> headMap(byte[] toKey)

Specified by:

headMap in interface SortedMap<byte[],byte[]>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<byte[],byte[]>

keySet

public Set<byte[]> keySet()

Specified by:

keySet in interface Map<byte[],byte[]>

Specified by:

keySet in interface SortedMap<byte[],byte[]>

lastKey

public byte[] lastKey()

Specified by:

lastKey in interface SortedMap<byte[],byte[]>

put

public byte[] put(byte[] key,
                  byte[] value)

Specified by:

put in interface Map<byte[],byte[]>

putAll

public void putAll(Map<? extends byte[],? extends byte[]> m)

Specified by:

putAll in interface Map<byte[],byte[]>

remove

public byte[] remove(Object key)

Specified by:

remove in interface Map<byte[],byte[]>

size

public int size()

Specified by:

size in interface Map<byte[],byte[]>

subMap

public SortedMap<byte[],byte[]> subMap(byte[] fromKey,
                                       byte[] toKey)

Specified by:

subMap in interface SortedMap<byte[],byte[]>

tailMap

public SortedMap<byte[],byte[]> tailMap(byte[] fromKey)

Specified by:

tailMap in interface SortedMap<byte[],byte[]>

values

public Collection<byte[]> values()

Specified by:

values in interface Map<byte[],byte[]>

Specified by:

values in interface SortedMap<byte[],byte[]>

initTrailerAndContext

public void initTrailerAndContext(ReaderContext context,
                                  org.apache.hadoop.conf.Configuration conf)
                           throws IOException

Throws:

IOException

initMetaAndIndex

public void initMetaAndIndex(HFile.Reader reader)
                      throws IOException

should be called after initTrailerAndContext

Throws:

IOException

close

public void close()

getMajorVersion

public int getMajorVersion()

setTrailer

public void setTrailer(FixedFileTrailer trailer)

getTrailer

public FixedFileTrailer getTrailer()

getDataBlockIndexReader

public org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.CellBasedKeyBlockIndexReader getDataBlockIndexReader()

getMetaBlockIndexReader

public org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.ByteArrayKeyBlockIndexReader getMetaBlockIndexReader()

getHFileContext

public HFileContext getHFileContext()

getLoadOnOpenBlocks

public List<HFileBlock> getLoadOnOpenBlocks()

getLastKeyCell

public Cell getLastKeyCell()

getAvgKeyLen

public int getAvgKeyLen()

getAvgValueLen

public int getAvgValueLen()

shouldIncludeMemStoreTS

public boolean shouldIncludeMemStoreTS()

isDecodeMemstoreTS

public boolean isDecodeMemstoreTS()