Skip to content

Commit 2433e2f

Browse files
committed
docs: clarify sqlquack positioning
1 parent 49958b6 commit 2433e2f

3 files changed

Lines changed: 9 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# SQLQuack
22

3-
SQLQuack is an early-stage Rust SQL semantic engine for warehouse SQL analysis and fail-closed DuckDB transpilation.
3+
SQLQuack is an early-stage SQLGlot-inspired Rust engine for warehouse SQL analysis and fail-closed DuckDB transpilation.
44

5-
The project is inspired by SQLGlot's feature breadth, but it is not intended to be an `N x N` best-effort transpiler. SQLQuack focuses on structured analysis first and only emits DuckDB SQL when supported semantics are expected to be preserved.
5+
SQLQuack is not a broad `N x N` dialect transpiler. It is intended for callers that need structured facts about expanded warehouse SQL: diagnostics, output columns, references, lineage, and conservative type/nullability information.
6+
7+
DuckDB output is fail-closed. SQLQuack should only emit DuckDB SQL when the source semantics are expected to be preserved; unsupported or ambiguous constructs should produce diagnostics instead of best-effort rewrites.
68

79
Status: early development. APIs are unstable.

‎crates/sqlquack-structure-checker/tests/rules/imports.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ const TEST_CASES: &[test_types::CheckRepoTestCase] = &[
1313
test_types::CheckRepoTestCase {
1414
description: "reports pub crate use reexport",
1515
repo_files: &[test_types::RepoFile {
16-
path: "crates/sqlquack/src/analysis/mod.rs",
17-
contents: "pub(crate) use models::AnalysisResult;\n",
16+
path: "crates/sqlquack/src/analysis/models.rs",
17+
contents:
18+
"pub(crate) use crate::ast::models as ast_models;\npub struct AnalysisResult;\n",
1819
}],
1920
expected_violation_codes: &["SQS023"],
2021
},

‎crates/sqlquack/Cargo.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ edition.workspace = true
55
license.workspace = true
66
repository.workspace = true
77
readme.workspace = true
8-
description = "Rust SQL semantic analysis and fail-closed DuckDB transpilation engine"
9-
keywords = ["sql", "duckdb", "parser", "transpiler", "lineage"]
8+
description = "Warehouse SQL analysis and fail-closed DuckDB transpilation engine"
9+
keywords = ["sql", "duckdb", "parser", "analysis", "lineage"]
1010
categories = ["parser-implementations", "database"]
1111

1212
[dependencies]

0 commit comments

Comments
 (0)