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