Package org.apache.hadoop.hbase.client

Class ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor

java.lang.Object

org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor

All Implemented Interfaces:

Comparable<ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor>, ColumnFamilyDescriptor

Enclosing class:

ColumnFamilyDescriptorBuilder

@Private
public static class ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor
extends Object
implements ColumnFamilyDescriptor, Comparable<ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor>

An ModifyableFamilyDescriptor contains information about a column family such as the number of versions, compression settings, etc. It is used as input when creating a table or adding a column. TODO: make this package-private after removing the HColumnDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	configuration	A map which holds the configuration specific to the column family.
private final byte[]	name
private final Map<Bytes,Bytes>	values

Fields inherited from interface org.apache.hadoop.hbase.client.ColumnFamilyDescriptor

COMPARATOR, COMPARATOR_IGNORE_REPLICATION, REPLICATION_SCOPE_BYTES

Constructor Summary

Constructors

Modifier	Constructor	Description
	ModifyableColumnFamilyDescriptor(byte[] name)	Construct a column descriptor specifying only the family name The other attributes are defaulted.
private	ModifyableColumnFamilyDescriptor(byte[] name, Map<Bytes,Bytes> values, Map<String,String> config)
	ModifyableColumnFamilyDescriptor(ColumnFamilyDescriptor desc)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor other)
