org.apache.hadoop.hbase.client

Class ColumnFamilyDescriptorBuilder

java.lang.Object

org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder

@InterfaceAudience.Public
public class ColumnFamilyDescriptorBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPRESSION_COMPACT_MAJOR
static String	COMPRESSION_COMPACT_MINOR
static boolean	DEFAULT_BLOCKCACHE Default setting for whether to use a block cache or not.
static int	DEFAULT_BLOCKSIZE Default size of blocks in files stored to the filesytem (hfiles).
static BloomType	DEFAULT_BLOOMFILTER Default setting for whether or not to use bloomfilters.
static boolean	DEFAULT_CACHE_BLOOMS_ON_WRITE Default setting for whether to cache bloom filter blocks on write if block caching is enabled.
static boolean	DEFAULT_CACHE_DATA_ON_WRITE Default setting for whether to cache data blocks on write if block caching is enabled.
static boolean	DEFAULT_CACHE_INDEX_ON_WRITE Default setting for whether to cache index blocks on write if block caching is enabled.
static boolean	DEFAULT_COMPRESS_TAGS Default compress tags along with any type of DataBlockEncoding.
static Compression.Algorithm	DEFAULT_COMPRESSION Default compression type.
static DataBlockEncoding	DEFAULT_DATA_BLOCK_ENCODING Default data block encoding algorithm.
static short	DEFAULT_DFS_REPLICATION
static boolean	DEFAULT_EVICT_BLOCKS_ON_CLOSE Default setting for whether to evict cached blocks from the blockcache on close.
static boolean	DEFAULT_IN_MEMORY Default setting for whether to try and serve this column family from memory or not.
static KeepDeletedCells	DEFAULT_KEEP_DELETED Default setting for preventing deleted from being collected immediately.
static int	DEFAULT_MAX_VERSIONS Default number of versions of a record to keep.
static int	DEFAULT_MIN_VERSIONS Default is not to keep a minimum of versions.
static MobCompactPartitionPolicy	DEFAULT_MOB_COMPACT_PARTITION_POLICY
static long	DEFAULT_MOB_THRESHOLD
static boolean	DEFAULT_NEW_VERSION_BEHAVIOR
static boolean	DEFAULT_PREFETCH_BLOCKS_ON_OPEN
static int	DEFAULT_REPLICATION_SCOPE Default scope.
static int	DEFAULT_TTL Default time to live of cell contents.
static String	NEW_VERSION_BEHAVIOR

Method Summary

