Modular SQL Linting for Humans
SqlFluff :scroll: :black_nib: :sparkles:
The SQL Linter for humans
Bored of not having a good SQL linter that works with whichever dialiect you're working with? Fluff is an extensible and modular linter designed to help you write good SQL and catch errors and bad SQL before it hits your database.
Sqlfluff is still in an open alpha phase - expect the tool to change significantly over the coming months, and expect potentially non-backward compatable api changes to happen at any point. In particular moving from 0.0.x to 0.1.x introduced some non backward compatible changes and potential loss in functionality. If you'd like to help please consider contributing.
To get started just install the package, make a sql file and then run sqlfluff and point it at the file.
$ 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 whitespace
For more details on usage see the docs on github here.
There's lots to do in this project, and we're just getting started. NB: This list has started again from the top due to the re-write. If you want to understand more about the architecture of sqlfluff, you can find more here.
- [x] Command line interface
- [x] Basic linting, both of paths and files
- [x] Version information
- [x] Nicely formatted readout of linting success or fail
- [x] Exit codes which reflect linting success or fail
- [x] Filtering to particular codes in the linting step
- [x] Allow basic correction of some linting codes
- [x] Basic ANSI linting
- [x] Simple whitespace testing
- [x] Whitespace around operators
- [x] Indentation (size and mix of tabs and spaces)
- [ ] Indentation between lines and when to indent
- [ ] Number of blank lines
- [ ] Indentation of comments
- [ ] Inconsistent capitalisation of keywords
- [ ] Inconsistent capitalisation of unquoted identifiers
- [ ] (idea) Implement a context manager in the parse and match functions to avoid passing around so many variables.
- [ ] Configurable linting
- [ ] Command line options for config
- [ ] Ability to read from config files
- [ ] Ability to read config from block comment
- [x] Ignore particular rules (blacklisting)
- [ ] Specifying particlar dialects to use
- [ ] Preconfiguring verbosity
- [x] Dialects
- [ ] ANSI
- [ ] Implement singleton matching for
- [ ] Bring in a much wider selection of test queries to identify next gaps.
- [ ] Flesh out function coverage.
- [ ] Implement singleton matching for
- [ ] MySQL
- [ ] Redshift
- [ ] Snowflake
- [ ] Detecting dialect from a config file of some kind
- [ ] jinja2 compatible linting (for dbt)
- [ ] ANSI
- [ ] Documentation
- [x] Basic architectural principles
- [ ] Update CLI docs to match current state
All notable changes to this project will be documented in this file.
[0.1.5] - 2019-11-11
- Python 3.8 Support!
- Moved some of the responsibility for formatted logging into the linter to mean that we can log progressively in large directories.
- Fixed a bug in the grammar where one of the return values was messed up.
[0.1.4] - 2019-11-10
- Added a
--exclude-rulesargument to most of the commands to allow rule users to exclude specific subset of rules, by @sumitkumar1209
- Added lexing for
- Added a new common segment:
LambdaSegmentwhich allows matching based on arbitrary functions which can be applied to segments.
- Recursive Expressions for both arithmetic and functions, based heavily off the grammar provided by the guys at CockroachDB.
Anythinggrammar, useful in matching rather than in parsing to match anything.
- Complete rewrite of the bracket counting functions, using some centralised class methods
BaseGrammarclass to support common matching features across multiple grammars. In particular this affects the
Delimitedgrammar which is now much simpler but does also require slightly more liberal use of terminators to match effectively.
- Rather than passing around multiple variables during parsing and matching, there is now
ParseContextobject which contains things like the dialect and various depths. This simplifies the parsing and matching code significantly.
- Bracket referencing is now done from the dialect directly, rather than in individual
Grammars (except the
Bracketedgrammar, which still implements it directly). This takes out some originally duplicated code.
- Corrected the parsing of ordering keywords in and
- Removed the
bracket_sensitive_forward_matchmethod from the
BaseGrammar. It was ugly and not flexible enough. It's been replaced by a suite of methods as described above.
[0.1.3] - 2019-10-30
- Tweak to the L001 rule so that it doesn't crash the whole thing.
[0.1.2] - 2019-10-30
- Fixed the errors raised by the lexer.
[0.1.1] - 2019-10-30
- Fixed which modules from sqlfluff are installed in the setup.py. This affects
[0.1.0] - 2019-10-29
- Big Rewrite - some loss in functionality might be apparent compared to pre-0.1.0. Please submit any major problems as issues on github
- Changed unicode handling for better escape codes in python 2. Thanks @mrshu
- BIG rewrite of the parser, completely new architecture. This introduces
breaking changes and some loss of functionality while we catch up.
- In particular, matches now return partial matches to speed up parsing.
Delimitedmatcher has had a significant re-write with a major speedup and broken the dependency on
- Rewrite of
Sequenceto use partial matches properly.
- Different treatment of numeric literals.
Delimitedrespect bracket counting.
- MASSIVE rewrite of
- Grammars now have timers.
- Joins properly parsing,
- Rewrite of logging to selectively output commands at different levels
of verbosity. This uses the
- Added a command line
sqlfluff parseoption which runs just the parsing step of the process to better understand how a file is being parsed. This also has options to configure how deep we recurse.
- Complete Re-write of the rules section, implementing new
crawlerswhich implement the linting rules. Now with inbuilt fixers in them.
- Old rules removed and re implemented so we now have parity with the old rule sets.
- Moved to using Ref mostly within the core grammar so that we can have recursion.
- Used recursion to do a first implementation of arithmetic parsing. Including a test for it.
- Moved the main grammar into a seperate dialect and renamed source and test files accordingly.
- Moved to file-based tests for the ansi dialect to make it easier to test using the tool directly.
- As part of file tests - expected outcomes are now encoded in yaml to make it easier to write new tests.
- Vastly improved readability and debugging potential of the _match logging.
- Added support for windows line endings in the lexer.
[0.0.7] - 2018-11-19
- Added a
sqlfluff fixas a command to implement auto-fixing of linting errors. For now only
L001is implemented as a rule that can fix things.
- Added a
rulescommand to introspec the available rules.
- Updated the cli table function to use the
testwraplibrary and also deal a lot better with longer values.
- Added a
--rulesargument to most of the commands to allow rule users to focus their search on a specific subset of rules.
- Refactor the cli tests to use the click CliRunner. Much faster
[0.0.6] - 2018-11-15
- Number matching
- Fixed operator parsing and linting (including allowing the exception of
[0.0.5] - 2018-11-15
- Much better documentation including the DOCS.md
- Fixed comma parsing and linting
[0.0.4] - 2018-11-14
- Added operator regexes
- Added a priority for matchers to resolve some abiguity
- Added tests for operator regexes
- Added ability to initialise the memory in rules
[0.0.3] - 2018-11-14
- Refactor of rules to allow rules with memory
- Adding comma linting rules (correcting the single character matchers)
- Adding mixed indentation linting rules
- Integration with CircleCI, CodeCov and lots of badges
- Changed import of version information to fix bug with importing config.ini
- Added basic violations/file reporting for some verbosities
- Refactor of rules to simplify definition
- Refactor of color cli output to make it more reusable
[0.0.2] - 2018-11-09
- Longer project description
- Proper exit codes
- colorama for colored output
- Significant CLI changes
- Much improved output from CLI
[0.0.1] - 2018-11-07
- Initial Commit! - VERY ALPHA
- Restructure into package layout
- Adding Tox and Pytest so that they work
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size sqlfluff-0.1.5.tar.gz (51.9 kB)||File type Source||Python version None||Upload date||Hashes View hashes|