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 memtable partition tree index max keys per shard.
47pub const MEMTABLE_PARTITION_TREE_INDEX_MAX_KEYS_PER_SHARD: &str =
48    "memtable.partition_tree.index_max_keys_per_shard";
49/// Option key for memtable partition tree data freeze threshold.
50pub const MEMTABLE_PARTITION_TREE_DATA_FREEZE_THRESHOLD: &str =
51    "memtable.partition_tree.data_freeze_threshold";
52/// Option key for memtable partition tree fork dictionary bytes.
53pub const MEMTABLE_PARTITION_TREE_FORK_DICTIONARY_BYTES: &str =
54    "memtable.partition_tree.fork_dictionary_bytes";
55/// Option key for skipping WAL.
56pub const SKIP_WAL_KEY: &str = "skip_wal";
57/// Option key for sst format.
58pub const SST_FORMAT_KEY: &str = "sst_format";
59// Note: Adding new options here should also check if this option should be removed in [metric_engine::engine::create::region_options_for_metadata_region].
60
61/// Returns true if the `key` is a valid option key for the mito engine.
62pub fn is_mito_engine_option_key(key: &str) -> bool {
63    [
64        "ttl",
65        COMPACTION_TYPE,
66        COMPACTION_OVERRIDE,
67        TWCS_TRIGGER_FILE_NUM,
68        TWCS_MAX_OUTPUT_FILE_SIZE,
69        TWCS_TIME_WINDOW,
70        TWCS_REMOTE_COMPACTION,
71        TWCS_FALLBACK_TO_LOCAL,
72        "storage",
73        "index.inverted_index.ignore_column_ids",
74        "index.inverted_index.segment_row_count",
75        WAL_OPTIONS_KEY,
76        MEMTABLE_TYPE,
77        MEMTABLE_PARTITION_TREE_INDEX_MAX_KEYS_PER_SHARD,
78        MEMTABLE_PARTITION_TREE_DATA_FREEZE_THRESHOLD,
79        MEMTABLE_PARTITION_TREE_FORK_DICTIONARY_BYTES,
80        // We don't allow to create a mito table with sparse primary key encoding directly.
81        APPEND_MODE_KEY,
82        MERGE_MODE_KEY,
83        SST_FORMAT_KEY,
84    ]
85    .contains(&key)
86}
87
88#[cfg(test)]
89mod tests {
90    use super::*;
91
92    #[test]
93    fn test_is_mito_engine_option_key() {
94        assert!(is_mito_engine_option_key("ttl"));
95        assert!(is_mito_engine_option_key("compaction.type"));
96        assert!(is_mito_engine_option_key("compaction.override"));
97        assert!(is_mito_engine_option_key(
98            "compaction.twcs.trigger_file_num"
99        ));
100        assert!(is_mito_engine_option_key("compaction.twcs.time_window"));
101        assert!(is_mito_engine_option_key("storage"));
102        assert!(is_mito_engine_option_key(
103            "index.inverted_index.ignore_column_ids"
104        ));
105        assert!(is_mito_engine_option_key(
106            "index.inverted_index.segment_row_count"
107        ));
108        assert!(is_mito_engine_option_key("wal_options"));
109        assert!(is_mito_engine_option_key("memtable.type"));
110        assert!(is_mito_engine_option_key(
111            "memtable.partition_tree.index_max_keys_per_shard"
112        ));
113        assert!(is_mito_engine_option_key(
114            "memtable.partition_tree.data_freeze_threshold"
115        ));
116        assert!(is_mito_engine_option_key(
117            "memtable.partition_tree.fork_dictionary_bytes"
118        ));
119        assert!(is_mito_engine_option_key("append_mode"));
120        assert!(!is_mito_engine_option_key("foo"));
121    }
122}
store_api/mito_engine_options.rs

store_api/
mito_engine_options.rs
