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 the scanner size limit to be used in compactions */ 371 public static final String COMPACTION_SCANNER_SIZE_MAX = 372 "hbase.hstore.compaction.scanner.size.limit"; 373 public static final long COMPACTION_SCANNER_SIZE_MAX_DEFAULT = 10 * 1024 * 1024L; // 10MB 374 375 /** Parameter name for HBase instance root directory */ 376 public static final String HBASE_DIR = "hbase.rootdir"; 377 378 /** Parameter name for HBase client IPC pool type */ 379 public static final String HBASE_CLIENT_IPC_POOL_TYPE = "hbase.client.ipc.pool.type"; 380 381 /** Parameter name for HBase client IPC pool size */ 382 public static final String HBASE_CLIENT_IPC_POOL_SIZE = "hbase.client.ipc.pool.size"; 383 384 /** Parameter name for HBase client operation timeout. */ 385 public static final String HBASE_CLIENT_OPERATION_TIMEOUT = "hbase.client.operation.timeout"; 386 387 /** Parameter name for HBase client meta operation timeout. */ 388 public static final String HBASE_CLIENT_META_OPERATION_TIMEOUT = 389 "hbase.client.meta.operation.timeout"; 390 391 /** Default HBase client operation timeout, which is tantamount to a blocking call */ 392 public static final int DEFAULT_HBASE_CLIENT_OPERATION_TIMEOUT = 1200000; 393 394 /** Parameter name for HBase client meta replica scan call timeout. */ 395 public static final String HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT = 396 "hbase.client.meta.replica.scan.timeout"; 397 398 /** Default HBase client meta replica scan call timeout, 1 second */ 399 public static final int HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT_DEFAULT = 1000000; 400 401 /** Used to construct the name of the log directory for a region server */ 402 public static final String HREGION_LOGDIR_NAME = "WALs"; 403 404 /** Used to construct the name of the splitlog directory for a region server */ 405 public static final String SPLIT_LOGDIR_NAME = "splitWAL"; 406 407 /** Like the previous, but for old logs that are about to be deleted */ 408 public static final String HREGION_OLDLOGDIR_NAME = "oldWALs"; 409 410 /** Staging dir used by bulk load */ 411 public static final String BULKLOAD_STAGING_DIR_NAME = "staging"; 412 413 public static final String CORRUPT_DIR_NAME = "corrupt"; 414 415 /** Used by HBCK to sideline backup data */ 416 public static final String HBCK_SIDELINEDIR_NAME = ".hbck"; 417 418 /** Any artifacts left from migration can be moved here */ 419 public static final String MIGRATION_NAME = ".migration"; 420 421 /** 422 * The directory from which co-processor/custom filter jars can be loaded dynamically by the 423 * region servers. This value can be overridden by the hbase.dynamic.jars.dir config. 424 */ 425 @Deprecated // unused. see HBASE-12054. remove this in 3.0 426 public static final String LIB_DIR = "lib"; 427 428 /** Used to construct the name of the compaction directory during compaction */ 429 public static final String HREGION_COMPACTIONDIR_NAME = "compaction.dir"; 430 431 /** Conf key for the max file size after which we split the region */ 432 public static final String HREGION_MAX_FILESIZE = "hbase.hregion.max.filesize"; 433 434 /** Default maximum file size */ 435 public static final long DEFAULT_MAX_FILE_SIZE = 10 * 1024 * 1024 * 1024L; 436 437 /** Conf key for if we should sum overall region files size when check to split */ 438 public static final String OVERALL_HREGION_FILES = "hbase.hregion.split.overallfiles"; 439 440 /** Default overall region files */ 441 public static final boolean DEFAULT_OVERALL_HREGION_FILES = false; 442 443 /** 444 * Max size of single row for Get's or Scan's without in-row scanning flag set. 445 */ 446 public static final String TABLE_MAX_ROWSIZE_KEY = "hbase.table.max.rowsize"; 447 448 /** 449 * Default max row size (1 Gb). 450 */ 451 public static final long TABLE_MAX_ROWSIZE_DEFAULT = 1024 * 1024 * 1024L; 452 453 /** 454 * The max number of threads used for opening and closing stores or store files in parallel 455 */ 456 public static final String HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 457 "hbase.hstore.open.and.close.threads.max"; 458 459 /** 460 * The default number for the max number of threads used for opening and closing stores or store 461 * files in parallel 462 */ 463 public static final int DEFAULT_HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 1; 464 465 /** 466 * Block updates if memstore has hbase.hregion.memstore.block.multiplier times 467 * hbase.hregion.memstore.flush.size bytes. Useful preventing runaway memstore during spikes in 468 * update traffic. 469 */ 470 public static final String HREGION_MEMSTORE_BLOCK_MULTIPLIER = 471 "hbase.hregion.memstore.block.multiplier"; 472 473 /** 474 * Default value for hbase.hregion.memstore.block.multiplier 475 */ 476 public static final int DEFAULT_HREGION_MEMSTORE_BLOCK_MULTIPLIER = 4; 477 478 /** Conf key for the memstore size at which we flush the memstore */ 479 public static final String HREGION_MEMSTORE_FLUSH_SIZE = "hbase.hregion.memstore.flush.size"; 480 481 public static final String HREGION_EDITS_REPLAY_SKIP_ERRORS = 482 "hbase.hregion.edits.replay.skip.errors"; 483 484 public static final boolean DEFAULT_HREGION_EDITS_REPLAY_SKIP_ERRORS = false; 485 486 /** Maximum value length, enforced on KeyValue construction */ 487 public static final int MAXIMUM_VALUE_LENGTH = Integer.MAX_VALUE - 1; 488 489 /** name of the file for unique cluster ID */ 490 public static final String CLUSTER_ID_FILE_NAME = "hbase.id"; 491 492 /** Default value for cluster ID */ 493 public static final String CLUSTER_ID_DEFAULT = "default-cluster"; 494 495 /** Parameter name for # days to keep MVCC values during a major compaction */ 496 public static final String KEEP_SEQID_PERIOD = "hbase.hstore.compaction.keep.seqId.period"; 497 /** At least to keep MVCC values in hfiles for 5 days */ 498 public static final int MIN_KEEP_SEQID_PERIOD = 5; 499 500 // Always store the location of the root table's HRegion. 501 // This HRegion is never split. 502 503 // region name = table + startkey + regionid. This is the row key. 504 // each row in the root and meta tables describes exactly 1 region 505 // Do we ever need to know all the information that we are storing? 506 507 // Note that the name of the root table starts with "-" and the name of the 508 // meta table starts with "." Why? it's a trick. It turns out that when we 509 // store region names in memory, we use a SortedMap. Since "-" sorts before 510 // "." (and since no other table name can start with either of these 511 // characters, the root region will always be the first entry in such a Map, 512 // followed by all the meta regions (which will be ordered by their starting 513 // row key as well), followed by all user tables. So when the Master is 514 // choosing regions to assign, it will always choose the root region first, 515 // followed by the meta regions, followed by user regions. Since the root 516 // and meta regions always need to be on-line, this ensures that they will 517 // be the first to be reassigned if the server(s) they are being served by 518 // should go down. 519 520 public static final String BASE_NAMESPACE_DIR = "data"; 521 522 /** delimiter used between portions of a region name */ 523 public static final int META_ROW_DELIMITER = ','; 524 525 /** The catalog family as a string */ 526 public static final String CATALOG_FAMILY_STR = "info"; 527 528 /** The catalog family */ 529 public static final byte[] CATALOG_FAMILY = Bytes.toBytes(CATALOG_FAMILY_STR); 530 531 /** The RegionInfo qualifier as a string */ 532 public static final String REGIONINFO_QUALIFIER_STR = "regioninfo"; 533 534 /** The regioninfo column qualifier */ 535 public static final byte[] REGIONINFO_QUALIFIER = Bytes.toBytes(REGIONINFO_QUALIFIER_STR); 536 537 /** The server column qualifier */ 538 public static final String SERVER_QUALIFIER_STR = "server"; 539 /** The server column qualifier */ 540 public static final byte[] SERVER_QUALIFIER = Bytes.toBytes(SERVER_QUALIFIER_STR); 541 542 /** The startcode column qualifier */ 543 public static final String STARTCODE_QUALIFIER_STR = "serverstartcode"; 544 /** The startcode column qualifier */ 545 public static final byte[] STARTCODE_QUALIFIER = Bytes.toBytes(STARTCODE_QUALIFIER_STR); 546 547 /** The open seqnum column qualifier */ 548 public static final String SEQNUM_QUALIFIER_STR = "seqnumDuringOpen"; 549 /** The open seqnum column qualifier */ 550 public static final byte[] SEQNUM_QUALIFIER = Bytes.toBytes(SEQNUM_QUALIFIER_STR); 551 552 /** The state column qualifier */ 553 public static final String STATE_QUALIFIER_STR = "state"; 554 555 public static final byte[] STATE_QUALIFIER = Bytes.toBytes(STATE_QUALIFIER_STR); 556 557 /** 558 * The serverName column qualifier. Its the server where the region is transitioning on, while 559 * column server is the server where the region is opened on. They are the same when the region is 560 * in state OPEN. 561 */ 562 public static final String SERVERNAME_QUALIFIER_STR = "sn"; 563 564 public static final byte[] SERVERNAME_QUALIFIER = Bytes.toBytes(SERVERNAME_QUALIFIER_STR); 565 566 /** The lower-half split region column qualifier string. */ 567 public static final String SPLITA_QUALIFIER_STR = "splitA"; 568 /** The lower-half split region column qualifier */ 569 public static final byte[] SPLITA_QUALIFIER = Bytes.toBytes(SPLITA_QUALIFIER_STR); 570 571 /** The upper-half split region column qualifier String. */ 572 public static final String SPLITB_QUALIFIER_STR = "splitB"; 573 /** The upper-half split region column qualifier */ 574 public static final byte[] SPLITB_QUALIFIER = Bytes.toBytes(SPLITB_QUALIFIER_STR); 575 576 /** 577 * Merge qualifier prefix. We used to only allow two regions merge; mergeA and mergeB. Now we 578 * allow many to merge. Each region to merge will be referenced in a column whose qualifier starts 579 * with this define. 580 */ 581 public static final String MERGE_QUALIFIER_PREFIX_STR = "merge"; 582 public static final byte[] MERGE_QUALIFIER_PREFIX = Bytes.toBytes(MERGE_QUALIFIER_PREFIX_STR); 583 584 /** 585 * The lower-half merge region column qualifier 586 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for the 587 * {@link #MERGE_QUALIFIER_PREFIX_STR} prefix. 588 */ 589 @Deprecated 590 public static final byte[] MERGEA_QUALIFIER = Bytes.toBytes(MERGE_QUALIFIER_PREFIX_STR + "A"); 591 592 /** 593 * The upper-half merge region column qualifier 594 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for the 595 * {@link #MERGE_QUALIFIER_PREFIX_STR} prefix. 596 */ 597 @Deprecated 598 public static final byte[] MERGEB_QUALIFIER = Bytes.toBytes(MERGE_QUALIFIER_PREFIX_STR + "B"); 599 600 /** The catalog family as a string */ 601 public static final String TABLE_FAMILY_STR = "table"; 602 603 /** The catalog family */ 604 public static final byte[] TABLE_FAMILY = Bytes.toBytes(TABLE_FAMILY_STR); 605 606 /** The serialized table state qualifier */ 607 public static final byte[] TABLE_STATE_QUALIFIER = Bytes.toBytes("state"); 608 609 /** The replication barrier family as a string */ 610 public static final String REPLICATION_BARRIER_FAMILY_STR = "rep_barrier"; 611 612 /** The replication barrier family */ 613 public static final byte[] REPLICATION_BARRIER_FAMILY = 614 Bytes.toBytes(REPLICATION_BARRIER_FAMILY_STR); 615 616 /** 617 * The meta table version column qualifier. We keep current version of the meta table in this 618 * column in <code>-ROOT-</code> table: i.e. in the 'info:v' column. 619 */ 620 public static final byte[] META_VERSION_QUALIFIER = Bytes.toBytes("v"); 621 622 /** The family str as a key in map */ 623 public static final String FAMILY_KEY_STR = "family"; 624 625 /** 626 * The current version of the meta table. - pre-hbase 0.92. There is no META_VERSION column in the 627 * root table in this case. The meta has HTableDescriptor serialized into the HRegionInfo; - 628 * version 0 is 0.92 and 0.94. Meta data has serialized HRegionInfo's using Writable 629 * serialization, and HRegionInfo's does not contain HTableDescriptors. - version 1 for 0.96+ 630 * keeps HRegionInfo data structures, but changes the byte[] serialization from Writables to 631 * Protobuf. See HRegionInfo.VERSION 632 */ 633 public static final short META_VERSION = 1; 634 635 // Other constants 636 637 /** 638 * An empty byte array instance. 639 */ 640 public static final byte[] EMPTY_BYTE_ARRAY = new byte[0]; 641 642 /** 643 * An empty string instance. 644 */ 645 public static final String EMPTY_STRING = ""; 646 647 public static final ByteBuffer EMPTY_BYTE_BUFFER = ByteBuffer.wrap(EMPTY_BYTE_ARRAY); 648 649 /** 650 * Used by scanners, etc when they want to start at the beginning of a region 651 */ 652 public static final byte[] EMPTY_START_ROW = EMPTY_BYTE_ARRAY; 653 654 /** 655 * Last row in a table. 656 */ 657 public static final byte[] EMPTY_END_ROW = EMPTY_BYTE_ARRAY; 658 659 /** 660 * Used by scanners and others when they're trying to detect the end of a table 661 */ 662 public static final byte[] LAST_ROW = EMPTY_BYTE_ARRAY; 663 664 /** 665 * Max length a row can have because of the limitation in TFile. 666 */ 667 public static final int MAX_ROW_LENGTH = Short.MAX_VALUE; 668 669 /** 670 * Timestamp to use when we want to refer to the latest cell. This is the timestamp sent by 671 * clients when no timestamp is specified on commit. 672 */ 673 public static final long LATEST_TIMESTAMP = Long.MAX_VALUE; 674 675 /** 676 * Timestamp to use when we want to refer to the oldest cell. Special! Used in fake Cells only. 677 * Should never be the timestamp on an actual Cell returned to a client. 678 * @deprecated Should not be public since hbase-1.3.0. For internal use only. Move internal to 679 * Scanners flagged as special timestamp value never to be returned as timestamp on a 680 * Cell. 681 */ 682 @Deprecated 683 public static final long OLDEST_TIMESTAMP = Long.MIN_VALUE; 684 685 /** 686 * LATEST_TIMESTAMP in bytes form 687 */ 688 public static final byte[] LATEST_TIMESTAMP_BYTES = { 689 // big-endian 690 (byte) (LATEST_TIMESTAMP >>> 56), (byte) (LATEST_TIMESTAMP >>> 48), 691 (byte) (LATEST_TIMESTAMP >>> 40), (byte) (LATEST_TIMESTAMP >>> 32), 692 (byte) (LATEST_TIMESTAMP >>> 24), (byte) (LATEST_TIMESTAMP >>> 16), 693 (byte) (LATEST_TIMESTAMP >>> 8), (byte) LATEST_TIMESTAMP, }; 694 695 /** 696 * Define for 'return-all-versions'. 697 */ 698 public static final int ALL_VERSIONS = Integer.MAX_VALUE; 699 700 /** 701 * Unlimited time-to-live. 702 */ 703 // public static final int FOREVER = -1; 704 public static final int FOREVER = Integer.MAX_VALUE; 705 706 /** 707 * Seconds in a week 708 */ 709 @Deprecated // unused. see HBASE-2692. remove this in 3.0 710 public static final int WEEK_IN_SECONDS = 7 * 24 * 3600; 711 712 /** 713 * Seconds in a day, hour and minute 714 */ 715 public static final int DAY_IN_SECONDS = 24 * 60 * 60; 716 public static final int HOUR_IN_SECONDS = 60 * 60; 717 public static final int MINUTE_IN_SECONDS = 60; 718 719 /** 720 * KB, MB, GB, TB equivalent to how many bytes 721 */ 722 public static final long KB_IN_BYTES = 1024; 723 public static final long MB_IN_BYTES = 1024 * KB_IN_BYTES; 724 public static final long GB_IN_BYTES = 1024 * MB_IN_BYTES; 725 public static final long TB_IN_BYTES = 1024 * GB_IN_BYTES; 726 727 // TODO: although the following are referenced widely to format strings for 728 // the shell. They really aren't a part of the public API. It would be 729 // nice if we could put them somewhere where they did not need to be 730 // public. They could have package visibility 731 public static final String NAME = "NAME"; 732 public static final String VERSIONS = "VERSIONS"; 733 public static final String IN_MEMORY = "IN_MEMORY"; 734 public static final String METADATA = "METADATA"; 735 public static final String CONFIGURATION = "CONFIGURATION"; 736 737 /** 738 * Retrying we multiply hbase.client.pause setting by what we have in this array until we run out 739 * of array items. Retries beyond this use the last number in the array. So, for example, if 740 * hbase.client.pause is 1 second, and maximum retries count hbase.client.retries.number is 10, we 741 * will retry at the following intervals: 1, 2, 3, 5, 10, 20, 40, 100, 100, 100. With 100ms, a 742 * back-off of 200 means 20s 743 */ 744 public static final int[] RETRY_BACKOFF = 745 { 1, 2, 3, 5, 10, 20, 40, 100, 100, 100, 100, 200, 200 }; 746 747 public static final String REGION_IMPL = "hbase.hregion.impl"; 748 749 /** 750 * Scope tag for locally scoped data. This data will not be replicated. 751 */ 752 public static final int REPLICATION_SCOPE_LOCAL = 0; 753 754 /** 755 * Scope tag for globally scoped data. This data will be replicated to all peers. 756 */ 757 public static final int REPLICATION_SCOPE_GLOBAL = 1; 758 759 /** 760 * Default cluster ID, cannot be used to identify a cluster so a key with this value means it 761 * wasn't meant for replication. 762 */ 763 public static final UUID DEFAULT_CLUSTER_ID = new UUID(0L, 0L); 764 765 /** 766 * Parameter name for maximum number of bytes returned when calling a scanner's next method. 767 * Controlled by the client. 768 */ 769 public static final String HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY = 770 "hbase.client.scanner.max.result.size"; 771 772 /** 773 * Parameter name for maximum number of bytes returned when calling a scanner's next method. 774 * Controlled by the server. 775 */ 776 public static final String HBASE_SERVER_SCANNER_MAX_RESULT_SIZE_KEY = 777 "hbase.server.scanner.max.result.size"; 778 779 /** 780 * Maximum number of bytes returned when calling a scanner's next method. Note that when a single 781 * row is larger than this limit the row is still returned completely. The default value is 2MB. 782 */ 783 public static final long DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE = 2 * 1024 * 1024; 784 785 /** 786 * Maximum number of bytes returned when calling a scanner's next method. Note that when a single 787 * row is larger than this limit the row is still returned completely. Safety setting to protect 788 * the region server. The default value is 100MB. (a client would rarely request larger chunks on 789 * purpose) 790 */ 791 public static final long DEFAULT_HBASE_SERVER_SCANNER_MAX_RESULT_SIZE = 100 * 1024 * 1024; 792 793 /** 794 * Parameter name for client pause value, used mostly as value to wait before running a retry of a 795 * failed get, region lookup, etc. 796 */ 797 public static final String HBASE_CLIENT_PAUSE = "hbase.client.pause"; 798 799 /** 800 * Default value of {@link #HBASE_CLIENT_PAUSE}. 801 */ 802 public static final long DEFAULT_HBASE_CLIENT_PAUSE = 100; 803 804 /** 805 * Parameter name for client pause value for special case such as call queue too big, etc. 806 * @deprecated Since 2.5.0, will be removed in 4.0.0. Please use 807 * hbase.client.pause.server.overloaded instead. 808 */ 809 @Deprecated 810 public static final String HBASE_CLIENT_PAUSE_FOR_CQTBE = "hbase.client.pause.cqtbe"; 811 812 /** 813 * The maximum number of concurrent connections the client will maintain. 814 */ 815 public static final String HBASE_CLIENT_MAX_TOTAL_TASKS = "hbase.client.max.total.tasks"; 816 817 /** 818 * Default value of {@link #HBASE_CLIENT_MAX_TOTAL_TASKS}. 819 */ 820 public static final int DEFAULT_HBASE_CLIENT_MAX_TOTAL_TASKS = 100; 821 822 /** 823 * The maximum number of concurrent connections the client will maintain to a single RegionServer. 824 */ 825 public static final String HBASE_CLIENT_MAX_PERSERVER_TASKS = "hbase.client.max.perserver.tasks"; 826 827 /** 828 * Default value of {@link #HBASE_CLIENT_MAX_PERSERVER_TASKS}. 829 */ 830 public static final int DEFAULT_HBASE_CLIENT_MAX_PERSERVER_TASKS = 2; 831 832 /** 833 * The maximum number of concurrent connections the client will maintain to a single Region. 834 */ 835 public static final String HBASE_CLIENT_MAX_PERREGION_TASKS = "hbase.client.max.perregion.tasks"; 836 837 /** 838 * Default value of {@link #HBASE_CLIENT_MAX_PERREGION_TASKS}. 839 */ 840 public static final int DEFAULT_HBASE_CLIENT_MAX_PERREGION_TASKS = 1; 841 842 /** 843 * The maximum number of concurrent pending RPC requests for one server in process level. 844 */ 845 public static final String HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD = 846 "hbase.client.perserver.requests.threshold"; 847 848 /** 849 * Default value of {@link #HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD}. 850 */ 851 public static final int DEFAULT_HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD = Integer.MAX_VALUE; 852 853 /** 854 * Parameter name for server pause value, used mostly as value to wait before running a retry of a 855 * failed operation. 856 */ 857 public static final String HBASE_SERVER_PAUSE = "hbase.server.pause"; 858 859 /** 860 * Default value of {@link #HBASE_SERVER_PAUSE}. 861 */ 862 public static final int DEFAULT_HBASE_SERVER_PAUSE = 1000; 863 864 /** 865 * Parameter name for maximum retries, used as maximum for all retryable operations such as 866 * fetching of the root region from root region server, getting a cell's value, starting a row 867 * update, etc. 868 */ 869 public static final String HBASE_CLIENT_RETRIES_NUMBER = "hbase.client.retries.number"; 870 871 /** 872 * Default value of {@link #HBASE_CLIENT_RETRIES_NUMBER}. 873 */ 874 public static final int DEFAULT_HBASE_CLIENT_RETRIES_NUMBER = 15; 875 876 public static final String HBASE_CLIENT_SERVERSIDE_RETRIES_MULTIPLIER = 877 "hbase.client.serverside.retries.multiplier"; 878 879 public static final int DEFAULT_HBASE_CLIENT_SERVERSIDE_RETRIES_MULTIPLIER = 3; 880 881 /** 882 * Parameter name to set the default scanner caching for all clients. 883 */ 884 public static final String HBASE_CLIENT_SCANNER_CACHING = "hbase.client.scanner.caching"; 885 886 /** 887 * Default value for {@link #HBASE_CLIENT_SCANNER_CACHING} 888 */ 889 public static final int DEFAULT_HBASE_CLIENT_SCANNER_CACHING = Integer.MAX_VALUE; 890 891 /** 892 * Parameter name for number of rows that will be fetched when calling next on a scanner if it is 893 * not served from memory. Higher caching values will enable faster scanners but will eat up more 894 * memory and some calls of next may take longer and longer times when the cache is empty. 895 */ 896 public static final String HBASE_META_SCANNER_CACHING = "hbase.meta.scanner.caching"; 897 898 /** 899 * Default value of {@link #HBASE_META_SCANNER_CACHING}. 900 */ 901 public static final int DEFAULT_HBASE_META_SCANNER_CACHING = 100; 902 903 /** 904 * Parameter name for number of versions, kept by meta table. 905 */ 906 public static final String HBASE_META_VERSIONS = "hbase.meta.versions"; 907 908 /** 909 * Default value of {@link #HBASE_META_VERSIONS}. 910 */ 911 public static final int DEFAULT_HBASE_META_VERSIONS = 3; 912 913 /** 914 * Parameter name for number of versions, kept by meta table. 915 */ 916 public static final String HBASE_META_BLOCK_SIZE = "hbase.meta.blocksize"; 917 918 /** 919 * Default value of {@link #HBASE_META_BLOCK_SIZE}. 920 */ 921 public static final int DEFAULT_HBASE_META_BLOCK_SIZE = 8 * 1024; 922 923 /** 924 * Parameter name for unique identifier for this {@link org.apache.hadoop.conf.Configuration} 925 * instance. If there are two or more {@link org.apache.hadoop.conf.Configuration} instances that, 926 * for all intents and purposes, are the same except for their instance ids, then they will not be 927 * able to share the same org.apache.hadoop.hbase.client.HConnection instance. On the other hand, 928 * even if the instance ids are the same, it could result in non-shared 929 * org.apache.hadoop.hbase.client.HConnection instances if some of the other connection parameters 930 * differ. 931 */ 932 public static final String HBASE_CLIENT_INSTANCE_ID = "hbase.client.instance.id"; 933 934 /** 935 * The client scanner timeout period in milliseconds. 936 */ 937 public static final String HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 938 "hbase.client.scanner.timeout.period"; 939 940 /** 941 * Use {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD} instead. 942 * @deprecated This config option is deprecated. Will be removed at later releases after 0.96. 943 */ 944 @Deprecated 945 public static final String HBASE_REGIONSERVER_LEASE_PERIOD_KEY = 946 "hbase.regionserver.lease.period"; 947 948 /** 949 * Default value of {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD}. 950 */ 951 public static final int DEFAULT_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 60000; 952 953 /** 954 * timeout for each RPC 955 */ 956 public static final String HBASE_RPC_TIMEOUT_KEY = "hbase.rpc.timeout"; 957 958 /** 959 * timeout for each read RPC 960 */ 961 public static final String HBASE_RPC_READ_TIMEOUT_KEY = "hbase.rpc.read.timeout"; 962 963 /** 964 * timeout for each write RPC 965 */ 966 public static final String HBASE_RPC_WRITE_TIMEOUT_KEY = "hbase.rpc.write.timeout"; 967 968 /** 969 * Default value of {@link #HBASE_RPC_TIMEOUT_KEY} 970 */ 971 public static final int DEFAULT_HBASE_RPC_TIMEOUT = 60000; 972 973 /** 974 * timeout for short operation RPC 975 */ 976 public static final String HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY = 977 "hbase.rpc.shortoperation.timeout"; 978 979 /** 980 * Default value of {@link #HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY} 981 */ 982 public static final int DEFAULT_HBASE_RPC_SHORTOPERATION_TIMEOUT = 10000; 983 984 /** 985 * Retry pause time for short operation RPC 986 */ 987 public static final String HBASE_RPC_SHORTOPERATION_RETRY_PAUSE_TIME = 988 "hbase.rpc.shortoperation.retry.pause.time"; 989 990 /** 991 * Default value of {@link #HBASE_RPC_SHORTOPERATION_RETRY_PAUSE_TIME} 992 */ 993 public static final long DEFAULT_HBASE_RPC_SHORTOPERATION_RETRY_PAUSE_TIME = 1000; 994 995 /** 996 * Value indicating the server name was saved with no sequence number. 997 */ 998 public static final long NO_SEQNUM = -1; 999 1000 /** 1001 * Registry implementation to be used on the client side. 1002 */ 1003 public static final String CLIENT_CONNECTION_REGISTRY_IMPL_CONF_KEY = 1004 "hbase.client.registry.impl"; 1005 1006 /* 1007 * cluster replication constants. 1008 */ 1009 public static final String REPLICATION_SOURCE_SERVICE_CLASSNAME = 1010 "hbase.replication.source.service"; 1011 public static final String REPLICATION_SINK_SERVICE_CLASSNAME = "hbase.replication.sink.service"; 1012 public static final String REPLICATION_SERVICE_CLASSNAME_DEFAULT = 1013 "org.apache.hadoop.hbase.replication.regionserver.Replication"; 1014 public static final String REPLICATION_BULKLOAD_ENABLE_KEY = "hbase.replication.bulkload.enabled"; 1015 public static final boolean REPLICATION_BULKLOAD_ENABLE_DEFAULT = false; 1016 /** Replication cluster id of source cluster which uniquely identifies itself with peer cluster */ 1017 public static final String REPLICATION_CLUSTER_ID = "hbase.replication.cluster.id"; 1018 /** 1019 * Max total size of buffered entries in all replication peers. It will prevent server getting OOM 1020 * if there are many peers. Default value is 256MB which is four times to default 1021 * replication.source.size.capacity. 1022 */ 1023 public static final String REPLICATION_SOURCE_TOTAL_BUFFER_KEY = "replication.total.buffer.quota"; 1024 1025 public static final int REPLICATION_SOURCE_TOTAL_BUFFER_DFAULT = 256 * 1024 * 1024; 1026 1027 /** Configuration key for ReplicationSource shipeEdits timeout */ 1028 public static final String REPLICATION_SOURCE_SHIPEDITS_TIMEOUT = 1029 "replication.source.shipedits.timeout"; 1030 public static final int REPLICATION_SOURCE_SHIPEDITS_TIMEOUT_DFAULT = 60000; 1031 1032 /** 1033 * Directory where the source cluster file system client configuration are placed which is used by 1034 * sink cluster to copy HFiles from source cluster file system 1035 */ 1036 public static final String REPLICATION_CONF_DIR = "hbase.replication.conf.dir"; 1037 1038 /** Maximum time to retry for a failed bulk load request */ 1039 public static final String BULKLOAD_MAX_RETRIES_NUMBER = "hbase.bulkload.retries.number"; 1040 1041 /** HBCK special code name used as server name when manipulating ZK nodes */ 1042 @Deprecated // unused. see HBASE-3789. remove this in 3.0 1043 public static final String HBCK_CODE_NAME = "HBCKServerName"; 1044 1045 public static final String KEY_FOR_HOSTNAME_SEEN_BY_MASTER = 1046 "hbase.regionserver.hostname.seen.by.master"; 1047 1048 public static final String HBASE_MASTER_LOGCLEANER_PLUGINS = "hbase.master.logcleaner.plugins"; 1049 1050 public static final String HBASE_REGION_SPLIT_POLICY_KEY = 1051 "hbase.regionserver.region.split.policy"; 1052 1053 /** Whether nonces are enabled; default is true. */ 1054 public static final String HBASE_RS_NONCES_ENABLED = "hbase.regionserver.nonces.enabled"; 1055 1056 /** 1057 * Configuration key for the size of the block cache 1058 */ 1059 public static final String HFILE_BLOCK_CACHE_SIZE_KEY = "hfile.block.cache.size"; 1060 1061 public static final float HFILE_BLOCK_CACHE_SIZE_DEFAULT = 0.4f; 1062 1063 /** 1064 * Configuration key for setting the fix size of the block size, default do nothing and it should 1065 * be explicitly set by user or only used within ClientSideRegionScanner. if it's set less than 1066 * current max on heap size, it overrides the max size of block cache 1067 */ 1068 public static final String HFILE_ONHEAP_BLOCK_CACHE_FIXED_SIZE_KEY = 1069 "hfile.onheap.block.cache.fixed.size"; 1070 public static final long HFILE_ONHEAP_BLOCK_CACHE_FIXED_SIZE_DEFAULT = 0L; 1071 public static final long HBASE_CLIENT_SCANNER_ONHEAP_BLOCK_CACHE_FIXED_SIZE_DEFAULT = 1072 32 * 1024 * 1024L; 1073 1074 /** 1075 * Configuration key for setting pread must read both necessaryLen and extraLen, default is 1076 * disabled. This is an optimized flag for reading HFile from blob storage. 1077 */ 1078 public static final String HFILE_PREAD_ALL_BYTES_ENABLED_KEY = "hfile.pread.all.bytes.enabled"; 1079 public static final boolean HFILE_PREAD_ALL_BYTES_ENABLED_DEFAULT = false; 1080 1081 /* 1082 * Minimum percentage of free heap necessary for a successful cluster startup. 1083 */ 1084 public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD = 0.2f; 1085 1086 /** 1087 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1088 */ 1089 @Deprecated 1090 public static final Pattern CP_HTD_ATTR_KEY_PATTERN = 1091 Pattern.compile("^coprocessor\\$([0-9]+)$", Pattern.CASE_INSENSITIVE); 1092 1093 /** 1094 * <pre> 1095 * Pattern that matches a coprocessor specification. Form is: 1096 * {@code <coprocessor jar file location> '|' <class name> ['|' <priority> ['|' <arguments>]]} 1097 * where arguments are {@code <KEY> '=' <VALUE> [,...]} 1098 * For example: {@code hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2} 1099 * </pre> 1100 * 1101 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1102 */ 1103 @Deprecated 1104 public static final Pattern CP_HTD_ATTR_VALUE_PATTERN = 1105 Pattern.compile("(^[^\\|]*)\\|([^\\|]+)\\|[\\s]*([\\d]*)[\\s]*(\\|.*)?$"); 1106 /** 1107 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1108 */ 1109 @Deprecated 1110 public static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN = "[^=,]+"; 1111 /** 1112 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1113 */ 1114 @Deprecated 1115 public static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN = "[^,]+"; 1116 /** 1117 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1118 */ 1119 @Deprecated 1120 public static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN = Pattern.compile("(" 1121 + CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN + ")=(" + CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN + "),?"); 1122 public static final String CP_HTD_ATTR_INCLUSION_KEY = 1123 "hbase.coprocessor.classloader.included.classes"; 1124 1125 /** The delay when re-trying a socket operation in a loop (HBASE-4712) */ 1126 public static final int SOCKET_RETRY_WAIT_MS = 200; 1127 1128 /** Host name of the local machine */ 1129 public static final String LOCALHOST = "localhost"; 1130 1131 /** 1132 * If this parameter is set to true, then hbase will read data and then verify checksums. Checksum 1133 * verification inside hdfs will be switched off. However, if the hbase-checksum verification 1134 * fails, then it will switch back to using hdfs checksums for verifiying data that is being read 1135 * from storage. If this parameter is set to false, then hbase will not verify any checksums, 1136 * instead it will depend on checksum verification being done in the hdfs client. 1137 */ 1138 public static final String HBASE_CHECKSUM_VERIFICATION = "hbase.regionserver.checksum.verify"; 1139 1140 public static final String LOCALHOST_IP = "127.0.0.1"; 1141 1142 public static final String REGION_SERVER_HANDLER_COUNT = "hbase.regionserver.handler.count"; 1143 public static final int DEFAULT_REGION_SERVER_HANDLER_COUNT = 30; 1144 1145 /* 1146 * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT: -1 => Disable aborting 0 => Abort if even a 1147 * single handler has died 0.x => Abort only when this percent of handlers have died 1 => Abort 1148 * only all of the handers have died 1149 */ 1150 public static final String REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 1151 "hbase.regionserver.handler.abort.on.error.percent"; 1152 public static final double DEFAULT_REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 0.5; 1153 1154 // High priority handlers to deal with admin requests and system table operation requests 1155 public static final String REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 1156 "hbase.regionserver.metahandler.count"; 1157 public static final int DEFAULT_REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 20; 1158 1159 public static final String REGION_SERVER_REPLICATION_HANDLER_COUNT = 1160 "hbase.regionserver.replication.handler.count"; 1161 public static final int DEFAULT_REGION_SERVER_REPLICATION_HANDLER_COUNT = 3; 1162 public static final String REGION_SERVER_BULKLOAD_HANDLER_COUNT = 1163 "hbase.regionserver.bulkload.handler.count"; 1164 public static final int DEFAULT_REGION_SERVER_BULKLOAD_HANDLER_COUNT = 0; 1165 // Meta Transition handlers to deal with meta ReportRegionStateTransitionRequest. Meta transition 1166 // should be dealt with in a separate handler in case blocking other region's transition. 1167 public static final String MASTER_META_TRANSITION_HANDLER_COUNT = 1168 "hbase.master.meta.transition.handler.count"; 1169 public static final int MASTER__META_TRANSITION_HANDLER_COUNT_DEFAULT = 1; 1170 1171 @Deprecated // unused. see HBASE-10569. remove this in 3.0 1172 public static final String MASTER_HANDLER_COUNT = "hbase.master.handler.count"; 1173 @Deprecated // unused. see HBASE-10569. remove this in 3.0 1174 public static final int DEFAULT_MASTER_HANLDER_COUNT = 25; 1175 1176 /** Conf key that specifies timeout value to wait for a region ready */ 1177 @Deprecated // unused. see HBASE-13616. remove this in 3.0 1178 public static final String LOG_REPLAY_WAIT_REGION_TIMEOUT = 1179 "hbase.master.log.replay.wait.region.timeout"; 1180 1181 /** Conf key for enabling meta replication */ 1182 public static final String USE_META_REPLICAS = "hbase.meta.replicas.use"; 1183 public static final boolean DEFAULT_USE_META_REPLICAS = false; 1184 1185 /** 1186 * @deprecated Since 2.4.0, will be removed in 4.0.0. Please change the meta replicas number by 1187 * altering meta table, i.e, set a new 'region replication' number and call 1188 * modifyTable. 1189 */ 1190 @Deprecated 1191 public static final String META_REPLICAS_NUM = "hbase.meta.replica.count"; 1192 /** 1193 * @deprecated Since 2.4.0, will be removed in 4.0.0. Please change the meta replicas number by 1194 * altering meta table, i.e, set a new 'region replication' number and call 1195 * modifyTable. 1196 */ 1197 @Deprecated 1198 public static final int DEFAULT_META_REPLICA_NUM = 1; 1199 1200 /** 1201 * The name of the configuration parameter that specifies the number of bytes in a newly created 1202 * checksum chunk. 1203 */ 1204 public static final String BYTES_PER_CHECKSUM = "hbase.hstore.bytes.per.checksum"; 1205 1206 /** 1207 * The name of the configuration parameter that specifies the name of an algorithm that is used to 1208 * compute checksums for newly created blocks. 1209 */ 1210 public static final String CHECKSUM_TYPE_NAME = "hbase.hstore.checksum.algorithm"; 1211 1212 /** Enable file permission modification from standard hbase */ 1213 public static final String ENABLE_DATA_FILE_UMASK = "hbase.data.umask.enable"; 1214 /** File permission umask to use when creating hbase data files */ 1215 public static final String DATA_FILE_UMASK_KEY = "hbase.data.umask"; 1216 1217 /** Configuration name of WAL Compression */ 1218 public static final String ENABLE_WAL_COMPRESSION = "hbase.regionserver.wal.enablecompression"; 1219 1220 /** 1221 * Configuration name of WAL storage policy Valid values are: HOT, COLD, WARM, ALL_SSD, ONE_SSD, 1222 * LAZY_PERSIST See 1223 * http://hadoop.apache.org/docs/r2.7.3/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html 1224 */ 1225 public static final String WAL_STORAGE_POLICY = "hbase.wal.storage.policy"; 1226 /** 1227 * "NONE" is not a valid storage policy and means we defer the policy to HDFS. @see 1228 * <a href="https://issues.apache.org/jira/browse/HBASE-20691">HBASE-20691</a> 1229 */ 1230 public static final String DEFER_TO_HDFS_STORAGE_POLICY = "NONE"; 1231 /** By default we defer the WAL storage policy to HDFS */ 1232 public static final String DEFAULT_WAL_STORAGE_POLICY = DEFER_TO_HDFS_STORAGE_POLICY; 1233 1234 /** Region in Transition metrics threshold time */ 1235 public static final String METRICS_RIT_STUCK_WARNING_THRESHOLD = 1236 "hbase.metrics.rit.stuck.warning.threshold"; 1237 1238 public static final String LOAD_BALANCER_SLOP_KEY = "hbase.regions.slop"; 1239 1240 /** delimiter used between portions of a region name */ 1241 public static final int DELIMITER = ','; 1242 1243 /** 1244 * QOS attributes: these attributes are used to demarcate RPC call processing by different set of 1245 * handlers. For example, HIGH_QOS tagged methods are handled by high priority handlers. 1246 */ 1247 // normal_QOS < replication_QOS < replay_QOS < QOS_threshold < admin_QOS < high_QOS < meta_QOS 1248 public static final int PRIORITY_UNSET = -1; 1249 public static final int NORMAL_QOS = 0; 1250 public static final int REPLICATION_QOS = 5; 1251 public static final int BULKLOAD_QOS = 4; 1252 /** 1253 * @deprecated since 3.0.0, will be removed in 4.0.0. DLR has been purged for a long time and 1254 * region replication has its own 'replay' method. 1255 */ 1256 @Deprecated 1257 public static final int REPLAY_QOS = 6; 1258 public static final int QOS_THRESHOLD = 10; 1259 public static final int ADMIN_QOS = 100; 1260 public static final int HIGH_QOS = 200; 1261 public static final int SYSTEMTABLE_QOS = HIGH_QOS; 1262 /** 1263 * @deprecated the name "META_QOS" is a bit ambiguous, actually only meta region transition can 1264 * use this priority, and you should not use this directly. Will be removed in 3.0.0. 1265 */ 1266 @Deprecated 1267 public static final int META_QOS = 300; 1268 1269 /** Directory under /hbase where archived hfiles are stored */ 1270 public static final String HFILE_ARCHIVE_DIRECTORY = "archive"; 1271 1272 /** 1273 * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for remaining 1274 * snapshot constants; this is here to keep HConstants dependencies at a minimum and 1275 * uni-directional. 1276 */ 1277 public static final String SNAPSHOT_DIR_NAME = ".hbase-snapshot"; 1278 1279 /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */ 1280 public static final String OLD_SNAPSHOT_DIR_NAME = ".snapshot"; 1281 1282 /** Temporary directory used for table creation and deletion */ 1283 public static final String HBASE_TEMP_DIRECTORY = ".tmp"; 1284 /** 1285 * The period (in milliseconds) between computing region server point in time metrics 1286 */ 1287 public static final String REGIONSERVER_METRICS_PERIOD = "hbase.regionserver.metrics.period"; 1288 public static final long DEFAULT_REGIONSERVER_METRICS_PERIOD = 5000; 1289 /** Directories that are not HBase table directories */ 1290 public static final List<String> HBASE_NON_TABLE_DIRS = Collections.unmodifiableList( 1291 Arrays.asList(new String[] { HBCK_SIDELINEDIR_NAME, HBASE_TEMP_DIRECTORY, MIGRATION_NAME })); 1292 1293 /** 1294 * Directories that are not HBase user table directories. 1295 * @deprecated Since hbase-2.3.0; no replacement as not used any more (internally at least) 1296 */ 1297 @Deprecated 1298 public static final List<String> HBASE_NON_USER_TABLE_DIRS = 1299 Collections.unmodifiableList(Arrays.asList( 1300 (String[]) ArrayUtils.addAll(new String[] { TableName.META_TABLE_NAME.getNameAsString() }, 1301 HBASE_NON_TABLE_DIRS.toArray()))); 1302 1303 /** Health script related settings. */ 1304 public static final String HEALTH_SCRIPT_LOC = "hbase.node.health.script.location"; 1305 public static final String HEALTH_SCRIPT_TIMEOUT = "hbase.node.health.script.timeout"; 1306 public static final String HEALTH_CHORE_WAKE_FREQ = "hbase.node.health.script.frequency"; 1307 public static final long DEFAULT_HEALTH_SCRIPT_TIMEOUT = 60000; 1308 /** 1309 * The maximum number of health check failures a server can encounter consecutively. 1310 */ 1311 public static final String HEALTH_FAILURE_THRESHOLD = "hbase.node.health.failure.threshold"; 1312 public static final int DEFAULT_HEALTH_FAILURE_THRESHOLD = 3; 1313 1314 /** 1315 * Setting to activate, or not, the publication of the status by the master. Default notification 1316 * is by a multicast message. 1317 */ 1318 public static final String STATUS_PUBLISHED = "hbase.status.published"; 1319 public static final boolean STATUS_PUBLISHED_DEFAULT = false; 1320 1321 /** 1322 * IP to use for the multicast status messages between the master and the clients. The default 1323 * address is chosen as one among others within the ones suitable for multicast messages. 1324 */ 1325 public static final String STATUS_MULTICAST_ADDRESS = "hbase.status.multicast.address.ip"; 1326 public static final String DEFAULT_STATUS_MULTICAST_ADDRESS = "226.1.1.3"; 1327 1328 /** 1329 * The address to use for binding the local socket for receiving multicast. Defaults to 0.0.0.0. 1330 * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a> 1331 */ 1332 public static final String STATUS_MULTICAST_BIND_ADDRESS = 1333 "hbase.status.multicast.bind.address.ip"; 1334 public static final String DEFAULT_STATUS_MULTICAST_BIND_ADDRESS = "0.0.0.0"; 1335 1336 /** 1337 * The port to use for the multicast messages. 1338 */ 1339 public static final String STATUS_MULTICAST_PORT = "hbase.status.multicast.address.port"; 1340 public static final int DEFAULT_STATUS_MULTICAST_PORT = 16100; 1341 1342 /** 1343 * The network interface name to use for the multicast messages. 1344 */ 1345 public static final String STATUS_MULTICAST_NI_NAME = "hbase.status.multicast.ni.name"; 1346 1347 /** 1348 * The address to use for binding the local socket for sending multicast. Defaults to 0.0.0.0. 1349 */ 1350 public static final String STATUS_MULTICAST_PUBLISHER_BIND_ADDRESS = 1351 "hbase.status.multicast.publisher.bind.address.ip"; 1352 public static final String DEFAULT_STATUS_MULTICAST_PUBLISHER_BIND_ADDRESS = "0.0.0.0"; 1353 1354 public static final long NO_NONCE = 0; 1355 1356 /** Default cipher for encryption */ 1357 public static final String CIPHER_AES = "AES"; 1358 1359 /** Configuration key for the crypto algorithm provider, a class name */ 1360 public static final String CRYPTO_CIPHERPROVIDER_CONF_KEY = "hbase.crypto.cipherprovider"; 1361 1362 /** Configuration key for the crypto key provider, a class name */ 1363 public static final String CRYPTO_KEYPROVIDER_CONF_KEY = "hbase.crypto.keyprovider"; 1364 1365 /** Configuration key for the crypto key provider parameters */ 1366 public static final String CRYPTO_KEYPROVIDER_PARAMETERS_KEY = 1367 "hbase.crypto.keyprovider.parameters"; 1368 1369 /** Configuration key for the name of the master key for the cluster, a string */ 1370 public static final String CRYPTO_MASTERKEY_NAME_CONF_KEY = "hbase.crypto.master.key.name"; 1371 1372 /** Configuration key for the name of the alternate master key for the cluster, a string */ 1373 public static final String CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY = 1374 "hbase.crypto.master.alternate.key.name"; 1375 1376 /** Configuration key for the algorithm to use when encrypting the WAL, a string */ 1377 public static final String CRYPTO_WAL_ALGORITHM_CONF_KEY = "hbase.crypto.wal.algorithm"; 1378 1379 /** Configuration key for the name of the master WAL encryption key for the cluster, a string */ 1380 public static final String CRYPTO_WAL_KEY_NAME_CONF_KEY = "hbase.crypto.wal.key.name"; 1381 1382 /** Configuration key for the algorithm used for creating jks key, a string */ 1383 public static final String CRYPTO_KEY_ALGORITHM_CONF_KEY = "hbase.crypto.key.algorithm"; 1384 1385 /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */ 1386 public static final String CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY = 1387 "hbase.crypto.alternate.key.algorithm"; 1388 1389 /** Configuration key for enabling WAL encryption, a boolean */ 1390 public static final String ENABLE_WAL_ENCRYPTION = "hbase.regionserver.wal.encryption"; 1391 1392 /** Configuration key for setting RPC codec class name */ 1393 public static final String RPC_CODEC_CONF_KEY = "hbase.client.rpc.codec"; 1394 1395 /** Configuration key for setting replication codec class name */ 1396 public static final String REPLICATION_CODEC_CONF_KEY = "hbase.replication.rpc.codec"; 1397 1398 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ 1399 public static final String REPLICATION_SOURCE_MAXTHREADS_KEY = 1400 "hbase.replication.source.maxthreads"; 1401 1402 /** 1403 * Drop edits for tables that been deleted from the replication source and target 1404 * @deprecated moved it into HBaseInterClusterReplicationEndpoint 1405 */ 1406 @Deprecated 1407 public static final String REPLICATION_DROP_ON_DELETED_TABLE_KEY = 1408 "hbase.replication.drop.on.deleted.table"; 1409 1410 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ 1411 public static final int REPLICATION_SOURCE_MAXTHREADS_DEFAULT = 10; 1412 1413 /** Configuration key for SplitLog manager timeout */ 1414 public static final String HBASE_SPLITLOG_MANAGER_TIMEOUT = "hbase.splitlog.manager.timeout"; 1415 1416 /** 1417 * Configuration keys for Bucket cache 1418 */ 1419 // TODO moving these bucket cache implementation specific configs to this level is violation of 1420 // encapsulation. But as these has to be referred from hbase-common and bucket cache 1421 // sits in hbase-server, there were no other go! Can we move the cache implementation to 1422 // hbase-common? 1423 1424 /** 1425 * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path to the 1426 * file that will host the file-based cache. See BucketCache#getIOEngineFromName() for list of 1427 * supported ioengine options. 1428 * <p> 1429 * Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache. 1430 */ 1431 public static final String BUCKET_CACHE_IOENGINE_KEY = "hbase.bucketcache.ioengine"; 1432 1433 /** 1434 * When using bucket cache, it is the capacity in megabytes of the cache. 1435 */ 1436 public static final String BUCKET_CACHE_SIZE_KEY = "hbase.bucketcache.size"; 1437 1438 /** 1439 * If the chosen ioengine can persist its state across restarts, the path to the file to persist 1440 * to. This file is NOT the data file. It is a file into which we will serialize the map of what 1441 * is in the data file. For example, if you pass the following argument as 1442 * BUCKET_CACHE_IOENGINE_KEY ("hbase.bucketcache.ioengine"), 1443 * <code>file:/tmp/bucketcache.data </code>, then we will write the bucketcache data to the file 1444 * <code>/tmp/bucketcache.data</code> but the metadata on where the data is in the supplied file 1445 * is an in-memory map that needs to be persisted across restarts. Where to store this in-memory 1446 * state is what you supply here: e.g. <code>/tmp/bucketcache.map</code>. 1447 */ 1448 public static final String BUCKET_CACHE_PERSISTENT_PATH_KEY = "hbase.bucketcache.persistent.path"; 1449 1450 /** 1451 * HConstants for fast fail on the client side follow 1452 */ 1453 /** 1454 * Config for enabling/disabling the fast fail mode. 1455 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1456 * this value will have no effect. The constants itself will be removed in 4.0.0. 1457 */ 1458 @Deprecated 1459 public static final String HBASE_CLIENT_FAST_FAIL_MODE_ENABLED = 1460 "hbase.client.fast.fail.mode.enabled"; 1461 1462 /** 1463 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1464 * this value will have no effect. The constants itself will be removed in 4.0.0. 1465 */ 1466 @Deprecated 1467 public static final boolean HBASE_CLIENT_ENABLE_FAST_FAIL_MODE_DEFAULT = false; 1468 1469 /** 1470 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1471 * this value will have no effect. The constants itself will be removed in 4.0.0. 1472 */ 1473 @Deprecated 1474 public static final String HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS = 1475 "hbase.client.fastfail.threshold"; 1476 1477 /** 1478 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1479 * this value will have no effect. The constants itself will be removed in 4.0.0. 1480 */ 1481 @Deprecated 1482 public static final long HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS_DEFAULT = 60000; 1483 1484 /** 1485 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1486 * this value will have no effect. The constants itself will be removed in 4.0.0. 1487 */ 1488 @Deprecated 1489 public static final String HBASE_CLIENT_FAILURE_MAP_CLEANUP_INTERVAL_MS = 1490 "hbase.client.failure.map.cleanup.interval"; 1491 1492 /** 1493 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1494 * this value will have no effect. The constants itself will be removed in 4.0.0. 1495 */ 1496 @Deprecated 1497 public static final long HBASE_CLIENT_FAILURE_MAP_CLEANUP_INTERVAL_MS_DEFAULT = 600000; 1498 1499 /** 1500 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1501 * this value will have no effect. The constants itself will be removed in 4.0.0. 1502 */ 1503 @Deprecated 1504 public static final String HBASE_CLIENT_FAST_FAIL_CLEANUP_MS_DURATION_MS = 1505 "hbase.client.fast.fail.cleanup.duration"; 1506 1507 /** 1508 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1509 * this value will have no effect. The constants itself will be removed in 4.0.0. 1510 */ 1511 @Deprecated 1512 public static final long HBASE_CLIENT_FAST_FAIL_CLEANUP_DURATION_MS_DEFAULT = 600000; 1513 1514 /** 1515 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config 1516 * this value will have no effect. The constants itself will be removed in 4.0.0. 1517 */ 1518 @Deprecated 1519 public static final String HBASE_CLIENT_FAST_FAIL_INTERCEPTOR_IMPL = 1520 "hbase.client.fast.fail.interceptor.impl"; 1521 1522 /** 1523 * @deprecated since 2.4.0 and in 3.0.0, to be removed in 4.0.0, replaced by procedure-based 1524 * distributed WAL splitter; see SplitWALManager. 1525 */ 1526 @Deprecated 1527 public static final String HBASE_SPLIT_WAL_COORDINATED_BY_ZK = "hbase.split.wal.zk.coordinated"; 1528 1529 /** 1530 * @deprecated since 2.4.0 and in 3.0.0, to be removed in 4.0.0. 1531 */ 1532 @Deprecated 1533 public static final boolean DEFAULT_HBASE_SPLIT_COORDINATED_BY_ZK = false; 1534 1535 public static final String HBASE_SPLIT_WAL_MAX_SPLITTER = "hbase.regionserver.wal.max.splitters"; 1536 1537 public static final int DEFAULT_HBASE_SPLIT_WAL_MAX_SPLITTER = 2; 1538 1539 /** 1540 * Config key for if the server should send backpressure and if the client should listen to that 1541 * backpressure from the server 1542 */ 1543 public static final String ENABLE_CLIENT_BACKPRESSURE = "hbase.client.backpressure.enabled"; 1544 public static final boolean DEFAULT_ENABLE_CLIENT_BACKPRESSURE = false; 1545 1546 public static final String HEAP_OCCUPANCY_LOW_WATERMARK_KEY = 1547 "hbase.heap.occupancy.low_water_mark"; 1548 public static final float DEFAULT_HEAP_OCCUPANCY_LOW_WATERMARK = 0.95f; 1549 public static final String HEAP_OCCUPANCY_HIGH_WATERMARK_KEY = 1550 "hbase.heap.occupancy.high_water_mark"; 1551 public static final float DEFAULT_HEAP_OCCUPANCY_HIGH_WATERMARK = 0.98f; 1552 1553 /** 1554 * The max number of threads used for splitting storefiles in parallel during the region split 1555 * process. 1556 */ 1557 public static final String REGION_SPLIT_THREADS_MAX = 1558 "hbase.regionserver.region.split.threads.max"; 1559 1560 /** Canary config keys */ 1561 // TODO: Move these defines to Canary Class 1562 public static final String HBASE_CANARY_WRITE_DATA_TTL_KEY = "hbase.canary.write.data.ttl"; 1563 1564 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_LOWERLIMIT_KEY = 1565 "hbase.canary.write.perserver.regions.lowerLimit"; 1566 1567 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_UPPERLIMIT_KEY = 1568 "hbase.canary.write.perserver.regions.upperLimit"; 1569 1570 public static final String HBASE_CANARY_WRITE_VALUE_SIZE_KEY = "hbase.canary.write.value.size"; 1571 1572 public static final String HBASE_CANARY_WRITE_TABLE_CHECK_PERIOD_KEY = 1573 "hbase.canary.write.table.check.period"; 1574 1575 public static final String HBASE_CANARY_READ_RAW_SCAN_KEY = "hbase.canary.read.raw.enabled"; 1576 1577 public static final String HBASE_CANARY_READ_ALL_CF = "hbase.canary.read.all.column.famliy"; 1578 /** 1579 * Configuration keys for programmatic JAAS configuration for secured ZK interaction 1580 */ 1581 public static final String ZK_CLIENT_KEYTAB_FILE = "hbase.zookeeper.client.keytab.file"; 1582 public static final String ZK_CLIENT_KERBEROS_PRINCIPAL = 1583 "hbase.zookeeper.client.kerberos.principal"; 1584 public static final String ZK_SERVER_KEYTAB_FILE = "hbase.zookeeper.server.keytab.file"; 1585 public static final String ZK_SERVER_KERBEROS_PRINCIPAL = 1586 "hbase.zookeeper.server.kerberos.principal"; 1587 1588 /** Config key for hbase temporary directory in hdfs */ 1589 public static final String TEMPORARY_FS_DIRECTORY_KEY = "hbase.fs.tmp.dir"; 1590 public static final String DEFAULT_TEMPORARY_HDFS_DIRECTORY = 1591 "/user/" + System.getProperty("user.name") + "/hbase-staging"; 1592 1593 public static final String SNAPSHOT_RESTORE_TAKE_FAILSAFE_SNAPSHOT = 1594 "hbase.snapshot.restore.take.failsafe.snapshot"; 1595 public static final boolean DEFAULT_SNAPSHOT_RESTORE_TAKE_FAILSAFE_SNAPSHOT = true; 1596 1597 public static final String SNAPSHOT_RESTORE_FAILSAFE_NAME = 1598 "hbase.snapshot.restore.failsafe.name"; 1599 public static final String DEFAULT_SNAPSHOT_RESTORE_FAILSAFE_NAME = 1600 "hbase-failsafe-{snapshot.name}-{restore.timestamp}"; 1601 1602 public static final String DEFAULT_LOSSY_COUNTING_ERROR_RATE = 1603 "hbase.util.default.lossycounting.errorrate"; 1604 public static final String NOT_IMPLEMENTED = "Not implemented"; 1605 1606 // Default TTL - FOREVER 1607 public static final long DEFAULT_SNAPSHOT_TTL = 0; 1608 1609 // User defined Default TTL config key 1610 public static final String DEFAULT_SNAPSHOT_TTL_CONFIG_KEY = "hbase.master.snapshot.ttl"; 1611 1612 // Regions Recovery based on high storeFileRefCount threshold value 1613 public static final String STORE_FILE_REF_COUNT_THRESHOLD = 1614 "hbase.regions.recovery.store.file.ref.count"; 1615 1616 // default -1 indicates there is no threshold on high storeRefCount 1617 public static final int DEFAULT_STORE_FILE_REF_COUNT_THRESHOLD = -1; 1618 1619 public static final String REGIONS_RECOVERY_INTERVAL = 1620 "hbase.master.regions.recovery.check.interval"; 1621 1622 public static final int DEFAULT_REGIONS_RECOVERY_INTERVAL = 1200 * 1000; // Default 20 min 1623 1624 /** 1625 * Configurations for master executor services. 1626 */ 1627 public static final String MASTER_OPEN_REGION_THREADS = 1628 "hbase.master.executor.openregion.threads"; 1629 public static final int MASTER_OPEN_REGION_THREADS_DEFAULT = 5; 1630 1631 public static final String MASTER_CLOSE_REGION_THREADS = 1632 "hbase.master.executor.closeregion.threads"; 1633 public static final int MASTER_CLOSE_REGION_THREADS_DEFAULT = 5; 1634 1635 public static final String MASTER_SERVER_OPERATIONS_THREADS = 1636 "hbase.master.executor.serverops.threads"; 1637 public static final int MASTER_SERVER_OPERATIONS_THREADS_DEFAULT = 5; 1638 1639 /** 1640 * Number of threads used to dispatch merge operations to the regionservers. 1641 */ 1642 public static final String MASTER_MERGE_DISPATCH_THREADS = 1643 "hbase.master.executor.merge.dispatch.threads"; 1644 public static final int MASTER_MERGE_DISPATCH_THREADS_DEFAULT = 2; 1645 1646 public static final String MASTER_META_SERVER_OPERATIONS_THREADS = 1647 "hbase.master.executor.meta.serverops.threads"; 1648 public static final int MASTER_META_SERVER_OPERATIONS_THREADS_DEFAULT = 5; 1649 1650 public static final String MASTER_LOG_REPLAY_OPS_THREADS = 1651 "hbase.master.executor.logreplayops.threads"; 1652 public static final int MASTER_LOG_REPLAY_OPS_THREADS_DEFAULT = 10; 1653 1654 public static final int DEFAULT_SLOW_LOG_RING_BUFFER_SIZE = 256; 1655 1656 public static final String SLOW_LOG_BUFFER_ENABLED_KEY = 1657 "hbase.regionserver.slowlog.buffer.enabled"; 1658 public static final boolean DEFAULT_ONLINE_LOG_PROVIDER_ENABLED = false; 1659 1660 /** The slowlog info family as a string */ 1661 private static final String SLOWLOG_INFO_FAMILY_STR = "info"; 1662 1663 /** The slowlog info family */ 1664 public static final byte[] SLOWLOG_INFO_FAMILY = Bytes.toBytes(SLOWLOG_INFO_FAMILY_STR); 1665 1666 public static final String SLOW_LOG_SYS_TABLE_ENABLED_KEY = 1667 "hbase.regionserver.slowlog.systable.enabled"; 1668 public static final boolean DEFAULT_SLOW_LOG_SYS_TABLE_ENABLED_KEY = false; 1669 1670 @Deprecated 1671 // since <need to know the version number> and will be removed in <version number> 1672 // Instead use hbase.regionserver.named.queue.chore.duration config property 1673 public static final String SLOW_LOG_SYS_TABLE_CHORE_DURATION_KEY = 1674 "hbase.slowlog.systable.chore.duration"; 1675 // Default 10 mins. 1676 public static final int DEFAULT_SLOW_LOG_SYS_TABLE_CHORE_DURATION = 10 * 60 * 1000; 1677 1678 public static final String SLOW_LOG_SCAN_PAYLOAD_ENABLED = "hbase.slowlog.scan.payload.enabled"; 1679 public static final boolean SLOW_LOG_SCAN_PAYLOAD_ENABLED_DEFAULT = false; 1680 1681 public static final String SHELL_TIMESTAMP_FORMAT_EPOCH_KEY = 1682 "hbase.shell.timestamp.format.epoch"; 1683 1684 public static final boolean DEFAULT_SHELL_TIMESTAMP_FORMAT_EPOCH = false; 1685 1686 /** 1687 * Number of rows in a batch operation above which a warning will be logged. 1688 */ 1689 public static final String BATCH_ROWS_THRESHOLD_NAME = "hbase.rpc.rows.warning.threshold"; 1690 1691 /** 1692 * Default value of {@link #BATCH_ROWS_THRESHOLD_NAME} 1693 */ 1694 public static final int BATCH_ROWS_THRESHOLD_DEFAULT = 5000; 1695 1696 /** 1697 * In some scenarios, such as the elastic scaling scenario on the cloud, the HBase client may not 1698 * be able to resolve the hostname of the newly added node. If the network is interconnected, the 1699 * client can actually access the HBase cluster nodes through ip. However, since the HBase client 1700 * obtains the Master/RS address info from or the ZK or the meta table, so the Master/RS of the 1701 * HBase cluster needs to expose the service with ip instead of the hostname. Therefore, We can 1702 * use hostname by default, but at the same time, we can also provide a config to support whether 1703 * to use ip for Master/RS service. See HBASE-27304 for details. 1704 */ 1705 public final static String HBASE_SERVER_USEIP_ENABLED_KEY = "hbase.server.useip.enabled"; 1706 1707 /** 1708 * Default value of {@link #HBASE_SERVER_USEIP_ENABLED_KEY} 1709 */ 1710 public final static boolean HBASE_SERVER_USEIP_ENABLED_DEFAULT = false; 1711 1712 /** 1713 * Should the HMaster reject hosts of decommissioned RegionServers, bypass matching their port and 1714 * startcode parts of their ServerName or not? When True, the HMaster will reject a RegionServer's 1715 * request to `reportForDuty` if it's hostname exists in the list of decommissioned RegionServers 1716 * it maintains internally. Added in HBASE-28342. 1717 */ 1718 public final static String REJECT_DECOMMISSIONED_HOSTS_KEY = 1719 "hbase.master.reject.decommissioned.hosts"; 1720 1721 /** 1722 * Default value of {@link #REJECT_DECOMMISSIONED_HOSTS_KEY} 1723 */ 1724 public final static boolean REJECT_DECOMMISSIONED_HOSTS_DEFAULT = false; 1725 1726 private HConstants() { 1727 // Can't be instantiated with this ctor. 1728 } 1729}