boolean	equals(Object obj)
int	getBlocksize()	Returns The storefile/hfile blocksize for this column family.
BloomType	getBloomFilterType()	Returns bloom filter type used for new StoreFiles in ColumnFamily
Compression.Algorithm	getCompactionCompressionType()	Returns Compression type setting.
Compression.Algorithm	getCompressionType()	Returns Compression type setting.
Map<String,String>	getConfiguration()	Returns an unmodifiable map.
String	getConfigurationValue(String key)	Returns accessing the configuration value by key.
DataBlockEncoding	getDataBlockEncoding()	Returns the data block encoding algorithm used in block cache and optionally on disk
short	getDFSReplication()	Returns replication factor set for this CF
byte[]	getEncryptionKey()	Returns Return the raw crypto key attribute for the family, or null if not set
String	getEncryptionType()	Returns Return the encryption algorithm in use by this family
IndexBlockEncoding	getIndexBlockEncoding()	Return the index block encoding algorithm used in block cache and optionally on disk
MemoryCompactionPolicy	getInMemoryCompaction()	Returns in-memory compaction policy if set for the cf.
KeepDeletedCells	getKeepDeletedCells()	Returns return the KeepDeletedCells
Compression.Algorithm	getMajorCompactionCompressionType()	Returns Compression type setting for major compactions.
int	getMaxVersions()	Returns maximum number of versions
Compression.Algorithm	getMinorCompactionCompressionType()	Returns Compression type setting for minor compactions.
int	getMinVersions()	Returns The minimum number of versions to keep.
MobCompactPartitionPolicy	getMobCompactPartitionPolicy()	Get the mob compact partition policy for this family
long	getMobThreshold()	Gets the mob threshold of the family.
byte[]	getName()	Returns a copy of Name of this column family
String	getNameAsString()	Returns Name of this column family
private <T> T	getOrDefault(Bytes key, Function<byte[],T> function, T defaultValue)
int	getScope()	Returns the scope tag
String	getStoragePolicy()	Not using enum here because HDFS is not using enum for storage policy, see org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more details.
private <T> T	getStringOrDefault(Bytes key, Function<String,T> function, T defaultValue)
int	getTimeToLive()	Returns Time-to-live of cell contents, in seconds.
byte[]	getValue(byte[] key)	Get a configuration value.
String	getValue(String key)	Get a configuration value.
Bytes	getValue(Bytes key)	Get a configuration value.
Map<Bytes,Bytes>	getValues()	Get all configuration values.
private StringBuilder	getValues(boolean printDefaults)
int	hashCode()
boolean	isBlockCacheEnabled()	Returns True if hfile DATA type blocks should be cached (You cannot disable caching of INDEX and BLOOM type blocks).
boolean	isCacheBloomsOnWrite()	Returns true if we should cache bloomfilter blocks on write
boolean	isCacheDataOnWrite()	Returns true if we should cache data blocks on write
boolean	isCacheIndexesOnWrite()	Returns true if we should cache index blocks on write
boolean	isCompressTags()	Returns Whether KV tags should be compressed along with DataBlockEncoding.
boolean	isEvictBlocksOnClose()	Returns true if we should evict cached blocks from the blockcache on close
boolean	isInMemory()	Returns True if we are to favor keeping all values for this column family in the HRegionServer cache.
boolean	isMobEnabled()	Gets whether the mob is enabled for the family.
boolean	isNewVersionBehavior()	By default, HBase only consider timestamp in versions.
boolean	isPrefetchBlocksOnOpen()	Returns true if we should prefetch blocks into the blockcache on open
private static ColumnFamilyDescriptor	parseFrom(byte[] bytes)	Parse the serialized representation of a ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	removeConfiguration(String key)	Remove a configuration setting represented by the key from the configuration map.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	removeValue(Bytes key)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setBlockCacheEnabled(boolean blockCacheEnabled)	Set the blockCacheEnabled flag
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setBlocksize(int s)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setBlocksize(String blocksize)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setBloomFilterType(BloomType bt)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setCacheBloomsOnWrite(boolean value)	Set the setCacheBloomsOnWrite flag.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setCacheDataOnWrite(boolean value)	Set the setCacheDataOnWrite flag
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setCacheIndexesOnWrite(boolean value)	Set the setCacheIndexesOnWrite flag
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setCompactionCompressionType(Compression.Algorithm type)	Compression types supported in hbase.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setCompressionType(Compression.Algorithm type)	Compression types supported in hbase.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setCompressTags(boolean compressTags)	Set whether the tags should be compressed along with DataBlockEncoding.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setConfiguration(String key, String value)	Setter for storing a configuration setting in configuration map.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setDataBlockEncoding(DataBlockEncoding type)	Set data block encoding algorithm used in block cache.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setDFSReplication(short replication)	Set the replication factor to hfile(s) belonging to this family
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setEncryptionKey(byte[] keyBytes)	Set the raw crypto key attribute for the family
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setEncryptionType(String algorithm)	Set the encryption algorithm for use with this family
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setEvictBlocksOnClose(boolean value)	Set the setEvictBlocksOnClose flag.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setIndexBlockEncoding(IndexBlockEncoding type)	Set index block encoding algorithm used in block cache.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setInMemory(boolean inMemory)	Set the inMemory flag
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setInMemoryCompaction(MemoryCompactionPolicy inMemoryCompaction)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setKeepDeletedCells(KeepDeletedCells keepDeletedCells)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setMajorCompactionCompressionType(Compression.Algorithm type)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setMaxVersions(int maxVersions)	Set the maximum number of versions to retain.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setMinorCompactionCompressionType(Compression.Algorithm type)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setMinVersions(int minVersions)	Set minimum versions to retain.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setMobCompactPartitionPolicy(MobCompactPartitionPolicy policy)	Set the mob compact partition policy for the family.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setMobEnabled(boolean isMobEnabled)	Enables the mob for the family.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setMobThreshold(long threshold)	Sets the mob threshold of the family.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setNewVersionBehavior(boolean newVersionBehavior)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setPrefetchBlocksOnOpen(boolean value)	Set the setPrefetchBlocksOnOpen flag
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setScope(int scope)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setStoragePolicy(String policy)	Set the storage policy for use with this family
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setTimeToLive(int timeToLive)	Set the time to live
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setTimeToLive(String timeToLive)	Set the time to live
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setValue(byte[] key, byte[] value)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setValue(String key, String value)
private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setValue(Bytes key, String value)
private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setValue(Bytes key, Bytes value)
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setVersions(int minVersions, int maxVersions)	Set minimum and maximum versions to keep.
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor	setVersionsWithTimeToLive(int retentionInterval, int versionAfterInterval)	Retain all versions for a given TTL(retentionInterval), and then only a specific number of versions(versionAfterInterval) after that interval elapses.
private byte[]	toByteArray()	Returns This instance serialized with pb with pb magic prefix
private static <T> Bytes	toBytesOrNull(T t, Function<T,byte[]> f)
String	toString()
String	toStringCustomizedValues()	Returns Column family descriptor with only the customized attributes.

