| blob | d518d217ba3b91610004c7413110145930d9472a |
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 */
32 /**
33 * HConstants holds a bunch of HBase-related constants
34 */
37 // NOTICE!!!! Please do not add a constants here, unless they are referenced by a lot of classes.
39 //Bytes.UTF8_ENCODING should be updated if this changed
40 /** When we encode strings, we always specify UTF8 encoding */
43 //Bytes.UTF8_CHARSET should be updated if this changed
44 /** When we encode strings, we always specify UTF8 encoding */
46 /**
47 * Default block size for an HFile.
48 */
51 /** Used as a magic return value while optimized index key feature enabled(HBASE-7845) */
54 /*
55 * Name of directory that holds recovered edits written by the wal log
56 * splitting code, one per region
57 */
60 /*
61 * Name of directory that holds recovered hfiles written by the wal log
62 * splitting code, one per region
63 */
66 /**
67 * The first four bytes of Hadoop RPC connections
68 */
72 // HFileBlock constants. TODO!!!! THESE DEFINES BELONG IN HFILEBLOCK, NOT UP HERE.
73 // Needed down in hbase-common though by encoders but these encoders should not be dealing
74 // in the internals of hfileblocks. Fix encapsulation.
76 /** The size data structures with minor version is 0 */
79 /** The size of a version 2 HFile block header, minor version 1.
80 * There is a 1 byte checksum type, followed by a 4 byte bytesPerChecksum
81 * followed by another 4 byte value to store sizeofDataOnDisk.
82 */
85 /** Just an array of bytes of the right size. */
88 //End HFileBlockConstants.
90 /**
91 * Status codes used for return values of bulk operations.
92 */
95 NOT_RUN,
96 SUCCESS,
97 BAD_FAMILY,
98 STORE_TOO_BUSY,
99 SANITY_CHECK_FAILURE,
100 FAILURE
101 }
103 /** long constant for zero */
108 // For migration
110 /** name of version file */
113 /**
114 * Current version of file system.
115 * Version 4 supports only one kind of bloom filter.
116 * Version 5 changes versions in catalog table regions.
117 * Version 6 enables blockcaching on catalog tables.
118 * Version 7 introduces hfile -- hbase 0.19 to 0.20..
119 * Version 8 introduces namespace
120 */
121 // public static final String FILE_SYSTEM_VERSION = "6";
124 // Configuration parameters
126 //TODO: Is having HBase homed on port 60k OK?
128 /** Cluster is in distributed mode or not */
131 /** Config for pluggable load balancers */
134 /** Config for balancing the cluster by table */
135 public static final String HBASE_MASTER_LOADBALANCE_BYTABLE = "hbase.master.loadbalance.bytable";
137 /** Config for the max percent of regions in transition */
141 /** Default value for the max percent of regions in transition */
144 /** Config for the max balancing time */
147 /** Config for the balancer period */
150 /** Default value for the balancer period */
153 /** The name of the ensemble table */
156 /** Config for pluggable region normalizer */
160 /** Cluster is standalone or pseudo-distributed */
163 /** Default value for cluster distributed mode */
166 /** default host address */
169 /** Parameter name for port master listens on. */
172 /** default port that the master listens on */
175 /** default port for master web api */
178 /** Configuration key for master web API port */
181 /** Configuration key for the list of master host:ports **/
184 /** Full class name of the Zookeeper based connection registry implementation */
188 /** Configuration to enable hedged reads on master registry **/
192 /** Default value for enabling hedging reads on master registry **/
195 /** Parameter name for the master type being backup (waits for primary to go inactive). */
198 /**
199 * by default every master is a possible primary master unless the conf explicitly overrides it
200 */
203 /** Name of ZooKeeper quorum configuration parameter. */
206 /** Name of ZooKeeper quorum configuration parameter for client to locate meta. */
209 /** Client port of ZooKeeper for client to locate meta */
213 /** Indicate whether the client ZK are observer nodes of the server ZK */
216 /** Assuming client zk not in observer mode and master need to synchronize information */
219 /** Common prefix of ZooKeeper configuration properties */
226 /**
227 * The ZK client port key in the ZK properties map. The name reflects the
228 * fact that this is not an HBase configuration key.
229 */
232 /** Parameter name for the client port that the zookeeper listens on */
236 /** Default client port that the zookeeper listens on */
239 /** Parameter name for the root dir in ZK for this cluster */
244 /**
245 * Parameter name for the limit on concurrent client-side zookeeper
246 * connections
247 */
251 /** Parameter name for the ZK data directory */
255 /** Parameter name for the ZK tick time */
259 /** Default limit on concurrent client-side zookeeper connections */
262 /** Configuration key for ZooKeeper session timeout */
265 /** Default value for ZooKeeper session timeout */
268 /** Parameter name for port region server listens on. */
271 /** Default port region server listens on. */
274 /** default port for region server web api */
277 /** A configuration key for regionserver info port */
281 /** A flag that enables automatic selection of regionserver info port */
285 /** Parameter name for what region server implementation to use. */
288 /** Parameter name for what master implementation to use. */
291 /** Parameter name for how often threads should wake up */
294 /** Default value for thread wake frequency */
297 /** Parameter name for how often we should try to write a version file, before failing */
298 public static final String VERSION_FILE_WRITE_ATTEMPTS = "hbase.server.versionfile.writeattempts";
300 /** Parameter name for how often we should try to write a version file, before failing */
303 /** Parameter name and default value for how often a region should perform a major compaction */
307 /**
308 * Parameter name and default value for major compaction jitter.
309 * Used as a multiplier applied to {@link HConstants#MAJOR_COMPACTION_PERIOD}
310 * to cause compaction to occur a given amount of time either side of
311 * {@link HConstants#MAJOR_COMPACTION_PERIOD}.
312 * Default to 0.5 so jitter has us fall evenly either side of when the compaction should run.
313 */
317 /** Parameter name for the maximum batch of KVs to be used in flushes and compactions */
321 /** Parameter name for HBase instance root directory */
324 /** Parameter name for HBase client IPC pool type */
327 /** Parameter name for HBase client IPC pool size */
330 /** Parameter name for HBase client operation timeout. */
333 /** Parameter name for HBase client meta operation timeout. */
337 /** Default HBase client operation timeout, which is tantamount to a blocking call */
340 /** Parameter name for HBase client meta replica scan call timeout. */
344 /** Default HBase client meta replica scan call timeout, 1 second */
347 /** Used to construct the name of the log directory for a region server */
350 /** Used to construct the name of the splitlog directory for a region server */
353 /** Like the previous, but for old logs that are about to be deleted */
356 /** Staging dir used by bulk load */
361 /** Used by HBCK to sideline backup data */
364 /** Any artifacts left from migration can be moved here */
367 /** Used to construct the name of the compaction directory during compaction */
370 /** Conf key for the max file size after which we split the region */
374 /** Default maximum file size */
377 /**
378 * Max size of single row for Get's or Scan's without in-row scanning flag set.
379 */
382 /**
383 * Default max row size (1 Gb).
384 */
387 /**
388 * The max number of threads used for opening and closing stores or store
389 * files in parallel
390 */
394 /**
395 * The default number for the max number of threads used for opening and
396 * closing stores or store files in parallel
397 */
400 /**
401 * Block updates if memstore has hbase.hregion.memstore.block.multiplier
402 * times hbase.hregion.memstore.flush.size bytes. Useful preventing
403 * runaway memstore during spikes in update traffic.
404 */
408 /**
409 * Default value for hbase.hregion.memstore.block.multiplier
410 */
413 /** Conf key for the memstore size at which we flush the memstore */
423 /** Maximum value length, enforced on KeyValue construction */
426 /** name of the file for unique cluster ID */
429 /** Default value for cluster ID */
432 /** Parameter name for # days to keep MVCC values during a major compaction */
434 /** At least to keep MVCC values in hfiles for 5 days */
437 // Always store the location of the root table's HRegion.
438 // This HRegion is never split.
440 // region name = table + startkey + regionid. This is the row key.
441 // each row in the root and meta tables describes exactly 1 region
442 // Do we ever need to know all the information that we are storing?
444 // Note that the name of the root table starts with "-" and the name of the
445 // meta table starts with "." Why? it's a trick. It turns out that when we
446 // store region names in memory, we use a SortedMap. Since "-" sorts before
447 // "." (and since no other table name can start with either of these
448 // characters, the root region will always be the first entry in such a Map,
449 // followed by all the meta regions (which will be ordered by their starting
450 // row key as well), followed by all user tables. So when the Master is
451 // choosing regions to assign, it will always choose the root region first,
452 // followed by the meta regions, followed by user regions. Since the root
453 // and meta regions always need to be on-line, this ensures that they will
454 // be the first to be reassigned if the server(s) they are being served by
455 // should go down.
459 /** delimiter used between portions of a region name */
462 /** The catalog family as a string*/
465 /** The catalog family */
468 /** The RegionInfo qualifier as a string */
471 /** The regioninfo column qualifier */
474 /** The server column qualifier */
476 /** The server column qualifier */
479 /** The startcode column qualifier */
481 /** The startcode column qualifier */
484 /** The open seqnum column qualifier */
486 /** The open seqnum column qualifier */
489 /** The state column qualifier */
494 /**
495 * The serverName column qualifier. Its the server where the region is
496 * transitioning on, while column server is the server where the region is
497 * opened on. They are the same when the region is in state OPEN.
498 */
503 /** The lower-half split region column qualifier */
506 /** The upper-half split region column qualifier */
509 /**
510 * Merge qualifier prefix.
511 * We used to only allow two regions merge; mergeA and mergeB.
512 * Now we allow many to merge. Each region to merge will be referenced
513 * in a column whose qualifier starts with this define.
514 */
519 /**
520 * The lower-half merge region column qualifier
521 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for
522 * the {@link #MERGE_QUALIFIER_PREFIX_STR} prefix.
523 */
524 @Deprecated
527 /**
528 * The upper-half merge region column qualifier
529 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for
530 * the {@link #MERGE_QUALIFIER_PREFIX_STR} prefix.
531 */
532 @Deprecated
535 /** The catalog family as a string*/
538 /** The catalog family */
541 /** The serialized table state qualifier */
544 /** The replication barrier family as a string*/
547 /** The replication barrier family */
551 /** The namespace family as a string */
554 /** The namespace family */
558 /**
559 * The meta table version column qualifier.
560 * We keep current version of the meta table in this column in <code>-ROOT-</code>
561 * table: i.e. in the 'info:v' column.
562 */
565 /**
566 * The current version of the meta table.
567 * - pre-hbase 0.92. There is no META_VERSION column in the root table
568 * in this case. The meta has HTableDescriptor serialized into the HRegionInfo;
569 * - version 0 is 0.92 and 0.94. Meta data has serialized HRegionInfo's using
570 * Writable serialization, and HRegionInfo's does not contain HTableDescriptors.
571 * - version 1 for 0.96+ keeps HRegionInfo data structures, but changes the
572 * byte[] serialization from Writables to Protobuf.
573 * See HRegionInfo.VERSION
574 */
577 // Other constants
579 /**
580 * An empty byte array instance.
581 */
584 /**
585 * An empty string instance.
586 */
591 /**
592 * Used by scanners, etc when they want to start at the beginning of a region
593 */
596 /**
597 * Last row in a table.
598 */
601 /**
602 * Used by scanners and others when they're trying to detect the end of a
603 * table
604 */
607 /**
608 * Max length a row can have because of the limitation in TFile.
609 */
612 /**
613 * Timestamp to use when we want to refer to the latest cell.
614 *
615 * On client side, this is the timestamp set by default when no timestamp is specified,
616 * to refer to the latest.
617 * On server side, this acts as a notation.
618 * (1) For a cell of Put, which has this notation,
619 * its timestamp will be replaced with server's current time.
620 * (2) For a cell of Delete, which has this notation,
621 * A. If the cell is of {@link KeyValue.Type#Delete}, HBase issues a Get operation firstly.
622 * a. When the count of cell it gets is less than the count of cell to delete,
623 * the timestamp of Delete cell will be replaced with server's current time.
624 * b. When the count of cell it gets is equal to the count of cell to delete,
625 * the timestamp of Delete cell will be replaced with the latest timestamp of cell it
626 * gets.
627 * (c. It is invalid and an exception will be thrown,
628 * if the count of cell it gets is greater than the count of cell to delete,
629 * as the max version of Get is set to the count of cell to delete.)
630 * B. If the cell is of other Delete types, like {@link KeyValue.Type#DeleteFamilyVersion},
631 * {@link KeyValue.Type#DeleteColumn}, or {@link KeyValue.Type#DeleteFamily},
632 * the timestamp of Delete cell will be replaced with server's current time.
633 *
634 * So that is why it is named as "latest" but assigned as the max value of Long.
635 */
638 /**
639 * Timestamp to use when we want to refer to the oldest cell.
640 * Special! Used in fake Cells only. Should never be the timestamp on an actual Cell returned to
641 * a client.
642 * @deprecated Should not be public since hbase-1.3.0. For internal use only. Move internal to
643 * Scanners flagged as special timestamp value never to be returned as timestamp on a Cell.
644 */
645 @Deprecated
648 /**
649 * LATEST_TIMESTAMP in bytes form
650 */
652 // big-endian
661 };
663 /**
664 * Define for 'return-all-versions'.
665 */
668 /**
669 * Unlimited time-to-live.
670 */
671 // public static final int FOREVER = -1;
674 /**
675 * Seconds in a day, hour and minute
676 */
681 //TODO: although the following are referenced widely to format strings for
682 // the shell. They really aren't a part of the public API. It would be
683 // nice if we could put them somewhere where they did not need to be
684 // public. They could have package visibility
691 /**
692 * Retrying we multiply hbase.client.pause setting by what we have in this array until we
693 * run out of array items. Retries beyond this use the last number in the array. So, for
694 * example, if hbase.client.pause is 1 second, and maximum retries count
695 * hbase.client.retries.number is 10, we will retry at the following intervals:
696 * 1, 2, 3, 5, 10, 20, 40, 100, 100, 100.
697 * With 100ms, a back-off of 200 means 20s
698 */
699 public static final int [] RETRY_BACKOFF = {1, 2, 3, 5, 10, 20, 40, 100, 100, 100, 100, 200, 200};
703 /**
704 * Scope tag for locally scoped data.
705 * This data will not be replicated.
706 */
709 /**
710 * Scope tag for globally scoped data.
711 * This data will be replicated to all peers.
712 */
715 /**
716 * Default cluster ID, cannot be used to identify a cluster so a key with
717 * this value means it wasn't meant for replication.
718 */
721 /**
722 * Parameter name for maximum number of bytes returned when calling a scanner's next method.
723 * Controlled by the client.
724 */
728 /**
729 * Parameter name for maximum number of bytes returned when calling a scanner's next method.
730 * Controlled by the server.
731 */
735 /**
736 * Maximum number of bytes returned when calling a scanner's next method.
737 * Note that when a single row is larger than this limit the row is still
738 * returned completely.
739 *
740 * The default value is 2MB.
741 */
744 /**
745 * Maximum number of bytes returned when calling a scanner's next method.
746 * Note that when a single row is larger than this limit the row is still
747 * returned completely.
748 * Safety setting to protect the region server.
749 *
750 * The default value is 100MB. (a client would rarely request larger chunks on purpose)
751 */
754 /**
755 * Parameter name for client pause value, used mostly as value to wait
756 * before running a retry of a failed get, region lookup, etc.
757 */
760 /**
761 * Default value of {@link #HBASE_CLIENT_PAUSE}.
762 */
765 /**
766 * Parameter name for client pause value for special case such as call queue too big, etc.
767 */
770 /**
771 * The maximum number of concurrent connections the client will maintain.
772 */
775 /**
776 * Default value of {@link #HBASE_CLIENT_MAX_TOTAL_TASKS}.
777 */
780 /**
781 * The maximum number of concurrent connections the client will maintain to a single
782 * RegionServer.
783 */
784 public static final String HBASE_CLIENT_MAX_PERSERVER_TASKS = "hbase.client.max.perserver.tasks";
786 /**
787 * Default value of {@link #HBASE_CLIENT_MAX_PERSERVER_TASKS}.
788 */
791 /**
792 * The maximum number of concurrent connections the client will maintain to a single
793 * Region.
794 */
795 public static final String HBASE_CLIENT_MAX_PERREGION_TASKS = "hbase.client.max.perregion.tasks";
797 /**
798 * Default value of {@link #HBASE_CLIENT_MAX_PERREGION_TASKS}.
799 */
802 /**
803 * The maximum number of concurrent pending RPC requests for one server in process level.
804 */
808 /**
809 * Default value of {@link #HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD}.
810 */
814 /**
815 * Parameter name for server pause value, used mostly as value to wait before
816 * running a retry of a failed operation.
817 */
820 /**
821 * Default value of {@link #HBASE_SERVER_PAUSE}.
822 */
825 /**
826 * Parameter name for maximum retries, used as maximum for all retryable
827 * operations such as fetching of the root region from root region server,
828 * getting a cell's value, starting a row update, etc.
829 */
832 /**
833 * Default value of {@link #HBASE_CLIENT_RETRIES_NUMBER}.
834 */
842 /**
843 * Parameter name to set the default scanner caching for all clients.
844 */
847 /**
848 * Default value for {@link #HBASE_CLIENT_SCANNER_CACHING}
849 */
852 /**
853 * Parameter name for number of rows that will be fetched when calling next on
854 * a scanner if it is not served from memory. Higher caching values will
855 * enable faster scanners but will eat up more memory and some calls of next
856 * may take longer and longer times when the cache is empty.
857 */
860 /**
861 * Default value of {@link #HBASE_META_SCANNER_CACHING}.
862 */
865 /**
866 * Parameter name for number of versions, kept by meta table.
867 */
870 /**
871 * Default value of {@link #HBASE_META_VERSIONS}.
872 */
875 /**
876 * Parameter name for number of versions, kept by meta table.
877 */
880 /**
881 * Default value of {@link #HBASE_META_BLOCK_SIZE}.
882 */
885 /**
886 * Parameter name for unique identifier for this {@link org.apache.hadoop.conf.Configuration}
887 * instance. If there are two or more {@link org.apache.hadoop.conf.Configuration} instances that,
888 * for all intents and purposes, are the same except for their instance ids, then they will not be
889 * able to share the same org.apache.hadoop.hbase.client.HConnection instance. On the other hand,
890 * even if the instance ids are the same, it could result in non-shared
891 * org.apache.hadoop.hbase.client.HConnection instances if some of the other connection parameters
892 * differ.
893 */
896 /**
897 * The client scanner timeout period in milliseconds.
898 */
902 /**
903 * Use {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD} instead.
904 * @deprecated This config option is deprecated. Will be removed at later releases after 0.96.
905 */
906 @Deprecated
910 /**
911 * Default value of {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD}.
912 */
915 /**
916 * timeout for each RPC
917 */
920 /** Configuration key that controls the fan out of requests in hedged channel implementation. **/
923 /** Default value for the fan out of hedged requests. **/
926 /**
927 * timeout for each read RPC
928 */
931 /**
932 * timeout for each write RPC
933 */
936 /**
937 * Default value of {@link #HBASE_RPC_TIMEOUT_KEY}
938 */
941 /**
942 * timeout for short operation RPC
943 */
947 /**
948 * Default value of {@link #HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY}
949 */
952 /**
953 * Value indicating the server name was saved with no sequence number.
954 */
957 /**
958 * Registry implementation to be used on the client side.
959 */
963 /*
964 * cluster replication constants.
965 */
966 public static final String
968 public static final String
972 public static final String REPLICATION_BULKLOAD_ENABLE_KEY = "hbase.replication.bulkload.enabled";
974 /** Replication cluster id of source cluster which uniquely identifies itself with peer cluster */
976 /**
977 * Max total size of buffered entries in all replication peers. It will prevent server getting
978 * OOM if there are many peers. Default value is 256MB which is four times to default
979 * replication.source.size.capacity.
980 */
981 public static final String REPLICATION_SOURCE_TOTAL_BUFFER_KEY = "replication.total.buffer.quota";
985 /** Configuration key for ReplicationSource shipeEdits timeout */
990 /**
991 * Directory where the source cluster file system client configuration are placed which is used by
992 * sink cluster to copy HFiles from source cluster file system
993 */
996 /** Maximum time to retry for a failed bulk load request */
1008 /** Whether nonces are enabled; default is true. */
1011 /**
1012 * Configuration key for the size of the block cache
1013 */
1019 /*
1020 * Minimum percentage of free heap necessary for a successful cluster startup.
1021 */
1024 /**
1025 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0.
1026 */
1027 @Deprecated
1031 /**
1032 * <pre>
1033 * Pattern that matches a coprocessor specification. Form is:
1034 * {@code <coprocessor jar file location> '|' <class name> ['|' <priority> ['|' <arguments>]]}
1035 * where arguments are {@code <KEY> '=' <VALUE> [,...]}
1036 * For example: {@code hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2}
1037 * </pre>
1038 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0.
1039 */
1040 @Deprecated
1043 /**
1044 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0.
1045 */
1046 @Deprecated
1048 /**
1049 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0.
1050 */
1051 @Deprecated
1053 /**
1054 * @deprecated It is used internally. As of release 2.0.0, this will be removed in HBase 3.0.0.
1055 */
1056 @Deprecated
1063 /** The delay when re-trying a socket operation in a loop (HBASE-4712) */
1066 /** Host name of the local machine */
1069 /**
1070 * If this parameter is set to true, then hbase will read
1071 * data and then verify checksums. Checksum verification
1072 * inside hdfs will be switched off. However, if the hbase-checksum
1073 * verification fails, then it will switch back to using
1074 * hdfs checksums for verifiying data that is being read from storage.
1075 *
1076 * If this parameter is set to false, then hbase will not
1077 * verify any checksums, instead it will depend on checksum verification
1078 * being done in the hdfs client.
1079 */
1088 /*
1089 * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT:
1090 * -1 => Disable aborting
1091 * 0 => Abort if even a single handler has died
1092 * 0.x => Abort only when this percent of handlers have died
1093 * 1 => Abort only all of the handers have died
1094 */
1099 //High priority handlers to deal with admin requests and system table operation requests
1107 // Meta Transition handlers to deal with meta ReportRegionStateTransitionRequest. Meta transition
1108 // should be dealt with in a separate handler in case blocking other region's transition.
1113 /** Conf key for enabling meta replication */
1119 /**
1120 * The name of the configuration parameter that specifies
1121 * the number of bytes in a newly created checksum chunk.
1122 */
1126 /**
1127 * The name of the configuration parameter that specifies
1128 * the name of an algorithm that is used to compute checksums
1129 * for newly created blocks.
1130 */
1134 /** Enable file permission modification from standard hbase */
1136 /** File permission umask to use when creating hbase data files */
1139 /** Configuration name of WAL Compression */
1143 /** Configuration name of WAL storage policy
1144 * Valid values are: HOT, COLD, WARM, ALL_SSD, ONE_SSD, LAZY_PERSIST
1145 * See http://hadoop.apache.org/docs/r2.7.3/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html*/
1147 /**
1148 * "NONE" is not a valid storage policy and means we defer the policy to HDFS. @see
1149 * <a href="https://issues.apache.org/jira/browse/HBASE-20691">HBASE-20691</a>
1150 */
1152 /** By default we defer the WAL storage policy to HDFS */
1155 /** Region in Transition metrics threshold time */
1161 /** delimiter used between portions of a region name */
1164 /**
1165 * QOS attributes: these attributes are used to demarcate RPC call processing
1166 * by different set of handlers. For example, HIGH_QOS tagged methods are
1167 * handled by high priority handlers.
1168 */
1169 // normal_QOS < replication_QOS < replay_QOS < QOS_threshold < admin_QOS < high_QOS < meta_QOS
1178 /**
1179 * @deprecated the name "META_QOS" is a bit ambiguous, actually only meta region transition can
1180 * use this priority, and you should not use this directly. Will be removed in 3.0.0.
1181 */
1182 @Deprecated
1185 /** Directory under /hbase where archived hfiles are stored */
1188 /**
1189 * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for
1190 * remaining snapshot constants; this is here to keep HConstants dependencies at a minimum and
1191 * uni-directional.
1192 */
1195 /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */
1198 /** Temporary directory used for table creation and deletion */
1200 /**
1201 * The period (in milliseconds) between computing region server point in time metrics
1202 */
1205 /** Directories that are not HBase table directories */
1209 }));
1211 /** Health script related settings. */
1217 /**
1218 * The maximum number of health check failures a server can encounter consecutively.
1219 */
1228 /**
1229 * Setting to activate, or not, the publication of the status by the master. Default
1230 * notification is by a multicast message.
1231 */
1235 /**
1236 * IP to use for the multicast status messages between the master and the clients.
1237 * The default address is chosen as one among others within the ones suitable for multicast
1238 * messages.
1239 */
1243 /**
1244 * The address to use for binding the local socket for receiving multicast. Defaults to
1245 * 0.0.0.0.
1246 * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a>
1247 */
1252 /**
1253 * The port to use for the multicast messages.
1254 */
1258 /**
1259 * The network interface name to use for the multicast messages.
1260 */
1263 /**
1264 * The address to use for binding the local socket for sending multicast. Defaults to 0.0.0.0.
1265 */
1272 /** Default cipher for encryption */
1275 /** Configuration key for the crypto algorithm provider, a class name */
1278 /** Configuration key for the crypto key provider, a class name */
1281 /** Configuration key for the crypto key provider parameters */
1285 /** Configuration key for the name of the master key for the cluster, a string */
1288 /** Configuration key for the name of the alternate master key for the cluster, a string */
1292 /** Configuration key for the algorithm to use when encrypting the WAL, a string */
1295 /** Configuration key for the name of the master WAL encryption key for the cluster, a string */
1298 /** Configuration key for the algorithm used for creating jks key, a string */
1301 /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */
1305 /** Configuration key for enabling WAL encryption, a boolean */
1308 /** Configuration key for setting RPC codec class name */
1311 /** Configuration key for setting replication codec class name */
1314 /** Maximum number of threads used by the replication source for shipping edits to the sinks */
1318 /** Drop edits for tables that been deleted from the replication source and target */
1322 /** Maximum number of threads used by the replication source for shipping edits to the sinks */
1325 /** Configuration key for SplitLog manager timeout */
1328 /**
1329 * Configuration keys for Bucket cache
1330 */
1331 // TODO moving these bucket cache implementation specific configs to this level is violation of
1332 // encapsulation. But as these has to be referred from hbase-common and bucket cache
1333 // sits in hbase-server, there were no other go! Can we move the cache implementation to
1334 // hbase-common?
1336 /**
1337 * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path
1338 * to the file that will host the file-based cache. See BucketCache#getIOEngineFromName() for
1339 * list of supported ioengine options.
1340 * <p>Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache.
1341 */
1344 /**
1345 * When using bucket cache, this is a float that EITHER represents a percentage of total heap
1346 * memory size to give to the cache (if < 1.0) OR, it is the capacity in
1347 * megabytes of the cache.
1348 */
1351 /**
1352 * HConstants for fast fail on the client side follow
1353 */
1354 /**
1355 * Config for enabling/disabling the fast fail mode.
1356 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1357 * this value will have no effect. The constants itself will be removed in 4.0.0.
1358 */
1359 @Deprecated
1363 /**
1364 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1365 * this value will have no effect. The constants itself will be removed in 4.0.0.
1366 */
1367 @Deprecated
1370 /**
1371 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1372 * this value will have no effect. The constants itself will be removed in 4.0.0.
1373 */
1374 @Deprecated
1378 /**
1379 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1380 * this value will have no effect. The constants itself will be removed in 4.0.0.
1381 */
1382 @Deprecated
1385 /**
1386 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1387 * this value will have no effect. The constants itself will be removed in 4.0.0.
1388 */
1389 @Deprecated
1393 /**
1394 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1395 * this value will have no effect. The constants itself will be removed in 4.0.0.
1396 */
1397 @Deprecated
1400 /**
1401 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1402 * this value will have no effect. The constants itself will be removed in 4.0.0.
1403 */
1404 @Deprecated
1408 /**
1409 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1410 * this value will have no effect. The constants itself will be removed in 4.0.0.
1411 */
1412 @Deprecated
1415 /**
1416 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1417 * this value will have no effect. The constants itself will be removed in 4.0.0.
1418 */
1419 @Deprecated
1423 public static final String HBASE_SPLIT_WAL_COORDINATED_BY_ZK = "hbase.split.wal.zk.coordinated";
1427 public static final String HBASE_SPLIT_WAL_MAX_SPLITTER = "hbase.regionserver.wal.max.splitters";
1431 /** Config key for if the server should send backpressure and if the client should listen to
1432 * that backpressure from the server */
1443 /**
1444 * The max number of threads used for splitting storefiles in parallel during
1445 * the region split process.
1446 */
1450 /** Canary config keys */
1451 // TODO: Move these defines to Canary Class
1460 public static final String HBASE_CANARY_WRITE_VALUE_SIZE_KEY = "hbase.canary.write.value.size";
1467 /**
1468 * Configuration keys for programmatic JAAS configuration for secured ZK interaction
1469 */
1477 /** Config key for hbase temporary directory in hdfs */
1480 /**
1481 * Don't use it! This'll get you the wrong path in a secure cluster.
1482 * Use FileSystem.getHomeDirectory() or
1483 * "/user/" + UserGroupInformation.getCurrentUser().getShortUserName()
1484 */
1501 // Default TTL - FOREVER
1504 // User defined Default TTL config key
1507 // Regions Recovery based on high storeFileRefCount threshold value
1511 // default -1 indicates there is no threshold on high storeRefCount
1519 /**
1520 * Configurations for master executor services.
1521 */
1549 // Can't be instantiated with this ctor.
1550 }
1551 }