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