query/
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
15use common_base::memory_limit::MemoryLimit;
16use serde::{Deserialize, Serialize};
17
18/// Query engine config
19#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
20#[serde(default)]
21pub struct QueryOptions {
22    /// Parallelism of query engine. Default to 0, which implies the number of logical CPUs.
23    pub parallelism: usize,
24    /// Whether to allow query fallback when push down fails.
25    pub allow_query_fallback: bool,
26    /// Memory pool size for query execution. Setting it to 0 disables the limit (unbounded).
27    /// Supports absolute size (e.g., "2GB") or percentage (e.g., "50%").
28    /// When this limit is reached, queries will fail with ResourceExhausted error.
29    pub memory_pool_size: MemoryLimit,
30}
31
32#[allow(clippy::derivable_impls)]
33impl Default for QueryOptions {
34    fn default() -> Self {
35        Self {
36            parallelism: 0,
37            allow_query_fallback: false,
38            memory_pool_size: MemoryLimit::default(),
39        }
40    }
41}
query/options.rs

query/
options.rs
