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_auto_cfg))]
23// Make cheap clones clear: https://github.com/apache/datafusion/issues/11143
24#![deny(clippy::clone_on_ref_ptr)]
25
26//! # DataFusion Optimizer
27//!
28//! Contains rules for rewriting [`LogicalPlan`]s
29//!
30//! 1. [`Analyzer`] applies [`AnalyzerRule`]s to transform `LogicalPlan`s
31//!    to make the plan valid prior to the rest of the DataFusion optimization
32//!    process (for example, [`TypeCoercion`]).
33//!
34//! 2. [`Optimizer`] applies [`OptimizerRule`]s to transform `LogicalPlan`s
35//!    into equivalent, but more efficient plans.
36//!
37//! [`LogicalPlan`]: datafusion_expr::LogicalPlan
38//! [`TypeCoercion`]: analyzer::type_coercion::TypeCoercion
39pub mod analyzer;
40pub mod common_subexpr_eliminate;
41pub mod decorrelate;
42pub mod decorrelate_predicate_subquery;
43pub mod eliminate_cross_join;
44pub mod eliminate_duplicated_expr;
45pub mod eliminate_filter;
46pub mod eliminate_group_by_constant;
47pub mod eliminate_join;
48pub mod eliminate_limit;
49pub mod eliminate_nested_union;
50pub mod eliminate_one_union;
51pub mod eliminate_outer_join;
52pub mod extract_equijoin_predicate;
53pub mod filter_null_join_keys;
54pub mod optimize_projections;
55pub mod optimizer;
56pub mod propagate_empty_relation;
57pub mod push_down_filter;
58pub mod push_down_limit;
59pub mod replace_distinct_aggregate;
60pub mod scalar_subquery_to_join;
61pub mod simplify_expressions;
62pub mod single_distinct_to_groupby;
63pub mod unwrap_cast_in_comparison;
64pub mod utils;
65
66#[cfg(test)]
67pub mod test;
68
69pub use analyzer::{Analyzer, AnalyzerRule};
70pub use optimizer::{
71    ApplyOrder, Optimizer, OptimizerConfig, OptimizerContext, OptimizerRule,
72};
73#[allow(deprecated)]
74pub use utils::optimize_children;
75
76pub(crate) mod join_key_set;
77mod plan_signature;
78
79#[cfg(test)]
80#[ctor::ctor]
81fn init() {
82    // Enable RUST_LOG logging configuration for test
83    let _ = env_logger::try_init();
84}
datafusion_optimizer/lib.rs

datafusion_optimizer/
lib.rs
