Skip to main content

query/
optimizer.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
15pub mod const_normalization;
16pub mod constant_term;
17pub mod count_nest_aggr;
18pub mod count_wildcard;
19pub mod enforce_sorting;
20pub(crate) mod expr_depth;
21pub mod global_limit;
22pub(crate) mod infer_aggregate_input_bounds;
23pub(crate) mod insert_assignment;
24pub(crate) mod json_schema_concretize;
25pub(crate) mod json_type_concretize;
26pub(crate) mod merge_scan_projection;
27pub mod parallelize_scan;
28pub mod promql_tsid_narrow_join;
29pub mod remove_duplicate;
30pub mod scan_hint;
31pub mod series_frame_output;
32pub(crate) mod sst_manifest_aggregate;
33pub mod string_normalization;
34#[cfg(test)]
35pub(crate) mod test_util;
36pub mod transcribe_atat;
37pub mod type_conversion;
38pub mod windowed_sort;
39
40use datafusion_common::Result;
41use datafusion_common::config::ConfigOptions;
42use datafusion_expr::LogicalPlan;
43
44use crate::QueryEngineContext;
45
46/// [`ExtensionAnalyzerRule`]s transform [`LogicalPlan`]s in some way to make
47/// the plan valid prior to the rest of the DataFusion optimization process.
48/// It's an extension of datafusion [`AnalyzerRule`]s but accepts [`QueryEngineContext`] as the second parameter.
49pub trait ExtensionAnalyzerRule {
50    /// Rewrite `plan`
51    fn analyze(
52        &self,
53        plan: LogicalPlan,
54        ctx: &QueryEngineContext,
55        config: &ConfigOptions,
56    ) -> Result<LogicalPlan>;
57}