CacheConfig (HBase 0.98.7-hadoop1 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`	`BLOCKCACHE_BLOCKSIZE_KEY` The target block size used by blockcache instances.
`static String`	`BUCKET_CACHE_BUCKETS_KEY` A comma-delimited array of values for use as bucket sizes.
`static String`	`BUCKET_CACHE_COMBINED_KEY`
`static String`	`BUCKET_CACHE_COMBINED_PERCENTAGE_KEY`
`static String`	`BUCKET_CACHE_IOENGINE_KEY` Configuration keys for Bucket cache
`static String`	`BUCKET_CACHE_PERSISTENT_PATH_KEY`
`static String`	`BUCKET_CACHE_SIZE_KEY`
`static String`	`BUCKET_CACHE_WRITER_QUEUE_KEY`
`static String`	`BUCKET_CACHE_WRITER_THREADS_KEY`
`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_DATA_BLOCKS_COMPRESSED_KEY` Configuration key to cache data blocks in compressed and/or encrypted format.
`static String`	`CACHE_INDEX_BLOCKS_ON_WRITE_KEY` Configuration key to cache leaf and intermediate-level index blocks on write.
`static boolean`	`DEFAULT_BUCKET_CACHE_COMBINED` Defaults for Bucket cache
`static float`	`DEFAULT_BUCKET_CACHE_COMBINED_PERCENTAGE`
`static int`	`DEFAULT_BUCKET_CACHE_WRITER_QUEUE`
`static int`	`DEFAULT_BUCKET_CACHE_WRITER_THREADS`
`static boolean`	`DEFAULT_CACHE_BLOOMS_ON_WRITE`
`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 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, HColumnDescriptor family)` Create a cache configuration using the specified configuration object and family descriptor.

Method Summary

Methods
Modifier and Type	Method and Description
`BlockCache`	`getBlockCache()` Returns the block cache.
`boolean`	`isBlockCacheEnabled()` Checks whether the block cache is enabled.
`boolean`	`isInMemory()`
`void`	`setCacheDataOnWrite(boolean cacheDataOnWrite)` Only used for testing.
`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`	`shouldCacheCompressed(BlockType.BlockCategory category)`
`boolean`	`shouldCacheDataCompressed()`
`boolean`	`shouldCacheDataOnRead()` Returns whether the blocks of this HFile should be cached on read or not.
`boolean`	`shouldCacheDataOnWrite()`
`boolean`	`shouldCacheIndexesOnWrite()`
`boolean`	`shouldEvictOnClose()`
`boolean`	`shouldPrefetchOnOpen()`
`String`	`toString()`

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

- Field Detail
  - 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
  - BUCKET_CACHE_IOENGINE_KEY
```
public static final String BUCKET_CACHE_IOENGINE_KEY
```
    Configuration keys for Bucket cache
    
    See Also:
    Constant Field Values
  - BUCKET_CACHE_SIZE_KEY
```
public static final String BUCKET_CACHE_SIZE_KEY
```
    See Also:
    Constant Field Values
  - BUCKET_CACHE_PERSISTENT_PATH_KEY
```
public static final String BUCKET_CACHE_PERSISTENT_PATH_KEY
```
    See Also:
    Constant Field Values
  - BUCKET_CACHE_COMBINED_KEY
```
public static final String BUCKET_CACHE_COMBINED_KEY
```
    See Also:
    Constant Field Values
  - BUCKET_CACHE_COMBINED_PERCENTAGE_KEY
```
public static final String BUCKET_CACHE_COMBINED_PERCENTAGE_KEY
```
    See Also:
    Constant Field Values
  - BUCKET_CACHE_WRITER_THREADS_KEY
```
public static final String BUCKET_CACHE_WRITER_THREADS_KEY
```
    See Also:
    Constant Field Values
  - BUCKET_CACHE_WRITER_QUEUE_KEY
```
public static final String BUCKET_CACHE_WRITER_QUEUE_KEY
```
    See Also:
    Constant Field Values
  - BUCKET_CACHE_BUCKETS_KEY
```
public static final String BUCKET_CACHE_BUCKETS_KEY
```
    A comma-delimited array of values for use as bucket sizes.
    
    See Also:
    Constant Field Values
  - DEFAULT_BUCKET_CACHE_COMBINED
```
public static final boolean DEFAULT_BUCKET_CACHE_COMBINED
```
    Defaults for Bucket cache
    
    See Also:
    Constant Field Values
  - DEFAULT_BUCKET_CACHE_WRITER_THREADS
```
public static final int DEFAULT_BUCKET_CACHE_WRITER_THREADS
```
    See Also:
    Constant Field Values
  - DEFAULT_BUCKET_CACHE_WRITER_QUEUE
```
public static final int DEFAULT_BUCKET_CACHE_WRITER_QUEUE
```
    See Also:
    Constant Field Values
  - DEFAULT_BUCKET_CACHE_COMBINED_PERCENTAGE
```
public static final float DEFAULT_BUCKET_CACHE_COMBINED_PERCENTAGE
```
    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
  - BLOCKCACHE_BLOCKSIZE_KEY
```
public static final String BLOCKCACHE_BLOCKSIZE_KEY
```
    The target block size used by blockcache instances. Defaults to HConstants.DEFAULT_BLOCKSIZE. TODO: this config point is completely wrong, as it's used to determine the target block size of BlockCache instances. Rename.
    
    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
- Constructor Detail
  - CacheConfig
```
public CacheConfig(org.apache.hadoop.conf.Configuration conf,
           HColumnDescriptor family)
