CacheConfig (Apache HBase - Server 2.5.6-hadoop3 API)

java.lang.Object
- org.apache.hadoop.hbase.io.hfile.CacheConfig

@InterfaceAudience.Private
public class CacheConfig
extends Object

Stores all of the cache objects and configuration for a single HFile.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CACHE_BLOCKS_ON_WRITE_KEY` Configuration key to cache data blocks on write.
`static String`	`CACHE_BLOOM_BLOCKS_ON_WRITE_KEY` Configuration key to cache compound bloom filter blocks on write.
`static String`	`CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY` Configuration key to cache blocks when a compacted file is written
`static String`	`CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY` Configuration key to determine total size in bytes of compacted files beyond which we do not cache blocks on compaction
`static String`	`CACHE_DATA_BLOCKS_COMPRESSED_KEY` Configuration key to cache data blocks in compressed and/or encrypted format.
`static String`	`CACHE_DATA_ON_READ_KEY` Configuration key to cache data blocks on read.
`static String`	`CACHE_INDEX_BLOCKS_ON_WRITE_KEY` Configuration key to cache leaf and intermediate-level index blocks on write.
`static boolean`	`DEFAULT_CACHE_BLOOMS_ON_WRITE`
`static boolean`	`DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE`
`static long`	`DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD`
`static boolean`	`DEFAULT_CACHE_DATA_COMPRESSED`
`static boolean`	`DEFAULT_CACHE_DATA_ON_READ`
`static boolean`	`DEFAULT_CACHE_DATA_ON_WRITE`
`static boolean`	`DEFAULT_CACHE_INDEXES_ON_WRITE`
`static boolean`	`DEFAULT_EVICT_ON_CLOSE`
`static boolean`	`DEFAULT_IN_MEMORY`
`static boolean`	`DEFAULT_PREFETCH_ON_OPEN`
`static CacheConfig`	`DISABLED` Disabled cache configuration
`static boolean`	`DROP_BEHIND_CACHE_COMPACTION_DEFAULT`
`static String`	`DROP_BEHIND_CACHE_COMPACTION_KEY`
`static String`	`EVICT_BLOCKS_ON_CLOSE_KEY` Configuration key to evict all blocks of a given file from the block cache when the file is closed.
`static String`	`PREFETCH_BLOCKS_ON_OPEN_KEY` Configuration key to prefetch all blocks of a given file into the block cache when the file is opened.

Constructor Summary

Constructors
Constructor and Description
`CacheConfig(CacheConfig cacheConf)` Constructs a cache configuration copied from the specified configuration.
`CacheConfig(org.apache.hadoop.conf.Configuration conf)` Create a cache configuration using the specified configuration object and defaults for family level settings.
`CacheConfig(org.apache.hadoop.conf.Configuration conf, BlockCache blockCache)`
`CacheConfig(org.apache.hadoop.conf.Configuration conf, ColumnFamilyDescriptor family, BlockCache blockCache, ByteBuffAllocator byteBuffAllocator)` Create a cache configuration using the specified configuration object and family descriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enableCacheOnWrite()` Enable cache on write including: cacheDataOnWrite cacheIndexesOnWrite cacheBloomsOnWrite
`Optional<BlockCache>`	`getBlockCache()` Returns the block cache.
`ByteBuffAllocator`	`getByteBuffAllocator()`
`long`	`getCacheCompactedBlocksOnWriteThreshold()` Returns total file size in bytes threshold for caching while writing during compaction
`boolean`	`isCombinedBlockCache()`
`boolean`	`isInMemory()` Returns true if blocks in this file should be flagged as in-memory
`void`	`setCacheDataOnWrite(boolean cacheDataOnWrite)`
`void`	`setEvictOnClose(boolean evictOnClose)` Only used for testing.
`boolean`	`shouldCacheBlockOnRead(BlockType.BlockCategory category)` Should we cache a block of a particular category? We always cache important blocks such as index blocks, as long as the block cache is available.
`boolean`	`shouldCacheBloomsOnWrite()`
`boolean`	`shouldCacheCompactedBlocksOnWrite()` Returns true if blocks should be cached while writing during compaction, false if not
`boolean`	`shouldCacheCompressed(BlockType.BlockCategory category)` Returns true if this `BlockType.BlockCategory` should be compressed in blockcache, false otherwise
`boolean`	`shouldCacheDataCompressed()` Returns true if data blocks should be compressed in the cache, false if not
`boolean`	`shouldCacheDataOnRead()` Returns whether the DATA blocks of this HFile should be cached on read or not (we always cache the meta blocks, the INDEX and BLOOM blocks).
`boolean`	`shouldCacheDataOnWrite()`
`boolean`	`shouldCacheIndexesOnWrite()`
`boolean`	`shouldDropBehindCompaction()`
`boolean`	`shouldEvictOnClose()`
`boolean`	`shouldLockOnCacheMiss(BlockType blockType)` If we make sure the block could not be cached, we will not acquire the lock otherwise we will acquire lock
`boolean`	`shouldPrefetchOnOpen()` Returns true if blocks should be prefetched into the cache on open, false if not
`boolean`	`shouldReadBlockFromCache(BlockType blockType)` Return true if we may find this type of block in block cache.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DISABLED
```
public static final CacheConfig DISABLED
```
    Disabled cache configuration
  - CACHE_DATA_ON_READ_KEY
