Skip to main content

Modular SQL Linting for Humans

Project description

SqlFluff :scroll: :black_nib: :sparkles:

The SQL Linter for humans

image image image codecov CircleCI

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.

Getting Started

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.

  • Command line interface
    • Basic linting, both of paths and files
    • Version information
    • Nicely formatted readout of linting success or fail
    • Exist codes which reflect linting success or fail
    • Filtering to particular codes in the linting step
    • Allow basic correction of some linting codes
  • Basic ANSI linting
    • Simple whitespace testing
    • Whitespace around operators
    • Indentation (size and mix of tabs and spaces)
    • Indentation between lines and when to indent
    • Number of blank lines
    • Indentation of comments
  • Configurable linting
    • Command line options for config
    • Ability to read from config files
    • Ignore particular rules
    • Specifying particlar dialects to use
    • Preconfiguring verbosity
  • Dialects
    • MySQL
    • Redshift
    • Detecting dialect from a config file of some kind


All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[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


  • 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 | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlfluff-0.0.7.tar.gz (21.2 kB view hashes)

Uploaded Source

Built Distribution

sqlfluff-0.0.7-py3.6.egg (47.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page