Add common planner

Signed-off-by: Xuanwo <github@xuanwo.io>

Author: Xuanwo

Cargo.lock

@@ -30,6 +30,7 @@ members = [
     "src/query/functions-v2",
     "src/query/legacy-parser",
     "src/query/management",
+    "src/query/planner",
     "src/query/pipeline/core",
     "src/query/pipeline/sinks",
     "src/query/pipeline/sources",

Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "common-planner"
+version = "0.1.0"
+authors = ["Databend Authors <opensource@datafuselabs.com>"]
+license = "Apache-2.0"
+publish = false
+edition = "2021"
+
+[dependencies]

src/query/planner/Cargo.toml

@@ -0,0 +1,25 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Databend Planner is the core part of Databend Query, it will:
+//!
+//! - Use `Parser` (provided by `common-ast`) to parse query into AST.
+//! - Use `Binder` to bind query into `LogicalPlan`
+//! - Use `Optimizer` to optimize `LogicalPlan` into `PhysicalPlan`
+//!
+//! After all the planners work, `Interpreter` will use `PhysicalPlan` to
+//! build pipelines, then our processes will produce result data blocks.
+
+mod metadata;
+pub use metadata::IndexType;

src/query/planner/src/lib.rs

@@ -0,0 +1,18 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// Planner use [`usize`] as it's index type.
+///
+/// This type will be used across the whole planner.
+pub type IndexType = usize;

src/query/planner/src/metadata.rs

@@ -61,6 +61,7 @@ common-pipeline-core = { path = "../pipeline/core" }
 common-pipeline-sinks = { path = "../pipeline/sinks" }
 common-pipeline-sources = { path = "../pipeline/sources" }
 common-pipeline-transforms = { path = "../pipeline/transforms" }
+common-planner = { path = "../planner" }
 common-settings = { path = "../settings" }
 common-storage = { path = "../../common/storage" }
 common-storages-fuse = { path = "../storages/fuse" }

src/query/service/Cargo.toml

@@ -25,12 +25,12 @@ use common_datavalues::DataSchemaRefExt;
 use common_datavalues::DataTypeImpl;
 use common_exception::ErrorCode;
 use common_exception::Result;
+use common_planner::IndexType;
 use parking_lot::RwLock;
 
 use super::AggregateInfo;
 use crate::sql::normalize_identifier;
 use crate::sql::optimizer::SExpr;
-use crate::sql::planner::IndexType;
 use crate::sql::plans::Scalar;
 use crate::sql::NameResolutionContext;
 

src/query/service/src/sql/planner/binder/bind_context.rs

@@ -15,12 +15,12 @@
 use std::collections::HashMap;
 
 use common_exception::Result;
+use common_planner::IndexType;
 
 use crate::sql::binder::Binder;
 use crate::sql::binder::ColumnBinding;
 use crate::sql::optimizer::SExpr;
 use crate::sql::planner::semantic::GroupingChecker;
-use crate::sql::planner::IndexType;
 use crate::sql::plans::Aggregate;
 use crate::sql::plans::AggregateMode;
 use crate::sql::plans::BoundColumnRef;

src/query/service/src/sql/planner/binder/distinct.rs

@@ -18,6 +18,7 @@ use common_ast::ast::Indirection;
 use common_ast::ast::SelectTarget;
 use common_exception::ErrorCode;
 use common_exception::Result;
+use common_planner::IndexType;
 
 use super::bind_context::NameResolutionResult;
 use crate::sql::binder::select::SelectItem;
@@ -31,7 +32,6 @@ use crate::sql::planner::binder::Binder;
 use crate::sql::planner::binder::ColumnBinding;
 use crate::sql::planner::semantic::normalize_identifier;
 use crate::sql::planner::semantic::GroupingChecker;
-use crate::sql::planner::IndexType;
 use crate::sql::plans::BoundColumnRef;
 use crate::sql::plans::EvalScalar;
 use crate::sql::plans::Project;

src/query/service/src/sql/planner/binder/project.rs

@@ -21,6 +21,7 @@ use common_ast::ast::OrderByExpr;
 use common_ast::DisplayError;
 use common_exception::ErrorCode;
 use common_exception::Result;
+use common_planner::IndexType;
 
 use super::bind_context::NameResolutionResult;
 use crate::sql::binder::scalar::ScalarBinder;
@@ -30,7 +31,6 @@ use crate::sql::binder::ColumnBinding;
 use crate::sql::normalize_identifier;
 use crate::sql::optimizer::SExpr;
 use crate::sql::planner::semantic::GroupingChecker;
-use crate::sql::planner::IndexType;
 use crate::sql::plans::AggregateFunction;
 use crate::sql::plans::AndExpr;
 use crate::sql::plans::BoundColumnRef;