session/
hints.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// For the given format: `x-greptime-hints: auto_create_table=true, ttl=7d`
16pub const HINTS_KEY: &str = "x-greptime-hints";
17/// Deprecated, use `HINTS_KEY` instead. Notes if "x-greptime-hints" is set, keys with this prefix will be ignored.
18pub const HINTS_KEY_PREFIX: &str = "x-greptime-hint-";
19pub const REMOTE_QUERY_ID_EXTENSION_KEY: &str = "remote_query_id";
20
21pub const READ_PREFERENCE_HINT: &str = "read_preference";
22pub const RESERVED_EXTENSION_KEYS: [&str; 1] = [REMOTE_QUERY_ID_EXTENSION_KEY];
23
24/// Deprecated, use `HINTS_KEY` instead.
25pub const HINT_KEYS: [&str; 7] = [
26    "x-greptime-hint-auto_create_table",
27    "x-greptime-hint-ttl",
28    "x-greptime-hint-append_mode",
29    "x-greptime-hint-merge_mode",
30    "x-greptime-hint-physical_table",
31    "x-greptime-hint-skip_wal",
32    "x-greptime-hint-read_preference",
33];
34
35pub fn is_reserved_extension_key(key: &str) -> bool {
36    RESERVED_EXTENSION_KEYS.contains(&key)
37}
38
39#[cfg(test)]
40mod tests {
41    use super::*;
42
43    #[test]
44    fn test_is_reserved_extension_key() {
45        assert!(is_reserved_extension_key(REMOTE_QUERY_ID_EXTENSION_KEY));
46        assert!(!is_reserved_extension_key(READ_PREFERENCE_HINT));
47    }
48}
session/hints.rs

session/
hints.rs
