README.md

sqruff

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!

Dialects Supported

Sqruff currently supports the following SQL dialects:

• ANSI SQL - Standard SQL syntax - This dialect is used by default
• BigQuery
• Athena
• Clickhouse
• DuckDB
• PostgreSQL
• Snowflake
• SparkSql
• SQLite
• Trino

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 to try out the linter and formatter online.

Installation

macOS

You can use brew to install sqruff easily on macOS.

brew install quarylabs/quary/sqruff

Linux

Using bash:

curl -fsSL https://raw.githubusercontent.com/quarylabs/sqruff/main/install.sh | bash

Pip

You can also install sqruff using pip.

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.

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 or compile it yourself and with cargo with the following commands.

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.

Usage

Linting

To lint a SQL file or set of files, run the following command:

sqruff lint <file>
sqruff lint <file1> <file2> <file3>
sqruff lint <directory>

Fixing

To fix a single or set of files, run the following command:

sqruff fix <file/paths/directory>

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. You can also refer to the rules documentation for more information on configuring specific rules.

[sqruff]
dialect = sqlite
exclude_rules = AM01,AM02
rules = all

[sqruff:indentation]
indent_unit = space
tab_space_size = 4
indented_joins = True

Help

To get help on the available commands and options, run the following command:

sqruff --help

For all the details on the CLI commands and options, see the CLI documentation.

Docs

For more details about, see the documents in the docs folder which contains:

• Details on the rules
• Details on the CLI
• Details on the templaters

Community

Join the Quary community on Slack 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 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 and ruff projects! We're very grateful to their awesome work!