ColumnFamilyDescriptorBuilder (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder

@InterfaceAudience.Public
public class ColumnFamilyDescriptorBuilder
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor` An ModifyableFamilyDescriptor contains information about a column family such as the number of versions, compression settings, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BLOCKCACHE` Key for the BLOCKCACHE attribute.
`private static Bytes`	`BLOCKCACHE_BYTES`
`static String`	`BLOCKSIZE` Size of storefile/hfile 'blocks'.
`private static Bytes`	`BLOCKSIZE_BYTES`
`static String`	`BLOOMFILTER`
`private static Bytes`	`BLOOMFILTER_BYTES`
`static String`	`CACHE_BLOOMS_ON_WRITE`
`private static Bytes`	`CACHE_BLOOMS_ON_WRITE_BYTES`
`static String`	`CACHE_DATA_ON_WRITE`
`private static Bytes`	`CACHE_DATA_ON_WRITE_BYTES`
`static String`	`CACHE_INDEX_ON_WRITE`
`private static Bytes`	`CACHE_INDEX_ON_WRITE_BYTES`
`private static byte`	`COLUMN_DESCRIPTOR_VERSION`
`static String`	`COMPRESS_TAGS`
`private static Bytes`	`COMPRESS_TAGS_BYTES`
`static String`	`COMPRESSION`
`private static Bytes`	`COMPRESSION_BYTES`
`static String`	`COMPRESSION_COMPACT`
`private static Bytes`	`COMPRESSION_COMPACT_BYTES`
`static String`	`COMPRESSION_COMPACT_MAJOR`
`private static Bytes`	`COMPRESSION_COMPACT_MAJOR_BYTES`
`static String`	`COMPRESSION_COMPACT_MINOR`
`private static Bytes`	`COMPRESSION_COMPACT_MINOR_BYTES`
`static String`	`DATA_BLOCK_ENCODING`
`private static Bytes`	`DATA_BLOCK_ENCODING_BYTES`
`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.
`private static boolean`	`DEFAULT_MOB`
`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.
`private static Map<String,String>`	`DEFAULT_VALUES`
`private ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor`	`desc`
`static String`	`DFS_REPLICATION`
`private static Bytes`	`DFS_REPLICATION_BYTES`
`static String`	`ENCRYPTION`
`private static Bytes`	`ENCRYPTION_BYTES`
`static String`	`ENCRYPTION_KEY`
`private static Bytes`	`ENCRYPTION_KEY_BYTES`
`static String`	`EVICT_BLOCKS_ON_CLOSE`
`private static Bytes`	`EVICT_BLOCKS_ON_CLOSE_BYTES`
`static String`	`IN_MEMORY`
`private static Bytes`	`IN_MEMORY_BYTES`
`static String`	`IN_MEMORY_COMPACTION`
`private static Bytes`	`IN_MEMORY_COMPACTION_BYTES`
`static String`	`IS_MOB`
`private static Bytes`	`IS_MOB_BYTES`
`static String`	`KEEP_DELETED_CELLS` Retain all cells across flushes and compactions even if they fall behind a delete tombstone.
`private static Bytes`	`KEEP_DELETED_CELLS_BYTES`
`static String`	`MAX_VERSIONS`
`private static Bytes`	`MAX_VERSIONS_BYTES`
`static String`	`MIN_VERSIONS`
`private static Bytes`	`MIN_VERSIONS_BYTES`
`static String`	`MOB_COMPACT_PARTITION_POLICY`
`private static Bytes`	`MOB_COMPACT_PARTITION_POLICY_BYTES`
`static String`	`MOB_THRESHOLD`
`private static Bytes`	`MOB_THRESHOLD_BYTES`
`static String`	`NEW_VERSION_BEHAVIOR`
`private static Bytes`	`NEW_VERSION_BEHAVIOR_BYTES`
`static String`	`PREFETCH_BLOCKS_ON_OPEN` Key for the PREFETCH_BLOCKS_ON_OPEN attribute.
`private static Bytes`	`PREFETCH_BLOCKS_ON_OPEN_BYTES`
`static String`	`REPLICATION_SCOPE`
`private static Set<Bytes>`	`RESERVED_KEYWORDS`
`static String`	`STORAGE_POLICY`
`private static Bytes`	`STORAGE_POLICY_BYTES`
`static String`	`TTL`
`private static Bytes`	`TTL_BYTES`

Constructor Summary

Constructors
Modifier Constructor and Description

private ColumnFamilyDescriptorBuilder(byte[] name)

private ColumnFamilyDescriptorBuilder(ColumnFamilyDescriptor desc)

Constructors
Modifier	Constructor and Description
`private`	`ColumnFamilyDescriptorBuilder(byte[] name)`
`private`	`ColumnFamilyDescriptorBuilder(ColumnFamilyDescriptor desc)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColumnFamilyDescriptor`	`build()`
`static ColumnFamilyDescriptor`	`copy(ColumnFamilyDescriptor desc)`
`Compression.Algorithm`	`getCompressionType()`
`static Map<String,String>`	`getDefaultValues()`
`private static Map<Bytes,Bytes>`	`getDefaultValuesBytes()`
`String`	`getNameAsString()`
`static 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
- COLUMN_DESCRIPTOR_VERSION
```
private static final byte COLUMN_DESCRIPTOR_VERSION
```
  See Also:
  
  Constant Field Values
- IN_MEMORY_COMPACTION
```
@InterfaceAudience.Private
public static final String IN_MEMORY_COMPACTION
```
  See Also:
  
  Constant Field Values
- IN_MEMORY_COMPACTION_BYTES
```
private static final Bytes IN_MEMORY_COMPACTION_BYTES
```
- IN_MEMORY
```
@InterfaceAudience.Private
public static final String IN_MEMORY
```
  See Also:
  
  Constant Field Values
- IN_MEMORY_BYTES
```
private static final Bytes IN_MEMORY_BYTES
```
- COMPRESSION
```
@InterfaceAudience.Private
public static final String COMPRESSION
```
  See Also:
  
  Constant Field Values
- COMPRESSION_BYTES
```
private static final Bytes COMPRESSION_BYTES
```
- COMPRESSION_COMPACT
```
@InterfaceAudience.Private
public static final String COMPRESSION_COMPACT
```
  See Also:
  
  Constant Field Values
- COMPRESSION_COMPACT_BYTES
```
private static final Bytes COMPRESSION_COMPACT_BYTES
```
- COMPRESSION_COMPACT_MAJOR
```
public static final String COMPRESSION_COMPACT_MAJOR
```
  See Also:
  
  Constant Field Values
- COMPRESSION_COMPACT_MAJOR_BYTES
```
private static final Bytes COMPRESSION_COMPACT_MAJOR_BYTES
```
- COMPRESSION_COMPACT_MINOR
```
public static final String COMPRESSION_COMPACT_MINOR
```
  See Also:
  
  Constant Field Values
- COMPRESSION_COMPACT_MINOR_BYTES
```
private static final Bytes COMPRESSION_COMPACT_MINOR_BYTES
```
- DATA_BLOCK_ENCODING
```
@InterfaceAudience.Private
public static final String DATA_BLOCK_ENCODING
```
  See Also:
  
  Constant Field Values
- DATA_BLOCK_ENCODING_BYTES
```
private static final Bytes DATA_BLOCK_ENCODING_BYTES
```
- BLOCKCACHE
```
@InterfaceAudience.Private
public static final String BLOCKCACHE
```
  Key for the BLOCKCACHE attribute. A more exact name would be CACHE_DATA_ON_READ because this flag sets whether or not we cache DATA blocks. We always cache INDEX and BLOOM blocks; caching these blocks cannot be disabled.
  
  See Also:
  
  Constant Field Values
- BLOCKCACHE_BYTES
```
private static final Bytes BLOCKCACHE_BYTES
```
- CACHE_DATA_ON_WRITE
```
@InterfaceAudience.Private
public static final String CACHE_DATA_ON_WRITE
```
  See Also:
  
  Constant Field Values
- CACHE_DATA_ON_WRITE_BYTES
```
private static final Bytes CACHE_DATA_ON_WRITE_BYTES
```
- CACHE_INDEX_ON_WRITE
```
@InterfaceAudience.Private
public static final String CACHE_INDEX_ON_WRITE
```
  See Also:
  
  Constant Field Values
- CACHE_INDEX_ON_WRITE_BYTES
```
private static final Bytes CACHE_INDEX_ON_WRITE_BYTES
```
- CACHE_BLOOMS_ON_WRITE
```
@InterfaceAudience.Private
public static final String CACHE_BLOOMS_ON_WRITE
```
  See Also:
  
  Constant Field Values
- CACHE_BLOOMS_ON_WRITE_BYTES
```
private static final Bytes CACHE_BLOOMS_ON_WRITE_BYTES
```
- EVICT_BLOCKS_ON_CLOSE
```
@InterfaceAudience.Private
public static final String EVICT_BLOCKS_ON_CLOSE
```
  See Also:
  
  Constant Field Values
- EVICT_BLOCKS_ON_CLOSE_BYTES
```
private static final Bytes EVICT_BLOCKS_ON_CLOSE_BYTES
```
- PREFETCH_BLOCKS_ON_OPEN
```
@InterfaceAudience.Private
public static final String PREFETCH_BLOCKS_ON_OPEN
```
  Key for the PREFETCH_BLOCKS_ON_OPEN attribute. If set, all INDEX, BLOOM, and DATA blocks of HFiles belonging to this family will be loaded into the cache as soon as the file is opened. These loads will not count as cache misses.
  
  See Also:
  
  Constant Field Values
- PREFETCH_BLOCKS_ON_OPEN_BYTES
```
private static final Bytes PREFETCH_BLOCKS_ON_OPEN_BYTES
```
- BLOCKSIZE
```
@InterfaceAudience.Private
public static final String BLOCKSIZE
```
  Size of storefile/hfile 'blocks'. Default is DEFAULT_BLOCKSIZE. Use smaller block sizes for faster random-access at expense of larger indices (more memory consumption). Note that this is a soft limit and that blocks have overhead (metadata, CRCs) so blocks will tend to be the size specified here and then some; i.e. don't expect that setting BLOCKSIZE=4k means hbase data will align with an SSDs 4k page accesses (TODO).
  
  See Also:
  
  Constant Field Values
- BLOCKSIZE_BYTES
```
private static final Bytes BLOCKSIZE_BYTES
```
- TTL
```
@InterfaceAudience.Private
public static final String TTL
```
  See Also:
  
  Constant Field Values
- TTL_BYTES
```
private static final Bytes TTL_BYTES
```
- BLOOMFILTER
```
@InterfaceAudience.Private
public static final String BLOOMFILTER
```
  See Also:
  
  Constant Field Values
- BLOOMFILTER_BYTES
```
private static final Bytes BLOOMFILTER_BYTES
```
- REPLICATION_SCOPE
```
@InterfaceAudience.Private
public static final String REPLICATION_SCOPE
```
  See Also:
  
  Constant Field Values
- MAX_VERSIONS
```
@InterfaceAudience.Private
public static final String MAX_VERSIONS
```
  See Also:
  
  Constant Field Values
- MAX_VERSIONS_BYTES
```
private static final Bytes MAX_VERSIONS_BYTES
```
- MIN_VERSIONS
```
@InterfaceAudience.Private
public static final String MIN_VERSIONS
```
  See Also:
  
  Constant Field Values
- MIN_VERSIONS_BYTES
```
private static final Bytes MIN_VERSIONS_BYTES
```
- KEEP_DELETED_CELLS
```
@InterfaceAudience.Private
public static final String KEEP_DELETED_CELLS
```
  Retain all cells across flushes and compactions even if they fall behind a delete tombstone. To see all retained cells, do a 'raw' scan; see Scan#setRaw or pass RAW => true attribute in the shell.
  
  See Also:
  
  Constant Field Values
- KEEP_DELETED_CELLS_BYTES
```
private static final Bytes KEEP_DELETED_CELLS_BYTES
```
- COMPRESS_TAGS
```
@InterfaceAudience.Private
public static final String COMPRESS_TAGS
```
  See Also:
  
  Constant Field Values
- COMPRESS_TAGS_BYTES
```
private static final Bytes COMPRESS_TAGS_BYTES
```
- ENCRYPTION
```
@InterfaceAudience.Private
public static final String ENCRYPTION
```
  See Also:
  
  Constant Field Values
- ENCRYPTION_BYTES
```
private static final Bytes ENCRYPTION_BYTES
```
- ENCRYPTION_KEY
```
@InterfaceAudience.Private
public static final String ENCRYPTION_KEY
```
  See Also:
  
  Constant Field Values
- ENCRYPTION_KEY_BYTES
```
private static final Bytes ENCRYPTION_KEY_BYTES
```
- DEFAULT_MOB
```
private static final boolean DEFAULT_MOB
```
  See Also:
  
  Constant Field Values
- IS_MOB
```
@InterfaceAudience.Private
public static final String IS_MOB
```
  See Also:
  
  Constant Field Values
- IS_MOB_BYTES
```
private static final Bytes IS_MOB_BYTES
```
- MOB_THRESHOLD
```
@InterfaceAudience.Private
public static final String MOB_THRESHOLD
```
  See Also:
  
  Constant Field Values
- MOB_THRESHOLD_BYTES
```
private static final Bytes MOB_THRESHOLD_BYTES
```
- DEFAULT_MOB_THRESHOLD
```
public static final long DEFAULT_MOB_THRESHOLD
```
  See Also:
  
  Constant Field Values
- MOB_COMPACT_PARTITION_POLICY
```
@InterfaceAudience.Private
public static final String MOB_COMPACT_PARTITION_POLICY
```
  See Also:
  
  Constant Field Values
- MOB_COMPACT_PARTITION_POLICY_BYTES
```
private static final Bytes MOB_COMPACT_PARTITION_POLICY_BYTES
```
- DEFAULT_MOB_COMPACT_PARTITION_POLICY
```
public static final MobCompactPartitionPolicy DEFAULT_MOB_COMPACT_PARTITION_POLICY
```
- DFS_REPLICATION
```
@InterfaceAudience.Private
public static final String DFS_REPLICATION
```
  See Also:
  
  Constant Field Values
- DFS_REPLICATION_BYTES
```
private static final Bytes DFS_REPLICATION_BYTES
```
- DEFAULT_DFS_REPLICATION
```
public static final short DEFAULT_DFS_REPLICATION
```
  See Also:
  
  Constant Field Values
- STORAGE_POLICY
```
@InterfaceAudience.Private
public static final String STORAGE_POLICY
```
  See Also:
  
  Constant Field Values
- STORAGE_POLICY_BYTES
```
private static final Bytes STORAGE_POLICY_BYTES
```
- NEW_VERSION_BEHAVIOR
```
public static final String NEW_VERSION_BEHAVIOR
```
  See Also:
  
  Constant Field Values
- NEW_VERSION_BEHAVIOR_BYTES
```
private static final Bytes NEW_VERSION_BEHAVIOR_BYTES
```
- 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
- DEFAULT_VALUES
```
private static final Map<String,String> DEFAULT_VALUES
```
- RESERVED_KEYWORDS
```
private static final Set<Bytes> RESERVED_KEYWORDS
```
- desc
```
private final ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor desc
```

Constructor Detail

ColumnFamilyDescriptorBuilder

private ColumnFamilyDescriptorBuilder(byte[] name)

ColumnFamilyDescriptorBuilder

private ColumnFamilyDescriptorBuilder(ColumnFamilyDescriptor desc)

Method Detail

getDefaultValuesBytes

private static Map<Bytes,Bytes> getDefaultValuesBytes()

getDefaultValues

public static Map<String,String> getDefaultValues()

getUnit

public static 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 DeserializationException

Throws:: 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 HBaseException

Throws:: 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 HBaseException

Throws:: 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)

Class ColumnFamilyDescriptorBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLUMN_DESCRIPTOR_VERSION

IN_MEMORY_COMPACTION

IN_MEMORY_COMPACTION_BYTES

IN_MEMORY

IN_MEMORY_BYTES

COMPRESSION

COMPRESSION_BYTES

COMPRESSION_COMPACT

COMPRESSION_COMPACT_BYTES

COMPRESSION_COMPACT_MAJOR

COMPRESSION_COMPACT_MAJOR_BYTES

COMPRESSION_COMPACT_MINOR

COMPRESSION_COMPACT_MINOR_BYTES

DATA_BLOCK_ENCODING

DATA_BLOCK_ENCODING_BYTES

BLOCKCACHE

BLOCKCACHE_BYTES

CACHE_DATA_ON_WRITE

CACHE_DATA_ON_WRITE_BYTES

CACHE_INDEX_ON_WRITE

CACHE_INDEX_ON_WRITE_BYTES

CACHE_BLOOMS_ON_WRITE

CACHE_BLOOMS_ON_WRITE_BYTES

EVICT_BLOCKS_ON_CLOSE

EVICT_BLOCKS_ON_CLOSE_BYTES

PREFETCH_BLOCKS_ON_OPEN

PREFETCH_BLOCKS_ON_OPEN_BYTES

BLOCKSIZE

BLOCKSIZE_BYTES

TTL

TTL_BYTES

BLOOMFILTER

BLOOMFILTER_BYTES

REPLICATION_SCOPE

MAX_VERSIONS

MAX_VERSIONS_BYTES

MIN_VERSIONS

MIN_VERSIONS_BYTES

KEEP_DELETED_CELLS

KEEP_DELETED_CELLS_BYTES

COMPRESS_TAGS

COMPRESS_TAGS_BYTES

ENCRYPTION

ENCRYPTION_BYTES

ENCRYPTION_KEY

ENCRYPTION_KEY_BYTES

DEFAULT_MOB

IS_MOB

IS_MOB_BYTES

MOB_THRESHOLD

MOB_THRESHOLD_BYTES

DEFAULT_MOB_THRESHOLD

MOB_COMPACT_PARTITION_POLICY

MOB_COMPACT_PARTITION_POLICY_BYTES

DEFAULT_MOB_COMPACT_PARTITION_POLICY

DFS_REPLICATION

DFS_REPLICATION_BYTES

DEFAULT_DFS_REPLICATION

STORAGE_POLICY

STORAGE_POLICY_BYTES

NEW_VERSION_BEHAVIOR

NEW_VERSION_BEHAVIOR_BYTES

DEFAULT_NEW_VERSION_BEHAVIOR

DEFAULT_COMPRESSION

DEFAULT_DATA_BLOCK_ENCODING

DEFAULT_MAX_VERSIONS

DEFAULT_MIN_VERSIONS

DEFAULT_IN_MEMORY

DEFAULT_KEEP_DELETED

DEFAULT_BLOCKCACHE

DEFAULT_CACHE_DATA_ON_WRITE

DEFAULT_CACHE_INDEX_ON_WRITE

DEFAULT_BLOCKSIZE