Skip to content

Commit 15fe939

Browse files
authored
Move name_resolver to a different crate (#387)
This PR is in preparation of upcomming work for adding an AST Typer. The name resolver seems to be required by the `typer` but it being in `partiql-logical-planner` implies its use only in planner. In addition, this PR defines a new crate call `partiql-ast-passes` (could pick a better name and open to ideas) that intends to include passes on AST transformation. Arguably `lower` in `partiql-logical-planner` can also be part of this new crate but leaving it out for now, as logical planning is a major transform and perhaps deserves its own crate. * This PR also updates the `partiql-tests` sub-module.
1 parent 8bdb756 commit 15fe939

File tree

12 files changed

+299
-70
lines changed

12 files changed

+299
-70
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ members = [
1111
"partiql",
1212
"partiql-ast",
1313
"partiql-ast/partiql-ast-macros",
14+
"partiql-ast-passes",
1415
"partiql-catalog",
1516
"partiql-conformance-tests",
1617
"partiql-conformance-test-generator",

partiql-ast-passes/Cargo.toml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[package]
2+
name = "partiql-ast-passes"
3+
description = "A crate for PartiQL AST transformation passes"
4+
authors.workspace = true
5+
homepage.workspace = true
6+
repository.workspace = true
7+
license = "Apache-2.0"
8+
readme = "../README.md"
9+
keywords = ["sql", "ast", "query", "compilers", "interpreters", "visitors", "passes"]
10+
categories = ["database", "compilers", "ast-implementations"]
11+
exclude = [
12+
"**/.git/**",
13+
"**/.github/**",
14+
]
15+
version.workspace = true
16+
edition.workspace = true
17+
18+
[lib]
19+
path = "src/lib.rs"
20+
bench = false
21+
22+
[dependencies]
23+
partiql-ast = { path = "../partiql-ast", version = "0.5.*" }
24+
partiql-catalog = { path = "../partiql-catalog", version = "0.5.*" }
25+
26+
fnv = "1"
27+
indexmap = "1.9"
28+
thiserror = "1.0"
29+
30+
[dev-dependencies]
31+
32+
[features]
33+
default = []

partiql-ast-passes/LICENSE

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.

partiql-logical-planner/src/error.rs renamed to partiql-ast-passes/src/error.rs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
use partiql_catalog::call_defs::CallLookupError;
22
use thiserror::Error;
33

4-
/// Contains the errors that occur during AST to logical plan conversion
4+
/// Contains the errors that occur during AST transformations
55
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
6-
pub struct LoweringError {
7-
pub errors: Vec<LowerError>,
6+
pub struct AstTransformationError {
7+
pub errors: Vec<AstTransformError>,
88
}
99

10-
/// An error that can happen during the AST to logical plan conversion
10+
/// Represents an AST transform Error
1111
#[derive(Error, Debug, Clone, PartialEq, Eq, Hash)]
1212
#[non_exhaustive]
13-
pub enum LowerError {
13+
pub enum AstTransformError {
1414
/// Indicates that AST lowering has not yet been implemented for this feature.
1515
#[error("Not yet implemented: {0}")]
1616
NotYetImplemented(String),
@@ -40,11 +40,13 @@ pub enum LowerError {
4040
Unknown(String),
4141
}
4242

43-
impl From<CallLookupError> for LowerError {
43+
impl From<CallLookupError> for AstTransformError {
4444
fn from(err: CallLookupError) -> Self {
4545
match err {
46-
CallLookupError::InvalidNumberOfArguments(e) => LowerError::InvalidNumberOfArguments(e),
47-
e => LowerError::Unknown(e.to_string()),
46+
CallLookupError::InvalidNumberOfArguments(e) => {
47+
AstTransformError::InvalidNumberOfArguments(e)
48+
}
49+
e => AstTransformError::Unknown(e.to_string()),
4850
}
4951
}
5052
}

partiql-ast-passes/src/lib.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
//! The PartiQL Abstract Syntax Tree (AST) passes.
2+
//!
3+
//! # Note
4+
//!
5+
//! This API is currently unstable and subject to change.
6+
7+
pub mod error;
8+
pub mod name_resolver;

partiql-logical-planner/src/name_resolver.rs renamed to partiql-ast-passes/src/name_resolver.rs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use crate::error::{LowerError, LoweringError};
1+
use crate::error::{AstTransformError, AstTransformationError};
22
use fnv::FnvBuildHasher;
33
use indexmap::{IndexMap, IndexSet};
44
use partiql_ast::ast;
@@ -98,17 +98,17 @@ pub struct NameResolver {
9898
aliases: FnvIndexMap<ast::NodeId, Symbol>,
9999

100100
// errors that occur during name resolution
101-
errors: Vec<LowerError>,
101+
errors: Vec<AstTransformError>,
102102
}
103103

104104
impl NameResolver {
105105
pub fn resolve(
106106
&mut self,
107107
query: &ast::AstNode<ast::Query>,
108-
) -> Result<KeyRegistry, LoweringError> {
108+
) -> Result<KeyRegistry, AstTransformationError> {
109109
query.visit(self);
110110
if !self.errors.is_empty() {
111-
return Err(LoweringError {
111+
return Err(AstTransformationError {
112112
errors: std::mem::take(&mut self.errors),
113113
});
114114
}
@@ -152,10 +152,10 @@ impl NameResolver {
152152
}
153153

154154
#[inline]
155-
fn exit_lateral(&mut self) -> Result<Vec<ast::NodeId>, LowerError> {
156-
self.lateral_stack
157-
.pop()
158-
.ok_or_else(|| LowerError::IllegalState("Expected non-empty lateral stack".to_string()))
155+
fn exit_lateral(&mut self) -> Result<Vec<ast::NodeId>, AstTransformError> {
156+
self.lateral_stack.pop().ok_or_else(|| {
157+
AstTransformError::IllegalState("Expected non-empty lateral stack".to_string())
158+
})
159159
}
160160

161161
#[inline]
@@ -164,10 +164,10 @@ impl NameResolver {
164164
}
165165

166166
#[inline]
167-
fn exit_child_stack(&mut self) -> Result<Vec<ast::NodeId>, LowerError> {
168-
self.id_child_stack
169-
.pop()
170-
.ok_or_else(|| LowerError::IllegalState("Expected non-empty child stack".to_string()))
167+
fn exit_child_stack(&mut self) -> Result<Vec<ast::NodeId>, AstTransformError> {
168+
self.id_child_stack.pop().ok_or_else(|| {
169+
AstTransformError::IllegalState("Expected non-empty child stack".to_string())
170+
})
171171
}
172172

173173
#[inline]
@@ -176,10 +176,10 @@ impl NameResolver {
176176
}
177177

178178
#[inline]
179-
fn exit_keyref(&mut self) -> Result<KeyRefs, LowerError> {
180-
self.keyref_stack
181-
.pop()
182-
.ok_or_else(|| LowerError::IllegalState("Expected non-empty keyrefs".to_string()))
179+
fn exit_keyref(&mut self) -> Result<KeyRefs, AstTransformError> {
180+
self.keyref_stack.pop().ok_or_else(|| {
181+
AstTransformError::IllegalState("Expected non-empty keyrefs".to_string())
182+
})
183183
}
184184

185185
#[inline]

partiql-conformance-tests/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ partiql-conformance-test-generator = { path = "../partiql-conformance-test-gener
3535
partiql-parser = { path = "../partiql-parser", version = "0.5.*" }
3636
partiql-catalog = { path = "../partiql-catalog", version = "0.5.*" }
3737
partiql-ast = { path = "../partiql-ast", version = "0.5.*" }
38+
partiql-ast-passes = { path = "../partiql-ast-passes", version = "0.5.*" }
3839
partiql-logical-planner = { path = "../partiql-logical-planner", version = "0.5.*" }
3940
partiql-logical = { path = "../partiql-logical", version = "0.5.*" }
4041
partiql-value = { path = "../partiql-value", version = "0.5.*" }

partiql-conformance-tests/tests/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
use partiql_ast_passes::error::AstTransformationError;
12
use partiql_catalog::{Catalog, PartiqlCatalog};
23
use partiql_eval as eval;
34
use partiql_eval::env::basic::MapBindings;
45
use partiql_eval::error::PlanErr;
56
use partiql_eval::eval::{EvalPlan, EvalResult};
67
use partiql_logical as logical;
7-
use partiql_logical_planner::error::LoweringError;
88
use partiql_parser::{Parsed, ParserResult};
99
use partiql_value::Value;
1010

@@ -29,7 +29,7 @@ pub(crate) fn parse(statement: &str) -> ParserResult {
2929
pub(crate) fn lower(
3030
catalog: &dyn Catalog,
3131
parsed: &Parsed,
32-
) -> Result<logical::LogicalPlan<logical::BindingsOp>, LoweringError> {
32+
) -> Result<logical::LogicalPlan<logical::BindingsOp>, AstTransformationError> {
3333
let planner = partiql_logical_planner::LogicalPlanner::new(catalog);
3434
planner.lower(parsed)
3535
}

partiql-logical-planner/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ partiql-logical = { path = "../partiql-logical", version = "0.5.*" }
2727
partiql-ast = { path = "../partiql-ast", version = "0.5.*" }
2828
partiql-parser = { path = "../partiql-parser", version = "0.5.*" }
2929
partiql-catalog = { path = "../partiql-catalog", version = "0.5.*" }
30+
partiql-ast-passes = { path = "../partiql-ast-passes", version = "0.5.*" }
3031
ion-rs = "0.17"
3132
ordered-float = "3.*"
3233
itertools = "0.10.*"

0 commit comments

Comments
 (0)