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