```
public static final String CACHE_DATA_ON_READ_KEY
```
    Configuration key to cache data blocks on read. Bloom blocks and index blocks are always be cached if the block cache is enabled.
    
    See Also:
    
    Constant Field Values
  - CACHE_BLOCKS_ON_WRITE_KEY
```
public static final String CACHE_BLOCKS_ON_WRITE_KEY
```
    Configuration key to cache data blocks on write. There are separate switches for bloom blocks and non-root index blocks.
    
    See Also:
    
    Constant Field Values
  - CACHE_INDEX_BLOCKS_ON_WRITE_KEY
```
public static final String CACHE_INDEX_BLOCKS_ON_WRITE_KEY
```
    Configuration key to cache leaf and intermediate-level index blocks on write.
    
    See Also:
    
    Constant Field Values
  - CACHE_BLOOM_BLOCKS_ON_WRITE_KEY
```
public static final String CACHE_BLOOM_BLOCKS_ON_WRITE_KEY
```
    Configuration key to cache compound bloom filter blocks on write.
    
    See Also:
    
    Constant Field Values
  - CACHE_DATA_BLOCKS_COMPRESSED_KEY
```
public static final String CACHE_DATA_BLOCKS_COMPRESSED_KEY
```
    Configuration key to cache data blocks in compressed and/or encrypted format.
    
    See Also:
    
    Constant Field Values
  - EVICT_BLOCKS_ON_CLOSE_KEY
```
public static final String EVICT_BLOCKS_ON_CLOSE_KEY
```
    Configuration key to evict all blocks of a given file from the block cache when the file is closed.
    
    See Also:
    
    Constant Field Values
  - PREFETCH_BLOCKS_ON_OPEN_KEY
```
public static final String PREFETCH_BLOCKS_ON_OPEN_KEY
```
    Configuration key to prefetch all blocks of a given file into the block cache when the file is opened.
    
    See Also:
    
    Constant Field Values
  - CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY
```
public static final String CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY
```
    Configuration key to cache blocks when a compacted file is written
    
    See Also:
    
    Constant Field Values
  - CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY
```
public static final String CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY
```
    Configuration key to determine total size in bytes of compacted files beyond which we do not cache blocks on compaction
    
    See Also:
    
    Constant Field Values
  - DROP_BEHIND_CACHE_COMPACTION_KEY
