001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, software 013 * distributed under the License is distributed on an "AS IS" BASIS, 014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 015 * See the License for the specific language governing permissions and 016 * limitations under the License. 017 */ 018package org.apache.hadoop.hbase; 019 020import static org.apache.hadoop.hbase.io.hfile.BlockType.MAGIC_LENGTH; 021 022import java.nio.ByteBuffer; 023import java.nio.charset.Charset; 024import java.util.Arrays; 025import java.util.Collections; 026import java.util.List; 027import java.util.UUID; 028import java.util.regex.Pattern; 029import org.apache.commons.lang3.ArrayUtils; 030import org.apache.hadoop.hbase.util.Bytes; 031import org.apache.yetus.audience.InterfaceAudience; 032 033/** 034 * HConstants holds a bunch of HBase-related constants 035 */ 036@InterfaceAudience.Public 037public final class HConstants { 038 // NOTICE!!!! Please do not add a constants here, unless they are referenced by a lot of classes. 039 040 // Bytes.UTF8_ENCODING should be updated if this changed 041 /** When we encode strings, we always specify UTF8 encoding */ 042 public static final String UTF8_ENCODING = "UTF-8"; 043 044 // Bytes.UTF8_CHARSET should be updated if this changed 045 /** When we encode strings, we always specify UTF8 encoding */ 046 public static final Charset UTF8_CHARSET = Charset.forName(UTF8_ENCODING); 047 /** 048 * Default block size for an HFile. 049 */ 050 public final static int DEFAULT_BLOCKSIZE = 64 * 1024; 051 052 /** Used as a magic return value while optimized index key feature enabled(HBASE-7845) */ 053 public final static int INDEX_KEY_MAGIC = -2; 054 055 /* 056 * Name of directory that holds recovered edits written by the wal log splitting code, one per 057 * region 058 */ 059 public static final String RECOVERED_EDITS_DIR = "recovered.edits"; 060 061 /* 062 * Name of directory that holds recovered hfiles written by the wal log splitting code, one per 063 * region 064 */ 065 public static final String RECOVERED_HFILES_DIR = "recovered.hfiles"; 066 067 /** 068 * Date Tiered Compaction tmp dir prefix name if use storage policy 069 */ 070 public static final String STORAGE_POLICY_PREFIX = "storage_policy_"; 071 072 /** 073 * The first four bytes of Hadoop RPC connections 074 */ 075 public static final byte[] RPC_HEADER = new byte[] { 'H', 'B', 'a', 's' }; 076 public static final byte RPC_CURRENT_VERSION = 0; 077 078 // HFileBlock constants. TODO!!!! THESE DEFINES BELONG IN HFILEBLOCK, NOT UP HERE. 079 // Needed down in hbase-common though by encoders but these encoders should not be dealing 080 // in the internals of hfileblocks. Fix encapsulation. 081 082 /** The size data structures with minor version is 0 */ 083 public static final int HFILEBLOCK_HEADER_SIZE_NO_CHECKSUM = 084 MAGIC_LENGTH + 2 * Bytes.SIZEOF_INT + Bytes.SIZEOF_LONG; 085 /** 086 * The size of a version 2 HFile block header, minor version 1. There is a 1 byte checksum type, 087 * followed by a 4 byte bytesPerChecksum followed by another 4 byte value to store 088 * sizeofDataOnDisk. 089 */ 090 public static final int HFILEBLOCK_HEADER_SIZE = 091 HFILEBLOCK_HEADER_SIZE_NO_CHECKSUM + Bytes.SIZEOF_BYTE + 2 * Bytes.SIZEOF_INT; 092 /** Just an array of bytes of the right size. */ 093 public static final byte[] HFILEBLOCK_DUMMY_HEADER = new byte[HFILEBLOCK_HEADER_SIZE]; 094 095 // End HFileBlockConstants. 096 097 /** 098 * Status codes used for return values of bulk operations. 099 */ 100 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC) 101 public enum OperationStatusCode { 102 NOT_RUN, 103 SUCCESS, 104 BAD_FAMILY, 105 STORE_TOO_BUSY, 106 SANITY_CHECK_FAILURE, 107 FAILURE 108 } 109 110 /** long constant for zero */ 111 public static final Long ZERO_L = Long.valueOf(0L); 112 public static final String NINES = "99999999999999"; 113 public static final String ZEROES = "00000000000000"; 114 115 // For migration 116 117 /** name of version file */ 118 public static final String VERSION_FILE_NAME = "hbase.version"; 119 120 /** 121 * Current version of file system. Version 4 supports only one kind of bloom filter. Version 5 122 * changes versions in catalog table regions. Version 6 enables blockcaching on catalog tables. 123 * Version 7 introduces hfile -- hbase 0.19 to 0.20.. Version 8 introduces namespace 124 */ 125 // public static final String FILE_SYSTEM_VERSION = "6"; 126 public static final String FILE_SYSTEM_VERSION = "8"; 127 128 // Configuration parameters 129 130 // TODO: Is having HBase homed on port 60k OK? 131 132 /** Cluster is in distributed mode or not */ 133 public static final String CLUSTER_DISTRIBUTED = "hbase.cluster.distributed"; 134 135 /** Config for pluggable load balancers */ 136 public static final String HBASE_MASTER_LOADBALANCER_CLASS = "hbase.master.loadbalancer.class"; 137 138 /** Config for balancing the cluster by table */ 139 public static final String HBASE_MASTER_LOADBALANCE_BYTABLE = "hbase.master.loadbalance.bytable"; 140 141 /** Config for the max percent of regions in transition */ 142 public static final String HBASE_MASTER_BALANCER_MAX_RIT_PERCENT = 143 "hbase.master.balancer.maxRitPercent"; 144 145 /** Default value for the max percent of regions in transition */ 146 public static final double DEFAULT_HBASE_MASTER_BALANCER_MAX_RIT_PERCENT = 1.0; 147 148 /** Config for the max balancing time */ 149 public static final String HBASE_BALANCER_MAX_BALANCING = "hbase.balancer.max.balancing"; 150 151 /** Config for the balancer period */ 152 public static final String HBASE_BALANCER_PERIOD = "hbase.balancer.period"; 153 154 /** Default value for the balancer period */ 155 public static final int DEFAULT_HBASE_BALANCER_PERIOD = 300000; 156 157 /** Config for the oldWALs directory size updater period */ 158 public static final String HBASE_OLDWAL_DIR_SIZE_UPDATER_PERIOD = 159 "hbase.master.oldwals.dir.updater.period"; 160 161 /** Default value for the oldWALs directory size updater period */ 162 public static final int DEFAULT_HBASE_OLDWAL_DIR_SIZE_UPDATER_PERIOD = 300000; 163 164 /** 165 * Config key for enable/disable automatically separate child regions to different region servers 166 * in the procedure of split regions. One child will be kept to the server where parent region is 167 * on, and the other child will be assigned to a random server. See HBASE-25518. 168 */ 169 public static final String HBASE_ENABLE_SEPARATE_CHILD_REGIONS = 170 "hbase.master.auto.separate.child.regions.after.split.enabled"; 171 172 /** 173 * Default value for automatically separate child regions to different region servers (set to 174 * "false" to keep all child regions to the server where parent region is on) 175 */ 176 public static final boolean DEFAULT_HBASE_ENABLE_SEPARATE_CHILD_REGIONS = false; 177 178 /** The name of the ensemble table */ 179 public static final TableName ENSEMBLE_TABLE_NAME = TableName.valueOf("hbase:ensemble"); 180 181 /** Config for pluggable region normalizer */ 182 public static final String HBASE_MASTER_NORMALIZER_CLASS = "hbase.master.normalizer.class"; 183 184 /** Cluster is standalone or pseudo-distributed */ 185 public static final boolean CLUSTER_IS_LOCAL = false; 186 187 /** Cluster is fully-distributed */ 188 @Deprecated // unused. see HBASE-13636. remove this in 3.0 189 public static final boolean CLUSTER_IS_DISTRIBUTED = true; 190 191 /** Default value for cluster distributed mode */ 192 public static final boolean DEFAULT_CLUSTER_DISTRIBUTED = CLUSTER_IS_LOCAL; 193 194 /** default host address */ 195 public static final String DEFAULT_HOST = "0.0.0.0"; 196 197 /** Parameter name for port master listens on. */ 198 public static final String MASTER_PORT = "hbase.master.port"; 199 200 /** default port that the master listens on */ 201 public static final int DEFAULT_MASTER_PORT = 16000; 202 203 /** default port for master web api */ 204 public static final int DEFAULT_MASTER_INFOPORT = 16010; 205 206 /** Configuration key for master web API port */ 207 public static final String MASTER_INFO_PORT = "hbase.master.info.port"; 208 209 /** Configuration key for the list of master host:ports **/ 210 public static final String MASTER_ADDRS_KEY = "hbase.masters"; 211 212 /** Full class name of the Zookeeper based connection registry implementation */ 213 public static final String ZK_CONNECTION_REGISTRY_CLASS = 214 "org.apache.hadoop.hbase.client.ZKConnectionRegistry"; 215 216 /** Parameter name for the master type being backup (waits for primary to go inactive). */ 217 public static final String MASTER_TYPE_BACKUP = "hbase.master.backup"; 218 219 /** 220 * by default every master is a possible primary master unless the conf explicitly overrides it 221 */ 222 public static final boolean DEFAULT_MASTER_TYPE_BACKUP = false; 223 224 /** Name of ZooKeeper quorum configuration parameter. */ 225 public static final String ZOOKEEPER_QUORUM = "hbase.zookeeper.quorum"; 226 227 /** Name of ZooKeeper quorum configuration parameter for client to locate meta. */ 228 public static final String CLIENT_ZOOKEEPER_QUORUM = "hbase.client.zookeeper.quorum"; 229 230 /** Client port of ZooKeeper for client to locate meta */ 231 public static final String CLIENT_ZOOKEEPER_CLIENT_PORT = 232 "hbase.client.zookeeper.property.clientPort"; 233 234 /** Indicate whether the client ZK are observer nodes of the server ZK */ 235 public static final String CLIENT_ZOOKEEPER_OBSERVER_MODE = 236 "hbase.client.zookeeper.observer.mode"; 237 /** Assuming client zk not in observer mode and master need to synchronize information */ 238 public static final boolean DEFAULT_CLIENT_ZOOKEEPER_OBSERVER_MODE = false; 239 240 /** Common prefix of ZooKeeper configuration properties */ 241 public static final String ZK_CFG_PROPERTY_PREFIX = "hbase.zookeeper.property."; 242 243 public static final int ZK_CFG_PROPERTY_PREFIX_LEN = ZK_CFG_PROPERTY_PREFIX.length(); 244 245 /** 246 * The ZK client port key in the ZK properties map. The name reflects the fact that this is not an 247 * HBase configuration key. 248 */ 249 public static final String CLIENT_PORT_STR = "clientPort"; 250 251 /** Parameter name for the client port that the zookeeper listens on */ 252 public static final String ZOOKEEPER_CLIENT_PORT = ZK_CFG_PROPERTY_PREFIX + CLIENT_PORT_STR; 253 254 /** 255 * Will be removed in hbase 3.0 256 * @deprecated use {@link #DEFAULT_ZOOKEEPER_CLIENT_PORT} instead 257 */ 258 @Deprecated 259 public static final int DEFAULT_ZOOKEPER_CLIENT_PORT = 2181; 260 261 /** Default client port that the zookeeper listens on */ 262 public static final int DEFAULT_ZOOKEEPER_CLIENT_PORT = 2181; 263 264 /** 265 * Parameter name for the wait time for the recoverable zookeeper 266 */ 267 @Deprecated // unused. see HBASE-3065. remove this in 3.0 268 public static final String ZOOKEEPER_RECOVERABLE_WAITTIME = 269 "hbase.zookeeper.recoverable.waittime"; 270 271 /** Default wait time for the recoverable zookeeper */ 272 @Deprecated // unused. see HBASE-3065. remove this in 3.0 273 public static final long DEFAULT_ZOOKEPER_RECOVERABLE_WAITIME = 10000; 274 275 /** Parameter name for the root dir in ZK for this cluster */ 276 public static final String ZOOKEEPER_ZNODE_PARENT = "zookeeper.znode.parent"; 277 278 public static final String DEFAULT_ZOOKEEPER_ZNODE_PARENT = "/hbase"; 279 280 /** 281 * Parameter name for the limit on concurrent client-side zookeeper connections 282 */ 283 public static final String ZOOKEEPER_MAX_CLIENT_CNXNS = ZK_CFG_PROPERTY_PREFIX + "maxClientCnxns"; 284 285 /** Parameter name for the ZK data directory */ 286 public static final String ZOOKEEPER_DATA_DIR = ZK_CFG_PROPERTY_PREFIX + "dataDir"; 287 288 /** Parameter name for the ZK tick time */ 289 public static final String ZOOKEEPER_TICK_TIME = ZK_CFG_PROPERTY_PREFIX + "tickTime"; 290 291 /** 292 * Will be removed in hbase 3.0 293 * @deprecated use {@link #DEFAULT_ZOOKEEPER_MAX_CLIENT_CNXNS} instead 294 */ 295 @Deprecated 296 public static final int DEFAULT_ZOOKEPER_MAX_CLIENT_CNXNS = 300; 297 298 /** Default limit on concurrent client-side zookeeper connections */ 299 public static final int DEFAULT_ZOOKEEPER_MAX_CLIENT_CNXNS = 300; 300 301 /** Configuration key for ZooKeeper session timeout */ 302 public static final String ZK_SESSION_TIMEOUT = "zookeeper.session.timeout"; 303 304 /** Timeout for the ZK sync() call */ 305 public static final String ZK_SYNC_BLOCKING_TIMEOUT_MS = "hbase.zookeeper.sync.timeout.millis"; 306 // Choice of the default value is based on the following ZK recommendation (from docs). Keeping it 307 // lower lets the callers fail fast in case of any issues. 308 // "The clients view of the system is guaranteed to be up-to-date within a certain time bound. 309 // (On the order of tens of seconds.) Either system changes will be seen by a client within this 310 // bound, or the client will detect a service outage." 311 public static final long ZK_SYNC_BLOCKING_TIMEOUT_DEFAULT_MS = 30 * 1000; 312 313 /** Default value for ZooKeeper session timeout */ 314 public static final int DEFAULT_ZK_SESSION_TIMEOUT = 90 * 1000; 315 316 /** Parameter name for port region server listens on. */ 317 public static final String REGIONSERVER_PORT = "hbase.regionserver.port"; 318 319 /** Default port region server listens on. */ 320 public static final int DEFAULT_REGIONSERVER_PORT = 16020; 321 322 /** default port for region server web api */ 323 public static final int DEFAULT_REGIONSERVER_INFOPORT = 16030; 324 325 /** A configuration key for regionserver info port */ 326 public static final String REGIONSERVER_INFO_PORT = "hbase.regionserver.info.port"; 327 328 /** A flag that enables automatic selection of regionserver info port */ 329 public static final String REGIONSERVER_INFO_PORT_AUTO = REGIONSERVER_INFO_PORT + ".auto"; 330 331 /** Parameter name for what region server implementation to use. */ 332 public static final String REGION_SERVER_IMPL = "hbase.regionserver.impl"; 333 334 /** Parameter name for what master implementation to use. */ 335 public static final String MASTER_IMPL = "hbase.master.impl"; 336 337 /** Parameter name for what hbase client implementation to use. */ 338 @Deprecated // unused. see HBASE-7460. remove this in 3.0 339 public static final String HBASECLIENT_IMPL = "hbase.hbaseclient.impl"; 340 341 /** Parameter name for how often threads should wake up */ 342 public static final String THREAD_WAKE_FREQUENCY = "hbase.server.thread.wakefrequency"; 343 344 /** Default value for thread wake frequency */ 345 public static final int DEFAULT_THREAD_WAKE_FREQUENCY = 10 * 1000; 346 347 /** Parameter name for how often we should try to write a version file, before failing */ 348 public static final String VERSION_FILE_WRITE_ATTEMPTS = "hbase.server.versionfile.writeattempts"; 349 350 /** Parameter name for how often we should try to write a version file, before failing */ 351 public static final int DEFAULT_VERSION_FILE_WRITE_ATTEMPTS = 3; 352 353 /** Parameter name and default value for how often a region should perform a major compaction */ 354 public static final String MAJOR_COMPACTION_PERIOD = "hbase.hregion.majorcompaction"; 355 public static final long DEFAULT_MAJOR_COMPACTION_PERIOD = 1000 * 60 * 60 * 24 * 7; // 7 days 356 357 /** 358 * Parameter name and default value for major compaction jitter. Used as a multiplier applied to 359 * {@link HConstants#MAJOR_COMPACTION_PERIOD} to cause compaction to occur a given amount of time 360 * either side of {@link HConstants#MAJOR_COMPACTION_PERIOD}. Default to 0.5 so jitter has us fall 361 * evenly either side of when the compaction should run. 362 */ 363 public static final String MAJOR_COMPACTION_JITTER = "hbase.hregion.majorcompaction.jitter"; 364 public static final float DEFAULT_MAJOR_COMPACTION_JITTER = 0.50F; 365 366 /** Parameter name for the maximum batch of KVs to be used in flushes and compactions */ 367 public static final String COMPACTION_KV_MAX = "hbase.hstore.compaction.kv.max"; 368 public static final int COMPACTION_KV_MAX_DEFAULT = 10; 369 370 /** Parameter name for HBase instance root directory */ 371 public static final String HBASE_DIR = "hbase.rootdir"; 372 373 /** Parameter name for HBase client IPC pool type */ 374 public static final String HBASE_CLIENT_IPC_POOL_TYPE = "hbase.client.ipc.pool.type"; 375 376 /** Parameter name for HBase client IPC pool size */ 377 public static final String HBASE_CLIENT_IPC_POOL_SIZE = "hbase.client.ipc.pool.size"; 378 379 /** Parameter name for HBase client operation timeout. */ 380 public static final String HBASE_CLIENT_OPERATION_TIMEOUT = "hbase.client.operation.timeout"; 381 382 /** Parameter name for HBase client meta operation timeout. */ 383 public static final String HBASE_CLIENT_META_OPERATION_TIMEOUT = 384 "hbase.client.meta.operation.timeout"; 385 386 /** Default HBase client operation timeout, which is tantamount to a blocking call */ 387 public static final int DEFAULT_HBASE_CLIENT_OPERATION_TIMEOUT = 1200000; 388 389 /** Parameter name for HBase client meta replica scan call timeout. */ 390 public static final String HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT = 391 "hbase.client.meta.replica.scan.timeout"; 392 393 /** Default HBase client meta replica scan call timeout, 1 second */ 394 public static final int HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT_DEFAULT = 1000000; 395 396 /** Used to construct the name of the log directory for a region server */ 397 public static final String HREGION_LOGDIR_NAME = "WALs"; 398 399 /** Used to construct the name of the splitlog directory for a region server */ 400 public static final String SPLIT_LOGDIR_NAME = "splitWAL"; 401 402 /** Like the previous, but for old logs that are about to be deleted */ 403 public static final String HREGION_OLDLOGDIR_NAME = "oldWALs"; 404 405 /** Staging dir used by bulk load */ 406 public static final String BULKLOAD_STAGING_DIR_NAME = "staging"; 407 408 public static final String CORRUPT_DIR_NAME = "corrupt"; 409 410 /** Used by HBCK to sideline backup data */ 411 public static final String HBCK_SIDELINEDIR_NAME = ".hbck"; 412 413 /** Any artifacts left from migration can be moved here */ 414 public static final String MIGRATION_NAME = ".migration"; 415 416 /** 417 * The directory from which co-processor/custom filter jars can be loaded dynamically by the 418 * region servers. This value can be overridden by the hbase.dynamic.jars.dir config. 419 */ 420 @Deprecated // unused. see HBASE-12054. remove this in 3.0 421 public static final String LIB_DIR = "lib"; 422 423 /** Used to construct the name of the compaction directory during compaction */ 424 public static final String HREGION_COMPACTIONDIR_NAME = "compaction.dir"; 425 426 /** Conf key for the max file size after which we split the region */ 427 public static final String HREGION_MAX_FILESIZE = "hbase.hregion.max.filesize"; 428 429 /** Default maximum file size */ 430 public static final long DEFAULT_MAX_FILE_SIZE = 10 * 1024 * 1024 * 1024L; 431 432 /** Conf key for if we should sum overall region files size when check to split */ 433 public static final String OVERALL_HREGION_FILES = "hbase.hregion.split.overallfiles"; 434 435 /** Default overall region files */ 436 public static final boolean DEFAULT_OVERALL_HREGION_FILES = false; 437 438 /** 439 * Max size of single row for Get's or Scan's without in-row scanning flag set. 440 */ 441 public static final String TABLE_MAX_ROWSIZE_KEY = "hbase.table.max.rowsize"; 442 443 /** 444 * Default max row size (1 Gb). 445 */ 446 public static final long TABLE_MAX_ROWSIZE_DEFAULT = 1024 * 1024 * 1024L; 447 448 /** 449 * The max number of threads used for opening and closing stores or store files in parallel 450 */ 451 public static final String HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 452 "hbase.hstore.open.and.close.threads.max"; 453 454 /** 455 * The default number for the max number of threads used for opening and closing stores or store 456 * files in parallel 457 */ 458 public static final int DEFAULT_HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 1; 459 460 /** 461 * Block updates if memstore has hbase.hregion.memstore.block.multiplier times 462 * hbase.hregion.memstore.flush.size bytes. Useful preventing runaway memstore during spikes in 463 * update traffic. 464 */ 465 public static final String HREGION_MEMSTORE_BLOCK_MULTIPLIER = 466 "hbase.hregion.memstore.block.multiplier"; 467 468 /** 469 * Default value for hbase.hregion.memstore.block.multiplier 470 */ 471 public static final int DEFAULT_HREGION_MEMSTORE_BLOCK_MULTIPLIER = 4; 472 473 /** Conf key for the memstore size at which we flush the memstore */ 474 public static final String HREGION_MEMSTORE_FLUSH_SIZE = "hbase.hregion.memstore.flush.size"; 475 476 public static final String HREGION_EDITS_REPLAY_SKIP_ERRORS = 477 "hbase.hregion.edits.replay.skip.errors"; 478 479 public static final boolean DEFAULT_HREGION_EDITS_REPLAY_SKIP_ERRORS = false; 480 481 /** Maximum value length, enforced on KeyValue construction */ 482 public static final int MAXIMUM_VALUE_LENGTH = Integer.MAX_VALUE - 1; 483 484 /** name of the file for unique cluster ID */ 485 public static final String CLUSTER_ID_FILE_NAME = "hbase.id"; 486 487 /** Default value for cluster ID */ 488 public static final String CLUSTER_ID_DEFAULT = "default-cluster"; 489 490 /** Parameter name for # days to keep MVCC values during a major compaction */ 491 public static final String KEEP_SEQID_PERIOD = "hbase.hstore.compaction.keep.seqId.period"; 492 /** At least to keep MVCC values in hfiles for 5 days */ 493 public static final int MIN_KEEP_SEQID_PERIOD = 5; 494 495 // Always store the location of the root table's HRegion. 496 // This HRegion is never split. 497 498 // region name = table + startkey + regionid. This is the row key. 499 // each row in the root and meta tables describes exactly 1 region 500 // Do we ever need to know all the information that we are storing? 501 502 // Note that the name of the root table starts with "-" and the name of the 503 // meta table starts with "." Why? it's a trick. It turns out that when we 504 // store region names in memory, we use a SortedMap. Since "-" sorts before 505 // "." (and since no other table name can start with either of these 506 // characters, the root region will always be the first entry in such a Map, 507 // followed by all the meta regions (which will be ordered by their starting 508 // row key as well), followed by all user tables. So when the Master is 509 // choosing regions to assign, it will always choose the root region first, 510 // followed by the meta regions, followed by user regions. Since the root 511 // and meta regions always need to be on-line, this ensures that they will 512 // be the first to be reassigned if the server(s) they are being served by 513 // should go down. 514 515 public static final String BASE_NAMESPACE_DIR = "data"; 516 517 /** delimiter used between portions of a region name */ 518 public static final int META_ROW_DELIMITER = ','; 519 520 /** The catalog family as a string */ 521 public static final String CATALOG_FAMILY_STR = "info"; 522 523 /** The catalog family */ 524 public static final byte[] CATALOG_FAMILY = Bytes.toBytes(CATALOG_FAMILY_STR); 525 526 /** The RegionInfo qualifier as a string */ 527 public static final String REGIONINFO_QUALIFIER_STR = "regioninfo"; 528 529 /** The regioninfo column qualifier */ 530 public static final byte[] REGIONINFO_QUALIFIER = Bytes.toBytes(REGIONINFO_QUALIFIER_STR); 531 532 /** The server column qualifier */ 533 public static final String SERVER_QUALIFIER_STR = "server"; 534 /** The server column qualifier */ 535 public static final byte[] SERVER_QUALIFIER = Bytes.toBytes(SERVER_QUALIFIER_STR); 536 537 /** The startcode column qualifier */ 538 public static final String STARTCODE_QUALIFIER_STR = "serverstartcode"; 539 /** The startcode column qualifier */ 540 public static final byte[] STARTCODE_QUALIFIER = Bytes.toBytes(STARTCODE_QUALIFIER_STR); 541 542 /** The open seqnum column qualifier */ 543 public static final String SEQNUM_QUALIFIER_STR = "seqnumDuringOpen"; 544 /** The open seqnum column qualifier */ 545 public static final byte[] SEQNUM_QUALIFIER = Bytes.toBytes(SEQNUM_QUALIFIER_STR); 546 547 /** The state column qualifier */ 548 public static final String STATE_QUALIFIER_STR = "state"; 549 550 public static final byte[] STATE_QUALIFIER = Bytes.toBytes(STATE_QUALIFIER_STR); 551 552 /** 553 * The serverName column qualifier. Its the server where the region is transitioning on, while 554 * column server is the server where the region is opened on. They are the same when the region is 555 * in state OPEN. 556 */ 557 public static final String SERVERNAME_QUALIFIER_STR = "sn"; 558 559 public static final byte[] SERVERNAME_QUALIFIER = Bytes.toBytes(SERVERNAME_QUALIFIER_STR); 560 561 /** The lower-half split region column qualifier string. */ 562 public static final String SPLITA_QUALIFIER_STR = "splitA"; 563 /** The lower-half split region column qualifier */ 564 public static final byte[] SPLITA_QUALIFIER = Bytes.toBytes(SPLITA_QUALIFIER_STR); 565 566 /** The upper-half split region column qualifier String. */ 567 public static final String SPLITB_QUALIFIER_STR = "splitB"; 568 /** The upper-half split region column qualifier */ 569 public static final byte[] SPLITB_QUALIFIER = Bytes.toBytes(SPLITB_QUALIFIER_STR); 570 571 /** 572 * Merge qualifier prefix. We used to only allow two regions merge; mergeA and mergeB. Now we 573 * allow many to merge. Each region to merge will be referenced in a column whose qualifier starts 574 * with this define. 575 */ 576 public static final String MERGE_QUALIFIER_PREFIX_STR = "merge"; 577 public static final byte[] MERGE_QUALIFIER_PREFIX = Bytes.toBytes(MERGE_QUALIFIER_PREFIX_STR); 578 579 /** 580 * The lower-half merge region column qualifier 581 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for the 582 * {@link #MERGE_QUALIFIER_PREFIX_STR} prefix. 583 */ 584 @Deprecated 585 public static final byte[] MERGEA_QUALIFIER = Bytes.toBytes(MERGE_QUALIFIER_PREFIX_STR + "A"); 586 587 /** 588 * The upper-half merge region column qualifier 589 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for the 590 * {@link #MERGE_QUALIFIER_PREFIX_STR} prefix. 591 */ 592 @Deprecated 593 public static final byte[] MERGEB_QUALIFIER = Bytes.toBytes(MERGE_QUALIFIER_PREFIX_STR + "B"); 594 595 /** The catalog family as a string */ 596 public static final String TABLE_FAMILY_STR = "table"; 597 598 /** The catalog family */ 599 public static final byte[] TABLE_FAMILY = Bytes.toBytes(TABLE_FAMILY_STR); 600 601 /** The serialized table state qualifier */ 602 public static final byte[] TABLE_STATE_QUALIFIER = Bytes.toBytes("state"); 603 604 /** The replication barrier family as a string */ 605 public static final String REPLICATION_BARRIER_FAMILY_STR = "rep_barrier"; 606 607 /** The replication barrier family */ 608 public static final byte[] REPLICATION_BARRIER_FAMILY = 609 Bytes.toBytes(REPLICATION_BARRIER_FAMILY_STR); 610 611 /** 612 * The meta table version column qualifier. We keep current version of the meta table in this 613 * column in <code>-ROOT-</code> table: i.e. in the 'info:v' column. 614 */ 615 public static final byte[] META_VERSION_QUALIFIER = Bytes.toBytes("v"); 616 617 /** The family str as a key in map */ 618 public static final String FAMILY_KEY_STR = "family"; 619 620 /** 621 * The current version of the meta table. - pre-hbase 0.92. There is no META_VERSION column in the 622 * root table in this case. The meta has HTableDescriptor serialized into the HRegionInfo; - 623 * version 0 is 0.92 and 0.94. Meta data has serialized HRegionInfo's using Writable 624 * serialization, and HRegionInfo's does not contain HTableDescriptors. - version 1 for 0.96+ 625 * keeps HRegionInfo data structures, but changes the byte[] serialization from Writables to 626 * Protobuf. See HRegionInfo.VERSION 627 */ 628 public static final short META_VERSION = 1; 629 630 // Other constants 631 632 /** 633 * An empty byte array instance. 634 */ 635 public static final byte[] EMPTY_BYTE_ARRAY = new byte[0]; 636 637 /** 638 * An empty string instance. 639 */ 640 public static final String EMPTY_STRING = ""; 641 642 public static final ByteBuffer EMPTY_BYTE_BUFFER = ByteBuffer.wrap(EMPTY_BYTE_ARRAY); 643 644 /** 645 * Used by scanners, etc when they want to start at the beginning of a region 646 */ 647 public static final byte[] EMPTY_START_ROW = EMPTY_BYTE_ARRAY; 648 649 /** 650 * Last row in a table. 651 */ 652 public static final byte[] EMPTY_END_ROW = EMPTY_BYTE_ARRAY; 653 654 /** 655 * Used by scanners and others when they're trying to detect the end of a table 656 */ 657 public static final byte[] LAST_ROW = EMPTY_BYTE_ARRAY; 658 659 /** 660 * Max length a row can have because of the limitation in TFile. 661 */ 662 public static final int MAX_ROW_LENGTH = Short.MAX_VALUE; 663 664 /** 665 * Timestamp to use when we want to refer to the latest cell. This is the timestamp sent by 666 * clients when no timestamp is specified on commit. 667 */ 668 public static final long LATEST_TIMESTAMP = Long.MAX_VALUE; 669 670 /** 671 * Timestamp to use when we want to refer to the oldest cell. Special! Used in fake Cells only. 672 * Should never be the timestamp on an actual Cell returned to a client. 673 * @deprecated Should not be public since hbase-1.3.0. For internal use only. Move internal to 674 * Scanners flagged as special timestamp value never to be returned as timestamp on a 675 * Cell. 676 */ 677 @Deprecated 678 public static final long OLDEST_TIMESTAMP = Long.MIN_VALUE; 679 680 /** 681 * LATEST_TIMESTAMP in bytes form 682 */ 683 public static final byte[] LATEST_TIMESTAMP_BYTES = { 684 // big-endian 685 (byte) (LATEST_TIMESTAMP >>> 56), (byte) (LATEST_TIMESTAMP >>> 48), 686 (byte) (LATEST_TIMESTAMP >>> 40), (byte) (LATEST_TIMESTAMP >>> 32), 687 (byte) (LATEST_TIMESTAMP >>> 24), (byte) (LATEST_TIMESTAMP >>> 16), 688 (byte) (LATEST_TIMESTAMP >>> 8), (byte) LATEST_TIMESTAMP, }; 689 690 /** 691 * Define for 'return-all-versions'. 692 */ 693 public static final int ALL_VERSIONS = Integer.MAX_VALUE; 694 695 /** 696 * Unlimited time-to-live. 697 */ 698 // public static final int FOREVER = -1; 699 public static final int FOREVER = Integer.MAX_VALUE; 700 701 /** 702 * Seconds in a week 703 */ 704 @Deprecated // unused. see HBASE-2692. remove this in 3.0 705 public static final int WEEK_IN_SECONDS = 7 * 24 * 3600; 706 707 /** 708 * Seconds in a day, hour and minute 709 */ 710 public static final int DAY_IN_SECONDS = 24 * 60 * 60; 711 public static final int HOUR_IN_SECONDS = 60 * 60; 712 public static final int MINUTE_IN_SECONDS = 60; 713 714 // TODO: although the following are referenced widely to format strings for 715 // the shell. They really aren't a part of the public API. It would be 716 // nice if we could put them somewhere where they did not need to be 717 // public. They could have package visibility 718 public static final String NAME = "NAME"; 719 public static final String VERSIONS = "VERSIONS"; 720 public static final String IN_MEMORY = "IN_MEMORY"; 721 public static final String METADATA = "METADATA"; 722 public static final String CONFIGURATION = "CONFIGURATION"; 723 724 /** 725 * Retrying we multiply hbase.client.pause setting by what we have in this array until we run out 726 * of array items. Retries beyond this use the last number in the array. So, for example, if 727 * hbase.client.pause is 1 second, and maximum retries count hbase.client.retries.number is 10, we 728 * will retry at the following intervals: 1, 2, 3, 5, 10, 20, 40, 100, 100, 100. With 100ms, a 729 * back-off of 200 means 20s 730 */ 731 public static final int[] RETRY_BACKOFF = 732 { 1, 2, 3, 5, 10, 20, 40, 100, 100, 100, 100, 200, 200 }; 733 734 public static final String REGION_IMPL = "hbase.hregion.impl"; 735 736 /** 737 * Scope tag for locally scoped data. This data will not be replicated. 738 */ 739 public static final int REPLICATION_SCOPE_LOCAL = 0; 740 741 /** 742 * Scope tag for globally scoped data. This data will be replicated to all peers. 743 */ 744 public static final int REPLICATION_SCOPE_GLOBAL = 1; 745 746 /** 747 * Default cluster ID, cannot be used to identify a cluster so a key with this value means it 748 * wasn't meant for replication. 749 */ 750 public static final UUID DEFAULT_CLUSTER_ID = new UUID(0L, 0L); 751 752 /** 753 * Parameter name for maximum number of bytes returned when calling a scanner's next method. 754 * Controlled by the client. 755 */ 756 public static final String HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY = 757 "hbase.client.scanner.max.result.size"; 758 759 /** 760 * Parameter name for maximum number of bytes returned when calling a scanner's next method. 761 * Controlled by the server. 762 */ 763 public static final String HBASE_SERVER_SCANNER_MAX_RESULT_SIZE_KEY = 764 "hbase.server.scanner.max.result.size"; 765 766 /** 767 * Maximum number of bytes returned when calling a scanner's next method. Note that when a single 768 * row is larger than this limit the row is still returned completely. The default value is 2MB. 769 */ 770 public static final long DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE = 2 * 1024 * 1024; 771 772 /** 773 * Maximum number of bytes returned when calling a scanner's next method. Note that when a single 774 * row is larger than this limit the row is still returned completely. Safety setting to protect 775 * the region server. The default value is 100MB. (a client would rarely request larger chunks on 776 * purpose) 777 */ 778 public static final long DEFAULT_HBASE_SERVER_SCANNER_MAX_RESULT_SIZE = 100 * 1024 * 1024; 779 780 /** 781 * Parameter name for client pause value, used mostly as value to wait before running a retry of a 782 * failed get, region lookup, etc. 783 */ 784 public static final String HBASE_CLIENT_PAUSE = "hbase.client.pause"; 785 786 /** 787 * Default value of {@link #HBASE_CLIENT_PAUSE}. 788 */ 789 public static final long DEFAULT_HBASE_CLIENT_PAUSE = 100; 790 791 /** 792 * Parameter name for client pause value for special case such as call queue too big, etc. 793 */ 794 public static final String HBASE_CLIENT_PAUSE_FOR_CQTBE = "hbase.client.pause.cqtbe"; 795 796 /** 797 * The maximum number of concurrent connections the client will maintain. 798 */ 799 public static final String HBASE_CLIENT_MAX_TOTAL_TASKS = "hbase.client.max.total.tasks"; 800 801 /** 802 * Default value of {@link #HBASE_CLIENT_MAX_TOTAL_TASKS}. 803 */ 804 public static final int DEFAULT_HBASE_CLIENT_MAX_TOTAL_TASKS = 100; 805 806 /** 807 * The maximum number of concurrent connections the client will maintain to a single RegionServer. 808 */ 809 public static final String HBASE_CLIENT_MAX_PERSERVER_TASKS = "hbase.client.max.perserver.tasks"; 810 811 /** 812 * Default value of {@link #HBASE_CLIENT_MAX_PERSERVER_TASKS}. 813 */ 814 public static final int DEFAULT_HBASE_CLIENT_MAX_PERSERVER_TASKS = 2; 815 816 /** 817 * The maximum number of concurrent connections the client will maintain to a single Region. 818 */ 819 public static final String HBASE_CLIENT_MAX_PERREGION_TASKS = "hbase.client.max.perregion.tasks"; 820 821 /** 822 * Default value of {@link #HBASE_CLIENT_MAX_PERREGION_TASKS}. 823 */ 824 public static final int DEFAULT_HBASE_CLIENT_MAX_PERREGION_TASKS = 1; 825 826 /** 827 * The maximum number of concurrent pending RPC requests for one server in process level. 828 */ 829 public static final String HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD = 830 "hbase.client.perserver.requests.threshold"; 831 832 /** 833 * Default value of {@link #HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD}. 834 */ 835 public static final int DEFAULT_HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD = Integer.MAX_VALUE; 836 837 /** 838 * Parameter name for server pause value, used mostly as value to wait before running a retry of a 839 * failed operation. 840 */ 841 public static final String HBASE_SERVER_PAUSE = "hbase.server.pause"; 842 843 /** 844 * Default value of {@link #HBASE_SERVER_PAUSE}. 845 */ 846 public static final int DEFAULT_HBASE_SERVER_PAUSE = 1000; 847 848 /** 849 * Parameter name for maximum retries, used as maximum for all retryable operations such as 850 * fetching of the root region from root region server, getting a cell's value, starting a row 851 * update, etc. 852 */ 853 public static final String HBASE_CLIENT_RETRIES_NUMBER = "hbase.client.retries.number"; 854 855 /** 856 * Default value of {@link #HBASE_CLIENT_RETRIES_NUMBER}. 857 */ 858 public static final int DEFAULT_HBASE_CLIENT_RETRIES_NUMBER = 15; 859 860 public static final String HBASE_CLIENT_SERVERSIDE_RETRIES_MULTIPLIER = 861 "hbase.client.serverside.retries.multiplier"; 862 863 public static final int DEFAULT_HBASE_CLIENT_SERVERSIDE_RETRIES_MULTIPLIER = 3; 864 865 /** 866 * Parameter name to set the default scanner caching for all clients. 867 */ 868 public static final String HBASE_CLIENT_SCANNER_CACHING = "hbase.client.scanner.caching"; 869 870 /** 871 * Default value for {@link #HBASE_CLIENT_SCANNER_CACHING} 872 */ 873 public static final int DEFAULT_HBASE_CLIENT_SCANNER_CACHING = Integer.MAX_VALUE; 874 875 /** 876 * Parameter name for number of rows that will be fetched when calling next on a scanner if it is 877 * not served from memory. Higher caching values will enable faster scanners but will eat up more 878 * memory and some calls of next may take longer and longer times when the cache is empty. 879 */ 880 public static final String HBASE_META_SCANNER_CACHING = "hbase.meta.scanner.caching"; 881 882 /** 883 * Default value of {@link #HBASE_META_SCANNER_CACHING}. 884 */ 885 public static final int DEFAULT_HBASE_META_SCANNER_CACHING = 100; 886 887 /** 888 * Parameter name for number of versions, kept by meta table. 889 */ 890 public static final String HBASE_META_VERSIONS = "hbase.meta.versions"; 891 892 /** 893 * Default value of {@link #HBASE_META_VERSIONS}. 894 */ 895 public static final int DEFAULT_HBASE_META_VERSIONS = 3; 896 897 /** 898 * Parameter name for number of versions, kept by meta table. 899 */ 900 public static final String HBASE_META_BLOCK_SIZE = "hbase.meta.blocksize"; 901 902 /** 903 * Default value of {@link #HBASE_META_BLOCK_SIZE}. 904 */ 905 public static final int DEFAULT_HBASE_META_BLOCK_SIZE = 8 * 1024; 906 907 /** 908 * Parameter name for unique identifier for this {@link org.apache.hadoop.conf.Configuration} 909 * instance. If there are two or more {@link org.apache.hadoop.conf.Configuration} instances that, 910 * for all intents and purposes, are the same except for their instance ids, then they will not be 911 * able to share the same org.apache.hadoop.hbase.client.HConnection instance. On the other hand, 912 * even if the instance ids are the same, it could result in non-shared 913 * org.apache.hadoop.hbase.client.HConnection instances if some of the other connection parameters 914 * differ. 915 */ 916 public static final String HBASE_CLIENT_INSTANCE_ID = "hbase.client.instance.id"; 917 918 /** 919 * The client scanner timeout period in milliseconds. 920 */ 921 public static final String HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 922 "hbase.client.scanner.timeout.period"; 923 924 /** 925 * Use {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD} instead. 926 * @deprecated This config option is deprecated. Will be removed at later releases after 0.96. 927 */ 928 @Deprecated 929 public static final String HBASE_REGIONSERVER_LEASE_PERIOD_KEY = 930 "hbase.regionserver.lease.period"; 931 932 /** 933 * Default value of {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD}. 934 */ 935 public static final int DEFAULT_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 60000; 936 937 /** 938 * timeout for each RPC 939 */ 940 public static final String HBASE_RPC_TIMEOUT_KEY = "hbase.rpc.timeout"; 941 942 /** 943 * timeout for each read RPC 944 */ 945 public static final String HBASE_RPC_READ_TIMEOUT_KEY = "hbase.rpc.read.timeout"; 946 947 /** 948 * timeout for each write RPC 949 */ 950 public static final String HBASE_RPC_WRITE_TIMEOUT_KEY = "hbase.rpc.write.timeout"; 951 952 /** 953 * Default value of {@link #HBASE_RPC_TIMEOUT_KEY} 954 */ 955 public static final int DEFAULT_HBASE_RPC_TIMEOUT = 60000; 956 957 /** 958 * timeout for short operation RPC 959 */ 960 public static final String HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY = 961 "hbase.rpc.shortoperation.timeout"; 962 963 /** 964 * Default value of {@link #HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY} 965 */ 966 public static final int DEFAULT_HBASE_RPC_SHORTOPERATION_TIMEOUT = 10000; 967 968 /** 969 * Value indicating the server name was saved with no sequence number. 970 */ 971 public static final long NO_SEQNUM = -1; 972 973 /** 974 * Registry implementation to be used on the client side. 975 */ 976 public static final String CLIENT_CONNECTION_REGISTRY_IMPL_CONF_KEY = 977 "hbase.client.registry.impl"; 978 979 /* 980 * cluster replication constants. 981 */ 982 public static final String REPLICATION_SOURCE_SERVICE_CLASSNAME = 983 "hbase.replication.source.service"; 984 public static final String REPLICATION_SINK_SERVICE_CLASSNAME = "hbase.replication.sink.service"; 985 public static final String REPLICATION_SERVICE_CLASSNAME_DEFAULT = 986 "org.apache.hadoop.hbase.replication.regionserver.Replication"; 987 public static final String REPLICATION_BULKLOAD_ENABLE_KEY = "hbase.replication.bulkload.enabled"; 988 public static final boolean REPLICATION_BULKLOAD_ENABLE_DEFAULT = false; 989 /** Replication cluster id of source cluster which uniquely identifies itself with peer cluster */ 990 public static final String REPLICATION_CLUSTER_ID = "hbase.replication.cluster.id"; 991 /** 992 * Max total size of buffered entries in all replication peers. It will prevent server getting OOM 993 * if there are many peers. Default value is 256MB which is four times to default 994 * replication.source.size.capacity. 995 */ 996 public static final String REPLICATION_SOURCE_TOTAL_BUFFER_KEY = "replication.total.buffer.quota"; 997 998 public static final int REPLICATION_SOURCE_TOTAL_BUFFER_DFAULT = 256 * 1024 * 1024; 999 1000 /** Configuration key for ReplicationSource shipeEdits timeout */ 1001 public static final String REPLICATION_SOURCE_SHIPEDITS_TIMEOUT = 1002 "replication.source.shipedits.timeout"; 1003 public static final int REPLICATION_SOURCE_SHIPEDITS_TIMEOUT_DFAULT = 60000; 1004 1005 /** 1006 * Directory where the source cluster file system client configuration are placed which is used by 1007 * sink cluster to copy HFiles from source cluster file system 1008 */ 1009 public static final String REPLICATION_CONF_DIR = "hbase.replication.conf.dir"; 1010 1011 /** Maximum time to retry for a failed bulk load request */ 1012 public static final String BULKLOAD_MAX_RETRIES_NUMBER = "hbase.bulkload.retries.number"; 1013 1014 /** HBCK special code name used as server name when manipulating ZK nodes */ 1015 @Deprecated // unused. see HBASE-3789. remove this in 3.0 1016 public static final String HBCK_CODE_NAME = "HBCKServerName"; 1017 1018 public static final String KEY_FOR_HOSTNAME_SEEN_BY_MASTER = 1019 "hbase.regionserver.hostname.seen.by.master"; 1020 1021 public static final String HBASE_MASTER_LOGCLEANER_PLUGINS = "hbase.master.logcleaner.plugins"; 1022 1023 public static final String HBASE_REGION_SPLIT_POLICY_KEY = 1024 "hbase.regionserver.region.split.policy"; 1025 1026 /** Whether nonces are enabled; default is true. */ 1027 public static final String HBASE_RS_NONCES_ENABLED = "hbase.regionserver.nonces.enabled"; 1028 1029 /** 1030 * Configuration key for the size of the block cache 1031 */ 1032 public static final String HFILE_BLOCK_CACHE_SIZE_KEY = "hfile.block.cache.size"; 1033 1034 public static final float HFILE_BLOCK_CACHE_SIZE_DEFAULT = 0.4f; 1035 1036 /** 1037 * Configuration key for setting the fix size of the block size, default do nothing and it should 1038 * be explicitly set by user or only used within ClientSideRegionScanner. if it's set less than 1039 * current max on heap size, it overrides the max size of block cache 1040 */ 1041 public static final String HFILE_ONHEAP_BLOCK_CACHE_FIXED_SIZE_KEY = 1042 "hfile.onheap.block.cache.fixed.size"; 1043 public static final long HFILE_ONHEAP_BLOCK_CACHE_FIXED_SIZE_DEFAULT = 0L; 1044 public static final long HBASE_CLIENT_SCANNER_ONHEAP_BLOCK_CACHE_FIXED_SIZE_DEFAULT = 1045 32 * 1024 * 1024L; 1046 1047 /** 1048 * Configuration key for setting pread must read both necessaryLen and extraLen, default is 1049 * disabled. This is an optimized flag for reading HFile from blob storage. 1050 */ 1051 public static final String HFILE_PREAD_ALL_BYTES_ENABLED_KEY = "hfile.pread.all.bytes.enabled"; 1052 public static final boolean HFILE_PREAD_ALL_BYTES_ENABLED_DEFAULT = false; 1053 1054 /* 1055 * Minimum percentage of free heap necessary for a successful cluster startup. 1056 */ 1057 public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD = 0.2f; 1058 1059 /** 1060 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1061 */ 1062 @Deprecated 1063 public static final Pattern CP_HTD_ATTR_KEY_PATTERN = 1064 Pattern.compile("^coprocessor\\$([0-9]+)$", Pattern.CASE_INSENSITIVE); 1065 1066 /** 1067 * <pre> 1068 * Pattern that matches a coprocessor specification. Form is: 1069 * {@code <coprocessor jar file location> '|' <class name> ['|' <priority> ['|' <arguments>]]} 1070 * where arguments are {@code <KEY> '=' <VALUE> [,...]} 1071 * For example: {@code hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2} 1072 * </pre> 1073 * 1074 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1075 */ 1076 @Deprecated 1077 public static final Pattern CP_HTD_ATTR_VALUE_PATTERN = 1078 Pattern.compile("(^[^\\|]*)\\|([^\\|]+)\\|[\\s]*([\\d]*)[\\s]*(\\|.*)?$"); 1079 /** 1080 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1081 */ 1082 @Deprecated 1083 public static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN = "[^=,]+"; 1084 /** 1085 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1086 */ 1087 @Deprecated 1088 public static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN = "[^,]+"; 1089 /** 1090 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1091 */ 1092 @Deprecated 1093 public static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN = Pattern.compile("(" 1094 + CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN + ")=(" + CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN + "),?"); 1095 public static final String CP_HTD_ATTR_INCLUSION_KEY = 1096 "hbase.coprocessor.classloader.included.classes"; 1097 1098 /** The delay when re-trying a socket operation in a loop (HBASE-4712) */ 1099 public static final int SOCKET_RETRY_WAIT_MS = 200; 1100 1101 /** Host name of the local machine */ 1102 public static final String LOCALHOST = "localhost"; 1103 1104 /** 1105 * If this parameter is set to true, then hbase will read data and then verify checksums. Checksum 1106 * verification inside hdfs will be switched off. However, if the hbase-checksum verification 1107 * fails, then it will switch back to using hdfs checksums for verifiying data that is being read 1108 * from storage. If this parameter is set to false, then hbase will not verify any checksums, 1109 * instead it will depend on checksum verification being done in the hdfs client. 1110 */ 1111 public static final String HBASE_CHECKSUM_VERIFICATION = "hbase.regionserver.checksum.verify"; 1112 1113 public static final String LOCALHOST_IP = "127.0.0.1"; 1114 1115 public static final String REGION_SERVER_HANDLER_COUNT = "hbase.regionserver.handler.count"; 1116 public static final int DEFAULT_REGION_SERVER_HANDLER_COUNT = 30; 1117 1118 /* 1119 * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT: -1 => Disable aborting 0 => Abort if even a 1120 * single handler has died 0.x => Abort only when this percent of handlers have died 1 => Abort 1121 * only all of the handers have died 1122 */ 1123 public static final String REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 1124 "hbase.regionserver.handler.abort.on.error.percent"; 1125 public static final double DEFAULT_REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 0.5; 1126 1127 // High priority handlers to deal with admin requests and system table operation requests 1128 public static final String REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 1129 "hbase.regionserver.metahandler.count"; 1130 public static final int DEFAULT_REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 20; 1131 1132 public static final String REGION_SERVER_REPLICATION_HANDLER_COUNT = 1133 "hbase.regionserver.replication.handler.count"; 1134 public static final int DEFAULT_REGION_SERVER_REPLICATION_HANDLER_COUNT = 3; 1135 // Meta Transition handlers to deal with meta ReportRegionStateTransitionRequest. Meta transition 1136 // should be dealt with in a separate handler in case blocking other region's transition. 1137 public static final String MASTER_META_TRANSITION_HANDLER_COUNT = 1138 "hbase.master.meta.transition.handler.count"; 1139 public static final int MASTER__META_TRANSITION_HANDLER_COUNT_DEFAULT = 1; 1140 1141 @Deprecated // unused. see HBASE-10569. remove this in 3.0 1142 public static final String MASTER_HANDLER_COUNT = "hbase.master.handler.count"; 1143 @Deprecated // unused. see HBASE-10569. remove this in 3.0 1144 public static final int DEFAULT_MASTER_HANLDER_COUNT = 25; 1145 1146 /** Conf key that specifies timeout value to wait for a region ready */ 1147 @Deprecated // unused. see HBASE-13616. remove this in 3.0 1148 public static final String LOG_REPLAY_WAIT_REGION_TIMEOUT = 1149 "hbase.master.log.replay.wait.region.timeout"; 1150 1151 /** Conf key for enabling meta replication */ 1152 public static final String USE_META_REPLICAS = "hbase.meta.replicas.use"; 1153 public static final boolean DEFAULT_USE_META_REPLICAS = false; 1154 1155 /** 1156 * @deprecated Since 2.4.0, will be removed in 4.0.0. Please change the meta replicas number by 1157 * altering meta table, i.e, set a new 'region replication' number and call 1158 * modifyTable. 1159 */ 1160 @Deprecated 1161 public static final String META_REPLICAS_NUM = "hbase.meta.replica.count"; 1162 /** 1163 * @deprecated Since 2.4.0, will be removed in 4.0.0. Please change the meta replicas number by 1164 * altering meta table, i.e, set a new 'region replication' number and call 1165 * modifyTable. 1166 */ 1167 @Deprecated 1168 public static final int DEFAULT_META_REPLICA_NUM = 1; 1169 1170 /** 1171 * The name of the configuration parameter that specifies the number of bytes in a newly created 1172 * checksum chunk. 1173 */ 1174 public static final String BYTES_PER_CHECKSUM = "hbase.hstore.bytes.per.checksum"; 1175 1176 /** 1177 * The name of the configuration parameter that specifies the name of an algorithm that is used to 1178 * compute checksums for newly created blocks. 1179 */ 1180 public static final String CHECKSUM_TYPE_NAME = "hbase.hstore.checksum.algorithm"; 1181 1182 /** Enable file permission modification from standard hbase */ 1183 public static final String ENABLE_DATA_FILE_UMASK = "hbase.data.umask.enable"; 1184 /** File permission umask to use when creating hbase data files */ 1185 public static final String DATA_FILE_UMASK_KEY = "hbase.data.umask"; 1186 1187 /** Configuration name of WAL Compression */ 1188 public static final String ENABLE_WAL_COMPRESSION = "hbase.regionserver.wal.enablecompression"; 1189 1190 /** 1191 * Configuration name of WAL storage policy Valid values are: HOT, COLD, WARM, ALL_SSD, ONE_SSD, 1192 * LAZY_PERSIST See 1193 * http://hadoop.apache.org/docs/r2.7.3/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html 1194 */ 1195 public static final String WAL_STORAGE_POLICY = "hbase.wal.storage.policy"; 1196 /** 1197 * "NONE" is not a valid storage policy and means we defer the policy to HDFS. @see 1198 * <a href="https://issues.apache.org/jira/browse/HBASE-20691">HBASE-20691</a> 1199 */ 1200 public static final String DEFER_TO_HDFS_STORAGE_POLICY = "NONE"; 1201 /** By default we defer the WAL storage policy to HDFS */ 1202 public static final String DEFAULT_WAL_STORAGE_POLICY = DEFER_TO_HDFS_STORAGE_POLICY; 1203 1204 /** Region in Transition metrics threshold time */ 1205 public static final String METRICS_RIT_STUCK_WARNING_THRESHOLD = 1206 "hbase.metrics.rit.stuck.warning.threshold"; 1207 1208 public static final String LOAD_BALANCER_SLOP_KEY = "hbase.regions.slop"; 1209 1210 /** delimiter used between portions of a region name */ 1211 public static final int DELIMITER = ','; 1212 1213 /** 1214 * QOS attributes: these attributes are used to demarcate RPC call processing by different set of 1215 * handlers. For example, HIGH_QOS tagged methods are handled by high priority handlers. 1216 */ 1217 // normal_QOS < replication_QOS < replay_QOS < QOS_threshold < admin_QOS < high_QOS < meta_QOS 1218 public static final int PRIORITY_UNSET = -1; 1219 public static final int NORMAL_QOS = 0; 1220 public static final int REPLICATION_QOS = 5; 1221 public static final int REPLAY_QOS = 6; 1222 public static final int QOS_THRESHOLD = 10; 1223 public static final int ADMIN_QOS = 100; 1224 public static final int HIGH_QOS = 200; 1225 public static final int SYSTEMTABLE_QOS = HIGH_QOS; 1226 /** 1227 * @deprecated the name "META_QOS" is a bit ambiguous, actually only meta region transition can 1228 * use this priority, and you should not use this directly. Will be removed in 3.0.0. 1229 */ 1230 @Deprecated 1231 public static final int META_QOS = 300; 1232 1233 /** Directory under /hbase where archived hfiles are stored */ 1234 public static final String HFILE_ARCHIVE_DIRECTORY = "archive"; 1235 1236 /** 1237 * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for remaining 1238 * snapshot constants; this is here to keep HConstants dependencies at a minimum and 1239 * uni-directional. 1240 */ 1241 public static final String SNAPSHOT_DIR_NAME = ".hbase-snapshot"; 1242 1243 /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */ 1244 public static final String OLD_SNAPSHOT_DIR_NAME = ".snapshot"; 1245 1246 /** Temporary directory used for table creation and deletion */ 1247 public static final String HBASE_TEMP_DIRECTORY = ".tmp"; 1248 /** 1249 * The period (in milliseconds) between computing region server point in time metrics 1250 */ 1251 public static final String REGIONSERVER_METRICS_PERIOD = "hbase.regionserver.metrics.period"; 1252 public static final long DEFAULT_REGIONSERVER_METRICS_PERIOD = 5000; 1253 /** Directories that are not HBase table directories */ 1254 public static final List<String> HBASE_NON_TABLE_DIRS = Collections.unmodifiableList( 1255 Arrays.asList(new String[] { HBCK_SIDELINEDIR_NAME, HBASE_TEMP_DIRECTORY, MIGRATION_NAME })); 1256 1257 /** 1258 * Directories that are not HBase user table directories. 1259 * @deprecated Since hbase-2.3.0; no replacement as not used any more (internally at least) 1260 */ 1261 @Deprecated 1262 public static final List<String> HBASE_NON_USER_TABLE_DIRS = 1263 Collections.unmodifiableList(Arrays.asList( 1264 (String[]) ArrayUtils.addAll(new String[] { TableName.META_TABLE_NAME.getNameAsString() }, 1265 HBASE_NON_TABLE_DIRS.toArray()))); 1266 1267 /** Health script related settings. */ 1268 public static final String HEALTH_SCRIPT_LOC = "hbase.node.health.script.location"; 1269 public static final String HEALTH_SCRIPT_TIMEOUT = "hbase.node.health.script.timeout"; 1270 public static final String HEALTH_CHORE_WAKE_FREQ = "hbase.node.health.script.frequency"; 1271 public static final long DEFAULT_HEALTH_SCRIPT_TIMEOUT = 60000; 1272 /** 1273 * The maximum number of health check failures a server can encounter consecutively. 1274 */ 1275 public static final String HEALTH_FAILURE_THRESHOLD = "hbase.node.health.failure.threshold"; 1276 public static final int DEFAULT_HEALTH_FAILURE_THRESHOLD = 3; 1277 1278 /** 1279 * Setting to activate, or not, the publication of the status by the master. Default notification 1280 * is by a multicast message. 1281 */ 1282 public static final String STATUS_PUBLISHED = "hbase.status.published"; 1283 public static final boolean STATUS_PUBLISHED_DEFAULT = false; 1284 1285 /** 1286 * IP to use for the multicast status messages between the master and the clients. The default 1287 * address is chosen as one among others within the ones suitable for multicast messages. 1288 */ 1289 public static final String STATUS_MULTICAST_ADDRESS = "hbase.status.multicast.address.ip"; 1290 public static final String DEFAULT_STATUS_MULTICAST_ADDRESS = "226.1.1.3"; 1291 1292 /** 1293 * The address to use for binding the local socket for receiving multicast. Defaults to 0.0.0.0. 1294 * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a> 1295 */ 1296 public static final String STATUS_MULTICAST_BIND_ADDRESS = 1297 "hbase.status.multicast.bind.address.ip"; 1298 public static final String DEFAULT_STATUS_MULTICAST_BIND_ADDRESS = "0.0.0.0"; 1299 1300 /** 1301 * The port to use for the multicast messages. 1302 */ 1303 public static final String STATUS_MULTICAST_PORT = "hbase.status.multicast.address.port"; 1304 public static final int DEFAULT_STATUS_MULTICAST_PORT = 16100; 1305 1306 /** 1307 * The network interface name to use for the multicast messages. 1308 */ 1309 public static final String STATUS_MULTICAST_NI_NAME = "hbase.status.multicast.ni.name"; 1310 1311 /** 1312 * The address to use for binding the local socket for sending multicast. Defaults to 0.0.0.0. 1313 */ 1314 public static final String STATUS_MULTICAST_PUBLISHER_BIND_ADDRESS = 1315 "hbase.status.multicast.publisher.bind.address.ip"; 1316 public static final String DEFAULT_STATUS_MULTICAST_PUBLISHER_BIND_ADDRESS = "0.0.0.0"; 1317 1318 public static final long NO_NONCE = 0; 1319 1320 /** Default cipher for encryption */ 1321 public static final String CIPHER_AES = "AES"; 1322 1323 /** Configuration key for the crypto algorithm provider, a class name */ 1324 public static final String CRYPTO_CIPHERPROVIDER_CONF_KEY = "hbase.crypto.cipherprovider"; 1325 1326 /** Configuration key for the crypto key provider, a class name */ 1327 public static final String CRYPTO_KEYPROVIDER_CONF_KEY = "hbase.crypto.keyprovider"; 1328 1329 /** Configuration key for the crypto key provider parameters */ 1330 public static final String CRYPTO_KEYPROVIDER_PARAMETERS_KEY = 1331 "hbase.crypto.keyprovider.parameters"; 1332 1333 /** Configuration key for the name of the master key for the cluster, a string */ 1334 public static final String CRYPTO_MASTERKEY_NAME_CONF_KEY = "hbase.crypto.master.key.name"; 1335 1336 /** Configuration key for the name of the alternate master key for the cluster, a string */ 1337 public static final String CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY = 1338 "hbase.crypto.master.alternate.key.name"; 1339 1340 /** Configuration key for the algorithm to use when encrypting the WAL, a string */ 1341 public static final String CRYPTO_WAL_ALGORITHM_CONF_KEY = "hbase.crypto.wal.algorithm"; 1342 1343 /** Configuration key for the name of the master WAL encryption key for the cluster, a string */ 1344 public static final String CRYPTO_WAL_KEY_NAME_CONF_KEY = "hbase.crypto.wal.key.name"; 1345 1346 /** Configuration key for the algorithm used for creating jks key, a string */ 1347 public static final String CRYPTO_KEY_ALGORITHM_CONF_KEY = "hbase.crypto.key.algorithm"; 1348 1349 /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */ 1350 public static final String CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY = 1351 "hbase.crypto.alternate.key.algorithm"; 1352 1353 /** Configuration key for enabling WAL encryption, a boolean */ 1354 public static final String ENABLE_WAL_ENCRYPTION = "hbase.regionserver.wal.encryption"; 1355 1356 /** Configuration key for setting RPC codec class name */ 1357 public static final String RPC_CODEC_CONF_KEY = "hbase.client.rpc.codec"; 1358 1359 /** Configuration key for setting replication codec class name */ 1360 public static final String REPLICATION_CODEC_CONF_KEY = "hbase.replication.rpc.codec"; 1361 1362 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ 1363 public static final String REPLICATION_SOURCE_MAXTHREADS_KEY = 1364 "hbase.replication.source.maxthreads"; 1365 1366 /** 1367 * Drop edits for tables that been deleted from the replication source and target 1368 * @deprecated moved it into HBaseInterClusterReplicationEndpoint 1369 */ 1370 @Deprecated 1371 public static final String REPLICATION_DROP_ON_DELETED_TABLE_KEY = 1372 "hbase.replication.drop.on.deleted.table"; 1373 1374 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ 1375 public static final int REPLICATION_SOURCE_MAXTHREADS_DEFAULT = 10; 1376 1377 /** Configuration key for SplitLog manager timeout */ 1378 public static final String HBASE_SPLITLOG_MANAGER_TIMEOUT = "hbase.splitlog.manager.timeout"; 1379 1380 /** 1381 * Configuration keys for Bucket cache 1382 */ 1383 // TODO moving these bucket cache implementation specific configs to this level is violation of 1384 // encapsulation. But as these has to be referred from hbase-common and bucket cache 1385 // sits in hbase-server, there were no other go! Can we move the cache implementation to 1386 // hbase-common? 1387 1388 /** 1389 * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path to the 1390 * file that will host the file-based cache. See BucketCache#getIOEngineFromName() for list of 1391 * supported ioengine options. 1392 * <p> 1393 * Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache. 1394 */ 1395 public static final String BUCKET_CACHE_IOENGINE_KEY = "hbase.bucketcache.ioengine"; 1396 1397 /** 1398 * When using bucket cache, this is a float that EITHER represents a percentage of total heap 1399 * memory size to give to the cache (if < 1.0) OR, it is the capacity in megabytes of the 1400 * cache. 1401 */ 1402 public static final String BUCKET_CACHE_SIZE_KEY = "hbase.bucketcache.size"; 1403 1404 /** 1405 * HConstants for fast fail on the client side follow 1406 */ 1407 /** 1408 * Config for enabling/disabling the fast fail mode. 1409 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1410 * this value will have no effect. The constants itself will be removed in 4.0.0. 1411 */ 1412 @Deprecated 1413 public static final String HBASE_CLIENT_FAST_FAIL_MODE_ENABLED = 1414 "hbase.client.fast.fail.mode.enabled"; 1415 1416 /** 1417 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1418 * this value will have no effect. The constants itself will be removed in 4.0.0. 1419 */ 1420 @Deprecated 1421 public static final boolean HBASE_CLIENT_ENABLE_FAST_FAIL_MODE_DEFAULT = false; 1422 1423 /** 1424 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1425 * this value will have no effect. The constants itself will be removed in 4.0.0. 1426 */ 1427 @Deprecated 1428 public static final String HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS = 1429 "hbase.client.fastfail.threshold"; 1430 1431 /** 1432 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1433 * this value will have no effect. The constants itself will be removed in 4.0.0. 1434 */ 1435 @Deprecated 1436 public static final long HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS_DEFAULT = 60000; 1437 1438 /** 1439 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1440 * this value will have no effect. The constants itself will be removed in 4.0.0. 1441 */ 1442 @Deprecated 1443 public static final String HBASE_CLIENT_FAILURE_MAP_CLEANUP_INTERVAL_MS = 1444 "hbase.client.failure.map.cleanup.interval"; 1445 1446 /** 1447 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1448 * this value will have no effect. The constants itself will be removed in 4.0.0. 1449 */ 1450 @Deprecated 1451 public static final long HBASE_CLIENT_FAILURE_MAP_CLEANUP_INTERVAL_MS_DEFAULT = 600000; 1452 1453 /** 1454 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1455 * this value will have no effect. The constants itself will be removed in 4.0.0. 1456 */ 1457 @Deprecated 1458 public static final String HBASE_CLIENT_FAST_FAIL_CLEANUP_MS_DURATION_MS = 1459 "hbase.client.fast.fail.cleanup.duration"; 1460 1461 /** 1462 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1463 * this value will have no effect. The constants itself will be removed in 4.0.0. 1464 */ 1465 @Deprecated 1466 public static final long HBASE_CLIENT_FAST_FAIL_CLEANUP_DURATION_MS_DEFAULT = 600000; 1467 1468 /** 1469 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1470 * this value will have no effect. The constants itself will be removed in 4.0.0. 1471 */ 1472 @Deprecated 1473 public static final String HBASE_CLIENT_FAST_FAIL_INTERCEPTOR_IMPL = 1474 "hbase.client.fast.fail.interceptor.impl"; 1475 1476 /** 1477 * @deprecated since 2.4.0 and in 3.0.0, to be removed in 4.0.0, replaced by procedure-based 1478 * distributed WAL splitter; see SplitWALManager. 1479 */ 1480 @Deprecated 1481 public static final String HBASE_SPLIT_WAL_COORDINATED_BY_ZK = "hbase.split.wal.zk.coordinated"; 1482 1483 /** 1484 * @deprecated since 2.4.0 and in 3.0.0, to be removed in 4.0.0. 1485 */ 1486 @Deprecated 1487 public static final boolean DEFAULT_HBASE_SPLIT_COORDINATED_BY_ZK = false; 1488 1489 public static final String HBASE_SPLIT_WAL_MAX_SPLITTER = "hbase.regionserver.wal.max.splitters"; 1490 1491 public static final int DEFAULT_HBASE_SPLIT_WAL_MAX_SPLITTER = 2; 1492 1493 /** 1494 * Config key for if the server should send backpressure and if the client should listen to that 1495 * backpressure from the server 1496 */ 1497 public static final String ENABLE_CLIENT_BACKPRESSURE = "hbase.client.backpressure.enabled"; 1498 public static final boolean DEFAULT_ENABLE_CLIENT_BACKPRESSURE = false; 1499 1500 public static final String HEAP_OCCUPANCY_LOW_WATERMARK_KEY = 1501 "hbase.heap.occupancy.low_water_mark"; 1502 public static final float DEFAULT_HEAP_OCCUPANCY_LOW_WATERMARK = 0.95f; 1503 public static final String HEAP_OCCUPANCY_HIGH_WATERMARK_KEY = 1504 "hbase.heap.occupancy.high_water_mark"; 1505 public static final float DEFAULT_HEAP_OCCUPANCY_HIGH_WATERMARK = 0.98f; 1506 1507 /** 1508 * The max number of threads used for splitting storefiles in parallel during the region split 1509 * process. 1510 */ 1511 public static final String REGION_SPLIT_THREADS_MAX = 1512 "hbase.regionserver.region.split.threads.max"; 1513 1514 /** Canary config keys */ 1515 // TODO: Move these defines to Canary Class 1516 public static final String HBASE_CANARY_WRITE_DATA_TTL_KEY = "hbase.canary.write.data.ttl"; 1517 1518 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_LOWERLIMIT_KEY = 1519 "hbase.canary.write.perserver.regions.lowerLimit"; 1520 1521 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_UPPERLIMIT_KEY = 1522 "hbase.canary.write.perserver.regions.upperLimit"; 1523 1524 public static final String HBASE_CANARY_WRITE_VALUE_SIZE_KEY = "hbase.canary.write.value.size"; 1525 1526 public static final String HBASE_CANARY_WRITE_TABLE_CHECK_PERIOD_KEY = 1527 "hbase.canary.write.table.check.period"; 1528 1529 public static final String HBASE_CANARY_READ_RAW_SCAN_KEY = "hbase.canary.read.raw.enabled"; 1530 1531 public static final String HBASE_CANARY_READ_ALL_CF = "hbase.canary.read.all.column.famliy"; 1532 /** 1533 * Configuration keys for programmatic JAAS configuration for secured ZK interaction 1534 */ 1535 public static final String ZK_CLIENT_KEYTAB_FILE = "hbase.zookeeper.client.keytab.file"; 1536 public static final String ZK_CLIENT_KERBEROS_PRINCIPAL = 1537 "hbase.zookeeper.client.kerberos.principal"; 1538 public static final String ZK_SERVER_KEYTAB_FILE = "hbase.zookeeper.server.keytab.file"; 1539 public static final String ZK_SERVER_KERBEROS_PRINCIPAL = 1540 "hbase.zookeeper.server.kerberos.principal"; 1541 1542 /** Config key for hbase temporary directory in hdfs */ 1543 public static final String TEMPORARY_FS_DIRECTORY_KEY = "hbase.fs.tmp.dir"; 1544 public static final String DEFAULT_TEMPORARY_HDFS_DIRECTORY = 1545 "/user/" + System.getProperty("user.name") + "/hbase-staging"; 1546 1547 public static final String SNAPSHOT_RESTORE_TAKE_FAILSAFE_SNAPSHOT = 1548 "hbase.snapshot.restore.take.failsafe.snapshot"; 1549 public static final boolean DEFAULT_SNAPSHOT_RESTORE_TAKE_FAILSAFE_SNAPSHOT = true; 1550 1551 public static final String SNAPSHOT_RESTORE_FAILSAFE_NAME = 1552 "hbase.snapshot.restore.failsafe.name"; 1553 public static final String DEFAULT_SNAPSHOT_RESTORE_FAILSAFE_NAME = 1554 "hbase-failsafe-{snapshot.name}-{restore.timestamp}"; 1555 1556 public static final String DEFAULT_LOSSY_COUNTING_ERROR_RATE = 1557 "hbase.util.default.lossycounting.errorrate"; 1558 public static final String NOT_IMPLEMENTED = "Not implemented"; 1559 1560 // Default TTL - FOREVER 1561 public static final long DEFAULT_SNAPSHOT_TTL = 0; 1562 1563 // User defined Default TTL config key 1564 public static final String DEFAULT_SNAPSHOT_TTL_CONFIG_KEY = "hbase.master.snapshot.ttl"; 1565 1566 // Regions Recovery based on high storeFileRefCount threshold value 1567 public static final String STORE_FILE_REF_COUNT_THRESHOLD = 1568 "hbase.regions.recovery.store.file.ref.count"; 1569 1570 // default -1 indicates there is no threshold on high storeRefCount 1571 public static final int DEFAULT_STORE_FILE_REF_COUNT_THRESHOLD = -1; 1572 1573 public static final String REGIONS_RECOVERY_INTERVAL = 1574 "hbase.master.regions.recovery.check.interval"; 1575 1576 public static final int DEFAULT_REGIONS_RECOVERY_INTERVAL = 1200 * 1000; // Default 20 min 1577 1578 /** 1579 * Configurations for master executor services. 1580 */ 1581 public static final String MASTER_OPEN_REGION_THREADS = 1582 "hbase.master.executor.openregion.threads"; 1583 public static final int MASTER_OPEN_REGION_THREADS_DEFAULT = 5; 1584 1585 public static final String MASTER_CLOSE_REGION_THREADS = 1586 "hbase.master.executor.closeregion.threads"; 1587 public static final int MASTER_CLOSE_REGION_THREADS_DEFAULT = 5; 1588 1589 public static final String MASTER_SERVER_OPERATIONS_THREADS = 1590 "hbase.master.executor.serverops.threads"; 1591 public static final int MASTER_SERVER_OPERATIONS_THREADS_DEFAULT = 5; 1592 1593 /** 1594 * Number of threads used to dispatch merge operations to the regionservers. 1595 */ 1596 public static final String MASTER_MERGE_DISPATCH_THREADS = 1597 "hbase.master.executor.merge.dispatch.threads"; 1598 public static final int MASTER_MERGE_DISPATCH_THREADS_DEFAULT = 2; 1599 1600 public static final String MASTER_META_SERVER_OPERATIONS_THREADS = 1601 "hbase.master.executor.meta.serverops.threads"; 1602 public static final int MASTER_META_SERVER_OPERATIONS_THREADS_DEFAULT = 5; 1603 1604 public static final String MASTER_LOG_REPLAY_OPS_THREADS = 1605 "hbase.master.executor.logreplayops.threads"; 1606 public static final int MASTER_LOG_REPLAY_OPS_THREADS_DEFAULT = 10; 1607 1608 public static final int DEFAULT_SLOW_LOG_RING_BUFFER_SIZE = 256; 1609 1610 public static final String SLOW_LOG_BUFFER_ENABLED_KEY = 1611 "hbase.regionserver.slowlog.buffer.enabled"; 1612 public static final boolean DEFAULT_ONLINE_LOG_PROVIDER_ENABLED = false; 1613 1614 /** The slowlog info family as a string */ 1615 private static final String SLOWLOG_INFO_FAMILY_STR = "info"; 1616 1617 /** The slowlog info family */ 1618 public static final byte[] SLOWLOG_INFO_FAMILY = Bytes.toBytes(SLOWLOG_INFO_FAMILY_STR); 1619 1620 public static final String SLOW_LOG_SYS_TABLE_ENABLED_KEY = 1621 "hbase.regionserver.slowlog.systable.enabled"; 1622 public static final boolean DEFAULT_SLOW_LOG_SYS_TABLE_ENABLED_KEY = false; 1623 1624 public static final String SHELL_TIMESTAMP_FORMAT_EPOCH_KEY = 1625 "hbase.shell.timestamp.format.epoch"; 1626 1627 public static final boolean DEFAULT_SHELL_TIMESTAMP_FORMAT_EPOCH = false; 1628 1629 /** 1630 * Number of rows in a batch operation above which a warning will be logged. 1631 */ 1632 public static final String BATCH_ROWS_THRESHOLD_NAME = "hbase.rpc.rows.warning.threshold"; 1633 1634 /** 1635 * Default value of {@link #BATCH_ROWS_THRESHOLD_NAME} 1636 */ 1637 public static final int BATCH_ROWS_THRESHOLD_DEFAULT = 5000; 1638 1639 private HConstants() { 1640 // Can't be instantiated with this ctor. 1641 } 1642}