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

datafusion_optimizer/
lib.rs
