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