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 /** Default value for ZooKeeper session timeout */ 275 public static final int DEFAULT_ZK_SESSION_TIMEOUT = 90 * 1000; 276 277 /** Parameter name for port region server listens on. */ 278 public static final String REGIONSERVER_PORT = "hbase.regionserver.port"; 279 280 /** Default port region server listens on. */ 281 public static final int DEFAULT_REGIONSERVER_PORT = 16020; 282 283 /** default port for region server web api */ 284 public static final int DEFAULT_REGIONSERVER_INFOPORT = 16030; 285 286 /** A configuration key for regionserver info port */ 287 public static final String REGIONSERVER_INFO_PORT = 288 "hbase.regionserver.info.port"; 289 290 /** A flag that enables automatic selection of regionserver info port */ 291 public static final String REGIONSERVER_INFO_PORT_AUTO = 292 REGIONSERVER_INFO_PORT + ".auto"; 293 294 /** Parameter name for what region server implementation to use. */ 295 public static final String REGION_SERVER_IMPL= "hbase.regionserver.impl"; 296 297 /** Parameter name for what master implementation to use. */ 298 public static final String MASTER_IMPL= "hbase.master.impl"; 299 300 /** Parameter name for what hbase client implementation to use. */ 301 @Deprecated // unused. see HBASE-7460. remove this in 3.0 302 public static final String HBASECLIENT_IMPL= "hbase.hbaseclient.impl"; 303 304 /** Parameter name for how often threads should wake up */ 305 public static final String THREAD_WAKE_FREQUENCY = "hbase.server.thread.wakefrequency"; 306 307 /** Default value for thread wake frequency */ 308 public static final int DEFAULT_THREAD_WAKE_FREQUENCY = 10 * 1000; 309 310 /** Parameter name for how often we should try to write a version file, before failing */ 311 public static final String VERSION_FILE_WRITE_ATTEMPTS = "hbase.server.versionfile.writeattempts"; 312 313 /** Parameter name for how often we should try to write a version file, before failing */ 314 public static final int DEFAULT_VERSION_FILE_WRITE_ATTEMPTS = 3; 315 316 /** Parameter name and default value for how often a region should perform a major compaction */ 317 public static final String MAJOR_COMPACTION_PERIOD = "hbase.hregion.majorcompaction"; 318 public static final long DEFAULT_MAJOR_COMPACTION_PERIOD = 1000 * 60 * 60 * 24 * 7; // 7 days 319 320 /** 321 * Parameter name and default value for major compaction jitter. 322 * Used as a multiplier applied to {@link HConstants#MAJOR_COMPACTION_PERIOD} 323 * to cause compaction to occur a given amount of time either side of 324 * {@link HConstants#MAJOR_COMPACTION_PERIOD}. 325 * Default to 0.5 so jitter has us fall evenly either side of when the compaction should run. 326 */ 327 public static final String MAJOR_COMPACTION_JITTER = "hbase.hregion.majorcompaction.jitter"; 328 public static final float DEFAULT_MAJOR_COMPACTION_JITTER = 0.50F; 329 330 /** Parameter name for the maximum batch of KVs to be used in flushes and compactions */ 331 public static final String COMPACTION_KV_MAX = "hbase.hstore.compaction.kv.max"; 332 public static final int COMPACTION_KV_MAX_DEFAULT = 10; 333 334 /** Parameter name for HBase instance root directory */ 335 public static final String HBASE_DIR = "hbase.rootdir"; 336 337 /** Parameter name for HBase client IPC pool type */ 338 public static final String HBASE_CLIENT_IPC_POOL_TYPE = "hbase.client.ipc.pool.type"; 339 340 /** Parameter name for HBase client IPC pool size */ 341 public static final String HBASE_CLIENT_IPC_POOL_SIZE = "hbase.client.ipc.pool.size"; 342 343 /** Parameter name for HBase client operation timeout. */ 344 public static final String HBASE_CLIENT_OPERATION_TIMEOUT = "hbase.client.operation.timeout"; 345 346 /** Parameter name for HBase client meta operation timeout. */ 347 public static final String HBASE_CLIENT_META_OPERATION_TIMEOUT = 348 "hbase.client.meta.operation.timeout"; 349 350 /** Default HBase client operation timeout, which is tantamount to a blocking call */ 351 public static final int DEFAULT_HBASE_CLIENT_OPERATION_TIMEOUT = 1200000; 352 353 /** Parameter name for HBase client meta replica scan call timeout. */ 354 public static final String HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT = 355 "hbase.client.meta.replica.scan.timeout"; 356 357 /** Default HBase client meta replica scan call timeout, 1 second */ 358 public static final int HBASE_CLIENT_META_REPLICA_SCAN_TIMEOUT_DEFAULT = 1000000; 359 360 /** Used to construct the name of the log directory for a region server */ 361 public static final String HREGION_LOGDIR_NAME = "WALs"; 362 363 /** Used to construct the name of the splitlog directory for a region server */ 364 public static final String SPLIT_LOGDIR_NAME = "splitWAL"; 365 366 /** Like the previous, but for old logs that are about to be deleted */ 367 public static final String HREGION_OLDLOGDIR_NAME = "oldWALs"; 368 369 /** Staging dir used by bulk load */ 370 public static final String BULKLOAD_STAGING_DIR_NAME = "staging"; 371 372 public static final String CORRUPT_DIR_NAME = "corrupt"; 373 374 /** Used by HBCK to sideline backup data */ 375 public static final String HBCK_SIDELINEDIR_NAME = ".hbck"; 376 377 /** Any artifacts left from migration can be moved here */ 378 public static final String MIGRATION_NAME = ".migration"; 379 380 /** 381 * The directory from which co-processor/custom filter jars can be loaded 382 * dynamically by the region servers. This value can be overridden by the 383 * hbase.dynamic.jars.dir config. 384 */ 385 @Deprecated // unused. see HBASE-12054. remove this in 3.0 386 public static final String LIB_DIR = "lib"; 387 388 /** Used to construct the name of the compaction directory during compaction */ 389 public static final String HREGION_COMPACTIONDIR_NAME = "compaction.dir"; 390 391 /** Conf key for the max file size after which we split the region */ 392 public static final String HREGION_MAX_FILESIZE = 393 "hbase.hregion.max.filesize"; 394 395 /** Default maximum file size */ 396 public static final long DEFAULT_MAX_FILE_SIZE = 10 * 1024 * 1024 * 1024L; 397 398 /** 399 * Max size of single row for Get's or Scan's without in-row scanning flag set. 400 */ 401 public static final String TABLE_MAX_ROWSIZE_KEY = "hbase.table.max.rowsize"; 402 403 /** 404 * Default max row size (1 Gb). 405 */ 406 public static final long TABLE_MAX_ROWSIZE_DEFAULT = 1024 * 1024 * 1024L; 407 408 /** 409 * The max number of threads used for opening and closing stores or store 410 * files in parallel 411 */ 412 public static final String HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 413 "hbase.hstore.open.and.close.threads.max"; 414 415 /** 416 * The default number for the max number of threads used for opening and 417 * closing stores or store files in parallel 418 */ 419 public static final int DEFAULT_HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 1; 420 421 /** 422 * Block updates if memstore has hbase.hregion.memstore.block.multiplier 423 * times hbase.hregion.memstore.flush.size bytes. Useful preventing 424 * runaway memstore during spikes in update traffic. 425 */ 426 public static final String HREGION_MEMSTORE_BLOCK_MULTIPLIER = 427 "hbase.hregion.memstore.block.multiplier"; 428 429 /** 430 * Default value for hbase.hregion.memstore.block.multiplier 431 */ 432 public static final int DEFAULT_HREGION_MEMSTORE_BLOCK_MULTIPLIER = 4; 433 434 /** Conf key for the memstore size at which we flush the memstore */ 435 public static final String HREGION_MEMSTORE_FLUSH_SIZE = 436 "hbase.hregion.memstore.flush.size"; 437 438 public static final String HREGION_EDITS_REPLAY_SKIP_ERRORS = 439 "hbase.hregion.edits.replay.skip.errors"; 440 441 public static final boolean DEFAULT_HREGION_EDITS_REPLAY_SKIP_ERRORS = 442 false; 443 444 /** Maximum value length, enforced on KeyValue construction */ 445 public static final int MAXIMUM_VALUE_LENGTH = Integer.MAX_VALUE - 1; 446 447 /** name of the file for unique cluster ID */ 448 public static final String CLUSTER_ID_FILE_NAME = "hbase.id"; 449 450 /** Default value for cluster ID */ 451 public static final String CLUSTER_ID_DEFAULT = "default-cluster"; 452 453 /** Parameter name for # days to keep MVCC values during a major compaction */ 454 public static final String KEEP_SEQID_PERIOD = "hbase.hstore.compaction.keep.seqId.period"; 455 /** At least to keep MVCC values in hfiles for 5 days */ 456 public static final int MIN_KEEP_SEQID_PERIOD = 5; 457 458 // Always store the location of the root table's HRegion. 459 // This HRegion is never split. 460 461 // region name = table + startkey + regionid. This is the row key. 462 // each row in the root and meta tables describes exactly 1 region 463 // Do we ever need to know all the information that we are storing? 464 465 // Note that the name of the root table starts with "-" and the name of the 466 // meta table starts with "." Why? it's a trick. It turns out that when we 467 // store region names in memory, we use a SortedMap. Since "-" sorts before 468 // "." (and since no other table name can start with either of these 469 // characters, the root region will always be the first entry in such a Map, 470 // followed by all the meta regions (which will be ordered by their starting 471 // row key as well), followed by all user tables. So when the Master is 472 // choosing regions to assign, it will always choose the root region first, 473 // followed by the meta regions, followed by user regions. Since the root 474 // and meta regions always need to be on-line, this ensures that they will 475 // be the first to be reassigned if the server(s) they are being served by 476 // should go down. 477 478 public static final String BASE_NAMESPACE_DIR = "data"; 479 480 /** delimiter used between portions of a region name */ 481 public static final int META_ROW_DELIMITER = ','; 482 483 /** The catalog family as a string*/ 484 public static final String CATALOG_FAMILY_STR = "info"; 485 486 /** The catalog family */ 487 public static final byte [] CATALOG_FAMILY = Bytes.toBytes(CATALOG_FAMILY_STR); 488 489 /** The RegionInfo qualifier as a string */ 490 public static final String REGIONINFO_QUALIFIER_STR = "regioninfo"; 491 492 /** The regioninfo column qualifier */ 493 public static final byte [] REGIONINFO_QUALIFIER = Bytes.toBytes(REGIONINFO_QUALIFIER_STR); 494 495 /** The server column qualifier */ 496 public static final String SERVER_QUALIFIER_STR = "server"; 497 /** The server column qualifier */ 498 public static final byte [] SERVER_QUALIFIER = Bytes.toBytes(SERVER_QUALIFIER_STR); 499 500 /** The startcode column qualifier */ 501 public static final String STARTCODE_QUALIFIER_STR = "serverstartcode"; 502 /** The startcode column qualifier */ 503 public static final byte [] STARTCODE_QUALIFIER = Bytes.toBytes(STARTCODE_QUALIFIER_STR); 504 505 /** The open seqnum column qualifier */ 506 public static final String SEQNUM_QUALIFIER_STR = "seqnumDuringOpen"; 507 /** The open seqnum column qualifier */ 508 public static final byte [] SEQNUM_QUALIFIER = Bytes.toBytes(SEQNUM_QUALIFIER_STR); 509 510 /** The state column qualifier */ 511 public static final String STATE_QUALIFIER_STR = "state"; 512 513 public static final byte [] STATE_QUALIFIER = Bytes.toBytes(STATE_QUALIFIER_STR); 514 515 /** 516 * The serverName column qualifier. Its the server where the region is 517 * transitioning on, while column server is the server where the region is 518 * opened on. They are the same when the region is in state OPEN. 519 */ 520 public static final String SERVERNAME_QUALIFIER_STR = "sn"; 521 522 public static final byte [] SERVERNAME_QUALIFIER = Bytes.toBytes(SERVERNAME_QUALIFIER_STR); 523 524 /** The lower-half split region column qualifier */ 525 public static final byte [] SPLITA_QUALIFIER = Bytes.toBytes("splitA"); 526 527 /** The upper-half split region column qualifier */ 528 public static final byte [] SPLITB_QUALIFIER = Bytes.toBytes("splitB"); 529 530 /** The lower-half merge region column qualifier */ 531 public static final byte[] MERGEA_QUALIFIER = Bytes.toBytes("mergeA"); 532 533 /** The upper-half merge region column qualifier */ 534 public static final byte[] MERGEB_QUALIFIER = Bytes.toBytes("mergeB"); 535 536 /** The catalog family as a string*/ 537 public static final String TABLE_FAMILY_STR = "table"; 538 539 /** The catalog family */ 540 public static final byte [] TABLE_FAMILY = Bytes.toBytes(TABLE_FAMILY_STR); 541 542 /** The serialized table state qualifier */ 543 public static final byte[] TABLE_STATE_QUALIFIER = Bytes.toBytes("state"); 544 545 /** The replication barrier family as a string*/ 546 public static final String REPLICATION_BARRIER_FAMILY_STR = "rep_barrier"; 547 548 /** The replication barrier family */ 549 public static final byte[] REPLICATION_BARRIER_FAMILY = 550 Bytes.toBytes(REPLICATION_BARRIER_FAMILY_STR); 551 552 /** 553 * The meta table version column qualifier. 554 * We keep current version of the meta table in this column in <code>-ROOT-</code> 555 * table: i.e. in the 'info:v' column. 556 */ 557 public static final byte [] META_VERSION_QUALIFIER = Bytes.toBytes("v"); 558 559 /** 560 * The current version of the meta table. 561 * - pre-hbase 0.92. There is no META_VERSION column in the root table 562 * in this case. The meta has HTableDescriptor serialized into the HRegionInfo; 563 * - version 0 is 0.92 and 0.94. Meta data has serialized HRegionInfo's using 564 * Writable serialization, and HRegionInfo's does not contain HTableDescriptors. 565 * - version 1 for 0.96+ keeps HRegionInfo data structures, but changes the 566 * byte[] serialization from Writables to Protobuf. 567 * See HRegionInfo.VERSION 568 */ 569 public static final short META_VERSION = 1; 570 571 // Other constants 572 573 /** 574 * An empty instance. 575 */ 576 public static final byte [] EMPTY_BYTE_ARRAY = new byte [0]; 577 578 public static final ByteBuffer EMPTY_BYTE_BUFFER = ByteBuffer.wrap(EMPTY_BYTE_ARRAY); 579 580 /** 581 * Used by scanners, etc when they want to start at the beginning of a region 582 */ 583 public static final byte [] EMPTY_START_ROW = EMPTY_BYTE_ARRAY; 584 585 /** 586 * Last row in a table. 587 */ 588 public static final byte [] EMPTY_END_ROW = EMPTY_START_ROW; 589 590 /** 591 * Used by scanners and others when they're trying to detect the end of a 592 * table 593 */ 594 public static final byte [] LAST_ROW = EMPTY_BYTE_ARRAY; 595 596 /** 597 * Max length a row can have because of the limitation in TFile. 598 */ 599 public static final int MAX_ROW_LENGTH = Short.MAX_VALUE; 600 601 /** 602 * Timestamp to use when we want to refer to the latest cell. 603 * This is the timestamp sent by clients when no timestamp is specified on 604 * commit. 605 */ 606 public static final long LATEST_TIMESTAMP = Long.MAX_VALUE; 607 608 /** 609 * Timestamp to use when we want to refer to the oldest cell. 610 * Special! Used in fake Cells only. Should never be the timestamp on an actual Cell returned to 611 * a client. 612 * @deprecated Should not be public since hbase-1.3.0. For internal use only. Move internal to 613 * Scanners flagged as special timestamp value never to be returned as timestamp on a Cell. 614 */ 615 @Deprecated 616 public static final long OLDEST_TIMESTAMP = Long.MIN_VALUE; 617 618 /** 619 * LATEST_TIMESTAMP in bytes form 620 */ 621 public static final byte [] LATEST_TIMESTAMP_BYTES = { 622 // big-endian 623 (byte) (LATEST_TIMESTAMP >>> 56), 624 (byte) (LATEST_TIMESTAMP >>> 48), 625 (byte) (LATEST_TIMESTAMP >>> 40), 626 (byte) (LATEST_TIMESTAMP >>> 32), 627 (byte) (LATEST_TIMESTAMP >>> 24), 628 (byte) (LATEST_TIMESTAMP >>> 16), 629 (byte) (LATEST_TIMESTAMP >>> 8), 630 (byte) LATEST_TIMESTAMP, 631 }; 632 633 /** 634 * Define for 'return-all-versions'. 635 */ 636 public static final int ALL_VERSIONS = Integer.MAX_VALUE; 637 638 /** 639 * Unlimited time-to-live. 640 */ 641// public static final int FOREVER = -1; 642 public static final int FOREVER = Integer.MAX_VALUE; 643 644 /** 645 * Seconds in a week 646 */ 647 @Deprecated // unused. see HBASE-2692. remove this in 3.0 648 public static final int WEEK_IN_SECONDS = 7 * 24 * 3600; 649 650 /** 651 * Seconds in a day, hour and minute 652 */ 653 public static final int DAY_IN_SECONDS = 24 * 60 * 60; 654 public static final int HOUR_IN_SECONDS = 60 * 60; 655 public static final int MINUTE_IN_SECONDS = 60; 656 657 //TODO: although the following are referenced widely to format strings for 658 // the shell. They really aren't a part of the public API. It would be 659 // nice if we could put them somewhere where they did not need to be 660 // public. They could have package visibility 661 public static final String NAME = "NAME"; 662 public static final String VERSIONS = "VERSIONS"; 663 public static final String IN_MEMORY = "IN_MEMORY"; 664 public static final String METADATA = "METADATA"; 665 public static final String CONFIGURATION = "CONFIGURATION"; 666 667 /** 668 * Retrying we multiply hbase.client.pause setting by what we have in this array until we 669 * run out of array items. Retries beyond this use the last number in the array. So, for 670 * example, if hbase.client.pause is 1 second, and maximum retries count 671 * hbase.client.retries.number is 10, we will retry at the following intervals: 672 * 1, 2, 3, 5, 10, 20, 40, 100, 100, 100. 673 * With 100ms, a back-off of 200 means 20s 674 */ 675 public static final int [] RETRY_BACKOFF = {1, 2, 3, 5, 10, 20, 40, 100, 100, 100, 100, 200, 200}; 676 677 public static final String REGION_IMPL = "hbase.hregion.impl"; 678 679 /** 680 * Scope tag for locally scoped data. 681 * This data will not be replicated. 682 */ 683 public static final int REPLICATION_SCOPE_LOCAL = 0; 684 685 /** 686 * Scope tag for globally scoped data. 687 * This data will be replicated to all peers. 688 */ 689 public static final int REPLICATION_SCOPE_GLOBAL = 1; 690 691 /** 692 * Default cluster ID, cannot be used to identify a cluster so a key with 693 * this value means it wasn't meant for replication. 694 */ 695 public static final UUID DEFAULT_CLUSTER_ID = new UUID(0L,0L); 696 697 /** 698 * Parameter name for maximum number of bytes returned when calling a scanner's next method. 699 * Controlled by the client. 700 */ 701 public static final String HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY = 702 "hbase.client.scanner.max.result.size"; 703 704 /** 705 * Parameter name for maximum number of bytes returned when calling a scanner's next method. 706 * Controlled by the server. 707 */ 708 public static final String HBASE_SERVER_SCANNER_MAX_RESULT_SIZE_KEY = 709 "hbase.server.scanner.max.result.size"; 710 711 /** 712 * Maximum number of bytes returned when calling a scanner's next method. 713 * Note that when a single row is larger than this limit the row is still 714 * returned completely. 715 * 716 * The default value is 2MB. 717 */ 718 public static final long DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE = 2 * 1024 * 1024; 719 720 /** 721 * Maximum number of bytes returned when calling a scanner's next method. 722 * Note that when a single row is larger than this limit the row is still 723 * returned completely. 724 * Safety setting to protect the region server. 725 * 726 * The default value is 100MB. (a client would rarely request larger chunks on purpose) 727 */ 728 public static final long DEFAULT_HBASE_SERVER_SCANNER_MAX_RESULT_SIZE = 100 * 1024 * 1024; 729 730 /** 731 * Parameter name for client pause value, used mostly as value to wait 732 * before running a retry of a failed get, region lookup, etc. 733 */ 734 public static final String HBASE_CLIENT_PAUSE = "hbase.client.pause"; 735 736 /** 737 * Default value of {@link #HBASE_CLIENT_PAUSE}. 738 */ 739 public static final long DEFAULT_HBASE_CLIENT_PAUSE = 100; 740 741 /** 742 * Parameter name for client pause value for special case such as call queue too big, etc. 743 */ 744 public static final String HBASE_CLIENT_PAUSE_FOR_CQTBE = "hbase.client.pause.cqtbe"; 745 746 /** 747 * The maximum number of concurrent connections the client will maintain. 748 */ 749 public static final String HBASE_CLIENT_MAX_TOTAL_TASKS = "hbase.client.max.total.tasks"; 750 751 /** 752 * Default value of {@link #HBASE_CLIENT_MAX_TOTAL_TASKS}. 753 */ 754 public static final int DEFAULT_HBASE_CLIENT_MAX_TOTAL_TASKS = 100; 755 756 /** 757 * The maximum number of concurrent connections the client will maintain to a single 758 * RegionServer. 759 */ 760 public static final String HBASE_CLIENT_MAX_PERSERVER_TASKS = "hbase.client.max.perserver.tasks"; 761 762 /** 763 * Default value of {@link #HBASE_CLIENT_MAX_PERSERVER_TASKS}. 764 */ 765 public static final int DEFAULT_HBASE_CLIENT_MAX_PERSERVER_TASKS = 2; 766 767 /** 768 * The maximum number of concurrent connections the client will maintain to a single 769 * Region. 770 */ 771 public static final String HBASE_CLIENT_MAX_PERREGION_TASKS = "hbase.client.max.perregion.tasks"; 772 773 /** 774 * Default value of {@link #HBASE_CLIENT_MAX_PERREGION_TASKS}. 775 */ 776 public static final int DEFAULT_HBASE_CLIENT_MAX_PERREGION_TASKS = 1; 777 778 /** 779 * The maximum number of concurrent pending RPC requests for one server in process level. 780 */ 781 public static final String HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD = 782 "hbase.client.perserver.requests.threshold"; 783 784 /** 785 * Default value of {@link #HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD}. 786 */ 787 public static final int DEFAULT_HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD = Integer.MAX_VALUE; 788 789 790 /** 791 * Parameter name for server pause value, used mostly as value to wait before 792 * running a retry of a failed operation. 793 */ 794 public static final String HBASE_SERVER_PAUSE = "hbase.server.pause"; 795 796 /** 797 * Default value of {@link #HBASE_SERVER_PAUSE}. 798 */ 799 public static final int DEFAULT_HBASE_SERVER_PAUSE = 1000; 800 801 /** 802 * Parameter name for maximum retries, used as maximum for all retryable 803 * operations such as fetching of the root region from root region server, 804 * getting a cell's value, starting a row update, etc. 805 */ 806 public static final String HBASE_CLIENT_RETRIES_NUMBER = "hbase.client.retries.number"; 807 808 /** 809 * Default value of {@link #HBASE_CLIENT_RETRIES_NUMBER}. 810 */ 811 public static final int DEFAULT_HBASE_CLIENT_RETRIES_NUMBER = 15; 812 813 public static final String HBASE_CLIENT_SERVERSIDE_RETRIES_MULTIPLIER = 814 "hbase.client.serverside.retries.multiplier"; 815 816 public static final int DEFAULT_HBASE_CLIENT_SERVERSIDE_RETRIES_MULTIPLIER = 3; 817 818 /** 819 * Parameter name to set the default scanner caching for all clients. 820 */ 821 public static final String HBASE_CLIENT_SCANNER_CACHING = "hbase.client.scanner.caching"; 822 823 /** 824 * Default value for {@link #HBASE_CLIENT_SCANNER_CACHING} 825 */ 826 public static final int DEFAULT_HBASE_CLIENT_SCANNER_CACHING = Integer.MAX_VALUE; 827 828 /** 829 * Parameter name for number of rows that will be fetched when calling next on 830 * a scanner if it is not served from memory. Higher caching values will 831 * enable faster scanners but will eat up more memory and some calls of next 832 * may take longer and longer times when the cache is empty. 833 */ 834 public static final String HBASE_META_SCANNER_CACHING = "hbase.meta.scanner.caching"; 835 836 /** 837 * Default value of {@link #HBASE_META_SCANNER_CACHING}. 838 */ 839 public static final int DEFAULT_HBASE_META_SCANNER_CACHING = 100; 840 841 /** 842 * Parameter name for number of versions, kept by meta table. 843 */ 844 public static final String HBASE_META_VERSIONS = "hbase.meta.versions"; 845 846 /** 847 * Default value of {@link #HBASE_META_VERSIONS}. 848 */ 849 public static final int DEFAULT_HBASE_META_VERSIONS = 3; 850 851 /** 852 * Parameter name for number of versions, kept by meta table. 853 */ 854 public static final String HBASE_META_BLOCK_SIZE = "hbase.meta.blocksize"; 855 856 /** 857 * Default value of {@link #HBASE_META_BLOCK_SIZE}. 858 */ 859 public static final int DEFAULT_HBASE_META_BLOCK_SIZE = 8 * 1024; 860 861 /** 862 * Parameter name for unique identifier for this {@link org.apache.hadoop.conf.Configuration} 863 * instance. If there are two or more {@link org.apache.hadoop.conf.Configuration} instances that, 864 * for all intents and purposes, are the same except for their instance ids, then they will not be 865 * able to share the same org.apache.hadoop.hbase.client.HConnection instance. On the other hand, 866 * even if the instance ids are the same, it could result in non-shared 867 * org.apache.hadoop.hbase.client.HConnection instances if some of the other connection parameters 868 * differ. 869 */ 870 public static final String HBASE_CLIENT_INSTANCE_ID = "hbase.client.instance.id"; 871 872 /** 873 * The client scanner timeout period in milliseconds. 874 */ 875 public static final String HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 876 "hbase.client.scanner.timeout.period"; 877 878 /** 879 * Use {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD} instead. 880 * @deprecated This config option is deprecated. Will be removed at later releases after 0.96. 881 */ 882 @Deprecated 883 public static final String HBASE_REGIONSERVER_LEASE_PERIOD_KEY = 884 "hbase.regionserver.lease.period"; 885 886 /** 887 * Default value of {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD}. 888 */ 889 public static final int DEFAULT_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 60000; 890 891 /** 892 * timeout for each RPC 893 */ 894 public static final String HBASE_RPC_TIMEOUT_KEY = "hbase.rpc.timeout"; 895 896 /** 897 * timeout for each read RPC 898 */ 899 public static final String HBASE_RPC_READ_TIMEOUT_KEY = "hbase.rpc.read.timeout"; 900 901 /** 902 * timeout for each write RPC 903 */ 904 public static final String HBASE_RPC_WRITE_TIMEOUT_KEY = "hbase.rpc.write.timeout"; 905 906 /** 907 * Default value of {@link #HBASE_RPC_TIMEOUT_KEY} 908 */ 909 public static final int DEFAULT_HBASE_RPC_TIMEOUT = 60000; 910 911 /** 912 * timeout for short operation RPC 913 */ 914 public static final String HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY = 915 "hbase.rpc.shortoperation.timeout"; 916 917 /** 918 * Default value of {@link #HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY} 919 */ 920 public static final int DEFAULT_HBASE_RPC_SHORTOPERATION_TIMEOUT = 10000; 921 922 /** 923 * Value indicating the server name was saved with no sequence number. 924 */ 925 public static final long NO_SEQNUM = -1; 926 927 928 /* 929 * cluster replication constants. 930 */ 931 public static final String 932 REPLICATION_SOURCE_SERVICE_CLASSNAME = "hbase.replication.source.service"; 933 public static final String 934 REPLICATION_SINK_SERVICE_CLASSNAME = "hbase.replication.sink.service"; 935 public static final String REPLICATION_SERVICE_CLASSNAME_DEFAULT = 936 "org.apache.hadoop.hbase.replication.regionserver.Replication"; 937 public static final String REPLICATION_BULKLOAD_ENABLE_KEY = "hbase.replication.bulkload.enabled"; 938 public static final boolean REPLICATION_BULKLOAD_ENABLE_DEFAULT = false; 939 /** Replication cluster id of source cluster which uniquely identifies itself with peer cluster */ 940 public static final String REPLICATION_CLUSTER_ID = "hbase.replication.cluster.id"; 941 /** 942 * Max total size of buffered entries in all replication peers. It will prevent server getting 943 * OOM if there are many peers. Default value is 256MB which is four times to default 944 * replication.source.size.capacity. 945 */ 946 public static final String REPLICATION_SOURCE_TOTAL_BUFFER_KEY = "replication.total.buffer.quota"; 947 948 public static final int REPLICATION_SOURCE_TOTAL_BUFFER_DFAULT = 256 * 1024 * 1024; 949 950 951 /** 952 * Directory where the source cluster file system client configuration are placed which is used by 953 * sink cluster to copy HFiles from source cluster file system 954 */ 955 public static final String REPLICATION_CONF_DIR = "hbase.replication.conf.dir"; 956 957 /** Maximum time to retry for a failed bulk load request */ 958 public static final String BULKLOAD_MAX_RETRIES_NUMBER = "hbase.bulkload.retries.number"; 959 960 /** HBCK special code name used as server name when manipulating ZK nodes */ 961 @Deprecated // unused. see HBASE-3789. remove this in 3.0 962 public static final String HBCK_CODE_NAME = "HBCKServerName"; 963 964 public static final String KEY_FOR_HOSTNAME_SEEN_BY_MASTER = 965 "hbase.regionserver.hostname.seen.by.master"; 966 967 public static final String HBASE_MASTER_LOGCLEANER_PLUGINS = 968 "hbase.master.logcleaner.plugins"; 969 970 public static final String HBASE_REGION_SPLIT_POLICY_KEY = 971 "hbase.regionserver.region.split.policy"; 972 973 /** Whether nonces are enabled; default is true. */ 974 public static final String HBASE_RS_NONCES_ENABLED = "hbase.regionserver.nonces.enabled"; 975 976 /** 977 * Configuration key for the size of the block cache 978 */ 979 public static final String HFILE_BLOCK_CACHE_SIZE_KEY = 980 "hfile.block.cache.size"; 981 982 public static final float HFILE_BLOCK_CACHE_SIZE_DEFAULT = 0.4f; 983 984 /* 985 * Minimum percentage of free heap necessary for a successful cluster startup. 986 */ 987 public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD = 0.2f; 988 989 /** 990 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 991 */ 992 @Deprecated 993 public static final Pattern CP_HTD_ATTR_KEY_PATTERN = 994 Pattern.compile("^coprocessor\\$([0-9]+)$", Pattern.CASE_INSENSITIVE); 995 996 /** 997 * <pre> 998 * Pattern that matches a coprocessor specification. Form is: 999 * {@code <coprocessor jar file location> '|' <class name> ['|' <priority> ['|' <arguments>]]} 1000 * where arguments are {@code <KEY> '=' <VALUE> [,...]} 1001 * For example: {@code hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2} 1002 * </pre> 1003 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1004 */ 1005 @Deprecated 1006 public static final Pattern CP_HTD_ATTR_VALUE_PATTERN = 1007 Pattern.compile("(^[^\\|]*)\\|([^\\|]+)\\|[\\s]*([\\d]*)[\\s]*(\\|.*)?$"); 1008 /** 1009 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1010 */ 1011 @Deprecated 1012 public static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN = "[^=,]+"; 1013 /** 1014 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1015 */ 1016 @Deprecated 1017 public static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN = "[^,]+"; 1018 /** 1019 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0. 1020 */ 1021 @Deprecated 1022 public static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN = Pattern.compile( 1023 "(" + CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN + ")=(" + 1024 CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN + "),?"); 1025 public static final String CP_HTD_ATTR_INCLUSION_KEY = 1026 "hbase.coprocessor.classloader.included.classes"; 1027 1028 /** The delay when re-trying a socket operation in a loop (HBASE-4712) */ 1029 public static final int SOCKET_RETRY_WAIT_MS = 200; 1030 1031 /** Host name of the local machine */ 1032 public static final String LOCALHOST = "localhost"; 1033 1034 /** 1035 * If this parameter is set to true, then hbase will read 1036 * data and then verify checksums. Checksum verification 1037 * inside hdfs will be switched off. However, if the hbase-checksum 1038 * verification fails, then it will switch back to using 1039 * hdfs checksums for verifiying data that is being read from storage. 1040 * 1041 * If this parameter is set to false, then hbase will not 1042 * verify any checksums, instead it will depend on checksum verification 1043 * being done in the hdfs client. 1044 */ 1045 public static final String HBASE_CHECKSUM_VERIFICATION = 1046 "hbase.regionserver.checksum.verify"; 1047 1048 public static final String LOCALHOST_IP = "127.0.0.1"; 1049 1050 public static final String REGION_SERVER_HANDLER_COUNT = "hbase.regionserver.handler.count"; 1051 public static final int DEFAULT_REGION_SERVER_HANDLER_COUNT = 30; 1052 1053 /* 1054 * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT: 1055 * -1 => Disable aborting 1056 * 0 => Abort if even a single handler has died 1057 * 0.x => Abort only when this percent of handlers have died 1058 * 1 => Abort only all of the handers have died 1059 */ 1060 public static final String REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 1061 "hbase.regionserver.handler.abort.on.error.percent"; 1062 public static final double DEFAULT_REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = 0.5; 1063 1064 //High priority handlers to deal with admin requests and system table operation requests 1065 public static final String REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 1066 "hbase.regionserver.metahandler.count"; 1067 public static final int DEFAULT_REGION_SERVER_HIGH_PRIORITY_HANDLER_COUNT = 20; 1068 1069 public static final String REGION_SERVER_REPLICATION_HANDLER_COUNT = 1070 "hbase.regionserver.replication.handler.count"; 1071 public static final int DEFAULT_REGION_SERVER_REPLICATION_HANDLER_COUNT = 3; 1072 // Meta Transition handlers to deal with meta ReportRegionStateTransitionRequest. Meta transition 1073 // should be dealt with in a separate handler in case blocking other region's transition. 1074 public static final String MASTER_META_TRANSITION_HANDLER_COUNT = 1075 "hbase.master.meta.transition.handler.count"; 1076 public static final int MASTER__META_TRANSITION_HANDLER_COUNT_DEFAULT = 1; 1077 1078 @Deprecated // unused. see HBASE-10569. remove this in 3.0 1079 public static final String MASTER_HANDLER_COUNT = "hbase.master.handler.count"; 1080 @Deprecated // unused. see HBASE-10569. remove this in 3.0 1081 public static final int DEFAULT_MASTER_HANLDER_COUNT = 25; 1082 1083 /** Conf key that specifies timeout value to wait for a region ready */ 1084 @Deprecated // unused. see HBASE-13616. remove this in 3.0 1085 public static final String LOG_REPLAY_WAIT_REGION_TIMEOUT = 1086 "hbase.master.log.replay.wait.region.timeout"; 1087 1088 /** Conf key for enabling meta replication */ 1089 public static final String USE_META_REPLICAS = "hbase.meta.replicas.use"; 1090 public static final boolean DEFAULT_USE_META_REPLICAS = false; 1091 public static final String META_REPLICAS_NUM = "hbase.meta.replica.count"; 1092 public static final int DEFAULT_META_REPLICA_NUM = 1; 1093 1094 /** 1095 * The name of the configuration parameter that specifies 1096 * the number of bytes in a newly created checksum chunk. 1097 */ 1098 public static final String BYTES_PER_CHECKSUM = 1099 "hbase.hstore.bytes.per.checksum"; 1100 1101 /** 1102 * The name of the configuration parameter that specifies 1103 * the name of an algorithm that is used to compute checksums 1104 * for newly created blocks. 1105 */ 1106 public static final String CHECKSUM_TYPE_NAME = 1107 "hbase.hstore.checksum.algorithm"; 1108 1109 /** Enable file permission modification from standard hbase */ 1110 public static final String ENABLE_DATA_FILE_UMASK = "hbase.data.umask.enable"; 1111 /** File permission umask to use when creating hbase data files */ 1112 public static final String DATA_FILE_UMASK_KEY = "hbase.data.umask"; 1113 1114 /** Configuration name of WAL Compression */ 1115 public static final String ENABLE_WAL_COMPRESSION = 1116 "hbase.regionserver.wal.enablecompression"; 1117 1118 /** Configuration name of WAL storage policy 1119 * Valid values are: HOT, COLD, WARM, ALL_SSD, ONE_SSD, LAZY_PERSIST 1120 * See http://hadoop.apache.org/docs/r2.7.3/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html*/ 1121 public static final String WAL_STORAGE_POLICY = "hbase.wal.storage.policy"; 1122 /** 1123 * "NONE" is not a valid storage policy and means we defer the policy to HDFS. @see 1124 * <a href="https://issues.apache.org/jira/browse/HBASE-20691">HBASE-20691</a> 1125 */ 1126 public static final String DEFER_TO_HDFS_STORAGE_POLICY = "NONE"; 1127 /** By default we defer the WAL storage policy to HDFS */ 1128 public static final String DEFAULT_WAL_STORAGE_POLICY = DEFER_TO_HDFS_STORAGE_POLICY; 1129 1130 /** Region in Transition metrics threshold time */ 1131 public static final String METRICS_RIT_STUCK_WARNING_THRESHOLD = 1132 "hbase.metrics.rit.stuck.warning.threshold"; 1133 1134 public static final String LOAD_BALANCER_SLOP_KEY = "hbase.regions.slop"; 1135 1136 /** delimiter used between portions of a region name */ 1137 public static final int DELIMITER = ','; 1138 1139 /** 1140 * QOS attributes: these attributes are used to demarcate RPC call processing 1141 * by different set of handlers. For example, HIGH_QOS tagged methods are 1142 * handled by high priority handlers. 1143 */ 1144 // normal_QOS < replication_QOS < replay_QOS < QOS_threshold < admin_QOS < high_QOS < meta_QOS 1145 public static final int PRIORITY_UNSET = -1; 1146 public static final int NORMAL_QOS = 0; 1147 public static final int REPLICATION_QOS = 5; 1148 public static final int REPLAY_QOS = 6; 1149 public static final int QOS_THRESHOLD = 10; 1150 public static final int ADMIN_QOS = 100; 1151 public static final int HIGH_QOS = 200; 1152 public static final int SYSTEMTABLE_QOS = HIGH_QOS; 1153 public static final int META_QOS = 300; 1154 1155 1156 /** Directory under /hbase where archived hfiles are stored */ 1157 public static final String HFILE_ARCHIVE_DIRECTORY = "archive"; 1158 1159 /** 1160 * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for 1161 * remaining snapshot constants; this is here to keep HConstants dependencies at a minimum and 1162 * uni-directional. 1163 */ 1164 public static final String SNAPSHOT_DIR_NAME = ".hbase-snapshot"; 1165 1166 /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */ 1167 public static final String OLD_SNAPSHOT_DIR_NAME = ".snapshot"; 1168 1169 /** Temporary directory used for table creation and deletion */ 1170 public static final String HBASE_TEMP_DIRECTORY = ".tmp"; 1171 /** 1172 * The period (in milliseconds) between computing region server point in time metrics 1173 */ 1174 public static final String REGIONSERVER_METRICS_PERIOD = "hbase.regionserver.metrics.period"; 1175 public static final long DEFAULT_REGIONSERVER_METRICS_PERIOD = 5000; 1176 /** Directories that are not HBase table directories */ 1177 public static final List<String> HBASE_NON_TABLE_DIRS = 1178 Collections.unmodifiableList(Arrays.asList(new String[] { 1179 HBCK_SIDELINEDIR_NAME, HBASE_TEMP_DIRECTORY, MIGRATION_NAME 1180 })); 1181 1182 /** Directories that are not HBase user table directories */ 1183 public static final List<String> HBASE_NON_USER_TABLE_DIRS = 1184 Collections.unmodifiableList(Arrays.asList((String[])ArrayUtils.addAll( 1185 new String[] { TableName.META_TABLE_NAME.getNameAsString() }, 1186 HBASE_NON_TABLE_DIRS.toArray()))); 1187 1188 /** Health script related settings. */ 1189 public static final String HEALTH_SCRIPT_LOC = "hbase.node.health.script.location"; 1190 public static final String HEALTH_SCRIPT_TIMEOUT = "hbase.node.health.script.timeout"; 1191 public static final String HEALTH_CHORE_WAKE_FREQ = 1192 "hbase.node.health.script.frequency"; 1193 public static final long DEFAULT_HEALTH_SCRIPT_TIMEOUT = 60000; 1194 /** 1195 * The maximum number of health check failures a server can encounter consecutively. 1196 */ 1197 public static final String HEALTH_FAILURE_THRESHOLD = 1198 "hbase.node.health.failure.threshold"; 1199 public static final int DEFAULT_HEALTH_FAILURE_THRESHOLD = 3; 1200 1201 1202 /** 1203 * Setting to activate, or not, the publication of the status by the master. Default 1204 * notification is by a multicast message. 1205 */ 1206 public static final String STATUS_PUBLISHED = "hbase.status.published"; 1207 public static final boolean STATUS_PUBLISHED_DEFAULT = false; 1208 1209 /** 1210 * IP to use for the multicast status messages between the master and the clients. 1211 * The default address is chosen as one among others within the ones suitable for multicast 1212 * messages. 1213 */ 1214 public static final String STATUS_MULTICAST_ADDRESS = "hbase.status.multicast.address.ip"; 1215 public static final String DEFAULT_STATUS_MULTICAST_ADDRESS = "226.1.1.3"; 1216 1217 /** 1218 * The address to use for binding the local socket for receiving multicast. Defaults to 1219 * 0.0.0.0. 1220 * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a> 1221 */ 1222 public static final String STATUS_MULTICAST_BIND_ADDRESS = 1223 "hbase.status.multicast.bind.address.ip"; 1224 public static final String DEFAULT_STATUS_MULTICAST_BIND_ADDRESS = "0.0.0.0"; 1225 1226 /** 1227 * The port to use for the multicast messages. 1228 */ 1229 public static final String STATUS_MULTICAST_PORT = "hbase.status.multicast.address.port"; 1230 public static final int DEFAULT_STATUS_MULTICAST_PORT = 16100; 1231 1232 /** 1233 * The network interface name to use for the multicast messages. 1234 */ 1235 public static final String STATUS_MULTICAST_NI_NAME = "hbase.status.multicast.ni.name"; 1236 1237 /** 1238 * The address to use for binding the local socket for sending multicast. Defaults to 0.0.0.0. 1239 */ 1240 public static final String STATUS_MULTICAST_PUBLISHER_BIND_ADDRESS = 1241 "hbase.status.multicast.publisher.bind.address.ip"; 1242 public static final String DEFAULT_STATUS_MULTICAST_PUBLISHER_BIND_ADDRESS = "0.0.0.0"; 1243 1244 public static final long NO_NONCE = 0; 1245 1246 /** Default cipher for encryption */ 1247 public static final String CIPHER_AES = "AES"; 1248 1249 /** Configuration key for the crypto algorithm provider, a class name */ 1250 public static final String CRYPTO_CIPHERPROVIDER_CONF_KEY = "hbase.crypto.cipherprovider"; 1251 1252 /** Configuration key for the crypto key provider, a class name */ 1253 public static final String CRYPTO_KEYPROVIDER_CONF_KEY = "hbase.crypto.keyprovider"; 1254 1255 /** Configuration key for the crypto key provider parameters */ 1256 public static final String CRYPTO_KEYPROVIDER_PARAMETERS_KEY = 1257 "hbase.crypto.keyprovider.parameters"; 1258 1259 /** Configuration key for the name of the master key for the cluster, a string */ 1260 public static final String CRYPTO_MASTERKEY_NAME_CONF_KEY = "hbase.crypto.master.key.name"; 1261 1262 /** Configuration key for the name of the alternate master key for the cluster, a string */ 1263 public static final String CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY = 1264 "hbase.crypto.master.alternate.key.name"; 1265 1266 /** Configuration key for the algorithm to use when encrypting the WAL, a string */ 1267 public static final String CRYPTO_WAL_ALGORITHM_CONF_KEY = "hbase.crypto.wal.algorithm"; 1268 1269 /** Configuration key for the name of the master WAL encryption key for the cluster, a string */ 1270 public static final String CRYPTO_WAL_KEY_NAME_CONF_KEY = "hbase.crypto.wal.key.name"; 1271 1272 /** Configuration key for the algorithm used for creating jks key, a string */ 1273 public static final String CRYPTO_KEY_ALGORITHM_CONF_KEY = "hbase.crypto.key.algorithm"; 1274 1275 /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */ 1276 public static final String CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY = 1277 "hbase.crypto.alternate.key.algorithm"; 1278 1279 /** Configuration key for enabling WAL encryption, a boolean */ 1280 public static final String ENABLE_WAL_ENCRYPTION = "hbase.regionserver.wal.encryption"; 1281 1282 /** Configuration key for setting RPC codec class name */ 1283 public static final String RPC_CODEC_CONF_KEY = "hbase.client.rpc.codec"; 1284 1285 /** Configuration key for setting replication codec class name */ 1286 public static final String REPLICATION_CODEC_CONF_KEY = "hbase.replication.rpc.codec"; 1287 1288 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ 1289 public static final String REPLICATION_SOURCE_MAXTHREADS_KEY = 1290 "hbase.replication.source.maxthreads"; 1291 1292 /** Drop edits for tables that been deleted from the replication source and target */ 1293 public static final String REPLICATION_DROP_ON_DELETED_TABLE_KEY = 1294 "hbase.replication.drop.on.deleted.table"; 1295 1296 /** Maximum number of threads used by the replication source for shipping edits to the sinks */ 1297 public static final int REPLICATION_SOURCE_MAXTHREADS_DEFAULT = 10; 1298 1299 /** Configuration key for SplitLog manager timeout */ 1300 public static final String HBASE_SPLITLOG_MANAGER_TIMEOUT = "hbase.splitlog.manager.timeout"; 1301 1302 /** 1303 * Configuration keys for Bucket cache 1304 */ 1305 // TODO moving these bucket cache implementation specific configs to this level is violation of 1306 // encapsulation. But as these has to be referred from hbase-common and bucket cache 1307 // sits in hbase-server, there were no other go! Can we move the cache implementation to 1308 // hbase-common? 1309 1310 /** 1311 * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path 1312 * to the file that will host the file-based cache. See BucketCache#getIOEngineFromName() for 1313 * list of supported ioengine options. 1314 * <p>Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache. 1315 */ 1316 public static final String BUCKET_CACHE_IOENGINE_KEY = "hbase.bucketcache.ioengine"; 1317 1318 /** 1319 * When using bucket cache, this is a float that EITHER represents a percentage of total heap 1320 * memory size to give to the cache (if < 1.0) OR, it is the capacity in 1321 * megabytes of the cache. 1322 */ 1323 public static final String BUCKET_CACHE_SIZE_KEY = "hbase.bucketcache.size"; 1324 1325 /** 1326 * HConstants for fast fail on the client side follow 1327 */ 1328 /** 1329 * Config for enabling/disabling the fast fail mode. 1330 */ 1331 public static final String HBASE_CLIENT_FAST_FAIL_MODE_ENABLED = 1332 "hbase.client.fast.fail.mode.enabled"; 1333 1334 public static final boolean HBASE_CLIENT_ENABLE_FAST_FAIL_MODE_DEFAULT = 1335 false; 1336 1337 public static final String HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS = 1338 "hbase.client.fastfail.threshold"; 1339 1340 public static final long HBASE_CLIENT_FAST_FAIL_THREASHOLD_MS_DEFAULT = 1341 60000; 1342 1343 public static final String HBASE_CLIENT_FAILURE_MAP_CLEANUP_INTERVAL_MS = 1344 "hbase.client.failure.map.cleanup.interval"; 1345 1346 public static final long HBASE_CLIENT_FAILURE_MAP_CLEANUP_INTERVAL_MS_DEFAULT = 1347 600000; 1348 1349 public static final String HBASE_CLIENT_FAST_FAIL_CLEANUP_MS_DURATION_MS = 1350 "hbase.client.fast.fail.cleanup.duration"; 1351 1352 public static final long HBASE_CLIENT_FAST_FAIL_CLEANUP_DURATION_MS_DEFAULT = 1353 600000; 1354 1355 public static final String HBASE_CLIENT_FAST_FAIL_INTERCEPTOR_IMPL = 1356 "hbase.client.fast.fail.interceptor.impl"; 1357 1358 /** Config key for if the server should send backpressure and if the client should listen to 1359 * that backpressure from the server */ 1360 public static final String ENABLE_CLIENT_BACKPRESSURE = "hbase.client.backpressure.enabled"; 1361 public static final boolean DEFAULT_ENABLE_CLIENT_BACKPRESSURE = false; 1362 1363 public static final String HEAP_OCCUPANCY_LOW_WATERMARK_KEY = 1364 "hbase.heap.occupancy.low_water_mark"; 1365 public static final float DEFAULT_HEAP_OCCUPANCY_LOW_WATERMARK = 0.95f; 1366 public static final String HEAP_OCCUPANCY_HIGH_WATERMARK_KEY = 1367 "hbase.heap.occupancy.high_water_mark"; 1368 public static final float DEFAULT_HEAP_OCCUPANCY_HIGH_WATERMARK = 0.98f; 1369 1370 /** 1371 * The max number of threads used for splitting storefiles in parallel during 1372 * the region split process. 1373 */ 1374 public static final String REGION_SPLIT_THREADS_MAX = 1375 "hbase.regionserver.region.split.threads.max"; 1376 1377 /** Canary config keys */ 1378 // TODO: Move these defines to Canary Class 1379 public static final String HBASE_CANARY_WRITE_DATA_TTL_KEY = "hbase.canary.write.data.ttl"; 1380 1381 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_LOWERLIMIT_KEY = 1382 "hbase.canary.write.perserver.regions.lowerLimit"; 1383 1384 public static final String HBASE_CANARY_WRITE_PERSERVER_REGIONS_UPPERLIMIT_KEY = 1385 "hbase.canary.write.perserver.regions.upperLimit"; 1386 1387 public static final String HBASE_CANARY_WRITE_VALUE_SIZE_KEY = "hbase.canary.write.value.size"; 1388 1389 public static final String HBASE_CANARY_WRITE_TABLE_CHECK_PERIOD_KEY = 1390 "hbase.canary.write.table.check.period"; 1391 1392 public static final String HBASE_CANARY_READ_RAW_SCAN_KEY = "hbase.canary.read.raw.enabled"; 1393 1394 /** 1395 * Configuration keys for programmatic JAAS configuration for secured ZK interaction 1396 */ 1397 public static final String ZK_CLIENT_KEYTAB_FILE = "hbase.zookeeper.client.keytab.file"; 1398 public static final String ZK_CLIENT_KERBEROS_PRINCIPAL = 1399 "hbase.zookeeper.client.kerberos.principal"; 1400 public static final String ZK_SERVER_KEYTAB_FILE = "hbase.zookeeper.server.keytab.file"; 1401 public static final String ZK_SERVER_KERBEROS_PRINCIPAL = 1402 "hbase.zookeeper.server.kerberos.principal"; 1403 1404 /** Config key for hbase temporary directory in hdfs */ 1405 public static final String TEMPORARY_FS_DIRECTORY_KEY = "hbase.fs.tmp.dir"; 1406 public static final String DEFAULT_TEMPORARY_HDFS_DIRECTORY = "/user/" 1407 + System.getProperty("user.name") + "/hbase-staging"; 1408 1409 public static final String SNAPSHOT_RESTORE_TAKE_FAILSAFE_SNAPSHOT = 1410 "hbase.snapshot.restore.take.failsafe.snapshot"; 1411 public static final boolean DEFAULT_SNAPSHOT_RESTORE_TAKE_FAILSAFE_SNAPSHOT = true; 1412 1413 public static final String SNAPSHOT_RESTORE_FAILSAFE_NAME = 1414 "hbase.snapshot.restore.failsafe.name"; 1415 public static final String DEFAULT_SNAPSHOT_RESTORE_FAILSAFE_NAME = 1416 "hbase-failsafe-{snapshot.name}-{restore.timestamp}"; 1417 1418 public static final String DEFAULT_LOSSY_COUNTING_ERROR_RATE = 1419 "hbase.util.default.lossycounting.errorrate"; 1420 public static final String NOT_IMPLEMENTED = "Not implemented"; 1421 1422 private HConstants() { 1423 // Can't be instantiated with this ctor. 1424 } 1425}