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