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