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