Methods inherited from class java.lang.Object

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

Field Details

name

private final byte[] name

values

private final Map<Bytes,Bytes> values

configuration

private final Map<String,String> configuration

A map which holds the configuration specific to the column family. The keys of the map have the same names as config keys and override the defaults with cf-specific settings. Example usage may be for compactions, etc.

Constructor Details

ModifyableColumnFamilyDescriptor

@Private
public ModifyableColumnFamilyDescriptor(byte[] name)

Construct a column descriptor specifying only the family name The other attributes are defaulted.

Parameters:

name - Column family name. Must be 'printable' -- digit or letter -- and may not contain a : TODO: make this private after the HCD is removed.

ModifyableColumnFamilyDescriptor

@Private
public ModifyableColumnFamilyDescriptor(ColumnFamilyDescriptor desc)

Constructor. Makes a deep copy of the supplied descriptor. TODO: make this private after the HCD is removed.

Parameters:

desc - The descriptor.

ModifyableColumnFamilyDescriptor

private ModifyableColumnFamilyDescriptor(byte[] name,
 Map<Bytes,Bytes> values,
 Map<String,String> config)

Method Details

getName

public byte[] getName()

Description copied from interface: ColumnFamilyDescriptor

Returns a copy of Name of this column family

Specified by:

getName in interface ColumnFamilyDescriptor

getNameAsString

public String getNameAsString()

Description copied from interface: ColumnFamilyDescriptor

Returns Name of this column family

Specified by:

getNameAsString in interface ColumnFamilyDescriptor

getValue

public Bytes getValue(Bytes key)

Description copied from interface: ColumnFamilyDescriptor

Get a configuration value.

Specified by:

getValue in interface ColumnFamilyDescriptor

Parameters:

key - The key.

Returns:

A clone value. Null if no mapping for the key

getValue

public byte[] getValue(byte[] key)

Description copied from interface: ColumnFamilyDescriptor

Get a configuration value.

Specified by:

getValue in interface ColumnFamilyDescriptor

Parameters:

key - The key.

Returns:

A clone value. Null if no mapping for the key

getValue

public String getValue(String key)

Description copied from interface: ColumnFamilyDescriptor

Get a configuration value.

Specified by:

getValue in interface ColumnFamilyDescriptor

Parameters:

key - The key.

Returns:

A clone value. Null if no mapping for the key

getValues

public Map<Bytes,Bytes> getValues()

Description copied from interface: ColumnFamilyDescriptor

Get all configuration values. It clone all bytes of all elements.

Specified by:

getValues in interface ColumnFamilyDescriptor

Returns:

All values

setValue

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(byte[] key,
 byte[] value)

setValue

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(String key,
 String value)

setValue

private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(Bytes key,
 String value)

setValue

private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setValue(Bytes key,
 Bytes value)

removeValue

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor removeValue(Bytes key)

toBytesOrNull

private static <T> Bytes toBytesOrNull(T t,
 Function<T,byte[]> f)

getStringOrDefault

private <T> T getStringOrDefault(Bytes key,
 Function<String,T> function,
 T defaultValue)

getOrDefault

private <T> T getOrDefault(Bytes key,
 Function<byte[],T> function,
 T defaultValue)

getMaxVersions

public int getMaxVersions()

Description copied from interface: ColumnFamilyDescriptor

Returns maximum number of versions

Specified by:

getMaxVersions in interface ColumnFamilyDescriptor

setMaxVersions

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMaxVersions(int maxVersions)

Set the maximum number of versions to retain.

Parameters:

maxVersions - maximum number of versions

Returns:

this (for chained invocation)

setVersions

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setVersions(int minVersions,
 int maxVersions)

