The SQL Linter for Humans
SQLFluff is a dialect-flexible and configurable SQL linter. Designed
with ELT applications in mind, SQLFluff also works with Jinja templating
and dbt. SQLFluff will auto-fix most linting errors, allowing you to focus
your time on what matters.
Table of Contents
- Dialects Supported
- Templates Supported
- VS Code Extension
- Getting Started
- Documentation
- Releases
- SQLFluff on Slack
- SQLFluff on Twitter
- Contributing
- Sponsors
Dialects Supported
Although SQL is reasonably consistent in its implementations, there are several
different dialects available with variations of syntax and grammar. SQLFluff
currently supports the following SQL dialects (though perhaps not in full):
We aim to make it easy to expand on the support of these dialects and also
add other, currently unsupported, dialects. Please raise issues
(or upvote any existing issues) to let us know of demand for missing support.
Pull requests from those that know the missing syntax or dialects are especially
welcomed and are the best way for you to get support added. We are happy
to work with any potential contributors on this to help them add this support.
Please raise an issue first for any large feature change to ensure it is a good
fit for this project before spending time on this work.
Templates Supported
SQL itself does not lend itself well to modularity,
so to introduce some flexibility and reusability it is often templated
as discussed more in our modularity documentation.
SQLFluff supports the following templates:
Again, please raise issues if you wish to support more templating languages/syntaxes.
VS Code Extension
We also have a VS Code extension:
Getting Started
To get started, install the package and run sqlfluff lint or sqlfluff fix.
$ pip install sqlfluff
$ echo " SELECT a + b FROM tbl; " > test.sql
$ sqlfluff lint test.sql --dialect ansi
== [test.sql] FAIL
L: 1 | P: 1 | LT01 | Expected only single space before 'SELECT' keyword.
| Found ' '. [layout.spacing]
L: 1 | P: 1 | LT02 | First line should not be indented.
| [layout.indent]
L: 1 | P: 1 | LT13 | Files must not begin with newlines or whitespace.
| [layout.start_of_file]
L: 1 | P: 11 | LT01 | Expected only single space before binary operator '+'.
| Found ' '. [layout.spacing]
L: 1 | P: 14 | LT01 | Expected only single space before naked identifier.
| Found ' '. [layout.spacing]
L: 1 | P: 27 | LT01 | Unnecessary trailing whitespace at end of file.
| [layout.spacing]
L: 1 | P: 27 | LT12 | Files must end with a single trailing newline.
| [layout.end_of_file]
All Finished 📜 🎉!
If you want the optional Rust-backed parser and lexer, install the rs extra:
$ pip install sqlfluff[rs]
On supported CPython 3.10+ platforms this installs a prebuilt ABI3 wheel. If no
wheel is published for your platform, pip falls back to building sqlfluffrs
from source, which requires a Rust toolchain and a working C/C++ build setup.
The easiest way to install Rust is with rustup.
Alternatively, you can use the Official SQLFluff Docker Image
or have a play using SQLFluff online.
For full CLI usage and
rules reference, see
the SQLFluff docs.
Documentation
For full documentation visit docs.sqlfluff.com.
This documentation is generated from this repository so please raise
issues or pull requests
for any additions, corrections, or clarifications.
Releases
SQLFluff adheres to Semantic Versioning,
so breaking changes should be restricted to major versions releases. Some
elements (such as the python API) are in a less stable state and may see more
significant changes more often. For details on breaking changes and how
to migrate between versions, see our
release notes. See the
changelog for more details. If you would like to join in, please
consider contributing.
New releases are made monthly. For more information, visit
Releases.
SQLFluff on Slack
We have a fast-growing community
on Slack,
come and join us!
SQLFluff on Twitter
Follow us on Twitter @SQLFluff for announcements
and other related posts.
Contributing
We are grateful to all our contributors.
There is a lot to do in this project, and we are just getting started.
If you want to understand more about the architecture of SQLFluff, you can
find more here.
If you would like to contribute, check out the
open issues on GitHub. You can also see
the guide to contributing, including the pull request
acceptance principles and AI-assisted contribution expectations.
Sponsors
The turnkey analytics stack, find out more at Datacoves.com.
