| blob | d5deb092730513f2c9ff7219bcba196e784de4ca |
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 * Date Tiered Compaction tmp dir prefix name if use storage policy
68 */
71 /**
72 * The first four bytes of Hadoop RPC connections
73 */
77 // HFileBlock constants. TODO!!!! THESE DEFINES BELONG IN HFILEBLOCK, NOT UP HERE.
78 // Needed down in hbase-common though by encoders but these encoders should not be dealing
79 // in the internals of hfileblocks. Fix encapsulation.
81 /** The size data structures with minor version is 0 */
84 /** The size of a version 2 HFile block header, minor version 1.
85 * There is a 1 byte checksum type, followed by a 4 byte bytesPerChecksum
86 * followed by another 4 byte value to store sizeofDataOnDisk.
87 */
90 /** Just an array of bytes of the right size. */
93 //End HFileBlockConstants.
95 /**
96 * Status codes used for return values of bulk operations.
97 */
100 NOT_RUN,
101 SUCCESS,
102 BAD_FAMILY,
103 STORE_TOO_BUSY,
104 SANITY_CHECK_FAILURE,
105 FAILURE
106 }
108 /** long constant for zero */
113 // For migration
115 /** name of version file */
118 /**
119 * Current version of file system.
120 * Version 4 supports only one kind of bloom filter.
121 * Version 5 changes versions in catalog table regions.
122 * Version 6 enables blockcaching on catalog tables.
123 * Version 7 introduces hfile -- hbase 0.19 to 0.20..
124 * Version 8 introduces namespace
125 */
126 // public static final String FILE_SYSTEM_VERSION = "6";
129 // Configuration parameters
131 //TODO: Is having HBase homed on port 60k OK?
133 /** Cluster is in distributed mode or not */
136 /** Config for pluggable load balancers */
139 /** Config for balancing the cluster by table */
140 public static final String HBASE_MASTER_LOADBALANCE_BYTABLE = "hbase.master.loadbalance.bytable";
142 /** Config for the max percent of regions in transition */
146 /** Default value for the max percent of regions in transition */
149 /** Config for the max balancing time */
152 /** Config for the balancer period */
155 /** Default value for the balancer period */
158 /**
159 * Config key for enable/disable automatically separate child regions to different region servers
160 * in the procedure of split regions. One child will be kept to the server where parent
161 * region is on, and the other child will be assigned to a random server.
162 * See HBASE-25518.
163 */
167 /**
168 * Default value for automatically separate child regions to different region servers
169 * (set to "false" to keep all child regions to the server where parent region is on)
170 */
173 /** The name of the ensemble table */
176 /** Config for pluggable region normalizer */
180 /** Cluster is standalone or pseudo-distributed */
183 /** Default value for cluster distributed mode */
186 /** default host address */
189 /** Parameter name for port master listens on. */
192 /** default port that the master listens on */
195 /** default port for master web api */
198 /** Configuration key for master web API port */
201 /** Configuration key for the list of master host:ports **/
204 /** Full class name of the Zookeeper based connection registry implementation */
208 /** Parameter name for the master type being backup (waits for primary to go inactive). */
211 /**
212 * by default every master is a possible primary master unless the conf explicitly overrides it
213 */
216 /** Name of ZooKeeper quorum configuration parameter. */
219 /** Name of ZooKeeper quorum configuration parameter for client to locate meta. */
222 /** Client port of ZooKeeper for client to locate meta */
226 /** Indicate whether the client ZK are observer nodes of the server ZK */
229 /** Assuming client zk not in observer mode and master need to synchronize information */
232 /** Common prefix of ZooKeeper configuration properties */
239 /**
240 * The ZK client port key in the ZK properties map. The name reflects the
241 * fact that this is not an HBase configuration key.
242 */
245 /** Parameter name for the client port that the zookeeper listens on */
249 /** Default client port that the zookeeper listens on */
252 /** Parameter name for the root dir in ZK for this cluster */
257 /**
258 * Parameter name for the limit on concurrent client-side zookeeper
259 * connections
260 */
264 /** Parameter name for the ZK data directory */
268 /** Parameter name for the ZK tick time */
272 /** Default limit on concurrent client-side zookeeper connections */
275 /** Configuration key for ZooKeeper session timeout */
278 /** Timeout for the ZK sync() call */
280 // Choice of the default value is based on the following ZK recommendation (from docs). Keeping it
281 // lower lets the callers fail fast in case of any issues.
282 // "The clients view of the system is guaranteed to be up-to-date within a certain time bound.
283 // (On the order of tens of seconds.) Either system changes will be seen by a client within this
284 // bound, or the client will detect a service outage."
287 /** Default value for ZooKeeper session timeout */
290 /** Parameter name for port region server listens on. */
293 /** Default port region server listens on. */
296 /** default port for region server web api */
299 /** A configuration key for regionserver info port */
303 /** A flag that enables automatic selection of regionserver info port */
307 /** Parameter name for what region server implementation to use. */
310 /** Parameter name for what master implementation to use. */
313 /** Parameter name for how often threads should wake up */
316 /** Default value for thread wake frequency */
319 /** Parameter name for how often we should try to write a version file, before failing */
320 public static final String VERSION_FILE_WRITE_ATTEMPTS = "hbase.server.versionfile.writeattempts";
322 /** Parameter name for how often we should try to write a version file, before failing */
325 /** Parameter name and default value for how often a region should perform a major compaction */
329 /**
330 * Parameter name and default value for major compaction jitter.
331 * Used as a multiplier applied to {@link HConstants#MAJOR_COMPACTION_PERIOD}
332 * to cause compaction to occur a given amount of time either side of
333 * {@link HConstants#MAJOR_COMPACTION_PERIOD}.
334 * Default to 0.5 so jitter has us fall evenly either side of when the compaction should run.
335 */
339 /** Parameter name for the maximum batch of KVs to be used in flushes and compactions */
343 /** Parameter name for HBase instance root directory */
346 /** Parameter name for HBase client IPC pool type */
349 /** Parameter name for HBase client IPC pool size */
352 /** Parameter name for HBase client operation timeout. */
355 /** Parameter name for HBase client meta operation timeout. */
359 /** Default HBase client operation timeout, which is tantamount to a blocking call */
362 /** Parameter name for HBase client meta replica scan call timeout. */
366 /** Default HBase client meta replica scan call timeout, 1 second */
369 /** Used to construct the name of the log directory for a region server */
372 /** Used to construct the name of the splitlog directory for a region server */
375 /** Like the previous, but for old logs that are about to be deleted */
378 /** Staging dir used by bulk load */
383 /** Used by HBCK to sideline backup data */
386 /** Any artifacts left from migration can be moved here */
389 /** Used to construct the name of the compaction directory during compaction */
392 /** Conf key for the max file size after which we split the region */
396 /** Default maximum file size */
399 /** Conf key for if we should sum overall region files size when check to split */
403 /** Default overall region files */
406 /**
407 * Max size of single row for Get's or Scan's without in-row scanning flag set.
408 */
411 /**
412 * Default max row size (1 Gb).
413 */
416 /**
417 * The max number of threads used for opening and closing stores or store
418 * files in parallel
419 */
423 /**
424 * The default number for the max number of threads used for opening and
425 * closing stores or store files in parallel
426 */
429 /**
430 * Block updates if memstore has hbase.hregion.memstore.block.multiplier
431 * times hbase.hregion.memstore.flush.size bytes. Useful preventing
432 * runaway memstore during spikes in update traffic.
433 */
437 /**
438 * Default value for hbase.hregion.memstore.block.multiplier
439 */
442 /** Conf key for the memstore size at which we flush the memstore */
452 /** Maximum value length, enforced on KeyValue construction */
455 /** name of the file for unique cluster ID */
458 /** Default value for cluster ID */
461 /** Parameter name for # days to keep MVCC values during a major compaction */
463 /** At least to keep MVCC values in hfiles for 5 days */
466 // Always store the location of the root table's HRegion.
467 // This HRegion is never split.
469 // region name = table + startkey + regionid. This is the row key.
470 // each row in the root and meta tables describes exactly 1 region
471 // Do we ever need to know all the information that we are storing?
473 // Note that the name of the root table starts with "-" and the name of the
474 // meta table starts with "." Why? it's a trick. It turns out that when we
475 // store region names in memory, we use a SortedMap. Since "-" sorts before
476 // "." (and since no other table name can start with either of these
477 // characters, the root region will always be the first entry in such a Map,
478 // followed by all the meta regions (which will be ordered by their starting
479 // row key as well), followed by all user tables. So when the Master is
480 // choosing regions to assign, it will always choose the root region first,
481 // followed by the meta regions, followed by user regions. Since the root
482 // and meta regions always need to be on-line, this ensures that they will
483 // be the first to be reassigned if the server(s) they are being served by
484 // should go down.
488 /** delimiter used between portions of a region name */
491 /** The catalog family as a string*/
494 /** The catalog family */
497 /** The RegionInfo qualifier as a string */
500 /** The regioninfo column qualifier */
503 /** The server column qualifier */
505 /** The server column qualifier */
508 /** The startcode column qualifier */
510 /** The startcode column qualifier */
513 /** The open seqnum column qualifier */
515 /** The open seqnum column qualifier */
518 /** The state column qualifier */
523 /**
524 * The serverName column qualifier. Its the server where the region is
525 * transitioning on, while column server is the server where the region is
526 * opened on. They are the same when the region is in state OPEN.
527 */
532 /** The lower-half split region column qualifier string. */
534 /** The lower-half split region column qualifier */
537 /** The upper-half split region column qualifier String. */
539 /** The upper-half split region column qualifier */
542 /**
543 * Merge qualifier prefix.
544 * We used to only allow two regions merge; mergeA and mergeB.
545 * Now we allow many to merge. Each region to merge will be referenced
546 * in a column whose qualifier starts with this define.
547 */
552 /**
553 * The lower-half merge region column qualifier
554 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for
555 * the {@link #MERGE_QUALIFIER_PREFIX_STR} prefix.
556 */
557 @Deprecated
560 /**
561 * The upper-half merge region column qualifier
562 * @deprecated Since 2.3.0 and 2.2.1. Not used anymore. Instead we look for
563 * the {@link #MERGE_QUALIFIER_PREFIX_STR} prefix.
564 */
565 @Deprecated
568 /** The catalog family as a string*/
571 /** The catalog family */
574 /** The serialized table state qualifier */
577 /** The replication barrier family as a string*/
580 /** The replication barrier family */
584 /** The namespace family as a string */
587 /** The namespace family */
591 /**
592 * The meta table version column qualifier.
593 * We keep current version of the meta table in this column in <code>-ROOT-</code>
594 * table: i.e. in the 'info:v' column.
595 */
598 /** The family str as a key in map*/
601 /**
602 * The current version of the meta table.
603 * - pre-hbase 0.92. There is no META_VERSION column in the root table
604 * in this case. The meta has HTableDescriptor serialized into the HRegionInfo;
605 * - version 0 is 0.92 and 0.94. Meta data has serialized HRegionInfo's using
606 * Writable serialization, and HRegionInfo's does not contain HTableDescriptors.
607 * - version 1 for 0.96+ keeps HRegionInfo data structures, but changes the
608 * byte[] serialization from Writables to Protobuf.
609 * See HRegionInfo.VERSION
610 */
613 // Other constants
615 /**
616 * An empty byte array instance.
617 */
620 /**
621 * An empty string instance.
622 */
627 /**
628 * Used by scanners, etc when they want to start at the beginning of a region
629 */
632 /**
633 * Last row in a table.
634 */
637 /**
638 * Used by scanners and others when they're trying to detect the end of a
639 * table
640 */
643 /**
644 * Max length a row can have because of the limitation in TFile.
645 */
648 /**
649 * Timestamp to use when we want to refer to the latest cell.
650 *
651 * On client side, this is the timestamp set by default when no timestamp is specified,
652 * to refer to the latest.
653 * On server side, this acts as a notation.
654 * (1) For a cell of Put, which has this notation,
655 * its timestamp will be replaced with server's current time.
656 * (2) For a cell of Delete, which has this notation,
657 * A. If the cell is of {@link KeyValue.Type#Delete}, HBase issues a Get operation firstly.
658 * a. When the count of cell it gets is less than the count of cell to delete,
659 * the timestamp of Delete cell will be replaced with server's current time.
660 * b. When the count of cell it gets is equal to the count of cell to delete,
661 * the timestamp of Delete cell will be replaced with the latest timestamp of cell it
662 * gets.
663 * (c. It is invalid and an exception will be thrown,
664 * if the count of cell it gets is greater than the count of cell to delete,
665 * as the max version of Get is set to the count of cell to delete.)
666 * B. If the cell is of other Delete types, like {@link KeyValue.Type#DeleteFamilyVersion},
667 * {@link KeyValue.Type#DeleteColumn}, or {@link KeyValue.Type#DeleteFamily},
668 * the timestamp of Delete cell will be replaced with server's current time.
669 *
670 * So that is why it is named as "latest" but assigned as the max value of Long.
671 */
674 /**
675 * LATEST_TIMESTAMP in bytes form
676 */
678 // big-endian
687 };
689 /**
690 * Define for 'return-all-versions'.
691 */
694 /**
695 * Unlimited time-to-live.
696 */
697 // public static final int FOREVER = -1;
700 /**
701 * Seconds in a day, hour and minute
702 */
707 /**
708 * KB, MB, GB, TB equivalent to how many bytes
709 */
715 //TODO: although the following are referenced widely to format strings for
716 // the shell. They really aren't a part of the public API. It would be
717 // nice if we could put them somewhere where they did not need to be
718 // public. They could have package visibility
725 /**
726 * Retrying we multiply hbase.client.pause setting by what we have in this array until we
727 * run out of array items. Retries beyond this use the last number in the array. So, for
728 * example, if hbase.client.pause is 1 second, and maximum retries count
729 * hbase.client.retries.number is 10, we will retry at the following intervals:
730 * 1, 2, 3, 5, 10, 20, 40, 100, 100, 100.
731 * With 100ms, a back-off of 200 means 20s
732 */
733 public static final int [] RETRY_BACKOFF = {1, 2, 3, 5, 10, 20, 40, 100, 100, 100, 100, 200, 200};
737 /**
738 * Scope tag for locally scoped data.
739 * This data will not be replicated.
740 */
743 /**
744 * Scope tag for globally scoped data.
745 * This data will be replicated to all peers.
746 */
749 /**
750 * Default cluster ID, cannot be used to identify a cluster so a key with
751 * this value means it wasn't meant for replication.
752 */
755 /**
756 * Parameter name for maximum number of bytes returned when calling a scanner's next method.
757 * Controlled by the client.
758 */
762 /**
763 * Parameter name for maximum number of bytes returned when calling a scanner's next method.
764 * Controlled by the server.
765 */
769 /**
770 * Maximum number of bytes returned when calling a scanner's next method.
771 * Note that when a single row is larger than this limit the row is still
772 * returned completely.
773 *
774 * The default value is 2MB.
775 */
778 /**
779 * Maximum number of bytes returned when calling a scanner's next method.
780 * Note that when a single row is larger than this limit the row is still
781 * returned completely.
782 * Safety setting to protect the region server.
783 *
784 * The default value is 100MB. (a client would rarely request larger chunks on purpose)
785 */
788 /**
789 * Parameter name for client pause value, used mostly as value to wait
790 * before running a retry of a failed get, region lookup, etc.
791 */
794 /**
795 * Default value of {@link #HBASE_CLIENT_PAUSE}.
796 */
799 /**
800 * Parameter name for client pause value for special case such as call queue too big, etc.
801 */
804 /**
805 * The maximum number of concurrent connections the client will maintain.
806 */
809 /**
810 * Default value of {@link #HBASE_CLIENT_MAX_TOTAL_TASKS}.
811 */
814 /**
815 * The maximum number of concurrent connections the client will maintain to a single
816 * RegionServer.
817 */
818 public static final String HBASE_CLIENT_MAX_PERSERVER_TASKS = "hbase.client.max.perserver.tasks";
820 /**
821 * Default value of {@link #HBASE_CLIENT_MAX_PERSERVER_TASKS}.
822 */
825 /**
826 * The maximum number of concurrent connections the client will maintain to a single
827 * Region.
828 */
829 public static final String HBASE_CLIENT_MAX_PERREGION_TASKS = "hbase.client.max.perregion.tasks";
831 /**
832 * Default value of {@link #HBASE_CLIENT_MAX_PERREGION_TASKS}.
833 */
836 /**
837 * The maximum number of concurrent pending RPC requests for one server in process level.
838 */
842 /**
843 * Default value of {@link #HBASE_CLIENT_PERSERVER_REQUESTS_THRESHOLD}.
844 */
848 /**
849 * Parameter name for server pause value, used mostly as value to wait before
850 * running a retry of a failed operation.
851 */
854 /**
855 * Default value of {@link #HBASE_SERVER_PAUSE}.
856 */
859 /**
860 * Parameter name for maximum retries, used as maximum for all retryable
861 * operations such as fetching of the root region from root region server,
862 * getting a cell's value, starting a row update, etc.
863 */
866 /**
867 * Default value of {@link #HBASE_CLIENT_RETRIES_NUMBER}.
868 */
876 /**
877 * Parameter name to set the default scanner caching for all clients.
878 */
881 /**
882 * Default value for {@link #HBASE_CLIENT_SCANNER_CACHING}
883 */
886 /**
887 * Parameter name for number of rows that will be fetched when calling next on
888 * a scanner if it is not served from memory. Higher caching values will
889 * enable faster scanners but will eat up more memory and some calls of next
890 * may take longer and longer times when the cache is empty.
891 */
894 /**
895 * Default value of {@link #HBASE_META_SCANNER_CACHING}.
896 */
899 /**
900 * Parameter name for number of versions, kept by meta table.
901 */
904 /**
905 * Default value of {@link #HBASE_META_VERSIONS}.
906 */
909 /**
910 * Parameter name for number of versions, kept by meta table.
911 */
914 /**
915 * Default value of {@link #HBASE_META_BLOCK_SIZE}.
916 */
919 /**
920 * Parameter name for unique identifier for this {@link org.apache.hadoop.conf.Configuration}
921 * instance. If there are two or more {@link org.apache.hadoop.conf.Configuration} instances that,
922 * for all intents and purposes, are the same except for their instance ids, then they will not be
923 * able to share the same org.apache.hadoop.hbase.client.HConnection instance. On the other hand,
924 * even if the instance ids are the same, it could result in non-shared
925 * org.apache.hadoop.hbase.client.HConnection instances if some of the other connection parameters
926 * differ.
927 */
930 /**
931 * The client scanner timeout period in milliseconds.
932 */
936 /**
937 * Default value of {@link #HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD}.
938 */
941 /**
942 * timeout for each RPC
943 */
946 /**
947 * timeout for each read RPC
948 */
951 /**
952 * timeout for each write RPC
953 */
956 /**
957 * Default value of {@link #HBASE_RPC_TIMEOUT_KEY}
958 */
961 /**
962 * timeout for short operation RPC
963 */
967 /**
968 * Default value of {@link #HBASE_RPC_SHORTOPERATION_TIMEOUT_KEY}
969 */
972 /**
973 * Retry pause time for short operation RPC
974 */
978 /**
979 * Default value of {@link #HBASE_RPC_SHORTOPERATION_RETRY_PAUSE_TIME}
980 */
983 /**
984 * Value indicating the server name was saved with no sequence number.
985 */
988 /**
989 * Registry implementation to be used on the client side.
990 */
994 /*
995 * cluster replication constants.
996 */
997 public static final String
1001 public static final String
1005 public static final String REPLICATION_BULKLOAD_ENABLE_KEY = "hbase.replication.bulkload.enabled";
1007 /** Replication cluster id of source cluster which uniquely identifies itself with peer cluster */
1009 /**
1010 * Max total size of buffered entries in all replication peers. It will prevent server getting
1011 * OOM if there are many peers. Default value is 256MB which is four times to default
1012 * replication.source.size.capacity.
1013 */
1014 public static final String REPLICATION_SOURCE_TOTAL_BUFFER_KEY = "replication.total.buffer.quota";
1018 /** Configuration key for ReplicationSource shipeEdits timeout */
1023 /**
1024 * Directory where the source cluster file system client configuration are placed which is used by
1025 * sink cluster to copy HFiles from source cluster file system
1026 */
1029 /** Maximum time to retry for a failed bulk load request */
1041 /** Whether nonces are enabled; default is true. */
1044 /**
1045 * Configuration key for the size of the block cache
1046 */
1052 /**
1053 * Configuration key for setting the fix size of the block size, default do nothing and it should
1054 * be explicitly set by user or only used within ClientSideRegionScanner. if it's set less than
1055 * current max on heap size, it overrides the max size of block cache
1056 */
1063 /*
1064 * Minimum percentage of free heap necessary for a successful cluster startup.
1065 */
1072 /** The delay when re-trying a socket operation in a loop (HBASE-4712) */
1075 /** Host name of the local machine */
1078 /**
1079 * If this parameter is set to true, then hbase will read
1080 * data and then verify checksums. Checksum verification
1081 * inside hdfs will be switched off. However, if the hbase-checksum
1082 * verification fails, then it will switch back to using
1083 * hdfs checksums for verifiying data that is being read from storage.
1084 *
1085 * If this parameter is set to false, then hbase will not
1086 * verify any checksums, instead it will depend on checksum verification
1087 * being done in the hdfs client.
1088 */
1097 /*
1098 * REGION_SERVER_HANDLER_ABORT_ON_ERROR_PERCENT:
1099 * -1 => Disable aborting
1100 * 0 => Abort if even a single handler has died
1101 * 0.x => Abort only when this percent of handlers have died
1102 * 1 => Abort only all of the handers have died
1103 */
1108 //High priority handlers to deal with admin requests and system table operation requests
1116 // Meta Transition handlers to deal with meta ReportRegionStateTransitionRequest. Meta transition
1117 // should be dealt with in a separate handler in case blocking other region's transition.
1122 /** Conf key for enabling meta replication */
1126 /**
1127 * @deprecated Since 2.4.0, will be removed in 4.0.0. Please change the meta replicas number by
1128 * altering meta table, i.e, set a new 'region replication' number and call
1129 * modifyTable.
1130 */
1131 @Deprecated
1133 /**
1134 * @deprecated Since 2.4.0, will be removed in 4.0.0. Please change the meta replicas number by
1135 * altering meta table, i.e, set a new 'region replication' number and call
1136 * modifyTable.
1137 */
1138 @Deprecated
1141 /**
1142 * The name of the configuration parameter that specifies
1143 * the number of bytes in a newly created checksum chunk.
1144 */
1148 /**
1149 * The name of the configuration parameter that specifies
1150 * the name of an algorithm that is used to compute checksums
1151 * for newly created blocks.
1152 */
1156 /** Enable file permission modification from standard hbase */
1158 /** File permission umask to use when creating hbase data files */
1161 /** Configuration name of WAL Compression */
1165 /** Configuration name of WAL storage policy
1166 * Valid values are: HOT, COLD, WARM, ALL_SSD, ONE_SSD, LAZY_PERSIST
1167 * See http://hadoop.apache.org/docs/r2.7.3/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html*/
1169 /**
1170 * "NONE" is not a valid storage policy and means we defer the policy to HDFS. @see
1171 * <a href="https://issues.apache.org/jira/browse/HBASE-20691">HBASE-20691</a>
1172 */
1174 /** By default we defer the WAL storage policy to HDFS */
1177 /** Region in Transition metrics threshold time */
1183 /** delimiter used between portions of a region name */
1186 /**
1187 * QOS attributes: these attributes are used to demarcate RPC call processing
1188 * by different set of handlers. For example, HIGH_QOS tagged methods are
1189 * handled by high priority handlers.
1190 */
1191 // normal_QOS < replication_QOS < replay_QOS < QOS_threshold < admin_QOS < high_QOS < meta_QOS
1195 /**
1196 * @deprecated since 3.0.0, will be removed in 4.0.0. DLR has been purged for a long time and
1197 * region replication has its own 'replay' method.
1198 */
1199 @Deprecated
1207 /** Directory under /hbase where archived hfiles are stored */
1210 /**
1211 * Name of the directory to store all snapshots. See SnapshotDescriptionUtils for
1212 * remaining snapshot constants; this is here to keep HConstants dependencies at a minimum and
1213 * uni-directional.
1214 */
1217 /* Name of old snapshot directory. See HBASE-8352 for details on why it needs to be renamed */
1220 /** Temporary directory used for table creation and deletion */
1222 /**
1223 * The period (in milliseconds) between computing region server point in time metrics
1224 */
1227 /** Directories that are not HBase table directories */
1231 }));
1233 /**
1234 * Directories that are not HBase user table directories.
1235 * @deprecated Since hbase-2.3.0; no replacement as not used any more (internally at least)
1236 */
1237 @Deprecated
1243 /** Health script related settings. */
1249 /**
1250 * The maximum number of health check failures a server can encounter consecutively.
1251 */
1260 /**
1261 * Setting to activate, or not, the publication of the status by the master. Default
1262 * notification is by a multicast message.
1263 */
1267 /**
1268 * IP to use for the multicast status messages between the master and the clients.
1269 * The default address is chosen as one among others within the ones suitable for multicast
1270 * messages.
1271 */
1275 /**
1276 * The address to use for binding the local socket for receiving multicast. Defaults to
1277 * 0.0.0.0.
1278 * @see <a href="https://issues.apache.org/jira/browse/HBASE-9961">HBASE-9961</a>
1279 */
1284 /**
1285 * The port to use for the multicast messages.
1286 */
1290 /**
1291 * The network interface name to use for the multicast messages.
1292 */
1295 /**
1296 * The address to use for binding the local socket for sending multicast. Defaults to 0.0.0.0.
1297 */
1304 /** Default cipher for encryption */
1307 /** Configuration key for the crypto algorithm provider, a class name */
1310 /** Configuration key for the crypto key provider, a class name */
1313 /** Configuration key for the crypto key provider parameters */
1317 /** Configuration key for the name of the master key for the cluster, a string */
1320 /** Configuration key for the name of the alternate master key for the cluster, a string */
1324 /** Configuration key for the algorithm to use when encrypting the WAL, a string */
1327 /** Configuration key for the name of the master WAL encryption key for the cluster, a string */
1330 /** Configuration key for the algorithm used for creating jks key, a string */
1333 /** Configuration key for the name of the alternate cipher algorithm for the cluster, a string */
1337 /** Configuration key for enabling WAL encryption, a boolean */
1340 /** Configuration key for setting RPC codec class name */
1343 /** Configuration key for setting replication codec class name */
1346 /** Maximum number of threads used by the replication source for shipping edits to the sinks */
1350 /**
1351 * Drop edits for tables that been deleted from the replication source and target
1352 * @deprecated since 3.0.0. Will be removed in 4.0.0.
1353 * Moved it into HBaseInterClusterReplicationEndpoint.
1354 * @see <a href="https://issues.apache.org/jira/browse/HBASE-24359">HBASE-24359</a>
1355 */
1356 @Deprecated
1360 /** Maximum number of threads used by the replication source for shipping edits to the sinks */
1363 /** Configuration key for SplitLog manager timeout */
1366 /**
1367 * Configuration keys for Bucket cache
1368 */
1369 // TODO moving these bucket cache implementation specific configs to this level is violation of
1370 // encapsulation. But as these has to be referred from hbase-common and bucket cache
1371 // sits in hbase-server, there were no other go! Can we move the cache implementation to
1372 // hbase-common?
1374 /**
1375 * Current ioengine options in include: heap, offheap and file:PATH (where PATH is the path
1376 * to the file that will host the file-based cache. See BucketCache#getIOEngineFromName() for
1377 * list of supported ioengine options.
1378 * <p>Set this option and a non-zero {@link #BUCKET_CACHE_SIZE_KEY} to enable bucket cache.
1379 */
1382 /**
1383 * When using bucket cache, it is the capacity in megabytes of the cache.
1384 */
1387 /**
1388 * HConstants for fast fail on the client side follow
1389 */
1390 /**
1391 * Config for enabling/disabling the fast fail mode.
1392 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1393 * this value will have no effect. The constants itself will be removed in 4.0.0.
1394 */
1395 @Deprecated
1399 /**
1400 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1401 * this value will have no effect. The constants itself will be removed in 4.0.0.
1402 */
1403 @Deprecated
1406 /**
1407 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1408 * this value will have no effect. The constants itself will be removed in 4.0.0.
1409 */
1410 @Deprecated
1414 /**
1415 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1416 * this value will have no effect. The constants itself will be removed in 4.0.0.
1417 */
1418 @Deprecated
1421 /**
1422 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1423 * this value will have no effect. The constants itself will be removed in 4.0.0.
1424 */
1425 @Deprecated
1429 /**
1430 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1431 * this value will have no effect. The constants itself will be removed in 4.0.0.
1432 */
1433 @Deprecated
1436 /**
1437 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1438 * this value will have no effect. The constants itself will be removed in 4.0.0.
1439 */
1440 @Deprecated
1444 /**
1445 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1446 * this value will have no effect. The constants itself will be removed in 4.0.0.
1447 */
1448 @Deprecated
1451 /**
1452 * @deprecated since 2.3.0, and in 3.0.0 the actually implementation will be removed so config
1453 * this value will have no effect. The constants itself will be removed in 4.0.0.
1454 */
1455 @Deprecated
1459 /**
1460 * @deprecated since 2.4.0 and in 3.0.0, to be removed in 4.0.0, replaced by procedure-based
1461 * distributed WAL splitter; see SplitWALManager.
1462 */
1463 @Deprecated
1464 public static final String HBASE_SPLIT_WAL_COORDINATED_BY_ZK = "hbase.split.wal.zk.coordinated";
1466 /**
1467 * @deprecated since 2.4.0 and in 3.0.0, to be removed in 4.0.0.
1468 */
1469 @Deprecated
1472 public static final String HBASE_SPLIT_WAL_MAX_SPLITTER = "hbase.regionserver.wal.max.splitters";
1476 /** Config key for if the server should send backpressure and if the client should listen to
1477 * that backpressure from the server */
1488 /**
1489 * The max number of threads used for splitting storefiles in parallel during
1490 * the region split process.
1491 */
1495 /** Canary config keys */
1496 // TODO: Move these defines to Canary Class
1505 public static final String HBASE_CANARY_WRITE_VALUE_SIZE_KEY = "hbase.canary.write.value.size";
1513 /**
1514 * Configuration keys for programmatic JAAS configuration for secured ZK interaction
1515 */
1523 /** Config key for hbase temporary directory in hdfs */
1526 /**
1527 * Don't use it! This'll get you the wrong path in a secure cluster.
1528 * Use FileSystem.getHomeDirectory() or
1529 * "/user/" + UserGroupInformation.getCurrentUser().getShortUserName()
1530 */
1547 // Default TTL - FOREVER
1550 // User defined Default TTL config key
1553 // Regions Recovery based on high storeFileRefCount threshold value
1557 // default -1 indicates there is no threshold on high storeRefCount
1565 /**
1566 * Configurations for master executor services.
1567 */
1580 /**
1581 * Number of threads used to dispatch merge operations to the regionservers.
1582 */
1601 /** The slowlog info family as a string*/
1604 /** The slowlog info family */
1616 /**
1617 * Number of rows in a batch operation above which a warning will be logged.
1618 */
1621 /**
1622 * Default value of {@link #BATCH_ROWS_THRESHOLD_NAME}
1623 */
1627 // Can't be instantiated with this ctor.
1628 }
1629 }