ColumnFamilyDescriptor (Apache HBase 2.0.6 API)

All Known Implementing Classes:

ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor, HColumnDescriptor, ImmutableHColumnDescriptor
```
@InterfaceAudience.Public
public interface ColumnFamilyDescriptor
```
An ColumnFamilyDescriptor 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. To construct a new instance, use the ColumnFamilyDescriptorBuilder methods

Since:

2.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static Comparator<ColumnFamilyDescriptor>`	`COMPARATOR`
`static Comparator<ColumnFamilyDescriptor>`	`COMPARATOR_IGNORE_REPLICATION`
`static Bytes`	`REPLICATION_SCOPE_BYTES`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getBlocksize()`
`BloomType`	`getBloomFilterType()`
`Compression.Algorithm`	`getCompactionCompressionType()`
`Compression.Algorithm`	`getCompressionType()`
`Map<String,String>`	`getConfiguration()`
`String`	`getConfigurationValue(String key)`
`DataBlockEncoding`	`getDataBlockEncoding()`
`short`	`getDFSReplication()`
`byte[]`	`getEncryptionKey()`
`String`	`getEncryptionType()`
`MemoryCompactionPolicy`	`getInMemoryCompaction()`
`KeepDeletedCells`	`getKeepDeletedCells()`
`int`	`getMaxVersions()`
`int`	`getMinVersions()`
`MobCompactPartitionPolicy`	`getMobCompactPartitionPolicy()` Get the mob compact partition policy for this family
`long`	`getMobThreshold()` Gets the mob threshold of the family.
`byte[]`	`getName()`
`String`	`getNameAsString()`
`int`	`getScope()`
`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.
`int`	`getTimeToLive()`
`byte[]`	`getValue(byte[] key)`
`Bytes`	`getValue(Bytes key)`
`Map<Bytes,Bytes>`	`getValues()` It clone all bytes of all elements.
`boolean`	`isBlockCacheEnabled()`
`boolean`	`isCacheBloomsOnWrite()`
`boolean`	`isCacheDataOnWrite()`
`boolean`	`isCacheIndexesOnWrite()`
`boolean`	`isCompressTags()`
`boolean`	`isEvictBlocksOnClose()`
`boolean`	`isInMemory()`
`boolean`	`isMobEnabled()` Gets whether the mob is enabled for the family.
`boolean`	`isNewVersionBehavior()` By default, HBase only consider timestamp in versions.
`boolean`	`isPrefetchBlocksOnOpen()`
`String`	`toStringCustomizedValues()`

- Field Detail
  - COMPARATOR
```
@InterfaceAudience.Private
static final Comparator<ColumnFamilyDescriptor> COMPARATOR
```
  - REPLICATION_SCOPE_BYTES
```
static final Bytes REPLICATION_SCOPE_BYTES
```
  - COMPARATOR_IGNORE_REPLICATION
```
@InterfaceAudience.Private
static final Comparator<ColumnFamilyDescriptor> COMPARATOR_IGNORE_REPLICATION
```
- Method Detail
  - getBlocksize
```
int getBlocksize()
```
    Returns:
    
    The storefile/hfile blocksize for this column family.
  - getBloomFilterType
```
BloomType getBloomFilterType()
```
    Returns:
    
    bloom filter type used for new StoreFiles in ColumnFamily
  - getCompactionCompressionType
```
Compression.Algorithm getCompactionCompressionType()
```
    Returns:
    
    Compression type setting.
  - getCompressionType
```
Compression.Algorithm getCompressionType()
```
    Returns:
    
    Compression type setting.
  - getConfiguration
```
Map<String,String> getConfiguration()
```
    Returns:
    
    an unmodifiable map.
  - getConfigurationValue
```
String getConfigurationValue(String key)
```
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    accessing the configuration value by key.
  - getDFSReplication
```
short getDFSReplication()
```
    Returns:
    
    replication factor set for this CF
  - getDataBlockEncoding
```
DataBlockEncoding getDataBlockEncoding()
```
    Returns:
    
    the data block encoding algorithm used in block cache and optionally on disk
  - getEncryptionKey
```
byte[] getEncryptionKey()
```
    Returns:
    
    Return the raw crypto key attribute for the family, or null if not set
  - getEncryptionType
```
String getEncryptionType()
```
    Returns:
    
    Return the encryption algorithm in use by this family
  - getInMemoryCompaction
```
MemoryCompactionPolicy getInMemoryCompaction()
```
    Returns:
    
    in-memory compaction policy if set for the cf. Returns null if no policy is set for for this column family
  - getKeepDeletedCells
```
KeepDeletedCells getKeepDeletedCells()
```
    Returns:
    
    return the KeepDeletedCells
  - getMaxVersions
```
int getMaxVersions()
```
    Returns:
    
    maximum number of versions
  - getMinVersions
```
int getMinVersions()
```
    Returns:
    
    The minimum number of versions to keep.
  - getMobCompactPartitionPolicy
```
MobCompactPartitionPolicy getMobCompactPartitionPolicy()
```
    Get the mob compact partition policy for this family
    
    Returns:
    
    MobCompactPartitionPolicy
  - getMobThreshold
```
long getMobThreshold()
```
    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.
    
    Returns:
    
    The mob threshold.
  - getName
```
byte[] getName()
```
    Returns:
    
    a copy of Name of this column family
  - getNameAsString
```
String getNameAsString()
```
    Returns:
    
    Name of this column family
  - getScope
```
int getScope()
```
    Returns:
    
    the scope tag
  - getStoragePolicy
```
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.
    
    Returns:
    
    Return the storage policy in use by this family
  - getTimeToLive
