View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase;
19  
20  import static org.apache.hadoop.hbase.io.hfile.BlockType.MAGIC_LENGTH;
21  
22  import java.nio.ByteBuffer;
23  import java.nio.charset.Charset;
24  import java.util.Arrays;
25  import java.util.Collections;
26  import java.util.List;
27  import java.util.UUID;
28  import java.util.regex.Pattern;
29  
30  import org.apache.commons.lang.ArrayUtils;
31  import org.apache.hadoop.hbase.classification.InterfaceAudience;
32  import org.apache.hadoop.hbase.classification.InterfaceStability;
33  import org.apache.hadoop.hbase.util.Bytes;
34  
35  /**
36   * HConstants holds a bunch of HBase-related constants
37   */
38  @InterfaceAudience.Public
39  @InterfaceStability.Stable
40  public final class HConstants {
41    // NOTICE!!!! Please do not add a constants here, unless they are referenced by a lot of classes.
42  
43    //Bytes.UTF8_ENCODING should be updated if this changed
44    /** When we encode strings, we always specify UTF8 encoding */
45    public static final String UTF8_ENCODING = "UTF-8";
46  
47    //Bytes.UTF8_CHARSET should be updated if this changed
48    /** When we encode strings, we always specify UTF8 encoding */
49    public static final Charset UTF8_CHARSET = Charset.forName(UTF8_ENCODING);
50    /**
51     * Default block size for an HFile.
52     */
53    public final static int DEFAULT_BLOCKSIZE = 64 * 1024;
54  
55    /** Used as a magic return value while optimized index key feature enabled(HBASE-7845) */
56    public final static int INDEX_KEY_MAGIC = -2;
57    /*
58       * Name of directory that holds recovered edits written by the wal log
59       * splitting code, one per region
60       */
61    public static final String RECOVERED_EDITS_DIR = "recovered.edits";
62    /**
63     * The first four bytes of Hadoop RPC connections
64     */
65    public static final ByteBuffer RPC_HEADER = ByteBuffer.wrap("HBas".getBytes());
66    public static final byte RPC_CURRENT_VERSION = 0;
67  
68    // HFileBlock constants.
69  
70    /** The size data structures with minor version is 0 */
71    public static final int HFILEBLOCK_HEADER_SIZE_NO_CHECKSUM = MAGIC_LENGTH + 2 * Bytes.SIZEOF_INT
72        + Bytes.SIZEOF_LONG;
73    /** The size of a version 2 HFile block header, minor version 1.
74     * There is a 1 byte checksum type, followed by a 4 byte bytesPerChecksum
75     * followed by another 4 byte value to store sizeofDataOnDisk.
76     */
77    public static final int HFILEBLOCK_HEADER_SIZE = HFILEBLOCK_HEADER_SIZE_NO_CHECKSUM +
78      Bytes.SIZEOF_BYTE + 2 * Bytes.SIZEOF_INT;
79    /** Just an array of bytes of the right size. */
80    public static final byte[] HFILEBLOCK_DUMMY_HEADER = new byte[HFILEBLOCK_HEADER_SIZE];
81  
82    //End HFileBlockConstants.
83  
84    /**
85     * Status codes used for return values of bulk operations.
86     */
87    public enum OperationStatusCode {
88      NOT_RUN,
89      SUCCESS,
90      BAD_FAMILY,
91      SANITY_CHECK_FAILURE,
92      FAILURE;
93    }
94  
95    /** long constant for zero */
96    public static final Long ZERO_L = Long.valueOf(0L);
97    public static final String NINES = "99999999999999";
98    public static final String ZEROES = "00000000000000";
99  
100   // For migration
101 
102   /** name of version file */
103   public static final String VERSION_FILE_NAME = "hbase.version";
104 
105   /**
106    * Current version of file system.
107    * Version 4 supports only one kind of bloom filter.
108    * Version 5 changes versions in catalog table regions.
109    * Version 6 enables blockcaching on catalog tables.
110    * Version 7 introduces hfile -- hbase 0.19 to 0.20..
111    * Version 8 introduces namespace
112    */
113   // public static final String FILE_SYSTEM_VERSION = "6";
114   public static final String FILE_SYSTEM_VERSION = "8";
115 
116   // Configuration parameters
117 
118   //TODO: Is having HBase homed on port 60k OK?
119 
120   /** Cluster is in distributed mode or not */
121   public static final String CLUSTER_DISTRIBUTED = "hbase.cluster.distributed";
122 
123   /** Config for pluggable load balancers */
124   public static final String HBASE_MASTER_LOADBALANCER_CLASS = "hbase.master.loadbalancer.class";
125 
126   /** Cluster is standalone or pseudo-distributed */
127   public static final boolean CLUSTER_IS_LOCAL = false;
128 
129   /** Cluster is fully-distributed */
130   public static final boolean CLUSTER_IS_DISTRIBUTED = true;
131 
132   /** Default value for cluster distributed mode */
133   public static final boolean DEFAULT_CLUSTER_DISTRIBUTED = CLUSTER_IS_LOCAL;
134 
135   /** default host address */
136   public static final String DEFAULT_HOST = "0.0.0.0";
137 
138   /** Parameter name for port master listens on. */
139   public static final String MASTER_PORT = "hbase.master.port";
140 
141   /** default port that the master listens on */
142   public static final int DEFAULT_MASTER_PORT = 60000;
143 
144   /** default port for master web api */
145   public static final int DEFAULT_MASTER_INFOPORT = 60010;
146 
147   /** Configuration key for master web API port */
148   public static final String MASTER_INFO_PORT = "hbase.master.info.port";
149 
150   /** Parameter name for the master type being backup (waits for primary to go inactive). */
151   public static final String MASTER_TYPE_BACKUP = "hbase.master.backup";
152 
153   /** by default every master is a possible primary master unless the conf explicitly overrides it */
154   public static final boolean DEFAULT_MASTER_TYPE_BACKUP = false;
155 
156   /** Name of ZooKeeper quorum configuration parameter. */
157   public static final String ZOOKEEPER_QUORUM = "hbase.zookeeper.quorum";
158 
159   /** Name of ZooKeeper config file in conf/ directory. */
160   public static final String ZOOKEEPER_CONFIG_NAME = "zoo.cfg";
161 
162   /** Common prefix of ZooKeeper configuration properties */
163   public static final String ZK_CFG_PROPERTY_PREFIX =
164       "hbase.zookeeper.property.";
165 
166   public static final int ZK_CFG_PROPERTY_PREFIX_LEN =
167       ZK_CFG_PROPERTY_PREFIX.length();
168 
169   /**
170    * The ZK client port key in the ZK properties map. The name reflects the
171    * fact that this is not an HBase configuration key.
172    */
173   public static final String CLIENT_PORT_STR = "clientPort";
174 
175   /** Parameter name for the client port that the zookeeper listens on */
176   public static final String ZOOKEEPER_CLIENT_PORT =
177       ZK_CFG_PROPERTY_PREFIX + CLIENT_PORT_STR;
178 
179   /** Default client port that the zookeeper listens on */
180   public static final int DEFAULT_ZOOKEPER_CLIENT_PORT = 2181;
181 
182   /** Parameter name for the wait time for the recoverable zookeeper */
183   public static final String ZOOKEEPER_RECOVERABLE_WAITTIME = "hbase.zookeeper.recoverable.waittime";
184 
185   /** Default wait time for the recoverable zookeeper */
186   public static final long DEFAULT_ZOOKEPER_RECOVERABLE_WAITIME = 10000;
187 
188   /** Parameter name for the root dir in ZK for this cluster */
189   public static final String ZOOKEEPER_ZNODE_PARENT = "zookeeper.znode.parent";
190 
191   public static final String DEFAULT_ZOOKEEPER_ZNODE_PARENT = "/hbase";
192 
193   /**
194    * Parameter name for the limit on concurrent client-side zookeeper
195    * connections
196    */
197   public static final String ZOOKEEPER_MAX_CLIENT_CNXNS =
198       ZK_CFG_PROPERTY_PREFIX + "maxClientCnxns";
199 
200   /** Parameter name for the ZK data directory */
201   public static final String ZOOKEEPER_DATA_DIR =
202       ZK_CFG_PROPERTY_PREFIX + "dataDir";
203 
204   /** Parameter name for the ZK tick time */
205   public static final String ZOOKEEPER_TICK_TIME =
206       ZK_CFG_PROPERTY_PREFIX + "tickTime";
207 
208   /** Default limit on concurrent client-side zookeeper connections */
209   public static final int DEFAULT_ZOOKEPER_MAX_CLIENT_CNXNS = 300;
210 
211   /** Configuration key for ZooKeeper session timeout */
212   public static final String ZK_SESSION_TIMEOUT = "zookeeper.session.timeout";
213 
214   /** Default value for ZooKeeper session timeout */
215   public static final int DEFAULT_ZK_SESSION_TIMEOUT = 180 * 1000;
216 
217   /** Configuration key for whether to use ZK.multi */
218   public static final String ZOOKEEPER_USEMULTI = "hbase.zookeeper.useMulti";
219 
220   /** Parameter name for port region server listens on. */
221   public static final String REGIONSERVER_PORT = "hbase.regionserver.port";
222 
223   /** Default port region server listens on. */
224   public static final int DEFAULT_REGIONSERVER_PORT = 60020;
225 
226   /** default port for region server web api */
227   public static final int DEFAULT_REGIONSERVER_INFOPORT = 60030;
228 
229   /** A configuration key for regionserver info port */
230   public static final String REGIONSERVER_INFO_PORT =
231     "hbase.regionserver.info.port";
232 
233   /** A flag that enables automatic selection of regionserver info port */
234   public static final String REGIONSERVER_INFO_PORT_AUTO =
235       REGIONSERVER_INFO_PORT + ".auto";
236 
237   /** Parameter name for what region server implementation to use. */
238   public static final String REGION_SERVER_IMPL= "hbase.regionserver.impl";
239 
240   /** Parameter name for what master implementation to use. */
241   public static final String MASTER_IMPL= "hbase.master.impl";
242 
243   /** Parameter name for what hbase client implementation to use. */
244   public static final String HBASECLIENT_IMPL= "hbase.hbaseclient.impl";
245 
246   /** Parameter name for how often threads should wake up */
247   public static final String THREAD_WAKE_FREQUENCY = "hbase.server.thread.wakefrequency";
248 
249   /** Default value for thread wake frequency */
250   public static final int DEFAULT_THREAD_WAKE_FREQUENCY = 10 * 1000;
251 
252   /** Parameter name for how often we should try to write a version file, before failing */
253   public static final String VERSION_FILE_WRITE_ATTEMPTS = "hbase.server.versionfile.writeattempts";
254 
255   /** Parameter name for how often we should try to write a version file, before failing */
256   public static final int DEFAULT_VERSION_FILE_WRITE_ATTEMPTS = 3;
257 
258   /** Parameter name for how often a region should should perform a major compaction */
259   public static final String MAJOR_COMPACTION_PERIOD = "hbase.hregion.majorcompaction";
260 
261   /** Parameter name for the maximum batch of KVs to be used in flushes and compactions */
262   public static final String COMPACTION_KV_MAX = "hbase.hstore.compaction.kv.max";
263   public static final int COMPACTION_KV_MAX_DEFAULT = 10;
264 
265   /** Parameter name for HBase instance root directory */
266   public static final String HBASE_DIR = "hbase.rootdir";
267 
268   /** Parameter name for HBase client IPC pool type */
269   public static final String HBASE_CLIENT_IPC_POOL_TYPE = "hbase.client.ipc.pool.type";
270 
271   /** Parameter name for HBase client IPC pool size */
272   public static final String HBASE_CLIENT_IPC_POOL_SIZE = "hbase.client.ipc.pool.size";
273 
274   /** Parameter name for HBase client operation timeout, which overrides RPC timeout */
275   public static final String HBASE_CLIENT_OPERATION_TIMEOUT = "hbase.client.operation.timeout";
276 
277   /** Parameter name for HBase client operation timeout, which overrides RPC timeout */
278   public static final String HBASE_CLIENT_META_OPERATION_TIMEOUT =
279     "hbase.client.meta.operation.timeout";
280 
281   /** Default HBase client operation timeout, which is tantamount to a blocking call */
282   public static final int DEFAULT_HBASE_CLIENT_OPERATION_TIMEOUT = Integer.MAX_VALUE;
283 
284   /** Used to construct the name of the log directory for a region server */
285   public static final String HREGION_LOGDIR_NAME = "WALs";
286 
287   /** Used to construct the name of the splitlog directory for a region server */
288   public static final String SPLIT_LOGDIR_NAME = "splitWAL";
289 
290   /** Like the previous, but for old logs that are about to be deleted */
291   public static final String HREGION_OLDLOGDIR_NAME = "oldWALs";
292 
293   public static final String CORRUPT_DIR_NAME = "corrupt";
294 
295   /** Used by HBCK to sideline backup data */
296   public static final String HBCK_SIDELINEDIR_NAME = ".hbck";
297 
298   /** Any artifacts left from migration can be moved here */
299   public static final String MIGRATION_NAME = ".migration";
300 
301   /**
302    * The directory from which co-processor/custom filter jars can be loaded
303    * dynamically by the region servers. This value can be overridden by the
304    * hbase.dynamic.jars.dir config.
305    */
306   public static final String LIB_DIR = "lib";
307 
308   /** Used to construct the name of the compaction directory during compaction */
309   public static final String HREGION_COMPACTIONDIR_NAME = "compaction.dir";
310 
311   /** Conf key for the max file size after which we split the region */
312   public static final String HREGION_MAX_FILESIZE =
313       "hbase.hregion.max.filesize";
314 
315   /** Default maximum file size */
316   public static final long DEFAULT_MAX_FILE_SIZE = 10 * 1024 * 1024 * 1024L;
317 
318   /**
319    * The max number of threads used for opening and closing stores or store
320    * files in parallel
321    */
322   public static final String HSTORE_OPEN_AND_CLOSE_THREADS_MAX =
323     "hbase.hstore.open.and.close.threads.max";
324 
325   /**
326    * The default number for the max number of threads used for opening and
327    * closing stores or store files in parallel
328    */
329   public static final int DEFAULT_HSTORE_OPEN_AND_CLOSE_THREADS_MAX = 1;
330 
331 
332   /** Conf key for the memstore size at which we flush the memstore */
333   public static final String HREGION_MEMSTORE_FLUSH_SIZE =
334       "hbase.hregion.memstore.flush.size";
335 
336   public static final String HREGION_EDITS_REPLAY_SKIP_ERRORS =
337       "hbase.hregion.edits.replay.skip.errors";
338 
339   public static final boolean DEFAULT_HREGION_EDITS_REPLAY_SKIP_ERRORS =
340       false;
341 
342   /** Maximum value length, enforced on KeyValue construction */
343   public static final int MAXIMUM_VALUE_LENGTH = Integer.MAX_VALUE - 1;
344 
345   /** name of the file for unique cluster ID */
346   public static final String CLUSTER_ID_FILE_NAME = "hbase.id";
347 
348   /** Default value for cluster ID */
349   public static final String CLUSTER_ID_DEFAULT = "default-cluster";
350 
351   // Always store the location of the root table's HRegion.
352   // This HRegion is never split.
353 
354   // region name = table + startkey + regionid. This is the row key.
355   // each row in the root and meta tables describes exactly 1 region
356   // Do we ever need to know all the information that we are storing?
357 
358   // Note that the name of the root table starts with "-" and the name of the
359   // meta table starts with "." Why? it's a trick. It turns out that when we
360   // store region names in memory, we use a SortedMap. Since "-" sorts before
361   // "." (and since no other table name can start with either of these
362   // characters, the root region will always be the first entry in such a Map,
363   // followed by all the meta regions (which will be ordered by their starting
364   // row key as well), followed by all user tables. So when the Master is
365   // choosing regions to assign, it will always choose the root region first,
366   // followed by the meta regions, followed by user regions. Since the root
367   // and meta regions always need to be on-line, this ensures that they will
368   // be the first to be reassigned if the server(s) they are being served by
369   // should go down.
370 
371 
372   /** The hbase:meta table's name. */
373   @Deprecated  // for compat from 0.94 -> 0.96.
374   public static final byte[] META_TABLE_NAME = TableName.META_TABLE_NAME.getName();
375 
376   public static final String BASE_NAMESPACE_DIR = "data";
377 
378   /** delimiter used between portions of a region name */
379   public static final int META_ROW_DELIMITER = ',';
380 
381   /** The catalog family as a string*/
382   public static final String CATALOG_FAMILY_STR = "info";
383 
384   /** The catalog family */
385   public static final byte [] CATALOG_FAMILY = Bytes.toBytes(CATALOG_FAMILY_STR);
386 
387   /** The RegionInfo qualifier as a string */
388   public static final String REGIONINFO_QUALIFIER_STR = "regioninfo";
389 
390   /** The regioninfo column qualifier */
391   public static final byte [] REGIONINFO_QUALIFIER = Bytes.toBytes(REGIONINFO_QUALIFIER_STR);
392 
393   /** The server column qualifier */
394   public static final byte [] SERVER_QUALIFIER = Bytes.toBytes("server");
395 
396   /** The startcode column qualifier */
397   public static final byte [] STARTCODE_QUALIFIER = Bytes.toBytes("serverstartcode");
398 
399   /** The open seqnum column qualifier */
400   public static final byte [] SEQNUM_QUALIFIER = Bytes.toBytes("seqnumDuringOpen");
401 
402   /** The state column qualifier */
403   public static final byte [] STATE_QUALIFIER = Bytes.toBytes("state");
404 
405   /**
406    * The serverName column qualifier. Its the server where the region is
407    * transitioning on, while column server is the server where the region is
408    * opened on. They are the same when the region is in state OPEN.
409    */
410   public static final byte [] SERVERNAME_QUALIFIER = Bytes.toBytes("sn");
411 
412   /** The lower-half split region column qualifier */
413   public static final byte [] SPLITA_QUALIFIER = Bytes.toBytes("splitA");
414 
415   /** The upper-half split region column qualifier */
416   public static final byte [] SPLITB_QUALIFIER = Bytes.toBytes("splitB");
417 
418   /** The lower-half merge region column qualifier */
419   public static final byte[] MERGEA_QUALIFIER = Bytes.toBytes("mergeA");
420 
421   /** The upper-half merge region column qualifier */
422   public static final byte[] MERGEB_QUALIFIER = Bytes.toBytes("mergeB");
423 
424   /**
425    * The meta table version column qualifier.
426    * We keep current version of the meta table in this column in <code>-ROOT-</code>
427    * table: i.e. in the 'info:v' column.
428    */
429   public static final byte [] META_VERSION_QUALIFIER = Bytes.toBytes("v");
430 
431   /**
432    * The current version of the meta table.
433    * - pre-hbase 0.92.  There is no META_VERSION column in the root table
434    * in this case. The meta has HTableDescriptor serialized into the HRegionInfo;
435    * - version 0 is 0.92 and 0.94. Meta data has serialized HRegionInfo's using
436    * Writable serialization, and HRegionInfo's does not contain HTableDescriptors.
437    * - version 1 for 0.96+ keeps HRegionInfo data structures, but changes the
438    * byte[] serialization from Writables to Protobuf.
439    * See HRegionInfo.VERSION
440    */
441   public static final short META_VERSION = 1;
442 
443   // Other constants
444 
445   /**
446    * An empty instance.
447    */
448   public static final byte [] EMPTY_BYTE_ARRAY = new byte [0];
449 
450   /**
451    * Used by scanners, etc when they want to start at the beginning of a region
452    */
453   public static final byte [] EMPTY_START_ROW = EMPTY_BYTE_ARRAY;
454 
455   /**
456    * Last row in a table.
457    */
458   public static final byte [] EMPTY_END_ROW = EMPTY_START_ROW;
459 
460   /**
461     * Used by scanners and others when they're trying to detect the end of a
462     * table
463     */
464   public static final byte [] LAST_ROW = EMPTY_BYTE_ARRAY;
465 
466   /**
467    * Max length a row can have because of the limitation in TFile.
468    */
469   public static final int MAX_ROW_LENGTH = Short.MAX_VALUE;
470 
471   /**
472    * Timestamp to use when we want to refer to the latest cell.
473    * This is the timestamp sent by clients when no timestamp is specified on
474    * commit.
475    */
476   public static final long LATEST_TIMESTAMP = Long.MAX_VALUE;
477 
478   /**
479    * Timestamp to use when we want to refer to the oldest cell.
480    */
481   public static final long OLDEST_TIMESTAMP = Long.MIN_VALUE;
482 
483   /**
484    * LATEST_TIMESTAMP in bytes form
485    */
486   public static final byte [] LATEST_TIMESTAMP_BYTES = {
487     // big-endian
488     (byte) (LATEST_TIMESTAMP >>> 56),
489     (byte) (LATEST_TIMESTAMP >>> 48),
490     (byte) (LATEST_TIMESTAMP >>> 40),
491     (byte) (LATEST_TIMESTAMP >>> 32),
492     (byte) (LATEST_TIMESTAMP >>> 24),
493     (byte) (LATEST_TIMESTAMP >>> 16),
494     (byte) (LATEST_TIMESTAMP >>> 8),
495     (byte) LATEST_TIMESTAMP,
496   };
497 
498   /**
499    * Define for 'return-all-versions'.
500    */
501   public static final int ALL_VERSIONS = Integer.MAX_VALUE;
502 
503   /**
504    * Unlimited time-to-live.
505    */
506 //  public static final int FOREVER = -1;
507   public static final int FOREVER = Integer.MAX_VALUE;
508 
509   /**
510    * Seconds in a week
511    */
512   public static final int WEEK_IN_SECONDS = 7 * 24 * 3600;
513 
514   /**
515    * Seconds in a day, hour and minute
516    */
517   public static final int DAY_IN_SECONDS = 24 * 60 * 60;
518   public static final int HOUR_IN_SECONDS = 60 * 60;
519   public static final int MINUTE_IN_SECONDS = 60;
520 
521   //TODO: although the following are referenced widely to format strings for
522   //      the shell. They really aren't a part of the public API. It would be
523   //      nice if we could put them somewhere where they did not need to be
524   //      public. They could have package visibility
525   public static final String NAME = "NAME";
526   public static final String VERSIONS = "VERSIONS";
527   public static final String IN_MEMORY = "IN_MEMORY";
528   public static final String METADATA = "METADATA";
529   public static final String CONFIGURATION = "CONFIGURATION";
530 
531   /**
532    * Retrying we multiply hbase.client.pause setting by what we have in this array until we
533    * run out of array items.  Retries beyond this use the last number in the array.  So, for
534    * example, if hbase.client.pause is 1 second, and maximum retries count
535    * hbase.client.retries.number is 10, we will retry at the following intervals:
536    * 1, 2, 3, 5, 10, 20, 40, 100, 100, 100.
537    * With 100ms, a back-off of 200 means 20s
538    */
539   public static final int RETRY_BACKOFF[] = {1, 2, 3, 5, 10, 20, 40, 100, 100, 100, 100, 200, 200};
540 
541   public static final String REGION_IMPL = "hbase.hregion.impl";
542 
543   /** modifyTable op for replacing the table descriptor */
544   public static enum Modify {
545     CLOSE_REGION,
546     TABLE_COMPACT,
547     TABLE_FLUSH,
548     TABLE_MAJOR_COMPACT,
549     TABLE_SET_HTD,
550     TABLE_SPLIT
551   }
552 
553   /**
554    * Scope tag for locally scoped data.
555    * This data will not be replicated.
556    */
557   public static final int REPLICATION_SCOPE_LOCAL = 0;
558 
559   /**
560    * Scope tag for globally scoped data.
561    * This data will be replicated to all peers.
562    */
563   public static final int REPLICATION_SCOPE_GLOBAL = 1;
564 
565   /**
566    * Default cluster ID, cannot be used to identify a cluster so a key with
567    * this value means it wasn't meant for replication.
568    */
569   public static final UUID DEFAULT_CLUSTER_ID = new UUID(0L,0L);
570 
571     /**
572      * Parameter name for maximum number of bytes returned when calling a
573      * scanner's next method.
574      */
575   public static final String HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY =
576       "hbase.client.scanner.max.result.size";
577 
578   /**
579    * Parameter name for maximum number of bytes returned when calling a scanner's next method.
580    * Controlled by the server.
581    */
582   public static final String HBASE_SERVER_SCANNER_MAX_RESULT_SIZE_KEY =
583       "hbase.server.scanner.max.result.size";
584 
585   /**
586    * Maximum number of bytes returned when calling a scanner's next method.
587    * Note that when a single row is larger than this limit the row is still
588    * returned completely.
589    *
590    * The default value is 2MB.
591    */
592   public static final long DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE = 2 * 1024 * 1024;
593 
594   /**
595    * Maximum number of bytes returned when calling a scanner's next method.
596    * Note that when a single row is larger than this limit the row is still
597    * returned completely.
598    * Safety setting to protect the region server.
599    *
600    * The default value unlimited for backwards compatibility
601    */
602   public static final long DEFAULT_HBASE_SERVER_SCANNER_MAX_RESULT_SIZE = Long.MAX_VALUE;
603 
604   /**
605    * Parameter name for client pause value, used mostly as value to wait
606    * before running a retry of a failed get, region lookup, etc.
607    */
608   public static final String HBASE_CLIENT_PAUSE = "hbase.client.pause";
609 
610   /**
611    * Default value of {@link #HBASE_CLIENT_PAUSE}.
612    */
613   public static final long DEFAULT_HBASE_CLIENT_PAUSE = 100;
614 
615   /**
616    * The maximum number of concurrent connections the client will maintain.
617    */
618   public static final String HBASE_CLIENT_MAX_TOTAL_TASKS = "hbase.client.max.total.tasks";
619 
620   /**
621    * Default value of {@link #HBASE_CLIENT_MAX_TOTAL_TASKS}.
622    */
623   public static final int DEFAULT_HBASE_CLIENT_MAX_TOTAL_TASKS = 100;
624 
625   /**
626    * The maximum number of concurrent connections the client will maintain to a single
627    * RegionServer.
628    */
629   public static final String HBASE_CLIENT_MAX_PERSERVER_TASKS = "hbase.client.max.perserver.tasks";
630 
631   /**
632    * Default value of {@link #HBASE_CLIENT_MAX_PERSERVER_TASKS}.
633    */
634   public static final int DEFAULT_HBASE_CLIENT_MAX_PERSERVER_TASKS = 2;
635 
636   /**
637    * The maximum number of concurrent connections the client will maintain to a single
638    * Region.
639    */
640   public static final String HBASE_CLIENT_MAX_PERREGION_TASKS = "hbase.client.max.perregion.tasks";
641 
642   /**
643    * Default value of {@link #HBASE_CLIENT_MAX_PERREGION_TASKS}.
644    */
645   public static final int DEFAULT_HBASE_CLIENT_MAX_PERREGION_TASKS = 1;
646 
647   /**
648    * Parameter name for server pause value, used mostly as value to wait before
649    * running a retry of a failed operation.
650    */
651   public static final String HBASE_SERVER_PAUSE = "hbase.server.pause";
652 
653   /**
654    * Default value of {@link #HBASE_SERVER_PAUSE}.
655    */
656   public static final int DEFAULT_HBASE_SERVER_PAUSE = 1000;
657 
658   /**
659    * Parameter name for maximum retries, used as maximum for all retryable
660    * operations such as fetching of the root region from root region server,
661    * getting a cell's value, starting a row update, etc.
662    */
663   public static final String HBASE_CLIENT_RETRIES_NUMBER = "hbase.client.retries.number";
664 
665   /**
666    * Default value of {@link #HBASE_CLIENT_RETRIES_NUMBER}.
667    */
668   public static final int DEFAULT_HBASE_CLIENT_RETRIES_NUMBER = 31;
669 
670   /**
671    * Parameter name for client region location prefetch toggle.
672    */
673   public static String HBASE_CLIENT_PREFETCH = "hbase.client.prefetch";
674 
675   /**
676    * Default value of {@link #HBASE_CLIENT_PREFETCH}.
677    */
678   public static boolean DEFAULT_HBASE_CLIENT_PREFETCH = true;
679 
680   /**
681    * Parameter name for client prefetch limit, used as the maximum number of regions
682    * info that will be prefetched.
683    */
684   public static String HBASE_CLIENT_PREFETCH_LIMIT = "hbase.client.prefetch.limit";
685 
686   /**
687    * Default value of {@link #HBASE_CLIENT_PREFETCH_LIMIT}.
688    */
689   public static int DEFAULT_HBASE_CLIENT_PREFETCH_LIMIT = 10;
690 
691   /**
692    * Parameter name to set the default scanner caching for all clients.
693    */
694   public static final String HBASE_CLIENT_SCANNER_CACHING = "hbase.client.scanner.caching";
695 
696   /**
697    * Default value for {@link #HBASE_CLIENT_SCANNER_CACHING}
698    */
699   public static final int DEFAULT_HBASE_CLIENT_SCANNER_CACHING = 100;
700 
701   /**
702    * Parameter name for number of versions, kept by meta table.
703    */
704   public static String HBASE_META_VERSIONS = "hbase.meta.versions";
705 
706   /**
707    * Default value of {@link #HBASE_META_VERSIONS}.
708    */
709   public static int DEFAULT_HBASE_META_VERSIONS = 10;
710 
711   /**
712    * Parameter name for number of versions, kept by meta table.
713    */
714   public static String HBASE_META_BLOCK_SIZE = "hbase.meta.blocksize";
715 
716   /**
717    * Default value of {@link #HBASE_META_BLOCK_SIZE}.
718    */
719   public static int DEFAULT_HBASE_META_BLOCK_SIZE = 8 * 1024;
720 
721   /**
722    * Parameter name for number of rows that will be fetched when calling next on
723    * a scanner if it is not served from memory. Higher caching values will
724    * enable faster scanners but will eat up more memory and some calls of next
725    * may take longer and longer times when the cache is empty.
726    */
727   public static final String HBASE_META_SCANNER_CACHING = "hbase.meta.scanner.caching";
728 
729   /**
730    * Default value of {@link #HBASE_META_SCANNER_CACHING}.
731    */
732   public static final int DEFAULT_HBASE_META_SCANNER_CACHING = 100;
733 
734   /**
735    * Parameter name for unique identifier for this {@link org.apache.hadoop.conf.Configuration}
736    * instance. If there are two or more {@link org.apache.hadoop.conf.Configuration} instances that,
737    * for all intents and purposes, are the same except for their instance ids, then they will not be
738    * able to share the same org.apache.hadoop.hbase.client.HConnection instance. On the other hand,
739    * even if the instance ids are the same, it could result in non-shared
740    * org.apache.hadoop.hbase.client.HConnection instances if some of the other connection parameters
741    * differ.
742    */
743   public static final String HBASE_CLIENT_INSTANCE_ID = "hbase.client.instance.id";
744 
745   /**
746    * The client scanner timeout period in milliseconds.
747    */
748   public static final String HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = "hbase.client.scanner.timeout.period";
749 
750   /**
751    * Use {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD} instead.
752    * @deprecated This config option is deprecated. Will be removed at later releases after 0.96.
753    */
754   @Deprecated
755   public static final String HBASE_REGIONSERVER_LEASE_PERIOD_KEY =
756       "hbase.regionserver.lease.period";
757 
758   /**
759    * Default value of {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD}.
760    */
761   public static final int DEFAULT_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = 60000;
762 
763   /**
764    * timeout for each RPC
765    */
766   public static final String HBASE_RPC_TIMEOUT_KEY = "hbase.rpc.timeout";
767 
768   /**
769    * Default value of {@link #HBASE_RPC_TIMEOUT_KEY}
770    */
771   public static final int DEFAULT_HBASE_RPC_TIMEOUT = 60000;
772 
773   /**
774    * timeout for short operation RPC
775    */
776   public static final String HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY = "hbase.rpc.shortoperation.timeout";
777 
778   /**
779    * Default value of {@link #HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY}
780    */
781   public static final int DEFAULT_HBASE_RPC_SHORTOPERATION_TIMEOUT = 10000;
782 
783   /**
784    * Value indicating the server name was saved with no sequence number.
785    */
786   public static final long NO_SEQNUM = -1;
787 
788 
789   /*
790    * cluster replication constants.
791    */
792   public static final String
793       REPLICATION_ENABLE_KEY = "hbase.replication";
794   public static final boolean
795       REPLICATION_ENABLE_DEFAULT = true;
796   public static final String
797       REPLICATION_SOURCE_SERVICE_CLASSNAME = "hbase.replication.source.service";
798   public static final String
799       REPLICATION_SINK_SERVICE_CLASSNAME = "hbase.replication.sink.service";
800   public static final String REPLICATION_SERVICE_CLASSNAME_DEFAULT =
801     "org.apache.hadoop.hbase.replication.regionserver.Replication";
802 
803   /** HBCK special code name used as server name when manipulating ZK nodes */
804   public static final String HBCK_CODE_NAME = "HBCKServerName";
805 
806   public static final String KEY_FOR_HOSTNAME_SEEN_BY_MASTER =
807     "hbase.regionserver.hostname.seen.by.master";
808 
809   public static final String HBASE_MASTER_LOGCLEANER_PLUGINS =
810       "hbase.master.logcleaner.plugins";
811 
812   public static final String HBASE_REGION_SPLIT_POLICY_KEY =
813     "hbase.regionserver.region.split.policy";
814 
815   /** Whether nonces are enabled; default is true. */
816   public static final String HBASE_RS_NONCES_ENABLED = "hbase.regionserver.nonces.enabled";
817 
818   /**
819    * Configuration key for the size of the block cache
820    */
821   public static final String HFILE_BLOCK_CACHE_SIZE_KEY =
822     "hfile.block.cache.size";
823 
824   public static final float HFILE_BLOCK_CACHE_SIZE_DEFAULT = 0.25f;
825 
826   /*
827     * Minimum percentage of free heap necessary for a successful cluster startup.
828     */
829   public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD = 0.2f;
830 
831   public static final Pattern CP_HTD_ATTR_KEY_PATTERN = Pattern.compile
832       ("^coprocessor\\$([0-9]+)$", Pattern.CASE_INSENSITIVE);
833   public static final Pattern CP_HTD_ATTR_VALUE_PATTERN =
834       Pattern.compile("(^[^\\|]*)\\|([^\\|]+)\\|[\\s]*([\\d]*)[\\s]*(\\|.*)?$");
835 
836   public static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN = "[^=,]+";
837   public static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN = "[^,]+";
838   public static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN = Pattern.compile(
839       "(" + CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN + ")=(" +
840       CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN + "),?");
841 
842   /** The delay when re-trying a socket operation in a loop (HBASE-4712) */
843   public static final int SOCKET_RETRY_WAIT_MS = 200;
844 
845   /** Host name of the local machine */
846   public static final String LOCALHOST = "localhost";
847 
848   /**
849    * If this parameter is set to true, then hbase will read
850    * data and then verify checksums. Checksum verification
851    * inside hdfs will be switched off.  However, if the hbase-checksum
852    * verification fails, then it will switch back to using
853    * hdfs checksums for verifiying data that is being read from storage.
854    *
855    * If this parameter is set to false, then hbase will not
856    * verify any checksums, instead it will depend on checksum verification
857    * being done in the hdfs client.
858    */
859   public static final String HBASE_CHECKSUM_VERIFICATION =
860       "hbase.regionserver.checksum.verify";
861 
862   public static final String LOCALHOST_IP = "127.0.0.1";
863 
864   /** Conf key that enables unflushed WAL edits directly being replayed to region servers */
865   public static final String DISTRIBUTED_LOG_REPLAY_KEY = "hbase.master.distributed.log.replay";
866   public static final boolean DEFAULT_DISTRIBUTED_LOG_REPLAY_CONFIG = false;
867   public static final String DISALLOW_WRITES_IN_RECOVERING =
868       "hbase.regionserver.disallow.writes.when.recovering";
869   public static final boolean DEFAULT_DISALLOW_WRITES_IN_RECOVERING_CONFIG = false;
870 
871   public static final String REGION_SERVER_HANDLER_COUNT = "hbase.regionserver.handler.count";
872   public static final int DEFAULT_REGION_SERVER_HANDLER_COUNT = 30;
873 
874   /*
875    * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT:
876    * -1  => Disable aborting
877    * 0   => Abort if even a single handler has died
878    * 0.x => Abort only when this percent of handlers have died
879    * 1   => Abort only all of the handers have died
880    */
881   public static final String REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT =
882       "hbase.regionserver.handler.abort.on.error.percent";
883   public static final float DEFAULT_REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT = -1;
884   
885   public static final String REGION_SERVER_META_HANDLER_COUNT =
886       "hbase.regionserver.metahandler.count";
887   public static final int DEFAULT_REGION_SERVER_META_HANDLER_COUNT = 10;
888 
889   public static final String REGION_SERVER_REPLICATION_HANDLER_COUNT =
890       "hbase.regionserver.replication.handler.count";
891   public static final int DEFAULT_REGION_SERVER_REPLICATION_HANDLER_COUNT = 3;
892 
893   public static final String MASTER_HANDLER_COUNT = "hbase.master.handler.count";
894   public static final int DEFAULT_MASTER_HANLDER_COUNT = 25;
895 
896   /** Conf key that specifies timeout value to wait for a region ready */
897   public static final String LOG_REPLAY_WAIT_REGION_TIMEOUT =
898       "hbase.master.log.replay.wait.region.timeout";
899 
900   /**
901    * The name of the configuration parameter that specifies
902    * the number of bytes in a newly created checksum chunk.
903    */
904   public static final String BYTES_PER_CHECKSUM =
905       "hbase.hstore.bytes.per.checksum";
906 
907   /**
908    * The name of the configuration parameter that specifies
909    * the name of an algorithm that is used to compute checksums
910    * for newly created blocks.
911    */
912   public static final String CHECKSUM_TYPE_NAME =
913       "hbase.hstore.checksum.algorithm";
914 
915   /** Enable file permission modification from standard hbase */
916   public static final String ENABLE_DATA_FILE_UMASK = "hbase.data.umask.enable";
917   /** File permission umask to use when creating hbase data files */
918   public static final String DATA_FILE_UMASK_KEY = "hbase.data.umask";
919 
920   /** Configuration name of HLog Compression */
921   public static final String ENABLE_WAL_COMPRESSION =
922     "hbase.regionserver.wal.enablecompression";
923 
924   /** Region in Transition metrics threshold time */
925   public static final String METRICS_RIT_STUCK_WARNING_THRESHOLD="hbase.metrics.rit.stuck.warning.threshold";
926 
927   public static final String LOAD_BALANCER_SLOP_KEY = "hbase.regions.slop";
928 
929   /**
930    * The byte array represents for NO_NEXT_INDEXED_KEY;
931    * The actual value is irrelevant because this is always compared by reference.
932    */
933   public static final byte [] NO_NEXT_INDEXED_KEY = Bytes.toBytes("NO_NEXT_INDEXED_KEY");
934   /** delimiter used between portions of a region name */
935   public static final int DELIMITER = ',';
936   public static final String HBASE_CONFIG_READ_ZOOKEEPER_CONFIG =
937       "hbase.config.read.zookeeper.config";
938   public static final boolean DEFAULT_HBASE_CONFIG_READ_ZOOKEEPER_CONFIG =
939       false;
940 
941   /**
942    * QOS attributes: these attributes are used to demarcate RPC call processing
943    * by different set of handlers. For example, HIGH_QOS tagged methods are
944    * handled by high priority handlers.
945    */
946   public static final int NORMAL_QOS = 0;
947   public static final int QOS_THRESHOLD = 10;
948   public static final int HIGH_QOS = 100;
949   public static final int REPLICATION_QOS = 5; // normal_QOS < replication_QOS < high_QOS
950   public static final int REPLAY_QOS = 6; // REPLICATION_QOS < REPLAY_QOS < high_QOS
951 
952   /** Directory under /hbase where archived hfiles are stored */
953   public static final String HFILE_ARCHIVE_DIRECTORY = "archive";
954 
955   /**
956    * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for
957    * remaining snapshot constants; this is here to keep HConstants dependencies at a minimum and
958    * uni-directional.
959    */
960   public static final String SNAPSHOT_DIR_NAME = ".hbase-snapshot";
961 
962   /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */
963   public static final String OLD_SNAPSHOT_DIR_NAME = ".snapshot";
964 
965   /** Temporary directory used for table creation and deletion */
966   public static final String HBASE_TEMP_DIRECTORY = ".tmp";
967   /**
968    * The period (in milliseconds) between computing region server point in time metrics
969    */
970   public static final String REGIONSERVER_METRICS_PERIOD = "hbase.regionserver.metrics.period";
971   public static final long DEFAULT_REGIONSERVER_METRICS_PERIOD = 5000;
972   /** Directories that are not HBase table directories */
973   public static final List<String> HBASE_NON_TABLE_DIRS =
974     Collections.unmodifiableList(Arrays.asList(new String[] {
975       HBCK_SIDELINEDIR_NAME, HBASE_TEMP_DIRECTORY, MIGRATION_NAME
976     }));
977 
978   /** Directories that are not HBase user table directories */
979   public static final List<String> HBASE_NON_USER_TABLE_DIRS =
980     Collections.unmodifiableList(Arrays.asList((String[])ArrayUtils.addAll(
981       new String[] { TableName.META_TABLE_NAME.getNameAsString() },
982       HBASE_NON_TABLE_DIRS.toArray())));
983 
984   /** Health script related settings. */
985   public static final String HEALTH_SCRIPT_LOC = "hbase.node.health.script.location";
986   public static final String HEALTH_SCRIPT_TIMEOUT = "hbase.node.health.script.timeout";
987   public static final String HEALTH_CHORE_WAKE_FREQ =
988       "hbase.node.health.script.frequency";
989   public static final long DEFAULT_HEALTH_SCRIPT_TIMEOUT = 60000;
990   /**
991    * The maximum number of health check failures a server can encounter consecutively.
992    */
993   public static final String HEALTH_FAILURE_THRESHOLD =
994       "hbase.node.health.failure.threshold";
995   public static final int DEFAULT_HEALTH_FAILURE_THRESHOLD = 3;
996 
997 
998   /**
999    * Setting to activate, or not, the publication of the status by the master. Default
1000    *  notification is by a multicast message.
1001    */
1002   public static final String STATUS_PUBLISHED = "hbase.status.published";
1003   public static final boolean STATUS_PUBLISHED_DEFAULT = false;
1004 
1005   /**
1006    * IP to use for the multicast status messages between the master and the clients.
1007    * The default address is chosen as one among others within the ones suitable for multicast
1008    * messages.
1009    */
1010   public static final String STATUS_MULTICAST_ADDRESS = "hbase.status.multicast.address.ip";
1011   public static final String DEFAULT_STATUS_MULTICAST_ADDRESS = "226.1.1.3";
1012 
1013   /**
1014    * The address to use for binding the local socket for receiving multicast. Defaults to
1015    * 0.0.0.0.
1016    * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a>
1017    */
1018   public static final String STATUS_MULTICAST_BIND_ADDRESS = "hbase.status.multicast.bind.address.ip";
1019   public static final String DEFAULT_STATUS_MULTICAST_BIND_ADDRESS = "0.0.0.0";
1020 
1021   /**
1022    * The port to use for the multicast messages.
1023    */
1024   public static final String STATUS_MULTICAST_PORT = "hbase.status.multicast.address.port";
1025   public static final int DEFAULT_STATUS_MULTICAST_PORT = 60100;
1026 
1027   public static final long NO_NONCE = 0;
1028 
1029   /** Default cipher for encryption */
1030   public static final String CIPHER_AES = "AES";
1031 
1032   /** Configuration key for the crypto algorithm provider, a class name */
1033   @InterfaceStability.Unstable
1034   public static final String CRYPTO_CIPHERPROVIDER_CONF_KEY = "hbase.crypto.cipherprovider";
1035 
1036   /** Configuration key for the crypto key provider, a class name */
1037   @InterfaceStability.Unstable
1038   public static final String CRYPTO_KEYPROVIDER_CONF_KEY = "hbase.crypto.keyprovider";
1039 
1040   /** Configuration key for the crypto key provider parameters */
1041   @InterfaceStability.Unstable
1042   public static final String CRYPTO_KEYPROVIDER_PARAMETERS_KEY =
1043       "hbase.crypto.keyprovider.parameters";
1044 
1045   /** Configuration key for the name of the master key for the cluster, a string */
1046   @InterfaceStability.Unstable
1047   public static final String CRYPTO_MASTERKEY_NAME_CONF_KEY = "hbase.crypto.master.key.name";
1048 
1049   /** Configuration key for the name of the alternate master key for the cluster, a string */
1050   @InterfaceStability.Unstable
1051   public static final String CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY =
1052     "hbase.crypto.master.alternate.key.name";
1053 
1054   /** Configuration key for the algorithm to use when encrypting the WAL, a string */
1055   @InterfaceStability.Unstable
1056   public static final String CRYPTO_WAL_ALGORITHM_CONF_KEY = "hbase.crypto.wal.algorithm";
1057 
1058   /** Configuration key for the name of the master WAL encryption key for the cluster, a string */
1059   @InterfaceStability.Unstable
1060   public static final String CRYPTO_WAL_KEY_NAME_CONF_KEY = "hbase.crypto.wal.key.name";
1061 
1062   /** Configuration key for the algorithm used for creating jks key, a string */
1063   public static final String CRYPTO_KEY_ALGORITHM_CONF_KEY = "hbase.crypto.key.algorithm";
1064 
1065   /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */
1066   public static final String CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY =
1067       "hbase.crypto.alternate.key.algorithm";
1068 
1069   /** Configuration key for enabling WAL encryption, a boolean */
1070   public static final String ENABLE_WAL_ENCRYPTION = "hbase.regionserver.wal.encryption";
1071 
1072   /** Configuration key for setting RPC codec class name */
1073   public static final String RPC_CODEC_CONF_KEY = "hbase.client.rpc.codec";
1074 
1075   /** Configuration key for setting replication codec class name */
1076   public static final String REPLICATION_CODEC_CONF_KEY = "hbase.replication.rpc.codec";
1077 
1078   /** Config key for if the server should send backpressure and if the client should listen to
1079    * that backpressure from the server */
1080   public static final String ENABLE_CLIENT_BACKPRESSURE = "hbase.client.backpressure.enabled";
1081   public static final boolean DEFAULT_ENABLE_CLIENT_BACKPRESSURE = false;
1082 
1083   public static final String HEAP_OCCUPANCY_LOW_WATERMARK_KEY =
1084       "hbase.heap.occupancy.low_water_mark";
1085   public static final float DEFAULT_HEAP_OCCUPANCY_LOW_WATERMARK = 0.95f;
1086   public static final String HEAP_OCCUPANCY_HIGH_WATERMARK_KEY =
1087       "hbase.heap.occupancy.high_water_mark";
1088   public static final float DEFAULT_HEAP_OCCUPANCY_HIGH_WATERMARK = 0.98f;
1089 
1090   private HConstants() {
1091     // Can't be instantiated with this ctor.
1092   }
1093 }