Set minimum and maximum versions to keep.

Parameters:

minVersions - minimal number of versions

maxVersions - maximum number of versions

Returns:

this (for chained invocation)

getBlocksize

public int getBlocksize()

Description copied from interface: ColumnFamilyDescriptor

Returns The storefile/hfile blocksize for this column family.

Specified by:

getBlocksize in interface ColumnFamilyDescriptor

setBlocksize

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setBlocksize(int s)

setBlocksize

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setBlocksize(String blocksize)
                                                                            throws HBaseException

Throws:

HBaseException

getCompressionType

public Compression.Algorithm getCompressionType()

Description copied from interface: ColumnFamilyDescriptor

Returns Compression type setting.

Specified by:

getCompressionType in interface ColumnFamilyDescriptor

setCompressionType

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCompressionType(Compression.Algorithm type)

Compression types supported in hbase. LZO is not bundled as part of the hbase distribution. See LZO Compression for how to enable it.

Parameters:

type - Compression type setting.

Returns:

this (for chained invocation)

getDataBlockEncoding

public DataBlockEncoding getDataBlockEncoding()

Description copied from interface: ColumnFamilyDescriptor

Returns the data block encoding algorithm used in block cache and optionally on disk

Specified by:

getDataBlockEncoding in interface ColumnFamilyDescriptor

setDataBlockEncoding

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setDataBlockEncoding(DataBlockEncoding type)

Set data block encoding algorithm used in block cache.

Parameters:

type - What kind of data block encoding will be used.

Returns:

this (for chained invocation)

getIndexBlockEncoding

public IndexBlockEncoding getIndexBlockEncoding()

Description copied from interface: ColumnFamilyDescriptor

Return the index block encoding algorithm used in block cache and optionally on disk

Specified by:

getIndexBlockEncoding in interface ColumnFamilyDescriptor

setIndexBlockEncoding

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setIndexBlockEncoding(IndexBlockEncoding type)

Set index block encoding algorithm used in block cache.

Parameters:

type - What kind of index block encoding will be used.

Returns:

this (for chained invocation)

setCompressTags

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCompressTags(boolean compressTags)

Set whether the tags should be compressed along with DataBlockEncoding. When no DataBlockEncoding is been used, this is having no effect.

Returns:

this (for chained invocation)

isCompressTags

public boolean isCompressTags()

Description copied from interface: ColumnFamilyDescriptor

Returns Whether KV tags should be compressed along with DataBlockEncoding. When no DataBlockEncoding is been used, this is having no effect.

Specified by:

isCompressTags in interface ColumnFamilyDescriptor

getCompactionCompressionType

public Compression.Algorithm getCompactionCompressionType()

Description copied from interface: ColumnFamilyDescriptor

Returns Compression type setting.

Specified by:

getCompactionCompressionType in interface ColumnFamilyDescriptor

getMajorCompactionCompressionType

public Compression.Algorithm getMajorCompactionCompressionType()

Description copied from interface: ColumnFamilyDescriptor

Returns Compression type setting for major compactions.

Specified by:

getMajorCompactionCompressionType in interface ColumnFamilyDescriptor

getMinorCompactionCompressionType

public Compression.Algorithm getMinorCompactionCompressionType()

Description copied from interface: ColumnFamilyDescriptor

Returns Compression type setting for minor compactions.

Specified by:

getMinorCompactionCompressionType in interface ColumnFamilyDescriptor

setCompactionCompressionType

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCompactionCompressionType(Compression.Algorithm type)

Compression types supported in hbase. LZO is not bundled as part of the hbase distribution. See LZO Compression for how to enable it.

Parameters:

type - Compression type setting.

Returns:

this (for chained invocation)

setMajorCompactionCompressionType

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMajorCompactionCompressionType(Compression.Algorithm type)

setMinorCompactionCompressionType

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMinorCompactionCompressionType(Compression.Algorithm type)

isInMemory

public boolean isInMemory()

Description copied from interface: ColumnFamilyDescriptor

Returns True if we are to favor keeping all values for this column family in the HRegionServer cache.