```
public static final String DROP_BEHIND_CACHE_COMPACTION_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_DATA_ON_READ
```
public static final boolean DEFAULT_CACHE_DATA_ON_READ
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_DATA_ON_WRITE
```
public static final boolean DEFAULT_CACHE_DATA_ON_WRITE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_IN_MEMORY
```
public static final boolean DEFAULT_IN_MEMORY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_INDEXES_ON_WRITE
```
public static final boolean DEFAULT_CACHE_INDEXES_ON_WRITE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_BLOOMS_ON_WRITE
```
public static final boolean DEFAULT_CACHE_BLOOMS_ON_WRITE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_EVICT_ON_CLOSE
```
public static final boolean DEFAULT_EVICT_ON_CLOSE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_DATA_COMPRESSED
```
public static final boolean DEFAULT_CACHE_DATA_COMPRESSED
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PREFETCH_ON_OPEN
```
public static final boolean DEFAULT_PREFETCH_ON_OPEN
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE
```
public static final boolean DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE
```
    See Also:
    
    Constant Field Values
  - DROP_BEHIND_CACHE_COMPACTION_DEFAULT
```
public static final boolean DROP_BEHIND_CACHE_COMPACTION_DEFAULT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD
```
public static final long DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CacheConfig
```
public CacheConfig(org.apache.hadoop.conf.Configuration conf)
```
    Create a cache configuration using the specified configuration object and defaults for family level settings. Only use if no column family context.
    
    Parameters:
    
    conf - hbase configuration
  - CacheConfig
```
public CacheConfig(org.apache.hadoop.conf.Configuration conf,
                   BlockCache blockCache)
```
  - CacheConfig
```
public CacheConfig(org.apache.hadoop.conf.Configuration conf,
                   ColumnFamilyDescriptor family,
                   BlockCache blockCache,
                   ByteBuffAllocator byteBuffAllocator)
```
    Create a cache configuration using the specified configuration object and family descriptor.
    
    Parameters:
    
    conf - hbase configuration
    
    family - column family configuration
  - CacheConfig
```
public CacheConfig(CacheConfig cacheConf)
```
    Constructs a cache configuration copied from the specified configuration.
- Method Detail
  - shouldCacheDataOnRead
```
public boolean shouldCacheDataOnRead()
```
    Returns whether the DATA blocks of this HFile should be cached on read or not (we always cache the meta blocks, the INDEX and BLOOM blocks).
    
    Returns:
    
    true if blocks should be cached on read, false if not
  - shouldDropBehindCompaction
```
public boolean shouldDropBehindCompaction()
```
  - shouldCacheBlockOnRead
```
public boolean shouldCacheBlockOnRead(BlockType.BlockCategory category)
```
    Should we cache a block of a particular category? We always cache important blocks such as index blocks, as long as the block cache is available.
  - isInMemory
```
public boolean isInMemory()
```
    Returns true if blocks in this file should be flagged as in-memory
  - shouldCacheDataOnWrite
```
public boolean shouldCacheDataOnWrite()
```
    Returns:
    
    true if data blocks should be written to the cache when an HFile is written, false if not
  - setCacheDataOnWrite
```
public void setCacheDataOnWrite(boolean cacheDataOnWrite)
```
    Parameters:
    
    cacheDataOnWrite - whether data blocks should be written to the cache when an HFile is written
  - enableCacheOnWrite
```
public void enableCacheOnWrite()
```
    Enable cache on write including: cacheDataOnWrite cacheIndexesOnWrite cacheBloomsOnWrite
  - shouldCacheIndexesOnWrite
```
public boolean shouldCacheIndexesOnWrite()
```
    Returns:
    
    true if index blocks should be written to the cache when an HFile is written, false if not
  - shouldCacheBloomsOnWrite
```
public boolean shouldCacheBloomsOnWrite()
```
    Returns:
    
    true if bloom blocks should be written to the cache when an HFile is written, false if not
  - shouldEvictOnClose
```
public boolean shouldEvictOnClose()
```
    Returns:
    
    true if blocks should be evicted from the cache when an HFile reader is closed, false if not
  - setEvictOnClose
```
public void setEvictOnClose(boolean evictOnClose)
```
    Only used for testing.
    
    Parameters:
    
    evictOnClose - whether blocks should be evicted from the cache when an HFile reader is closed
  - shouldCacheDataCompressed
```
public boolean shouldCacheDataCompressed()
```
    Returns true if data blocks should be compressed in the cache, false if not
  - shouldCacheCompressed
```
public boolean shouldCacheCompressed(BlockType.BlockCategory category)
```
    Returns true if this BlockType.BlockCategory should be compressed in blockcache, false otherwise
  - shouldPrefetchOnOpen
```
public boolean shouldPrefetchOnOpen()
```
    Returns true if blocks should be prefetched into the cache on open, false if not
  - shouldCacheCompactedBlocksOnWrite
```
public boolean shouldCacheCompactedBlocksOnWrite()
```
    Returns true if blocks should be cached while writing during compaction, false if not
  - getCacheCompactedBlocksOnWriteThreshold
```
public long getCacheCompactedBlocksOnWriteThreshold()
```
    Returns total file size in bytes threshold for caching while writing during compaction
  - shouldReadBlockFromCache
```
public boolean shouldReadBlockFromCache(BlockType blockType)
```
    Return true if we may find this type of block in block cache.
    TODO: today family.isBlockCacheEnabled() only means cacheDataOnRead, so here we consider lots of other configurations such as cacheDataOnWrite. We should fix this in the future, cacheDataOnWrite should honor the CF level isBlockCacheEnabled configuration.
  - shouldLockOnCacheMiss
```
public boolean shouldLockOnCacheMiss(BlockType blockType)
```
    If we make sure the block could not be cached, we will not acquire the lock otherwise we will acquire lock
  - getBlockCache
```
public Optional<BlockCache> getBlockCache()
```
    Returns the block cache.
    
    Returns:
    
    the block cache, or null if caching is completely disabled
  - isCombinedBlockCache
```
public boolean isCombinedBlockCache()
```
  - getByteBuffAllocator
```
public ByteBuffAllocator getByteBuffAllocator()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CacheConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISABLED

