Bored of not having a good SQL linter that works with whichever dialect you're working with? SQLFluff is an extensible and modular linter designed to help you write good SQL and catch errors before it hits your database. SQLFluff can auto-fix most linting errors too.
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
== [test.sql] FAIL
L: 1 | P: 1 | L003 | Single indentation uses a number of spaces not a multiple of 4
L: 1 | P: 14 | L006 | Operators should be surrounded by a single space unless at the start/end of a line
L: 1 | P: 27 | L001 | Unnecessary trailing whitespaceYou can also have a play using SQLFluff online.
For full CLI usage and rules reference, see the docs.
For full documentation visit docs.sqlfluff.com.
SQLFluff is still in an open alpha phase - expect the tool to change significantly over the coming months, and expect potentially non-backward compatible api changes to happen at any point. If you'd like to help please consider contributing.
- 0.4.x (ongoing development) will fully support dbt packages and macros with significant speed improvements and new rules.
- 0.3.x dropped support for python 2.7 and 3.4, and reworked the handling of indentation linting in a potentially not backward compatible way.
- 0.2.x added templating support and a big restructure of rules and changed how users might interact with sqlfluff on templated code.
- 0.1.x involved a major re-write of the parser, completely changing the behaviour of the tool with respect to complex parsing.
We have a fast-growing community on Slack, come and join us!
https://join.slack.com/t/sqlfluff/shared_invite/zt-js0wsnvo-78gEI0phW9_LiItXAiJcqQ
There's lots to do in this project, and we're just getting started. If you want to understand more about the architecture of SQLFluff, you can find more here.
If you'd like to contribute, check out the open issues on GitHub. You can also see the guide to contributing.