```
    Create a cache configuration using the specified configuration object and family descriptor.
    
    Parameters:
    conf - hbase configuration
    family - column family configuration
  - CacheConfig
```
public CacheConfig(org.apache.hadoop.conf.Configuration conf)
```
    Create a cache configuration using the specified configuration object and defaults for family level settings.
    
    Parameters:
    conf - hbase configuration
  - CacheConfig
```
public CacheConfig(CacheConfig cacheConf)
```
    Constructs a cache configuration copied from the specified configuration.
    
    Parameters:
    cacheConf -
- Method Detail
  - isBlockCacheEnabled
```
public boolean isBlockCacheEnabled()
```
    Checks whether the block cache is enabled.
  - getBlockCache
```
public BlockCache getBlockCache()
```
    Returns the block cache.
    
    Returns:
    the block cache, or null if caching is completely disabled
  - shouldCacheDataOnRead
```
public boolean shouldCacheDataOnRead()
```
    Returns whether the blocks of this HFile should be cached on read or not.
    
    Returns:
    true if blocks should be cached on read, false if not
  - 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)
```
    Only used for testing.
    
    Parameters:
    cacheDataOnWrite - whether data blocks should be written to the cache when an HFile is written
  - 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
  - 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

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

BUCKET_CACHE_IOENGINE_KEY

BUCKET_CACHE_SIZE_KEY

BUCKET_CACHE_PERSISTENT_PATH_KEY

BUCKET_CACHE_COMBINED_KEY

BUCKET_CACHE_COMBINED_PERCENTAGE_KEY

BUCKET_CACHE_WRITER_THREADS_KEY

BUCKET_CACHE_WRITER_QUEUE_KEY

BUCKET_CACHE_BUCKETS_KEY

DEFAULT_BUCKET_CACHE_COMBINED

DEFAULT_BUCKET_CACHE_WRITER_THREADS

DEFAULT_BUCKET_CACHE_WRITER_QUEUE

DEFAULT_BUCKET_CACHE_COMBINED_PERCENTAGE

PREFETCH_BLOCKS_ON_OPEN_KEY

BLOCKCACHE_BLOCKSIZE_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

Constructor Detail

CacheConfig

CacheConfig

CacheConfig

Method Detail

isBlockCacheEnabled

getBlockCache

shouldCacheDataOnRead

shouldCacheBlockOnRead

isInMemory

shouldCacheDataOnWrite

setCacheDataOnWrite

shouldCacheIndexesOnWrite

shouldCacheBloomsOnWrite

shouldEvictOnClose

setEvictOnClose

shouldCacheDataCompressed

shouldCacheCompressed

shouldPrefetchOnOpen

toString