| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CacheConfig (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.io.hfile, class: CacheConfig"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/CacheConfig.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.io.hfile</a></div> |
| <h1 title="Class CacheConfig" class="title">Class CacheConfig</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.io.hfile.CacheConfig</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../conf/ConfigurationObserver.html" title="interface in org.apache.hadoop.hbase.conf">ConfigurationObserver</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-33">CacheConfig</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../../conf/ConfigurationObserver.html" title="interface in org.apache.hadoop.hbase.conf">ConfigurationObserver</a></span></div> |
| <div class="block">Stores all of the cache objects and configuration for a single HFile.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private final <a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#blockCache" class="member-name-link">blockCache</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#BUCKETCACHE_PERSIST_INTERVAL_KEY" class="member-name-link">BUCKETCACHE_PERSIST_INTERVAL_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key to set interval for persisting bucket cache to disk.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private final <a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#byteBuffAllocator" class="member-name-link">byteBuffAllocator</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CACHE_BLOCKS_ON_WRITE_KEY" class="member-name-link">CACHE_BLOCKS_ON_WRITE_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key to cache data blocks on write.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#CACHE_BLOOM_BLOCKS_ON_WRITE_KEY" class="member-name-link">CACHE_BLOOM_BLOCKS_ON_WRITE_KEY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Configuration key to cache compound bloom filter blocks on write.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY" class="member-name-link">CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key to cache blocks when a compacted file is written</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY" class="member-name-link">CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Configuration key to determine total size in bytes of compacted files beyond which we do not |
| cache blocks on compaction</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CACHE_DATA_BLOCKS_COMPRESSED_KEY" class="member-name-link">CACHE_DATA_BLOCKS_COMPRESSED_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key to cache data blocks in compressed and/or encrypted format.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#CACHE_DATA_ON_READ_KEY" class="member-name-link">CACHE_DATA_ON_READ_KEY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Configuration key to cache data blocks on read.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CACHE_INDEX_BLOCKS_ON_WRITE_KEY" class="member-name-link">CACHE_INDEX_BLOCKS_ON_WRITE_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key to cache leaf and intermediate-level index blocks on write.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#cacheBloomsOnWrite" class="member-name-link">cacheBloomsOnWrite</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Whether compound bloom filter blocks should be cached on write</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#cacheCompactedDataOnWrite" class="member-name-link">cacheCompactedDataOnWrite</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether data blocks should be cached when compacted file is written</div> |
| </div> |
| <div class="col-first even-row-color"><code>private long</code></div> |
| <div class="col-second even-row-color"><code><a href="#cacheCompactedDataOnWriteThreshold" class="member-name-link">cacheCompactedDataOnWriteThreshold</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Determine threshold beyond which we do not cache blocks on compaction</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#cacheDataCompressed" class="member-name-link">cacheDataCompressed</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether data blocks should be stored in compressed and/or encrypted form in the cache</div> |
| </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#cacheDataOnRead" class="member-name-link">cacheDataOnRead</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Whether blocks should be cached on read (default is on if there is a cache but this can be |
| turned off on a per-family or per-request basis).</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#cacheDataOnWrite" class="member-name-link">cacheDataOnWrite</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether data blocks should be cached when new files are written</div> |
| </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#cacheIndexesOnWrite" class="member-name-link">cacheIndexesOnWrite</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Whether index blocks should be cached when new files are written</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_CACHE_BLOOMS_ON_WRITE" class="member-name-link">DEFAULT_CACHE_BLOOMS_ON_WRITE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE" class="member-name-link">DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD" class="member-name-link">DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_CACHE_DATA_COMPRESSED" class="member-name-link">DEFAULT_CACHE_DATA_COMPRESSED</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_CACHE_DATA_ON_READ" class="member-name-link">DEFAULT_CACHE_DATA_ON_READ</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_CACHE_DATA_ON_WRITE" class="member-name-link">DEFAULT_CACHE_DATA_ON_WRITE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_CACHE_INDEXES_ON_WRITE" class="member-name-link">DEFAULT_CACHE_INDEXES_ON_WRITE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_EVICT_ON_CLOSE" class="member-name-link">DEFAULT_EVICT_ON_CLOSE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_EVICT_ON_SPLIT" class="member-name-link">DEFAULT_EVICT_ON_SPLIT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_IN_MEMORY" class="member-name-link">DEFAULT_IN_MEMORY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final double</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_PREFETCH_HEAP_USAGE_THRESHOLD" class="member-name-link">DEFAULT_PREFETCH_HEAP_USAGE_THRESHOLD</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_PREFETCH_ON_OPEN" class="member-name-link">DEFAULT_PREFETCH_ON_OPEN</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="CacheConfig.html" title="class in org.apache.hadoop.hbase.io.hfile">CacheConfig</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DISABLED" class="member-name-link">DISABLED</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Disabled cache configuration</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#DROP_BEHIND_CACHE_COMPACTION_DEFAULT" class="member-name-link">DROP_BEHIND_CACHE_COMPACTION_DEFAULT</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DROP_BEHIND_CACHE_COMPACTION_KEY" class="member-name-link">DROP_BEHIND_CACHE_COMPACTION_KEY</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#dropBehindCompaction" class="member-name-link">dropBehindCompaction</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#EVICT_BLOCKS_ON_CLOSE_KEY" class="member-name-link">EVICT_BLOCKS_ON_CLOSE_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key to evict all blocks of a given file from the block cache when the file is |
| closed.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#EVICT_BLOCKS_ON_SPLIT_KEY" class="member-name-link">EVICT_BLOCKS_ON_SPLIT_KEY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#evictOnClose" class="member-name-link">evictOnClose</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether blocks of a file should be evicted when the file is closed</div> |
| </div> |
| <div class="col-first even-row-color"><code>private final double</code></div> |
| <div class="col-second even-row-color"><code><a href="#heapUsageThreshold" class="member-name-link">heapUsageThreshold</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#inMemory" class="member-name-link">inMemory</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether blocks should be flagged as in-memory when being cached</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#PREFETCH_BLOCKS_ON_OPEN_KEY" class="member-name-link">PREFETCH_BLOCKS_ON_OPEN_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key to prefetch all blocks of a given file into the block cache when the file is |
| opened.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#PREFETCH_HEAP_USAGE_THRESHOLD" class="member-name-link">PREFETCH_HEAP_USAGE_THRESHOLD</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Configuration key to set the heap usage threshold limit once prefetch threads should be |
| interrupted.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#prefetchOnOpen" class="member-name-link">prefetchOnOpen</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether data blocks should be prefetched into the cache</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CacheConfig</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration)" class="member-name-link">CacheConfig</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a cache configuration using the specified configuration object and defaults for family |
| level settings.</div> |
| </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.ColumnFamilyDescriptor,org.apache.hadoop.hbase.io.hfile.BlockCache,org.apache.hadoop.hbase.io.ByteBuffAllocator)" class="member-name-link">CacheConfig</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a> family, |
| <a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a> blockCache, |
| <a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a> byteBuffAllocator)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a cache configuration using the specified configuration object and family descriptor.</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.io.hfile.BlockCache)" class="member-name-link">CacheConfig</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a> blockCache)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.io.hfile.CacheConfig)" class="member-name-link">CacheConfig</a><wbr>(<a href="CacheConfig.html" title="class in org.apache.hadoop.hbase.io.hfile">CacheConfig</a> cacheConf)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a cache configuration copied from the specified configuration.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableCacheOnWrite()" class="member-name-link">enableCacheOnWrite</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enable cache on write including: cacheDataOnWrite cacheIndexesOnWrite cacheBloomsOnWrite</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlockCache()" class="member-name-link">getBlockCache</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the block cache.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getByteBuffAllocator()" class="member-name-link">getByteBuffAllocator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCacheCompactedBlocksOnWriteThreshold()" class="member-name-link">getCacheCompactedBlocksOnWriteThreshold</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns total file size in bytes threshold for caching while writing during compaction</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCacheCompactedBlocksOnWriteThreshold(org.apache.hadoop.conf.Configuration)" class="member-name-link">getCacheCompactedBlocksOnWriteThreshold</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeapUsageThreshold()" class="member-name-link">getHeapUsageThreshold</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCombinedBlockCache()" class="member-name-link">isCombinedBlockCache</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isHeapUsageBelowThreshold()" class="member-name-link">isHeapUsageBelowThreshold</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks if the current heap usage is below the threshold configured by |
| "hbase.rs.prefetchheapusage" (0.8 by default).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInMemory()" class="member-name-link">isInMemory</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if blocks in this file should be flagged as in-memory</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onConfigurationChange(org.apache.hadoop.conf.Configuration)" class="member-name-link">onConfigurationChange</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method would be called by the <a href="../../conf/ConfigurationManager.html" title="class in org.apache.hadoop.hbase.conf"><code>ConfigurationManager</code></a> object when the |
| <code>Configuration</code> object is reloaded from disk.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCacheDataOnWrite(boolean)" class="member-name-link">setCacheDataOnWrite</a><wbr>(boolean cacheDataOnWrite)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEvictOnClose(boolean)" class="member-name-link">setEvictOnClose</a><wbr>(boolean evictOnClose)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Only used for testing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheBlockOnRead(org.apache.hadoop.hbase.io.hfile.BlockType.BlockCategory)" class="member-name-link">shouldCacheBlockOnRead</a><wbr>(<a href="BlockType.BlockCategory.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType.BlockCategory</a> category)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">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.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheBloomsOnWrite()" class="member-name-link">shouldCacheBloomsOnWrite</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheCompactedBlocksOnWrite()" class="member-name-link">shouldCacheCompactedBlocksOnWrite</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if blocks should be cached while writing during compaction, false if not</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheCompressed(org.apache.hadoop.hbase.io.hfile.BlockType.BlockCategory)" class="member-name-link">shouldCacheCompressed</a><wbr>(<a href="BlockType.BlockCategory.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType.BlockCategory</a> category)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if this <a href="BlockType.BlockCategory.html" title="enum class in org.apache.hadoop.hbase.io.hfile"><code>BlockType.BlockCategory</code></a> should be compressed in blockcache, false otherwise</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheDataCompressed()" class="member-name-link">shouldCacheDataCompressed</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if data blocks should be compressed in the cache, false if not</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheDataOnRead()" class="member-name-link">shouldCacheDataOnRead</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">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).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheDataOnWrite()" class="member-name-link">shouldCacheDataOnWrite</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldCacheIndexesOnWrite()" class="member-name-link">shouldCacheIndexesOnWrite</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldDropBehindCompaction()" class="member-name-link">shouldDropBehindCompaction</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldEvictOnClose()" class="member-name-link">shouldEvictOnClose</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldLockOnCacheMiss(org.apache.hadoop.hbase.io.hfile.BlockType)" class="member-name-link">shouldLockOnCacheMiss</a><wbr>(<a href="BlockType.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType</a> blockType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If we make sure the block could not be cached, we will not acquire the lock otherwise we will |
| acquire lock</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldPrefetchOnOpen()" class="member-name-link">shouldPrefetchOnOpen</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if blocks should be prefetched into the cache on open, false if not</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldReadBlockFromCache(org.apache.hadoop.hbase.io.hfile.BlockType)" class="member-name-link">shouldReadBlockFromCache</a><wbr>(<a href="BlockType.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType</a> blockType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return true if we may find this type of block in block cache.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-35">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DISABLED"> |
| <h3>DISABLED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="CacheConfig.html" title="class in org.apache.hadoop.hbase.io.hfile">CacheConfig</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-40">DISABLED</a></span></div> |
| <div class="block">Disabled cache configuration</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CACHE_DATA_ON_READ_KEY"> |
| <h3>CACHE_DATA_ON_READ_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-46">CACHE_DATA_ON_READ_KEY</a></span></div> |
| <div class="block">Configuration key to cache data blocks on read. Bloom blocks and index blocks are always be |
| cached if the block cache is enabled.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.CACHE_DATA_ON_READ_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CACHE_BLOCKS_ON_WRITE_KEY"> |
| <h3>CACHE_BLOCKS_ON_WRITE_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-52">CACHE_BLOCKS_ON_WRITE_KEY</a></span></div> |
| <div class="block">Configuration key to cache data blocks on write. There are separate switches for bloom blocks |
| and non-root index blocks.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.CACHE_BLOCKS_ON_WRITE_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CACHE_INDEX_BLOCKS_ON_WRITE_KEY"> |
| <h3>CACHE_INDEX_BLOCKS_ON_WRITE_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-57">CACHE_INDEX_BLOCKS_ON_WRITE_KEY</a></span></div> |
| <div class="block">Configuration key to cache leaf and intermediate-level index blocks on write.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.CACHE_INDEX_BLOCKS_ON_WRITE_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CACHE_BLOOM_BLOCKS_ON_WRITE_KEY"> |
| <h3>CACHE_BLOOM_BLOCKS_ON_WRITE_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-62">CACHE_BLOOM_BLOCKS_ON_WRITE_KEY</a></span></div> |
| <div class="block">Configuration key to cache compound bloom filter blocks on write.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.CACHE_BLOOM_BLOCKS_ON_WRITE_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CACHE_DATA_BLOCKS_COMPRESSED_KEY"> |
| <h3>CACHE_DATA_BLOCKS_COMPRESSED_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-67">CACHE_DATA_BLOCKS_COMPRESSED_KEY</a></span></div> |
| <div class="block">Configuration key to cache data blocks in compressed and/or encrypted format.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.CACHE_DATA_BLOCKS_COMPRESSED_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EVICT_BLOCKS_ON_CLOSE_KEY"> |
| <h3>EVICT_BLOCKS_ON_CLOSE_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-73">EVICT_BLOCKS_ON_CLOSE_KEY</a></span></div> |
| <div class="block">Configuration key to evict all blocks of a given file from the block cache when the file is |
| closed.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.EVICT_BLOCKS_ON_CLOSE_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EVICT_BLOCKS_ON_SPLIT_KEY"> |
| <h3>EVICT_BLOCKS_ON_SPLIT_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-75">EVICT_BLOCKS_ON_SPLIT_KEY</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.EVICT_BLOCKS_ON_SPLIT_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PREFETCH_BLOCKS_ON_OPEN_KEY"> |
| <h3>PREFETCH_BLOCKS_ON_OPEN_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-81">PREFETCH_BLOCKS_ON_OPEN_KEY</a></span></div> |
| <div class="block">Configuration key to prefetch all blocks of a given file into the block cache when the file is |
| opened.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.PREFETCH_BLOCKS_ON_OPEN_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY"> |
| <h3>CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-86">CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY</a></span></div> |
| <div class="block">Configuration key to cache blocks when a compacted file is written</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.CACHE_COMPACTED_BLOCKS_ON_WRITE_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY"> |
| <h3>CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-93">CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY</a></span></div> |
| <div class="block">Configuration key to determine total size in bytes of compacted files beyond which we do not |
| cache blocks on compaction</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DROP_BEHIND_CACHE_COMPACTION_KEY"> |
| <h3>DROP_BEHIND_CACHE_COMPACTION_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-96">DROP_BEHIND_CACHE_COMPACTION_KEY</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DROP_BEHIND_CACHE_COMPACTION_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BUCKETCACHE_PERSIST_INTERVAL_KEY"> |
| <h3>BUCKETCACHE_PERSIST_INTERVAL_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-102">BUCKETCACHE_PERSIST_INTERVAL_KEY</a></span></div> |
| <div class="block">Configuration key to set interval for persisting bucket cache to disk.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.BUCKETCACHE_PERSIST_INTERVAL_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PREFETCH_HEAP_USAGE_THRESHOLD"> |
| <h3>PREFETCH_HEAP_USAGE_THRESHOLD</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-109">PREFETCH_HEAP_USAGE_THRESHOLD</a></span></div> |
| <div class="block">Configuration key to set the heap usage threshold limit once prefetch threads should be |
| interrupted.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.PREFETCH_HEAP_USAGE_THRESHOLD">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CACHE_DATA_ON_READ"> |
| <h3>DEFAULT_CACHE_DATA_ON_READ</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-112">DEFAULT_CACHE_DATA_ON_READ</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_CACHE_DATA_ON_READ">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CACHE_DATA_ON_WRITE"> |
| <h3>DEFAULT_CACHE_DATA_ON_WRITE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-113">DEFAULT_CACHE_DATA_ON_WRITE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_CACHE_DATA_ON_WRITE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_IN_MEMORY"> |
| <h3>DEFAULT_IN_MEMORY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-114">DEFAULT_IN_MEMORY</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_IN_MEMORY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CACHE_INDEXES_ON_WRITE"> |
| <h3>DEFAULT_CACHE_INDEXES_ON_WRITE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-115">DEFAULT_CACHE_INDEXES_ON_WRITE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_CACHE_INDEXES_ON_WRITE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CACHE_BLOOMS_ON_WRITE"> |
| <h3>DEFAULT_CACHE_BLOOMS_ON_WRITE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-116">DEFAULT_CACHE_BLOOMS_ON_WRITE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_CACHE_BLOOMS_ON_WRITE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_EVICT_ON_CLOSE"> |
| <h3>DEFAULT_EVICT_ON_CLOSE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-117">DEFAULT_EVICT_ON_CLOSE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_EVICT_ON_CLOSE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_EVICT_ON_SPLIT"> |
| <h3>DEFAULT_EVICT_ON_SPLIT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-118">DEFAULT_EVICT_ON_SPLIT</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_EVICT_ON_SPLIT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CACHE_DATA_COMPRESSED"> |
| <h3>DEFAULT_CACHE_DATA_COMPRESSED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-119">DEFAULT_CACHE_DATA_COMPRESSED</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_CACHE_DATA_COMPRESSED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_PREFETCH_ON_OPEN"> |
| <h3>DEFAULT_PREFETCH_ON_OPEN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-120">DEFAULT_PREFETCH_ON_OPEN</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_PREFETCH_ON_OPEN">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE"> |
| <h3>DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-121">DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DROP_BEHIND_CACHE_COMPACTION_DEFAULT"> |
| <h3>DROP_BEHIND_CACHE_COMPACTION_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-122">DROP_BEHIND_CACHE_COMPACTION_DEFAULT</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DROP_BEHIND_CACHE_COMPACTION_DEFAULT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD"> |
| <h3>DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-123">DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_CACHE_COMPACTED_BLOCKS_ON_WRITE_THRESHOLD">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_PREFETCH_HEAP_USAGE_THRESHOLD"> |
| <h3>DEFAULT_PREFETCH_HEAP_USAGE_THRESHOLD</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-124">DEFAULT_PREFETCH_HEAP_USAGE_THRESHOLD</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.CacheConfig.DEFAULT_PREFETCH_HEAP_USAGE_THRESHOLD">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cacheDataOnRead"> |
| <h3>cacheDataOnRead</h3> |
| <div class="member-signature"><span class="modifiers">private volatile</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-131">cacheDataOnRead</a></span></div> |
| <div class="block">Whether blocks should be cached on read (default is on if there is a cache but this can be |
| turned off on a per-family or per-request basis). If off we will STILL cache meta blocks; i.e. |
| INDEX and BLOOM types. This cannot be disabled.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="inMemory"> |
| <h3>inMemory</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-134">inMemory</a></span></div> |
| <div class="block">Whether blocks should be flagged as in-memory when being cached</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cacheDataOnWrite"> |
| <h3>cacheDataOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">private volatile</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-137">cacheDataOnWrite</a></span></div> |
| <div class="block">Whether data blocks should be cached when new files are written</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cacheIndexesOnWrite"> |
| <h3>cacheIndexesOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-140">cacheIndexesOnWrite</a></span></div> |
| <div class="block">Whether index blocks should be cached when new files are written</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cacheBloomsOnWrite"> |
| <h3>cacheBloomsOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-143">cacheBloomsOnWrite</a></span></div> |
| <div class="block">Whether compound bloom filter blocks should be cached on write</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="evictOnClose"> |
| <h3>evictOnClose</h3> |
| <div class="member-signature"><span class="modifiers">private volatile</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-146">evictOnClose</a></span></div> |
| <div class="block">Whether blocks of a file should be evicted when the file is closed</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cacheDataCompressed"> |
| <h3>cacheDataCompressed</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-149">cacheDataCompressed</a></span></div> |
| <div class="block">Whether data blocks should be stored in compressed and/or encrypted form in the cache</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prefetchOnOpen"> |
| <h3>prefetchOnOpen</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-152">prefetchOnOpen</a></span></div> |
| <div class="block">Whether data blocks should be prefetched into the cache</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cacheCompactedDataOnWrite"> |
| <h3>cacheCompactedDataOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-157">cacheCompactedDataOnWrite</a></span></div> |
| <div class="block">Whether data blocks should be cached when compacted file is written</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cacheCompactedDataOnWriteThreshold"> |
| <h3>cacheCompactedDataOnWriteThreshold</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-162">cacheCompactedDataOnWriteThreshold</a></span></div> |
| <div class="block">Determine threshold beyond which we do not cache blocks on compaction</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dropBehindCompaction"> |
| <h3>dropBehindCompaction</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-164">dropBehindCompaction</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="blockCache"> |
| <h3>blockCache</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-167">blockCache</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="byteBuffAllocator"> |
| <h3>byteBuffAllocator</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-169">byteBuffAllocator</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="heapUsageThreshold"> |
| <h3>heapUsageThreshold</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-171">heapUsageThreshold</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration)"> |
| <h3>CacheConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-178">CacheConfig</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Create a cache configuration using the specified configuration object and defaults for family |
| level settings. Only use if no column family context.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - hbase configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.io.hfile.BlockCache)"> |
| <h3>CacheConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-182">CacheConfig</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a> blockCache)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.ColumnFamilyDescriptor,org.apache.hadoop.hbase.io.hfile.BlockCache,org.apache.hadoop.hbase.io.ByteBuffAllocator)"> |
| <h3>CacheConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-191">CacheConfig</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a> family, |
| <a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a> blockCache, |
| <a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a> byteBuffAllocator)</span></div> |
| <div class="block">Create a cache configuration using the specified configuration object and family descriptor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - hbase configuration</dd> |
| <dd><code>family</code> - column family configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.io.hfile.CacheConfig)"> |
| <h3>CacheConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-226">CacheConfig</a></span><wbr><span class="parameters">(<a href="CacheConfig.html" title="class in org.apache.hadoop.hbase.io.hfile">CacheConfig</a> cacheConf)</span></div> |
| <div class="block">Constructs a cache configuration copied from the specified configuration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>CacheConfig</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-243">CacheConfig</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="shouldCacheDataOnRead()"> |
| <h3>shouldCacheDataOnRead</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-264">shouldCacheDataOnRead</a></span>()</div> |
| <div class="block">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).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if blocks should be cached on read, false if not</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldDropBehindCompaction()"> |
| <h3>shouldDropBehindCompaction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-268">shouldDropBehindCompaction</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldCacheBlockOnRead(org.apache.hadoop.hbase.io.hfile.BlockType.BlockCategory)"> |
| <h3>shouldCacheBlockOnRead</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-276">shouldCacheBlockOnRead</a></span><wbr><span class="parameters">(<a href="BlockType.BlockCategory.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType.BlockCategory</a> category)</span></div> |
| <div class="block">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.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInMemory()"> |
| <h3>isInMemory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-282">isInMemory</a></span>()</div> |
| <div class="block">Returns true if blocks in this file should be flagged as in-memory</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldCacheDataOnWrite()"> |
| <h3>shouldCacheDataOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-290">shouldCacheDataOnWrite</a></span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if data blocks should be written to the cache when an HFile is written, false if |
| not</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCacheDataOnWrite(boolean)"> |
| <h3>setCacheDataOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-298">setCacheDataOnWrite</a></span><wbr><span class="parameters">(boolean cacheDataOnWrite)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cacheDataOnWrite</code> - whether data blocks should be written to the cache when an HFile is |
| written</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enableCacheOnWrite()"> |
| <h3>enableCacheOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-305">enableCacheOnWrite</a></span>()</div> |
| <div class="block">Enable cache on write including: cacheDataOnWrite cacheIndexesOnWrite cacheBloomsOnWrite</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldCacheIndexesOnWrite()"> |
| <h3>shouldCacheIndexesOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-315">shouldCacheIndexesOnWrite</a></span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if index blocks should be written to the cache when an HFile is written, false if |
| not</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldCacheBloomsOnWrite()"> |
| <h3>shouldCacheBloomsOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-323">shouldCacheBloomsOnWrite</a></span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if bloom blocks should be written to the cache when an HFile is written, false if |
| not</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldEvictOnClose()"> |
| <h3>shouldEvictOnClose</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-331">shouldEvictOnClose</a></span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if blocks should be evicted from the cache when an HFile reader is closed, false |
| if not</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEvictOnClose(boolean)"> |
| <h3>setEvictOnClose</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-340">setEvictOnClose</a></span><wbr><span class="parameters">(boolean evictOnClose)</span></div> |
| <div class="block">Only used for testing.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>evictOnClose</code> - whether blocks should be evicted from the cache when an HFile reader is |
| closed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldCacheDataCompressed()"> |
| <h3>shouldCacheDataCompressed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-345">shouldCacheDataCompressed</a></span>()</div> |
| <div class="block">Returns true if data blocks should be compressed in the cache, false if not</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldCacheCompressed(org.apache.hadoop.hbase.io.hfile.BlockType.BlockCategory)"> |
| <h3>shouldCacheCompressed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-352">shouldCacheCompressed</a></span><wbr><span class="parameters">(<a href="BlockType.BlockCategory.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType.BlockCategory</a> category)</span></div> |
| <div class="block">Returns true if this <a href="BlockType.BlockCategory.html" title="enum class in org.apache.hadoop.hbase.io.hfile"><code>BlockType.BlockCategory</code></a> should be compressed in blockcache, false otherwise</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldPrefetchOnOpen()"> |
| <h3>shouldPrefetchOnOpen</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-362">shouldPrefetchOnOpen</a></span>()</div> |
| <div class="block">Returns true if blocks should be prefetched into the cache on open, false if not</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldCacheCompactedBlocksOnWrite()"> |
| <h3>shouldCacheCompactedBlocksOnWrite</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-367">shouldCacheCompactedBlocksOnWrite</a></span>()</div> |
| <div class="block">Returns true if blocks should be cached while writing during compaction, false if not</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCacheCompactedBlocksOnWriteThreshold()"> |
| <h3>getCacheCompactedBlocksOnWriteThreshold</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-372">getCacheCompactedBlocksOnWriteThreshold</a></span>()</div> |
| <div class="block">Returns total file size in bytes threshold for caching while writing during compaction</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldReadBlockFromCache(org.apache.hadoop.hbase.io.hfile.BlockType)"> |
| <h3>shouldReadBlockFromCache</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-384">shouldReadBlockFromCache</a></span><wbr><span class="parameters">(<a href="BlockType.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType</a> blockType)</span></div> |
| <div class="block">Return true if we may find this type of block in block cache. |
| <p> |
| TODO: today <code>family.isBlockCacheEnabled()</code> only means <code>cacheDataOnRead</code>, so here we |
| consider lots of other configurations such as <code>cacheDataOnWrite</code>. We should fix this in |
| the future, <code>cacheDataOnWrite</code> should honor the CF level <code>isBlockCacheEnabled</code> |
| configuration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isHeapUsageBelowThreshold()"> |
| <h3>isHeapUsageBelowThreshold</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-410">isHeapUsageBelowThreshold</a></span>()</div> |
| <div class="block">Checks if the current heap usage is below the threshold configured by |
| "hbase.rs.prefetchheapusage" (0.8 by default).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldLockOnCacheMiss(org.apache.hadoop.hbase.io.hfile.BlockType)"> |
| <h3>shouldLockOnCacheMiss</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-421">shouldLockOnCacheMiss</a></span><wbr><span class="parameters">(<a href="BlockType.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType</a> blockType)</span></div> |
| <div class="block">If we make sure the block could not be cached, we will not acquire the lock otherwise we will |
| acquire lock</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBlockCache()"> |
| <h3>getBlockCache</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="BlockCache.html" title="interface in org.apache.hadoop.hbase.io.hfile">BlockCache</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-432">getBlockCache</a></span>()</div> |
| <div class="block">Returns the block cache.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the block cache, or null if caching is completely disabled</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCombinedBlockCache()"> |
| <h3>isCombinedBlockCache</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-436">isCombinedBlockCache</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getByteBuffAllocator()"> |
| <h3>getByteBuffAllocator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-440">getByteBuffAllocator</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapUsageThreshold()"> |
| <h3>getHeapUsageThreshold</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-444">getHeapUsageThreshold</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCacheCompactedBlocksOnWriteThreshold(org.apache.hadoop.conf.Configuration)"> |
| <h3>getCacheCompactedBlocksOnWriteThreshold</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-448">getCacheCompactedBlocksOnWriteThreshold</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-463">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onConfigurationChange(org.apache.hadoop.conf.Configuration)"> |
| <h3>onConfigurationChange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html#line-472">onConfigurationChange</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../conf/ConfigurationObserver.html#onConfigurationChange(org.apache.hadoop.conf.Configuration)">ConfigurationObserver</a></code></span></div> |
| <div class="block">This method would be called by the <a href="../../conf/ConfigurationManager.html" title="class in org.apache.hadoop.hbase.conf"><code>ConfigurationManager</code></a> object when the |
| <code>Configuration</code> object is reloaded from disk.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../conf/ConfigurationObserver.html#onConfigurationChange(org.apache.hadoop.conf.Configuration)">onConfigurationChange</a></code> in interface <code><a href="../../conf/ConfigurationObserver.html" title="interface in org.apache.hadoop.hbase.conf">ConfigurationObserver</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
