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