datafusion_sql/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//! This crate provides:
27//!
28//! 1. A SQL parser, [`DFParser`], that translates SQL query text into
29//! an abstract syntax tree (AST), [`Statement`].
30//!
31//! 2. A SQL query planner [`SqlToRel`] that creates [`LogicalPlan`]s
32//! from [`Statement`]s.
33//!
34//! 3. A SQL [`unparser`] that converts [`Expr`]s and [`LogicalPlan`]s
35//! into SQL query text.
36//!
37//! [`DFParser`]: parser::DFParser
38//! [`Statement`]: parser::Statement
39//! [`SqlToRel`]: planner::SqlToRel
40//! [`LogicalPlan`]: datafusion_expr::logical_plan::LogicalPlan
41//! [`Expr`]: datafusion_expr::expr::Expr
42
43mod cte;
44mod expr;
45pub mod parser;
46pub mod planner;
47mod query;
48mod relation;
49pub mod resolve;
50mod select;
51mod set_expr;
52mod stack;
53mod statement;
54#[cfg(feature = "unparser")]
55pub mod unparser;
56pub mod utils;
57mod values;
58#[deprecated(
59 since = "46.0.0",
60 note = "use datafusion_common::{ResolvedTableReference, TableReference}"
61)]
62pub use datafusion_common::{ResolvedTableReference, TableReference};
63pub use sqlparser;