Specified by:

isInMemory in interface ColumnFamilyDescriptor

setInMemory

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setInMemory(boolean inMemory)

Set the inMemory flag

Parameters:

inMemory - True if we are to favor keeping all values for this column family in the HRegionServer cache

Returns:

this (for chained invocation)

getInMemoryCompaction

public MemoryCompactionPolicy getInMemoryCompaction()

Description copied from interface: ColumnFamilyDescriptor

Returns in-memory compaction policy if set for the cf. Returns null if no policy is set for for this column family

Specified by:

getInMemoryCompaction in interface ColumnFamilyDescriptor

setInMemoryCompaction

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setInMemoryCompaction(MemoryCompactionPolicy inMemoryCompaction)

getKeepDeletedCells

public KeepDeletedCells getKeepDeletedCells()

Description copied from interface: ColumnFamilyDescriptor

Returns return the KeepDeletedCells

Specified by:

getKeepDeletedCells in interface ColumnFamilyDescriptor

setKeepDeletedCells

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setKeepDeletedCells(KeepDeletedCells keepDeletedCells)

isNewVersionBehavior

public boolean isNewVersionBehavior()

By default, HBase only consider timestamp in versions. So a previous Delete with higher ts will mask a later Put with lower ts. Set this to true to enable new semantics of versions. We will also consider mvcc in versions. See HBASE-15968 for details.

Specified by:

isNewVersionBehavior in interface ColumnFamilyDescriptor

setNewVersionBehavior

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setNewVersionBehavior(boolean newVersionBehavior)

getTimeToLive

public int getTimeToLive()

Description copied from interface: ColumnFamilyDescriptor

Returns Time-to-live of cell contents, in seconds.

Specified by:

getTimeToLive in interface ColumnFamilyDescriptor

setTimeToLive

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setTimeToLive(int timeToLive)

Set the time to live

Parameters:

timeToLive - Time-to-live of cell contents, in seconds.

Returns:

this (for chained invocation)

setTimeToLive

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setTimeToLive(String timeToLive)
                                                                             throws HBaseException

Set the time to live

Parameters:

timeToLive - Time-to-live of cell contents, in seconds.

Returns:

this (for chained invocation)

Throws:

HBaseException - exception

getMinVersions

public int getMinVersions()

Description copied from interface: ColumnFamilyDescriptor

Returns The minimum number of versions to keep.

Specified by:

getMinVersions in interface ColumnFamilyDescriptor

setMinVersions

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMinVersions(int minVersions)

Set minimum versions to retain.

Parameters:

minVersions - The minimum number of versions to keep. (used when timeToLive is set)

Returns:

this (for chained invocation)

setVersionsWithTimeToLive

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setVersionsWithTimeToLive(int retentionInterval,
 int versionAfterInterval)

Retain all versions for a given TTL(retentionInterval), and then only a specific number of versions(versionAfterInterval) after that interval elapses.

Parameters:

retentionInterval - Retain all versions for this interval

versionAfterInterval - Retain no of versions to retain after retentionInterval

Returns:

this (for chained invocation)

isBlockCacheEnabled

public boolean isBlockCacheEnabled()

Description copied from interface: ColumnFamilyDescriptor

Returns True if hfile DATA type blocks should be cached (You cannot disable caching of INDEX and BLOOM type blocks).

Specified by:

isBlockCacheEnabled in interface ColumnFamilyDescriptor

setBlockCacheEnabled

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setBlockCacheEnabled(boolean blockCacheEnabled)

Set the blockCacheEnabled flag

Parameters:

blockCacheEnabled - True if hfile DATA type blocks should be cached (We always cache INDEX and BLOOM blocks; you cannot turn this off).

Returns:

this (for chained invocation)

getBloomFilterType

public BloomType getBloomFilterType()

Description copied from interface: ColumnFamilyDescriptor

Returns bloom filter type used for new StoreFiles in ColumnFamily

Specified by:

getBloomFilterType in interface ColumnFamilyDescriptor

