The documentation below is generated using the default hbase configuration file, hbase-default.xml, as source. hbase.rootdirThe directory shared by region servers and into which HBase persists. The URL should be 'fully-qualified' to include the filesystem scheme. For example, to specify the HDFS directory '/hbase' where the HDFS instance's namenode is running at namenode.example.org on port 9000, set this value to: hdfs://namenode.example.org:9000/hbase. By default HBase writes into /tmp. Change this configuration else all data will be lost on machine restart. Default: file:///tmp/hbase-${user.name}/hbasehbase.master.portThe port the HBase Master should bind to.Default: 60000hbase.cluster.distributedThe mode the cluster will be in. Possible values are false for standalone mode and true for distributed mode. If false, startup will run all HBase and ZooKeeper daemons together in the one JVM. Default: falsehbase.tmp.dirTemporary directory on the local filesystem. Change this setting to point to a location more permanent than '/tmp' (The '/tmp' directory is often cleared on machine restart). Default: ${java.io.tmpdir}/hbase-${user.name}hbase.local.dirDirectory on the local filesystem to be used as a local storage. Default: ${hbase.tmp.dir}/local/hbase.master.info.portThe port for the HBase Master web UI. Set to -1 if you do not want a UI instance run. Default: 60010hbase.master.info.bindAddressThe bind address for the HBase Master web UI Default: 0.0.0.0hbase.client.write.bufferDefault size of the HTable clien write buffer in bytes. A bigger buffer takes more memory -- on both the client and server side since server instantiates the passed write buffer to process it -- but a larger buffer size reduces the number of RPCs made. For an estimate of server-side memory-used, evaluate hbase.client.write.buffer * hbase.regionserver.handler.count Default: 2097152hbase.regionserver.portThe port the HBase RegionServer binds to. Default: 60020hbase.regionserver.info.portThe port for the HBase RegionServer web UI Set to -1 if you do not want the RegionServer UI to run. Default: 60030hbase.regionserver.info.port.autoWhether or not the Master or RegionServer UI should search for a port to bind to. Enables automatic port search if hbase.regionserver.info.port is already in use. Useful for testing, turned off by default. Default: falsehbase.regionserver.info.bindAddressThe address for the HBase RegionServer web UI Default: 0.0.0.0hbase.regionserver.classThe RegionServer interface to use. Used by the client opening proxy to remote region server. Default: org.apache.hadoop.hbase.ipc.HRegionInterfacehbase.client.pauseGeneral client pause value. Used mostly as value to wait before running a retry of a failed get, region lookup, etc.Default: 1000hbase.client.retries.numberMaximum retries. Used as maximum for all retryable operations such as fetching of the root region from root region server, getting a cell's value, starting a row update, etc. Default: 14. Default: 14hbase.bulkload.retries.numberMaximum retries. This is maximum number of iterations to atomic bulk loads are attempted in the face of splitting operations 0 means never give up. Default: 0. Default: 0hbase.client.scanner.cachingNumber of rows that will be fetched when calling next on a scanner if it is not served from (local, client) memory. Higher caching values will enable faster scanners but will eat up more memory and some calls of next may take longer and longer times when the cache is empty. Do not set this value such that the time between invocations is greater than the scanner timeout; i.e. hbase.regionserver.lease.period Default: 1hbase.client.keyvalue.maxsizeSpecifies the combined maximum allowed size of a KeyValue instance. This is to set an upper boundary for a single entry saved in a storage file. Since they cannot be split it helps avoiding that a region cannot be split any further because the data is too large. It seems wise to set this to a fraction of the maximum region size. Setting it to zero or less disables the check. Default: 10485760hbase.regionserver.lease.periodHRegion server lease period in milliseconds. Default is 60 seconds. Clients must report in within this period else they are considered dead.Default: 60000hbase.regionserver.handler.countCount of RPC Listener instances spun up on RegionServers. Same property is used by the Master for count of master handlers. Default is 10. Default: 10hbase.regionserver.msgintervalInterval between messages from the RegionServer to Master in milliseconds. Default: 3000hbase.regionserver.optionallogflushintervalSync the HLog to the HDFS after this interval if it has not accumulated enough entries to trigger a sync. Default 1 second. Units: milliseconds. Default: 1000hbase.regionserver.regionSplitLimitLimit for the number of regions after which no more region splitting should take place. This is not a hard limit for the number of regions but acts as a guideline for the regionserver to stop splitting after a certain limit. Default is set to MAX_INT; i.e. do not block splitting. Default: 2147483647hbase.regionserver.logroll.periodPeriod at which we will roll the commit log regardless of how many edits it has.Default: 3600000hbase.regionserver.logroll.errors.toleratedThe number of consecutive WAL close errors we will allow before triggering a server abort. A setting of 0 will cause the region server to abort if closing the current WAL writer fails during log rolling. Even a small value (2 or 3) will allow a region server to ride over transient HDFS errors.Default: 2hbase.regionserver.hlog.reader.implThe HLog file reader implementation.Default: org.apache.hadoop.hbase.regionserver.wal.SequenceFileLogReaderhbase.regionserver.hlog.writer.implThe HLog file writer implementation.Default: org.apache.hadoop.hbase.regionserver.wal.SequenceFileLogWriterhbase.regionserver.separate.hlog.for.metaDefault: falsehbase.regionserver.nbreservationblocksThe number of resevoir blocks of memory release on OOME so we can cleanup properly before server shutdown. Default: 4hbase.zookeeper.dns.interfaceThe name of the Network Interface from which a ZooKeeper server should report its IP address. Default: defaulthbase.zookeeper.dns.nameserverThe host name or IP address of the name server (DNS) which a ZooKeeper server should use to determine the host name used by the master for communication and display purposes. Default: defaulthbase.regionserver.dns.interfaceThe name of the Network Interface from which a region server should report its IP address. Default: defaulthbase.regionserver.dns.nameserverThe host name or IP address of the name server (DNS) which a region server should use to determine the host name used by the master for communication and display purposes. Default: defaultfail.fast.expired.active.masterIf abort immediately for the expired master without trying to recover its zk session.Default: falsehbase.master.dns.interfaceThe name of the Network Interface from which a master should report its IP address. Default: defaulthbase.master.dns.nameserverThe host name or IP address of the name server (DNS) which a master should use to determine the host name used for communication and display purposes. Default: defaulthbase.balancer.period Period at which the region balancer runs in the Master. Default: 300000hbase.regions.slopRebalance if any regionserver has average + (average * slop) regions. Default is 20% slop. Default: 0.2hbase.master.logcleaner.ttlMaximum time a HLog can stay in the .oldlogdir directory, after which it will be cleaned by a Master thread. Default: 600000hbase.master.logcleaner.pluginsA comma-separated list of LogCleanerDelegate invoked by the LogsCleaner service. These WAL/HLog cleaners are called in order, so put the HLog cleaner that prunes the most HLog files in front. To implement your own LogCleanerDelegate, just put it in HBase's classpath and add the fully qualified class name here. Always add the above default log cleaners in the list. Default: org.apache.hadoop.hbase.master.cleaner.TimeToLiveLogCleanerhbase.regionserver.global.memstore.upperLimitMaximum size of all memstores in a region server before new updates are blocked and flushes are forced. Defaults to 40% of heap Default: 0.4hbase.regionserver.global.memstore.lowerLimitWhen memstores are being forced to flush to make room in memory, keep flushing until we hit this mark. Defaults to 35% of heap. This value equal to hbase.regionserver.global.memstore.upperLimit causes the minimum possible flushing to occur when updates are blocked due to memstore limiting. Default: 0.35hbase.server.thread.wakefrequencyTime to sleep in between searches for work (in milliseconds). Used as sleep interval by service threads such as log roller. Default: 10000hbase.server.versionfile.writeattempts How many time to retry attempting to write a version file before just aborting. Each attempt is seperated by the hbase.server.thread.wakefrequency milliseconds. Default: 3hbase.regionserver.optionalcacheflushinterval Maximum amount of time an edit lives in memory before being automatically flushed. Default 1 hour. Set it to 0 to disable automatic flushing. Default: 3600000hbase.hregion.memstore.flush.size Memstore will be flushed to disk if size of the memstore exceeds this number of bytes. Value is checked by a thread that runs every hbase.server.thread.wakefrequency. Default: 134217728hbase.hregion.preclose.flush.size If the memstores in a region are this size or larger when we go to close, run a "pre-flush" to clear out memstores before we put up the region closed flag and take the region offline. On close, a flush is run under the close flag to empty memory. During this time the region is offline and we are not taking on any writes. If the memstore content is large, this flush could take a long time to complete. The preflush is meant to clean out the bulk of the memstore before putting up the close flag and taking the region offline so the flush that runs under the close flag has little to do. Default: 5242880hbase.hregion.memstore.block.multiplier Block updates if memstore has hbase.hregion.block.memstore time hbase.hregion.flush.size bytes. Useful preventing runaway memstore during spikes in update traffic. Without an upper-bound, memstore fills such that when it flushes the resultant flush files take a long time to compact or split, or worse, we OOME. Default: 2hbase.hregion.memstore.mslab.enabled Enables the MemStore-Local Allocation Buffer, a feature which works to prevent heap fragmentation under heavy write loads. This can reduce the frequency of stop-the-world GC pauses on large heaps. Default: truehbase.hregion.max.filesize Maximum HStoreFile size. If any one of a column families' HStoreFiles has grown to exceed this value, the hosting HRegion is split in two. Default: 10G. Default: 10737418240hbase.hstore.compactionThreshold If more than this number of HStoreFiles in any one HStore (one HStoreFile is written per flush of memstore) then a compaction is run to rewrite all HStoreFiles files as one. Larger numbers put off compaction but when it runs, it takes longer to complete. Default: 3hbase.hstore.blockingStoreFiles If more than this number of StoreFiles in any one Store (one StoreFile is written per flush of MemStore) then updates are blocked for this HRegion until a compaction is completed, or until hbase.hstore.blockingWaitTime has been exceeded. Default: 7hbase.hstore.blockingWaitTime The time an HRegion will block updates for after hitting the StoreFile limit defined by hbase.hstore.blockingStoreFiles. After this time has elapsed, the HRegion will stop blocking updates even if a compaction has not been completed. Default: 90 seconds. Default: 90000hbase.hstore.compaction.maxMax number of HStoreFiles to compact per 'minor' compaction. Default: 10hbase.hregion.majorcompactionThe time (in miliseconds) between 'major' compactions of all HStoreFiles in a region. Default: 1 day. Set to 0 to disable automated major compactions. Default: 86400000hfile.block.cache.size Percentage of maximum heap (-Xmx setting) to allocate to block cache used by HFile/StoreFile. Default of 0.25 means allocate 25%. Set to 0 to disable but it's not recommended. Default: 0.25hbase.hash.typeThe hashing algorithm for use in HashFunction. Two values are supported now: murmur (MurmurHash) and jenkins (JenkinsHash). Used by bloom filters. Default: murmurhfile.block.index.cacheonwrite This allows to put non-root multi-level index blocks into the block cache at the time the index is being written. Default: falsehbase.regionserver.checksum.verify Allow hbase to do checksums rather than using hdfs checksums. This is a backwards incompatible change. Default: falsehfile.index.block.max.size When the size of a leaf-level, intermediate-level, or root-level index block in a multi-level block index grows to this size, the block is written out and a new block is started. Default: 131072hfile.format.version The HFile format version to use for new files. Set this to 1 to test backwards-compatibility. The default value of this option should be consistent with FixedFileTrailer.MAX_VERSION. Default: 2io.storefile.bloom.block.size The size in bytes of a single block ("chunk") of a compound Bloom filter. This size is approximate, because Bloom blocks can only be inserted at data block boundaries, and the number of keys per data block varies. Default: 131072io.storefile.bloom.cacheonwrite Enables cache-on-write for inline blocks of a compound Bloom filter. Default: falsehbase.rs.cacheblocksonwrite Whether an HFile block should be added to the block cache when the block is finished. Default: falsehbase.rpc.engineImplementation of org.apache.hadoop.hbase.ipc.RpcEngine to be used for client / server RPC call marshalling. Default: org.apache.hadoop.hbase.ipc.WritableRpcEnginehbase.rpc.timeoutThis is for the RPC layer to define how long HBase client applications take for a remote call to time out. It uses pings to check connections but will eventually throw a TimeoutException.Default: 60000hbase.rpc.shortoperation.timeoutThis is another version of "hbase.rpc.timeout". For those RPC operation within cluster, we rely on this configuration to set a short timeout limitation for short operation. For example, short rpc timeout for region server's trying to report to active master can benefit quicker master failover process.Default: 10000hbase.regionserver.region.split.policy A split policy determines when a region should be split. The various other split policies that are available currently are ConstantSizeRegionSplitPolicy, DisabledRegionSplitPolicy, DelimitedKeyPrefixRegionSplitPolicy, KeyPrefixRegionSplitPolicy etc. Default: org.apache.hadoop.hbase.regionserver.IncreasingToUpperBoundRegionSplitPolicyhbase.master.keytab.fileFull path to the kerberos keytab file to use for logging in the configured HMaster server principal. Default: hbase.master.kerberos.principalEx. "hbase/_HOST@EXAMPLE.COM". The kerberos principal name that should be used to run the HMaster process. The principal name should be in the form: user/hostname@DOMAIN. If "_HOST" is used as the hostname portion, it will be replaced with the actual hostname of the running instance. Default: hbase.regionserver.keytab.fileFull path to the kerberos keytab file to use for logging in the configured HRegionServer server principal. Default: hbase.regionserver.kerberos.principalEx. "hbase/_HOST@EXAMPLE.COM". The kerberos principal name that should be used to run the HRegionServer process. The principal name should be in the form: user/hostname@DOMAIN. If "_HOST" is used as the hostname portion, it will be replaced with the actual hostname of the running instance. An entry for this principal must exist in the file specified in hbase.regionserver.keytab.file Default: hadoop.policy.fileThe policy configuration file used by RPC servers to make authorization decisions on client requests. Only used when HBase security is enabled. Default: hbase-policy.xmlhbase.superuserList of users or groups (comma-separated), who are allowed full privileges, regardless of stored ACLs, across the cluster. Only used when HBase security is enabled. Default: hbase.auth.key.update.intervalThe update interval for master key for authentication tokens in servers in milliseconds. Only used when HBase security is enabled. Default: 86400000hbase.auth.token.max.lifetimeThe maximum lifetime in milliseconds after which an authentication token expires. Only used when HBase security is enabled. Default: 604800000zookeeper.session.timeoutZooKeeper session timeout. HBase passes this to the zk quorum as suggested maximum time for a session (This setting becomes zookeeper's 'maxSessionTimeout'). See http://hadoop.apache.org/zookeeper/docs/current/zookeeperProgrammers.html#ch_zkSessions "The client sends a requested timeout, the server responds with the timeout that it can give the client. " In milliseconds. Default: 180000zookeeper.znode.parentRoot ZNode for HBase in ZooKeeper. All of HBase's ZooKeeper files that are configured with a relative path will go under this node. By default, all of HBase's ZooKeeper file path are configured with a relative path, so they will all go under this directory unless changed. Default: /hbasezookeeper.znode.rootserverPath to ZNode holding root region location. This is written by the master and read by clients and region servers. If a relative path is given, the parent folder will be ${zookeeper.znode.parent}. By default, this means the root location is stored at /hbase/root-region-server. Default: root-region-serverhbase.ipc.client.fallback-to-simple-auth-allowed When a client is configured to attempt a secure connection, but attempts to connect to an insecure server, that server may instruct the client to switch to SASL SIMPLE (unsecure) authentication. This setting controls whether or not the client will accept this instruction from the server. When false (the default), the client will not allow the fallback to SIMPLE authentication, and will abort the connection. This setting is only used by the secure RPC engine. Default: falsezookeeper.znode.acl.parentRoot ZNode for access control lists.Default: aclhbase.coprocessor.region.classesA comma-separated list of Coprocessors that are loaded by default on all tables. For any override coprocessor method, these classes will be called in order. After implementing your own Coprocessor, just put it in HBase's classpath and add the fully qualified class name here. A coprocessor can also be loaded on demand by setting HTableDescriptor. Default: hbase.coprocessor.master.classesA comma-separated list of org.apache.hadoop.hbase.coprocessor.MasterObserver coprocessors that are loaded by default on the active HMaster process. For any implemented coprocessor methods, the listed classes will be called in order. After implementing your own MasterObserver, just put it in HBase's classpath and add the fully qualified class name here. Default: hbase.zookeeper.quorumComma separated list of servers in the ZooKeeper Quorum. For example, "host1.mydomain.com,host2.mydomain.com,host3.mydomain.com". By default this is set to localhost for local and pseudo-distributed modes of operation. For a fully-distributed setup, this should be set to a full list of ZooKeeper quorum servers. If HBASE_MANAGES_ZK is set in hbase-env.sh this is the list of servers which we will start/stop ZooKeeper on. Default: localhosthbase.zookeeper.peerportPort used by ZooKeeper peers to talk to each other. See http://hadoop.apache.org/zookeeper/docs/r3.1.1/zookeeperStarted.html#sc_RunningReplicatedZooKeeper for more information. Default: 2888hbase.zookeeper.leaderportPort used by ZooKeeper for leader election. See http://hadoop.apache.org/zookeeper/docs/r3.1.1/zookeeperStarted.html#sc_RunningReplicatedZooKeeper for more information. Default: 3888hbase.zookeeper.useMultiInstructs HBase to make use of ZooKeeper's multi-update functionality. This allows certain ZooKeeper operations to complete more quickly and prevents some issues with rare ZooKeeper failure scenarios (see the release note of HBASE-6710 for an example). IMPORTANT: only set this to true if all ZooKeeper servers in the cluster are on version 3.4+ and will not be downgraded. ZooKeeper versions before 3.4 do not support multi-update and will not fail gracefully if multi-update is invoked (see ZOOKEEPER-1495). Default: falsehbase.zookeeper.property.initLimitProperty from ZooKeeper's config zoo.cfg. The number of ticks that the initial synchronization phase can take. Default: 10hbase.zookeeper.property.syncLimitProperty from ZooKeeper's config zoo.cfg. The number of ticks that can pass between sending a request and getting an acknowledgment. Default: 5hbase.zookeeper.property.dataDirProperty from ZooKeeper's config zoo.cfg. The directory where the snapshot is stored. Default: ${hbase.tmp.dir}/zookeeperhbase.zookeeper.property.clientPortProperty from ZooKeeper's config zoo.cfg. The port at which the clients will connect. Default: 2181hbase.zookeeper.property.maxClientCnxnsProperty from ZooKeeper's config zoo.cfg. Limit on number of concurrent connections (at the socket level) that a single client, identified by IP address, may make to a single member of the ZooKeeper ensemble. Set high to avoid zk connection issues running standalone and pseudo-distributed. Default: 300hbase.rest.portThe port for the HBase REST server.Default: 8080hbase.rest.readonly Defines the mode the REST server will be started in. Possible values are: false: All HTTP methods are permitted - GET/PUT/POST/DELETE. true: Only the GET method is permitted. Default: falsehbase.defaults.for.version.skip Set to true to skip the 'hbase.defaults.for.version' check. Setting this to true can be useful in contexts other than the other side of a maven generation; i.e. running in an ide. You'll want to set this boolean to true to avoid seeing the RuntimException complaint: "hbase-default.xml file seems to be for and old version of HBase (@@@VERSION@@@), this version is X.X.X-SNAPSHOT" Default: falsehbase.coprocessor.abortonerror Set to true to cause the hosting server (master or regionserver) to abort if a coprocessor throws a Throwable object that is not IOException or a subclass of IOException. Setting it to true might be useful in development environments where one wants to terminate the server as soon as possible to simplify coprocessor failure analysis. Default: falsehbase.online.schema.update.enable Set true to enable online schema changes. This is an experimental feature. There are known issues modifying table schemas at the same time a region split is happening so your table needs to be quiescent or else you have to be running with splits disabled. Default: falsedfs.support.appendDoes HDFS allow appends to files? This is an hdfs config. set in here so the hdfs client will do append support. You must ensure that this config. is true serverside too when running hbase (You will have to restart your cluster after setting it). Default: truehbase.regionserver.thrift.framedUse Thrift TFramedTransport on the server side. This is the recommended transport for thrift servers and requires a similar setting on the client side. Setting this to false will select the default transport, vulnerable to DoS when malformed requests are issued due to THRIFT-601. Default: falsehbase.regionserver.thrift.framed.max_frame_size_in_mbDefault frame size when using framed transportDefault: 2hbase.regionserver.thrift.compactUse Thrift TCompactProtocol binary serialization protocol.Default: falsehbase.thrift.minWorkerThreads The "core size" of the thread pool. New threads are created on every connection until this many threads are created. Default: 16hbase.thrift.maxWorkerThreads The maximum size of the thread pool. When the pending request queue overflows, new threads are created until their number reaches this number. After that, the server starts dropping connections. Default: 1000hbase.thrift.maxQueuedRequests The maximum number of pending Thrift connections waiting in the queue. If there are no idle threads in the pool, the server queues requests. Only when the queue overflows, new threads are added, up to hbase.thrift.maxQueuedRequests threads. Default: 1000hbase.thrift.htablepool.size.maxThe upper bound for the table pool used in the Thrift gateways server. Since this is per table name, we assume a single table and so with 1000 default worker threads max this is set to a matching number. For other workloads this number can be adjusted as needed. Default: 1000hbase.offheapcache.percentage The amount of off heap space to be allocated towards the experimental off heap cache. If you desire the cache to be disabled, simply set this value to 0. Default: 0hbase.data.umask.enableEnable, if true, that file permissions should be assigned to the files written by the regionserver Default: falsehbase.data.umaskFile permissions that should be used to write data files when hbase.data.umask.enable is true Default: 000hbase.metrics.showTableNameWhether to include the prefix "tbl.tablename" in per-column family metrics. If true, for each metric M, per-cf metrics will be reported for tbl.T.cf.CF.M, if false, per-cf metrics will be aggregated by column-family across tables, and reported for cf.CF.M. In both cases, the aggregated metric M across tables and cfs will be reported. Default: truehbase.table.archive.directoryPer-table directory name under which to backup files for a table. Files are moved to the same directories as they would be under the table directory, but instead are just one level lower (under table/.archive/... rather than table/...). Currently only applies to HFiles.Default: .archivehbase.master.hfilecleaner.pluginsA comma-separated list of HFileCleanerDelegate invoked by the HFileCleaner service. These HFiles cleaners are called in order, so put the cleaner that prunes the most files in front. To implement your own HFileCleanerDelegate, just put it in HBase's classpath and add the fully qualified class name here. Always add the above default log cleaners in the list as they will be overwritten in hbase-site.xml. Default: org.apache.hadoop.hbase.master.cleaner.TimeToLiveHFileCleanerhbase.rest.threads.max The maximum number of threads of the REST server thread pool. Threads in the pool are reused to process REST requests. This controls the maximum number of requests processed concurrently. It may help to control the memory used by the REST server to avoid OOM issues. If the thread pool is full, incoming requests will be queued up and wait for some free threads. The default is 100. Default: 100hbase.rest.threads.min The minimum number of threads of the REST server thread pool. The thread pool always has at least these number of threads so the REST server is ready to serve incoming requests. The default is 2. Default: 2hbase.lease.recovery.timeout How long we wait on dfs lease recovery in total before giving up. Default: 900000hbase.lease.recovery.dfs.timeout How long between dfs recover lease invocations. Should be just larger than how long it takes the namenode to timeout trying to reach a datanode; usually dfs.socket.timeout. If HBase asked hdfs its cluster configs, we would not need this config. See the end of HBASE-8389 for more. Default: 61000hbase.dynamic.jars.dir The directory from which the custom filter/co-processor jars can be loaded dynamically by the region server without the need to restart. However, an already loaded filter/co-processor class would not be un-loaded. See HBASE-1936 for more details. Default: ${hbase.rootdir}/.libhbase.security.authentication Controls whether or not secure authentication is enabled for HBase. Possible values are 'simple' (no authentication), and 'kerberos'. Default: simple