Modifier and Type	Method and Description
ColumnFamilyDescriptor	build()
static ColumnFamilyDescriptor	copy(ColumnFamilyDescriptor desc)
Compression.Algorithm	getCompressionType()
static Map<String,String>	getDefaultValues()
String	getNameAsString()
static org.apache.hadoop.hbase.util.PrettyPrinter.Unit	getUnit(String key)
static byte[]	isLegalColumnFamilyName(byte[] b) Check if the column family name is legal.
static ColumnFamilyDescriptorBuilder	newBuilder(byte[] name)
static ColumnFamilyDescriptorBuilder	newBuilder(ColumnFamilyDescriptor desc)
static ColumnFamilyDescriptor	of(byte[] name)
static ColumnFamilyDescriptor	of(String name)
static ColumnFamilyDescriptor	parseFrom(byte[] pbBytes)
ColumnFamilyDescriptorBuilder	removeConfiguration(String key)
ColumnFamilyDescriptorBuilder	setBlockCacheEnabled(boolean value)
ColumnFamilyDescriptorBuilder	setBlocksize(int value)
ColumnFamilyDescriptorBuilder	setBlocksize(String value)
ColumnFamilyDescriptorBuilder	setBloomFilterType(BloomType value)
ColumnFamilyDescriptorBuilder	setCacheBloomsOnWrite(boolean value)
ColumnFamilyDescriptorBuilder	setCacheDataOnWrite(boolean value)
ColumnFamilyDescriptorBuilder	setCacheIndexesOnWrite(boolean value)
ColumnFamilyDescriptorBuilder	setCompactionCompressionType(Compression.Algorithm value)
ColumnFamilyDescriptorBuilder	setCompressionType(Compression.Algorithm value)
ColumnFamilyDescriptorBuilder	setCompressTags(boolean value)
ColumnFamilyDescriptorBuilder	setConfiguration(String key, String value)
ColumnFamilyDescriptorBuilder	setDataBlockEncoding(DataBlockEncoding value)
ColumnFamilyDescriptorBuilder	setDFSReplication(short value)
ColumnFamilyDescriptorBuilder	setEncryptionKey(byte[] value)
ColumnFamilyDescriptorBuilder	setEncryptionType(String value)
ColumnFamilyDescriptorBuilder	setEvictBlocksOnClose(boolean value)
ColumnFamilyDescriptorBuilder	setInMemory(boolean value)
ColumnFamilyDescriptorBuilder	setInMemoryCompaction(MemoryCompactionPolicy value)
ColumnFamilyDescriptorBuilder	setKeepDeletedCells(KeepDeletedCells value)
ColumnFamilyDescriptorBuilder	setMajorCompactionCompressionType(Compression.Algorithm value)
ColumnFamilyDescriptorBuilder	setMaxVersions(int value)
ColumnFamilyDescriptorBuilder	setMinorCompactionCompressionType(Compression.Algorithm value)
ColumnFamilyDescriptorBuilder	setMinVersions(int value)
ColumnFamilyDescriptorBuilder	setMobCompactPartitionPolicy(MobCompactPartitionPolicy value)
ColumnFamilyDescriptorBuilder	setMobEnabled(boolean value)
ColumnFamilyDescriptorBuilder	setMobThreshold(long value)
ColumnFamilyDescriptorBuilder	setNewVersionBehavior(boolean value)
ColumnFamilyDescriptorBuilder	setPrefetchBlocksOnOpen(boolean value)
ColumnFamilyDescriptorBuilder	setScope(int value)
ColumnFamilyDescriptorBuilder	setStoragePolicy(String value)
ColumnFamilyDescriptorBuilder	setTimeToLive(int value)
ColumnFamilyDescriptorBuilder	setTimeToLive(String value)
ColumnFamilyDescriptorBuilder	setValue(byte[] key, byte[] value)
ColumnFamilyDescriptorBuilder	setValue(Bytes key, Bytes value)
ColumnFamilyDescriptorBuilder	setValue(String key, String value)
ColumnFamilyDescriptorBuilder	setVersionsWithTimeToLive(int retentionInterval, int versionAfterInterval)
static byte[]	toByteArray(ColumnFamilyDescriptor desc) Serialize the table descriptor to a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

COMPRESSION_COMPACT_MAJOR

public static final String COMPRESSION_COMPACT_MAJOR

See Also:

Constant Field Values

COMPRESSION_COMPACT_MINOR

public static final String COMPRESSION_COMPACT_MINOR

See Also:

Constant Field Values

DEFAULT_MOB_THRESHOLD

public static final long DEFAULT_MOB_THRESHOLD

See Also:

Constant Field Values

DEFAULT_MOB_COMPACT_PARTITION_POLICY

public static final MobCompactPartitionPolicy DEFAULT_MOB_COMPACT_PARTITION_POLICY

DEFAULT_DFS_REPLICATION

public static final short DEFAULT_DFS_REPLICATION

See Also:

Constant Field Values

NEW_VERSION_BEHAVIOR

public static final String NEW_VERSION_BEHAVIOR

See Also:

Constant Field Values

DEFAULT_NEW_VERSION_BEHAVIOR

public static final boolean DEFAULT_NEW_VERSION_BEHAVIOR

See Also:

Constant Field Values

DEFAULT_COMPRESSION

public static final Compression.Algorithm DEFAULT_COMPRESSION

Default compression type.

DEFAULT_DATA_BLOCK_ENCODING

public static final DataBlockEncoding DEFAULT_DATA_BLOCK_ENCODING

Default data block encoding algorithm.

DEFAULT_MAX_VERSIONS

public static final int DEFAULT_MAX_VERSIONS

Default number of versions of a record to keep.

See Also:

Constant Field Values

DEFAULT_MIN_VERSIONS

public static final int DEFAULT_MIN_VERSIONS

Default is not to keep a minimum of versions.

See Also:

Constant Field Values

DEFAULT_IN_MEMORY

public static final boolean DEFAULT_IN_MEMORY

