datafusion_optimizer/
lib.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18#![doc(
19    html_logo_url = "https://raw.githubusercontent.com/apache/datafusion/19fe44cf2f30cbdd63d4a4f52c74055163c6cc38/docs/logos/standalone_logo/logo_original.svg",
20    html_favicon_url = "https://raw.githubusercontent.com/apache/datafusion/19fe44cf2f30cbdd63d4a4f52c74055163c6cc38/docs/logos/standalone_logo/logo_original.svg"
21)]
22#![cfg_attr(docsrs, feature(doc_cfg))]
23// Make sure fast / cheap clones on Arc are explicit:
24// https://github.com/apache/datafusion/issues/11143
25#![deny(clippy::clone_on_ref_ptr)]
26#![cfg_attr(test, allow(clippy::needless_pass_by_value))]
27
28//! # DataFusion Optimizer
29//!
30//! Contains rules for rewriting [`LogicalPlan`]s
31//!
32//! 1. [`Analyzer`] applies [`AnalyzerRule`]s to transform `LogicalPlan`s
33//!    to make the plan valid prior to the rest of the DataFusion optimization
34//!    process (for example, [`TypeCoercion`]).
35//!
36//! 2. [`Optimizer`] applies [`OptimizerRule`]s to transform `LogicalPlan`s
37//!    into equivalent, but more efficient plans.
38//!
39//! [`LogicalPlan`]: datafusion_expr::LogicalPlan
40//! [`TypeCoercion`]: analyzer::type_coercion::TypeCoercion
41pub mod analyzer;
42pub mod common_subexpr_eliminate;
43pub mod decorrelate;
44pub mod decorrelate_lateral_join;
45pub mod decorrelate_predicate_subquery;
46pub mod eliminate_cross_join;
47pub mod eliminate_duplicated_expr;
48pub mod eliminate_filter;
49pub mod eliminate_group_by_constant;
50pub mod eliminate_join;
51pub mod eliminate_limit;
52#[deprecated(since = "52.0.0", note = "Please use OptimizeUnions instead")]
53pub mod eliminate_nested_union {
54    use crate::optimize_unions::OptimizeUnions;
55    #[deprecated(since = "52.0.0", note = "Please use OptimizeUnions instead")]
56    pub type EliminateNestedUnion = OptimizeUnions;
57}
58pub mod eliminate_outer_join;
59pub mod extract_equijoin_predicate;
60pub mod extract_leaf_expressions;
61pub mod filter_null_join_keys;
62pub mod optimize_projections;
63pub mod optimize_unions;
64pub mod optimizer;
65pub mod propagate_empty_relation;
66pub mod push_down_filter;
67pub mod push_down_limit;
68pub mod replace_distinct_aggregate;
69pub mod rewrite_set_comparison;
70pub mod scalar_subquery_to_join;
71pub mod simplify_expressions;
72pub mod single_distinct_to_groupby;
73pub mod unions_to_filter;
74pub mod utils;
75
76#[cfg(test)]
77pub mod test;
78
79pub use analyzer::{Analyzer, AnalyzerRule};
80pub use optimizer::{
81    ApplyOrder, Optimizer, OptimizerConfig, OptimizerContext, OptimizerRule,
82};
83
84pub(crate) mod join_key_set;
85mod plan_signature;
86
87#[cfg(test)]
88#[ctor::ctor(unsafe)]
89fn init() {
90    // Enable RUST_LOG logging configuration for test
91    let _ = env_logger::try_init();
92}
datafusion_optimizer/lib.rs

datafusion_optimizer/
lib.rs