setBloomFilterType

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setBloomFilterType(BloomType bt)

getScope

public int getScope()

Description copied from interface: ColumnFamilyDescriptor

Returns the scope tag

Specified by:

getScope in interface ColumnFamilyDescriptor

setScope

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setScope(int scope)

isCacheDataOnWrite

public boolean isCacheDataOnWrite()

Description copied from interface: ColumnFamilyDescriptor

Returns true if we should cache data blocks on write

Specified by:

isCacheDataOnWrite in interface ColumnFamilyDescriptor

setCacheDataOnWrite

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCacheDataOnWrite(boolean value)

Set the setCacheDataOnWrite flag

Parameters:

value - true if we should cache data blocks on write

Returns:

this (for chained invocation)

isCacheIndexesOnWrite

public boolean isCacheIndexesOnWrite()

Description copied from interface: ColumnFamilyDescriptor

Returns true if we should cache index blocks on write

Specified by:

isCacheIndexesOnWrite in interface ColumnFamilyDescriptor

setCacheIndexesOnWrite

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCacheIndexesOnWrite(boolean value)

Set the setCacheIndexesOnWrite flag

Parameters:

value - true if we should cache index blocks on write

Returns:

this (for chained invocation)

isCacheBloomsOnWrite

public boolean isCacheBloomsOnWrite()

Description copied from interface: ColumnFamilyDescriptor

Returns true if we should cache bloomfilter blocks on write

Specified by:

isCacheBloomsOnWrite in interface ColumnFamilyDescriptor

setCacheBloomsOnWrite

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setCacheBloomsOnWrite(boolean value)

Set the setCacheBloomsOnWrite flag.

Parameters:

value - true if we should cache bloomfilter blocks on write

Returns:

this (for chained invocation)

isEvictBlocksOnClose

public boolean isEvictBlocksOnClose()

Description copied from interface: ColumnFamilyDescriptor

Returns true if we should evict cached blocks from the blockcache on close

Specified by:

isEvictBlocksOnClose in interface ColumnFamilyDescriptor

setEvictBlocksOnClose

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setEvictBlocksOnClose(boolean value)

Set the setEvictBlocksOnClose flag.

Parameters:

value - true if we should evict cached blocks from the blockcache on close

Returns:

this (for chained invocation)

isPrefetchBlocksOnOpen

public boolean isPrefetchBlocksOnOpen()

Description copied from interface: ColumnFamilyDescriptor

Returns true if we should prefetch blocks into the blockcache on open

Specified by:

isPrefetchBlocksOnOpen in interface ColumnFamilyDescriptor

setPrefetchBlocksOnOpen

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setPrefetchBlocksOnOpen(boolean value)

Set the setPrefetchBlocksOnOpen flag

Parameters:

value - true if we should prefetch blocks into the blockcache on open

Returns:

this (for chained invocation)

toString

public String toString()

Overrides:

toString in class Object

toStringCustomizedValues

public String toStringCustomizedValues()

Description copied from interface: ColumnFamilyDescriptor

Returns Column family descriptor with only the customized attributes.

Specified by:

toStringCustomizedValues in interface ColumnFamilyDescriptor

getValues

private StringBuilder getValues(boolean printDefaults)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor other)

Specified by:

compareTo in interface Comparable<ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor>

toByteArray

private byte[] toByteArray()

Returns This instance serialized with pb with pb magic prefix

parseFrom

private static ColumnFamilyDescriptor parseFrom(byte[] bytes)
                                         throws DeserializationException

Parse the serialized representation of a ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor

Parameters:

bytes - A pb serialized ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor instance with pb magic prefix

Returns:

An instance of ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor made from bytes

Throws:

DeserializationException

See Also:

• toByteArray()

getConfigurationValue

public String getConfigurationValue(String key)

Description copied from interface: ColumnFamilyDescriptor

Returns accessing the configuration value by key.

Specified by:

getConfigurationValue in interface ColumnFamilyDescriptor

getConfiguration

public Map<String,String> getConfiguration()

Description copied from interface: ColumnFamilyDescriptor

