store_api/
mito_engine_options.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Option keys for the mito engine.
16//! We define them in this mod so the create parser can use it to validate table options.
17
18/// Option key for all WAL options.
19pub use common_wal::options::WAL_OPTIONS_KEY;
20/// Option key for append mode.
21pub const APPEND_MODE_KEY: &str = "append_mode";
22/// Option key for merge mode.
23pub const MERGE_MODE_KEY: &str = "merge_mode";
24/// Option key for TTL(time-to-live)
25pub const TTL_KEY: &str = "ttl";
26/// Option key for snapshot read.
27pub const SNAPSHOT_READ: &str = "snapshot_read";
28/// Option key for compaction type.
29pub const COMPACTION_TYPE: &str = "compaction.type";
30/// Option key for forcing compaction options override.
31pub const COMPACTION_OVERRIDE: &str = "compaction.override";
32/// TWCS compaction strategy.
33pub const COMPACTION_TYPE_TWCS: &str = "twcs";
34/// Option key for twcs min file num to trigger a compaction.
35pub const TWCS_TRIGGER_FILE_NUM: &str = "compaction.twcs.trigger_file_num";
36/// Option key for twcs max output file size.
37pub const TWCS_MAX_OUTPUT_FILE_SIZE: &str = "compaction.twcs.max_output_file_size";
38/// Option key for twcs time window.
39pub const TWCS_TIME_WINDOW: &str = "compaction.twcs.time_window";
40/// Option key for twcs remote compaction.
41pub const TWCS_REMOTE_COMPACTION: &str = "compaction.twcs.remote_compaction";
42/// Option key for twcs fallback to local.
43pub const TWCS_FALLBACK_TO_LOCAL: &str = "compaction.twcs.fallback_to_local";
44/// Option key for memtable type.
45pub const MEMTABLE_TYPE: &str = "memtable.type";
46/// Option key for bulk memtable merge threshold.
47pub const MEMTABLE_BULK_MERGE_THRESHOLD: &str = "memtable.bulk.merge_threshold";
48/// Option key for bulk memtable encode row threshold.
49pub const MEMTABLE_BULK_ENCODE_ROW_THRESHOLD: &str = "memtable.bulk.encode_row_threshold";
50/// Option key for bulk memtable encode bytes threshold.
51pub const MEMTABLE_BULK_ENCODE_BYTES_THRESHOLD: &str = "memtable.bulk.encode_bytes_threshold";
52/// Option key for bulk memtable max merge groups.
53pub const MEMTABLE_BULK_MAX_MERGE_GROUPS: &str = "memtable.bulk.max_merge_groups";
54/// Option key for memtable partition tree index max keys per shard.
55pub const MEMTABLE_PARTITION_TREE_INDEX_MAX_KEYS_PER_SHARD: &str =
56    "memtable.partition_tree.index_max_keys_per_shard";
57/// Option key for memtable partition tree data freeze threshold.
58pub const MEMTABLE_PARTITION_TREE_DATA_FREEZE_THRESHOLD: &str =
59    "memtable.partition_tree.data_freeze_threshold";
60/// Option key for memtable partition tree fork dictionary bytes.
61pub const MEMTABLE_PARTITION_TREE_FORK_DICTIONARY_BYTES: &str =
62    "memtable.partition_tree.fork_dictionary_bytes";
63/// Option key for skipping WAL.
64pub const SKIP_WAL_KEY: &str = "skip_wal";
65/// Option key for sst format.
66pub const SST_FORMAT_KEY: &str = "sst_format";
67// Note: Adding new options here should also check if this option should be removed in [metric_engine::engine::create::region_options_for_metadata_region].
68
69/// Returns true if the `key` is a valid option key for the mito engine.
70pub fn is_mito_engine_option_key(key: &str) -> bool {
71    [
72        "ttl",
73        COMPACTION_TYPE,
74        COMPACTION_OVERRIDE,
75        TWCS_TRIGGER_FILE_NUM,
76        TWCS_MAX_OUTPUT_FILE_SIZE,
77        TWCS_TIME_WINDOW,
78        TWCS_REMOTE_COMPACTION,
79        TWCS_FALLBACK_TO_LOCAL,
80        "storage",
81        "index.inverted_index.ignore_column_ids",
82        "index.inverted_index.segment_row_count",
83        WAL_OPTIONS_KEY,
84        MEMTABLE_TYPE,
85        MEMTABLE_BULK_MERGE_THRESHOLD,
86        MEMTABLE_BULK_ENCODE_ROW_THRESHOLD,
87        MEMTABLE_BULK_ENCODE_BYTES_THRESHOLD,
88        MEMTABLE_BULK_MAX_MERGE_GROUPS,
89        MEMTABLE_PARTITION_TREE_INDEX_MAX_KEYS_PER_SHARD,
90        MEMTABLE_PARTITION_TREE_DATA_FREEZE_THRESHOLD,
91        MEMTABLE_PARTITION_TREE_FORK_DICTIONARY_BYTES,
92        // We don't allow to create a mito table with sparse primary key encoding directly.
93        APPEND_MODE_KEY,
94        MERGE_MODE_KEY,
95        SST_FORMAT_KEY,
96    ]
97    .contains(&key)
98}
99
100#[cfg(test)]
101mod tests {
102    use super::*;
103
104    #[test]
105    fn test_is_mito_engine_option_key() {
106        assert!(is_mito_engine_option_key("ttl"));
107        assert!(is_mito_engine_option_key("compaction.type"));
108        assert!(is_mito_engine_option_key("compaction.override"));
109        assert!(is_mito_engine_option_key(
110            "compaction.twcs.trigger_file_num"
111        ));
112        assert!(is_mito_engine_option_key("compaction.twcs.time_window"));
113        assert!(is_mito_engine_option_key("storage"));
114        assert!(is_mito_engine_option_key(
115            "index.inverted_index.ignore_column_ids"
116        ));
117        assert!(is_mito_engine_option_key(
118            "index.inverted_index.segment_row_count"
119        ));
120        assert!(is_mito_engine_option_key("wal_options"));
121        assert!(is_mito_engine_option_key("memtable.type"));
122        assert!(is_mito_engine_option_key("memtable.bulk.merge_threshold"));
123        assert!(is_mito_engine_option_key(
124            "memtable.bulk.encode_row_threshold"
125        ));
126        assert!(is_mito_engine_option_key(
127            "memtable.bulk.encode_bytes_threshold"
128        ));
129        assert!(is_mito_engine_option_key("memtable.bulk.max_merge_groups"));
130        assert!(is_mito_engine_option_key(
131            "memtable.partition_tree.index_max_keys_per_shard"
132        ));
133        assert!(is_mito_engine_option_key(
134            "memtable.partition_tree.data_freeze_threshold"
135        ));
136        assert!(is_mito_engine_option_key(
137            "memtable.partition_tree.fork_dictionary_bytes"
138        ));
139        assert!(is_mito_engine_option_key("append_mode"));
140        assert!(!is_mito_engine_option_key("foo"));
141    }
142}
store_api/mito_engine_options.rs

store_api/
mito_engine_options.rs