Default setting for whether to try and serve this column family from memory or not.

See Also:

Constant Field Values

DEFAULT_KEEP_DELETED

public static final KeepDeletedCells DEFAULT_KEEP_DELETED

Default setting for preventing deleted from being collected immediately.

DEFAULT_BLOCKCACHE

public static final boolean DEFAULT_BLOCKCACHE

Default setting for whether to use a block cache or not.

See Also:

Constant Field Values

DEFAULT_CACHE_DATA_ON_WRITE

public static final boolean DEFAULT_CACHE_DATA_ON_WRITE

Default setting for whether to cache data blocks on write if block caching is enabled.

See Also:

Constant Field Values

DEFAULT_CACHE_INDEX_ON_WRITE

public static final boolean DEFAULT_CACHE_INDEX_ON_WRITE

Default setting for whether to cache index blocks on write if block caching is enabled.

See Also:

Constant Field Values

DEFAULT_BLOCKSIZE

public static final int DEFAULT_BLOCKSIZE

Default size of blocks in files stored to the filesytem (hfiles).

See Also:

Constant Field Values

DEFAULT_BLOOMFILTER

public static final BloomType DEFAULT_BLOOMFILTER

Default setting for whether or not to use bloomfilters.

DEFAULT_CACHE_BLOOMS_ON_WRITE

public static final boolean DEFAULT_CACHE_BLOOMS_ON_WRITE

Default setting for whether to cache bloom filter blocks on write if block caching is enabled.

See Also:

Constant Field Values

DEFAULT_TTL

public static final int DEFAULT_TTL

Default time to live of cell contents.

See Also:

Constant Field Values

DEFAULT_REPLICATION_SCOPE

public static final int DEFAULT_REPLICATION_SCOPE

Default scope.

See Also:

Constant Field Values

DEFAULT_EVICT_BLOCKS_ON_CLOSE

public static final boolean DEFAULT_EVICT_BLOCKS_ON_CLOSE

Default setting for whether to evict cached blocks from the blockcache on close.

See Also:

Constant Field Values

DEFAULT_COMPRESS_TAGS

public static final boolean DEFAULT_COMPRESS_TAGS

Default compress tags along with any type of DataBlockEncoding.

See Also:

Constant Field Values

DEFAULT_PREFETCH_BLOCKS_ON_OPEN

public static final boolean DEFAULT_PREFETCH_BLOCKS_ON_OPEN

See Also:

Constant Field Values

Method Detail

getDefaultValues

public static Map<String,String> getDefaultValues()

getUnit

public static org.apache.hadoop.hbase.util.PrettyPrinter.Unit getUnit(String key)

isLegalColumnFamilyName

public static byte[] isLegalColumnFamilyName(byte[] b)

Check if the column family name is legal.

Parameters:

b - Family name.

Returns:

b

Throws:

IllegalArgumentException - If not null and not a legitimate family name: i.e. 'printable' and ends in a ':' (Null passes are allowed because b can be null when deserializing). Cannot start with a '.' either. Also Family can not be an empty value or equal "recovered.edits".

parseFrom

public static ColumnFamilyDescriptor parseFrom(byte[] pbBytes)
                                        throws org.apache.hadoop.hbase.exceptions.DeserializationException

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException

newBuilder

public static ColumnFamilyDescriptorBuilder newBuilder(byte[] name)

newBuilder

public static ColumnFamilyDescriptorBuilder newBuilder(ColumnFamilyDescriptor desc)

copy

public static ColumnFamilyDescriptor copy(ColumnFamilyDescriptor desc)

of

public static ColumnFamilyDescriptor of(String name)

of

public static ColumnFamilyDescriptor of(byte[] name)

toByteArray

public static byte[] toByteArray(ColumnFamilyDescriptor desc)

Serialize the table descriptor to a byte array.

Parameters:

desc - The table descriptor to serialize

Returns:

This instance serialized with pb with pb magic prefix

build

public ColumnFamilyDescriptor build()

removeConfiguration

public ColumnFamilyDescriptorBuilder removeConfiguration(String key)

getNameAsString

public String getNameAsString()

setBlockCacheEnabled

public ColumnFamilyDescriptorBuilder setBlockCacheEnabled(boolean value)

setBlocksize