Returns an unmodifiable map.

Specified by:

getConfiguration in interface ColumnFamilyDescriptor

setConfiguration

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setConfiguration(String key,
 String value)

Setter for storing a configuration setting in configuration map.

Parameters:

key - Config key. Same as XML config key e.g. hbase.something.or.other.

value - String value. If null, removes the configuration.

Returns:

this (for chained invocation)

removeConfiguration

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor removeConfiguration(String key)

Remove a configuration setting represented by the key from the configuration map.

Returns:

this (for chained invocation)

getEncryptionType

public String getEncryptionType()

Description copied from interface: ColumnFamilyDescriptor

Returns Return the encryption algorithm in use by this family

Specified by:

getEncryptionType in interface ColumnFamilyDescriptor

setEncryptionType

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setEncryptionType(String algorithm)

Set the encryption algorithm for use with this family

Returns:

this (for chained invocation)

getEncryptionKey

public byte[] getEncryptionKey()

Description copied from interface: ColumnFamilyDescriptor

Returns Return the raw crypto key attribute for the family, or null if not set

Specified by:

getEncryptionKey in interface ColumnFamilyDescriptor

setEncryptionKey

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setEncryptionKey(byte[] keyBytes)

Set the raw crypto key attribute for the family

Returns:

this (for chained invocation)

getMobThreshold

public long getMobThreshold()

Description copied from interface: ColumnFamilyDescriptor

Gets the mob threshold of the family. If the size of a cell value is larger than this threshold, it's regarded as a mob. The default threshold is 1024*100(100K)B.

Specified by:

getMobThreshold in interface ColumnFamilyDescriptor

Returns:

The mob threshold.

setMobThreshold

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMobThreshold(long threshold)

Sets the mob threshold of the family.

Parameters:

threshold - The mob threshold.

Returns:

this (for chained invocation)

isMobEnabled

public boolean isMobEnabled()

Description copied from interface: ColumnFamilyDescriptor

Gets whether the mob is enabled for the family.

Specified by:

isMobEnabled in interface ColumnFamilyDescriptor

Returns:

True if the mob is enabled for the family.

setMobEnabled

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMobEnabled(boolean isMobEnabled)

Enables the mob for the family.

Parameters:

isMobEnabled - Whether to enable the mob for the family.

Returns:

this (for chained invocation)

getMobCompactPartitionPolicy

public MobCompactPartitionPolicy getMobCompactPartitionPolicy()

Description copied from interface: ColumnFamilyDescriptor

Get the mob compact partition policy for this family

Specified by:

getMobCompactPartitionPolicy in interface ColumnFamilyDescriptor

setMobCompactPartitionPolicy

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setMobCompactPartitionPolicy(MobCompactPartitionPolicy policy)

Set the mob compact partition policy for the family.

Parameters:

policy - policy type

Returns:

this (for chained invocation)

getDFSReplication

public short getDFSReplication()

Description copied from interface: ColumnFamilyDescriptor

Returns replication factor set for this CF

Specified by:

getDFSReplication in interface ColumnFamilyDescriptor

setDFSReplication

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setDFSReplication(short replication)

Set the replication factor to hfile(s) belonging to this family

Parameters:

replication - number of replicas the blocks(s) belonging to this CF should have, or ColumnFamilyDescriptorBuilder.DEFAULT_DFS_REPLICATION for the default replication factor set in the filesystem

Returns:

this (for chained invocation)

getStoragePolicy

public String getStoragePolicy()

Description copied from interface: ColumnFamilyDescriptor

Not using enum here because HDFS is not using enum for storage policy, see org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more details.

Specified by:

getStoragePolicy in interface ColumnFamilyDescriptor

Returns:

Return the storage policy in use by this family

setStoragePolicy

public ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor setStoragePolicy(String policy)

Set the storage policy for use with this family

Parameters:

policy - the policy to set, valid setting includes: "LAZY_PERSIST", "ALL_SSD", "ONE_SSD", "HOT", "WARM", "COLD"

Returns:

this (for chained invocation)