HBASE-15351 Fix description of hbase.bucketcache.size in hbase-default.xml
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/8f6e2978 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/8f6e2978 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/8f6e2978 Branch: refs/heads/hbase-12439 Commit: 8f6e29785abff6b3205d7058d9b88c1cf27faa29 Parents: 3c660e2 Author: stack <st...@apache.org> Authored: Fri Feb 26 13:49:26 2016 -0800 Committer: stack <st...@apache.org> Committed: Fri Feb 26 13:49:26 2016 -0800 ---------------------------------------------------------------------- .../src/main/resources/hbase-default.xml | 28 ++++++++++++-------- 1 file changed, 17 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/8f6e2978/hbase-common/src/main/resources/hbase-default.xml ---------------------------------------------------------------------- diff --git a/hbase-common/src/main/resources/hbase-default.xml b/hbase-common/src/main/resources/hbase-default.xml index e446a24..e50e89e 100644 --- a/hbase-common/src/main/resources/hbase-default.xml +++ b/hbase-common/src/main/resources/hbase-default.xml @@ -857,29 +857,35 @@ possible configurations would overwhelm and obscure the important. <name>hbase.bucketcache.ioengine</name> <value></value> <description>Where to store the contents of the bucketcache. One of: heap, - offheap, or file. If a file, set it to file:PATH_TO_FILE. See - http://hbase.apache.org/book.html#offheap.blockcache for more information. + offheap, or file. If a file, set it to file:PATH_TO_FILE. See + http://hbase.apache.org/book.html#offheap.blockcache for more information. </description> </property> <property> <name>hbase.bucketcache.combinedcache.enabled</name> <value>true</value> <description>Whether or not the bucketcache is used in league with the LRU - on-heap block cache. In this mode, indices and blooms are kept in the LRU - blockcache and the data blocks are kept in the bucketcache.</description> + on-heap block cache. In this mode, indices and blooms are kept in the LRU + blockcache and the data blocks are kept in the bucketcache.</description> </property> <property> <name>hbase.bucketcache.size</name> - <value>65536</value> - <description>The size of the buckets for the bucketcache if you only use a single size. - Defaults to the default blocksize, which is 64 * 1024.</description> + <value></value> + <description>A float that EITHER represents a percentage of total heap memory + size to give to the cache (if < 1.0) OR, it is the total capacity in + megabytes of BucketCache. Default: 0.0</description> </property> <property> <name>hbase.bucketcache.sizes</name> <value></value> - <description>A comma-separated list of sizes for buckets for the bucketcache - if you use multiple sizes. Should be a list of block sizes in order from smallest - to largest. The sizes you use will depend on your data access patterns.</description> + <description>A comma-separated list of sizes for buckets for the bucketcache. + Can be multiple sizes. List block sizes in order from smallest to largest. + The sizes you use will depend on your data access patterns. + Must be a multiple of 1024 else you will run into + 'java.io.IOException: Invalid HFile block magic' when you go to read from cache. + If you specify no values here, then you pick up the default bucketsizes set + in code (See BucketAllocator#DEFAULT_BUCKET_SIZES). + </description> </property> <property> <name>hfile.format.version</name> @@ -907,7 +913,7 @@ possible configurations would overwhelm and obscure the important. <name>hbase.rs.cacheblocksonwrite</name> <value>false</value> <description>Whether an HFile block should be added to the block cache when the - block is finished.</description> + block is finished.</description> </property> <property> <name>hbase.rpc.timeout</name>