Skip to content

docs: say which dialects check, fix and format read #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kvlonge merged 1 commit into from
Nov 8, 2026
Merged

docs: say which dialects check, fix and format read #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions crates/sqlclean-cli/skill/references/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,16 +123,19 @@ SELECT [order id] FROM orders
error[SQLCLEAN999]: SQL could not be parsed as duckdb: Parse error at line 1, column 17: Expected RBracket, got Var ('id') near [SELECT [order id] FROM orders]
```

SQLClean reads SQL with SQLQuack's parsers. A file in a dialect SQLQuack does not parse yet, such
as `mysql`, is not checked, fixed or formatted: `check` reports it once as a warning (in JSON, under
`unavailable`), and it never fails a command or counts as a problem.
SQLClean reads SQL with SQLQuack's parsers. `check` and `fix` read `duckdb`, `generic`, `postgres`,
`snowflake` and `sqlite` files, and `format` lays out `duckdb` and `snowflake` files; a `generic`,
`postgres` or `sqlite` file is checked and fixed but left as written by `format`. A file in any
other dialect, such as `mysql` or `tsql`, is not checked, fixed or formatted: `check` reports it once
as a warning (in JSON, under `unavailable`), `format` leaves it unchanged with a warning, and it
never fails a command or counts as a problem.

```text
warning: SQL lint is unavailable for the mysql dialect: SQLQuack does not parse it yet
--> reports/q.sql
```

Supported dialects, case-insensitive:
Dialect names SQLClean accepts, case-insensitive:

| Dialect | Also accepted |
|---------|---------------|
Expand Down
11 changes: 7 additions & 4 deletions website/src/content/docs/docs/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,19 @@ SELECT [order id] FROM orders
error[SQLCLEAN999]: SQL could not be parsed as duckdb: Parse error at line 1, column 17: Expected RBracket, got Var ('id') near [SELECT [order id] FROM orders]
```

SQLClean reads SQL with SQLQuack's parsers. A file in a dialect SQLQuack does not parse yet, such
as `mysql`, is not checked, fixed or formatted: `check` reports it once as a warning (in JSON, under
`unavailable`), and it never fails a command or counts as a problem.
SQLClean reads SQL with SQLQuack's parsers. `check` and `fix` read `duckdb`, `generic`, `postgres`,
`snowflake` and `sqlite` files, and `format` lays out `duckdb` and `snowflake` files; a `generic`,
`postgres` or `sqlite` file is checked and fixed but left as written by `format`. A file in any
other dialect, such as `mysql` or `tsql`, is not checked, fixed or formatted: `check` reports it once
as a warning (in JSON, under `unavailable`), `format` leaves it unchanged with a warning, and it
never fails a command or counts as a problem.

```text
warning: SQL lint is unavailable for the mysql dialect: SQLQuack does not parse it yet
--> reports/q.sql
```

Supported dialects, case-insensitive:
Dialect names SQLClean accepts, case-insensitive:

| Dialect | Also accepted |
|---------|---------------|
Expand Down
Loading