```
int getTimeToLive()
```
    Returns:
    
    Time-to-live of cell contents, in seconds.
  - getValue
```
Bytes getValue(Bytes key)
```
    Parameters:
    
    key - The key.
    
    Returns:
    
    A clone value. Null if no mapping for the key
  - getValue
```
byte[] getValue(byte[] key)
```
    Parameters:
    
    key - The key.
    
    Returns:
    
    A clone value. Null if no mapping for the key
  - getValues
```
Map<Bytes,Bytes> getValues()
```
    It clone all bytes of all elements.
    
    Returns:
    
    All values
  - isBlockCacheEnabled
```
boolean isBlockCacheEnabled()
```
    Returns:
    
    True if hfile DATA type blocks should be cached (You cannot disable caching of INDEX and BLOOM type blocks).
  - isCacheBloomsOnWrite
```
boolean isCacheBloomsOnWrite()
```
    Returns:
    
    true if we should cache bloomfilter blocks on write
  - isCacheDataOnWrite
```
boolean isCacheDataOnWrite()
```
    Returns:
    
    true if we should cache data blocks on write
  - isCacheIndexesOnWrite
```
boolean isCacheIndexesOnWrite()
```
    Returns:
    
    true if we should cache index blocks on write
  - isCompressTags
```
boolean isCompressTags()
```
    Returns:
    
    Whether KV tags should be compressed along with DataBlockEncoding. When no DataBlockEncoding is been used, this is having no effect.
  - isEvictBlocksOnClose
```
boolean isEvictBlocksOnClose()
```
    Returns:
    
    true if we should evict cached blocks from the blockcache on close
  - isInMemory
```
boolean isInMemory()
```
    Returns:
    
    True if we are to favor keeping all values for this column family in the HRegionServer cache.
  - isMobEnabled
```
boolean isMobEnabled()
```
    Gets whether the mob is enabled for the family.
    
    Returns:
    
    True if the mob is enabled for the family.
  - isPrefetchBlocksOnOpen
```
boolean isPrefetchBlocksOnOpen()
```
    Returns:
    
    true if we should prefetch blocks into the blockcache on open
  - toStringCustomizedValues
```
String toStringCustomizedValues()
```
    Returns:
    
    Column family descriptor with only the customized attributes.
  - isNewVersionBehavior
```
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.

Interface ColumnFamilyDescriptor

Field Summary

Method Summary

Field Detail

COMPARATOR

REPLICATION_SCOPE_BYTES

COMPARATOR_IGNORE_REPLICATION

Method Detail

getBlocksize

getBloomFilterType

getCompactionCompressionType

getCompressionType

getConfiguration

getConfigurationValue

getDFSReplication

getDataBlockEncoding

getEncryptionKey

getEncryptionType

getInMemoryCompaction

getKeepDeletedCells

getMaxVersions

getMinVersions

getMobCompactPartitionPolicy

getMobThreshold

getName

getNameAsString

getScope

getStoragePolicy

getTimeToLive

getValue

getValue

getValues

isBlockCacheEnabled

isCacheBloomsOnWrite

isCacheDataOnWrite

isCacheIndexesOnWrite

isCompressTags

isEvictBlocksOnClose

isInMemory

isMobEnabled

isPrefetchBlocksOnOpen

toStringCustomizedValues

isNewVersionBehavior