public ColumnFamilyDescriptorBuilder setBlocksize(int value)

setBlocksize

public ColumnFamilyDescriptorBuilder setBlocksize(String value)
                                           throws org.apache.hadoop.hbase.exceptions.HBaseException

Throws:

org.apache.hadoop.hbase.exceptions.HBaseException

setBloomFilterType

public ColumnFamilyDescriptorBuilder setBloomFilterType(BloomType value)

setCacheBloomsOnWrite

public ColumnFamilyDescriptorBuilder setCacheBloomsOnWrite(boolean value)

setCacheDataOnWrite

public ColumnFamilyDescriptorBuilder setCacheDataOnWrite(boolean value)

setCacheIndexesOnWrite

public ColumnFamilyDescriptorBuilder setCacheIndexesOnWrite(boolean value)

setCompactionCompressionType

public ColumnFamilyDescriptorBuilder setCompactionCompressionType(Compression.Algorithm value)

setMajorCompactionCompressionType

public ColumnFamilyDescriptorBuilder setMajorCompactionCompressionType(Compression.Algorithm value)

setMinorCompactionCompressionType

public ColumnFamilyDescriptorBuilder setMinorCompactionCompressionType(Compression.Algorithm value)

setCompressTags

public ColumnFamilyDescriptorBuilder setCompressTags(boolean value)

setCompressionType

public ColumnFamilyDescriptorBuilder setCompressionType(Compression.Algorithm value)

getCompressionType

public Compression.Algorithm getCompressionType()

setConfiguration

public ColumnFamilyDescriptorBuilder setConfiguration(String key,
                                                      String value)

setDFSReplication

public ColumnFamilyDescriptorBuilder setDFSReplication(short value)

setDataBlockEncoding

public ColumnFamilyDescriptorBuilder setDataBlockEncoding(DataBlockEncoding value)

setEncryptionKey

public ColumnFamilyDescriptorBuilder setEncryptionKey(byte[] value)

setEncryptionType

public ColumnFamilyDescriptorBuilder setEncryptionType(String value)

setEvictBlocksOnClose

public ColumnFamilyDescriptorBuilder setEvictBlocksOnClose(boolean value)

setInMemory

public ColumnFamilyDescriptorBuilder setInMemory(boolean value)

setInMemoryCompaction

public ColumnFamilyDescriptorBuilder setInMemoryCompaction(MemoryCompactionPolicy value)

setKeepDeletedCells

public ColumnFamilyDescriptorBuilder setKeepDeletedCells(KeepDeletedCells value)

setMaxVersions

public ColumnFamilyDescriptorBuilder setMaxVersions(int value)

setMinVersions

public ColumnFamilyDescriptorBuilder setMinVersions(int value)

setMobCompactPartitionPolicy

public ColumnFamilyDescriptorBuilder setMobCompactPartitionPolicy(MobCompactPartitionPolicy value)

setMobEnabled

public ColumnFamilyDescriptorBuilder setMobEnabled(boolean value)

setMobThreshold

public ColumnFamilyDescriptorBuilder setMobThreshold(long value)

setPrefetchBlocksOnOpen

public ColumnFamilyDescriptorBuilder setPrefetchBlocksOnOpen(boolean value)

setScope

public ColumnFamilyDescriptorBuilder setScope(int value)

setStoragePolicy

public ColumnFamilyDescriptorBuilder setStoragePolicy(String value)

setTimeToLive

public ColumnFamilyDescriptorBuilder setTimeToLive(int value)

setTimeToLive

public ColumnFamilyDescriptorBuilder setTimeToLive(String value)
                                            throws org.apache.hadoop.hbase.exceptions.HBaseException

Throws:

org.apache.hadoop.hbase.exceptions.HBaseException

setNewVersionBehavior

public ColumnFamilyDescriptorBuilder setNewVersionBehavior(boolean value)

setValue

public ColumnFamilyDescriptorBuilder setValue(Bytes key,
                                              Bytes value)

setValue

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

setValue

public ColumnFamilyDescriptorBuilder setValue(String key,
                                              String value)

setVersionsWithTimeToLive

public ColumnFamilyDescriptorBuilder setVersionsWithTimeToLive(int retentionInterval,
                                                               int versionAfterInterval)