Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quarylabs/sqruff
A compact, high-speed SQL linter, engineered with Rust efficiency.
https://github.com/quarylabs/sqruff
Last synced: about 2 months ago
JSON representation
A compact, high-speed SQL linter, engineered with Rust efficiency.
- Host: GitHub
- URL: https://github.com/quarylabs/sqruff
- Owner: quarylabs
- License: mit
- Created: 2023-02-13T19:36:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T19:44:00.000Z (8 months ago)
- Last Synced: 2024-04-13T20:45:25.774Z (8 months ago)
- Language: Rust
- Homepage: https://quary.dev/
- Size: 897 KB
- Stars: 82
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-clickhouse - quarylabs/sqruff - Sqruff is a fast SQL linter and formatter written in Rust. (UIs / CLI)
README
`sqruff` is a SQL linter and formatter written in Rust. Key features include:
- **Linting:** Advanced, customizable SQL linting capabilities to ensure query quality.
- **Formatting:** Automated, configurable formatting for SQL code consistency.
- **Speed:** Fast and efficient, with minimal overhead.
- **Portability:** Designed to be easily integrated into various development workflows like a website.
Try it out in the [playground](https://playground.quary.dev)!
## Dialects Supported
Sqruff currently supports the following SQL dialects:
- **ANSI SQL** - Standard SQL syntax - **This dialect is used by default**
- [**BigQuery**](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax)
- [**Athena**](https://docs.aws.amazon.com/athena/latest/ug/ddl-sql-reference.html)
- [**Clickhouse**](https://clickhouse.com/docs/en/sql-reference/)
- [**DuckDB**](https://duckdb.org/docs/sql/introduction)
- [**PostgreSQL**](https://www.postgresql.org/docs/current/sql.html)
- [**Snowflake**](https://docs.snowflake.com/en/sql-reference.html)
- [**SparkSql**](https://spark.apache.org/sql/)
- [**SQLite**](https://www.sqlite.org/lang.html)
- [**Trino**](https://trino.io/docs/current/sql.html)
While those above are the supported dialects, we are working on adding support for more dialects in the future.
## Getting Started
### Try it in your browser
Open the [playground](https://playground.quary.dev) to try out the linter and formatter online.
### Installation
#### macOS
You can use [brew](https://brew.sh/) to install sqruff easily on macOS.
```bash
brew install quarylabs/quary/sqruff
```
#### Linux
Using `bash`:
```bash
curl -fsSL https://raw.githubusercontent.com/quarylabs/sqruff/main/install.sh | bash
```
#### Pip
You can also install sqruff using [pip](https://pypi.org/project/sqruff/).
```bash
pip install sqruff
```
#### GitHub Action
You can also use the GitHub Action to install and run sqruff in your CI/CD pipeline. Inside a Github Action, `sqruff` automatically outputs linting output in the GitHub format so that it can be easily viewed in the PR tab.
```yaml
jobs:
sqruff-lint:
name: Lint with sqruff
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: quarylabs/install-sqruff-cli-action@main
- run: sqruff lint .
```
#### For other platforms
Either download the binary from the [releases page](https://github.com/quarylabs/sqruff/releases) or compile it yourself and with cargo with the following commands.
```bash
rustup toolchain install nightly
cargo +nightly install sqruff
sqruff --help
```
#### Visual Studio Code Extension
In addition to the CLI installation mechanism listed above, sqruff is also released as a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=Quary.sqruff).
### Usage
#### Linting
To lint a SQL file or set of files, run the following command:
```bash
sqruff lint
sqruff lint
sqruff lint
```
#### Fixing
To fix a single or set of files, run the following command:
```bash
sqruff fix
```
#### Configuration
Settings for SQL dialect, indentation, capitalization, and other linting/style options are configured in a `.sqruff` file. This file should be located in the directory where Sqruff is being run.
The following example highlights a few configuration points: setting the dialect to `sqlite`, turning on all rules except AM01 and AM02, and configuring some indentation settings. For a comprehensive list of configuration options, see the [default configuration file](crates/lib/src/core/default_config.cfg). You can also refer to the [rules documentation](docs/rules.md) for more information on configuring specific rules.
```ini
[sqruff]
dialect = sqlite
exclude_rules = AM01,AM02
rules = all
[sqruff:indentation]
indent_unit = space
tab_space_size = 4
indented_joins = True
```
#### Ignoring errors
The NoQA directive is a way to disable specific rules or all rules for a specific line or range of lines. Similar to flake8’s ignore, individual lines can be ignored by adding `-- noqa` to the end of the line.
##### Ignoring single line errors
The following example will ignore all errors on the line where it is placed:
```sql
-- Ignore all errors
SeLeCt 1 from tBl ; -- noqa
-- Ignore rule CP02 & rule CP03
SeLeCt 1 from tBl ; -- noqa: CP02,CP03
```
##### Ignoring multiple line errors
Similar to pylint’s “pylint directive”, ranges of lines can be ignored by adding `-- noqa:disable=[,...] | all` to the line. Following this directive, specified rules (or all rules, if “all” was specified) will be ignored until a corresponding `-– noqa:enable=[,…] | all`.
For example:
```sql
-- Ignore rule AL02 from this line forward
SELECT col_a a FROM foo -- noqa: disable=AL02
-- Ignore all rules from this line forward
SELECT col_a a FROM foo -- noqa: disable=all
-- Enforce all rules from this line forward
SELECT col_a a FROM foo -- noqa: enable=all
```
#### Help
To get help on the available commands and options, run the following command:
```bash
sqruff --help
```
For all the details on the CLI commands and options, see the [CLI documentation](./docs/cli.md).
## Docs
For more details about, see the documents in the [docs](./docs/) folder which contains:
- [Details on the rules](./docs/rules.md)
- [Details on the CLI](./docs/cli.md)
- [Details on the templaters](./docs/templaters.md)
## Community
Join the Quary community on [Slack](https://join.slack.com/t/quarylabs/shared_invite/zt-2dlbfnztw-dMLXJVL38NcbhqRuM5gUcw) to ask questions, suggest features, or share your projects. Also feel free to raise any issues in the repository.
## Contributing
Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to run things locally and on how to contribute.
## Credits
The sqruff project wouldn't be possible without "heavy inspiration" from the [sqlfluff](https://sqlfluff.com/) and [ruff](https://github.com/astral-sh/ruff) projects! We're very grateful to their awesome work!