CACHE_DATA_ON_READ_KEY

CACHE_BLOCKS_ON_WRITE_KEY

CACHE_INDEX_BLOCKS_ON_WRITE_KEY

CACHE_BLOOM_BLOCKS_ON_WRITE_KEY

CACHE_DATA_BLOCKS_COMPRESSED_KEY

EVICT_BLOCKS_ON_CLOSE_KEY

PREFETCH_BLOCKS_ON_OPEN_KEY

CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY

CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY

DROP_BEHIND_CACHE_COMPACTION_KEY

DEFAULT_CACHE_DATA_ON_READ

DEFAULT_CACHE_DATA_ON_WRITE

DEFAULT_IN_MEMORY

DEFAULT_CACHE_INDEXES_ON_WRITE

DEFAULT_CACHE_BLOOMS_ON_WRITE

DEFAULT_EVICT_ON_CLOSE

DEFAULT_CACHE_DATA_COMPRESSED

DEFAULT_PREFETCH_ON_OPEN

DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE

DROP_BEHIND_CACHE_COMPACTION_DEFAULT

DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD

Constructor Detail

CacheConfig

CacheConfig

CacheConfig

CacheConfig

Method Detail

shouldCacheDataOnRead

shouldDropBehindCompaction

shouldCacheBlockOnRead

isInMemory

shouldCacheDataOnWrite

setCacheDataOnWrite

enableCacheOnWrite

shouldCacheIndexesOnWrite

shouldCacheBloomsOnWrite

shouldEvictOnClose

setEvictOnClose

shouldCacheDataCompressed

shouldCacheCompressed

shouldPrefetchOnOpen

shouldCacheCompactedBlocksOnWrite

getCacheCompactedBlocksOnWriteThreshold

shouldReadBlockFromCache

shouldLockOnCacheMiss

getBlockCache

isCombinedBlockCache

getByteBuffAllocator

toString