squabble 1.3.0

Installation

$ pip3 install squabble
$ squabble --help

If you’d like to install from source:

$ git clone https://github.com/erik/squabble.git && cd squabble
$ python3 -m venv ve && source ve/bin/activate
$ python setup.py install
$ squabble --help

Configuration

To see a list of rules, try

$ squabble --list-rules

Then, to show more verbose information about a rule (such as rationale and configuration options)

$ squabble --show-rule AddColumnsDisallowConstraints

Once a configuration file is in place, it can be passed explicitly on the command line, or automatically looked up.

$ squabble -c path/to/config ...

If not explicitly given on the command line, squabble will look for a file named .squabblerc in the following places (in order):

• ./.squabblerc

• (git_repo_root)/.squabblerc

• ~/.squabblerc

-- disable:RuleA
-- enable:RuleB config=value array=1,2,3
SELECT email FROM users WHERE ...;

{
  "reporter": "color",

  "plugins": [
    "/some/directory/with/custom/rules"
  ],

  "rules": {
    "AddColumnsDisallowConstraints": {
      "disallowed": ["DEFAULT", "FOREIGN", "NOT NULL"]
    }
  }
}

Prior Art

squabble is of course not the first tool in this space. If it doesn’t fit your needs, consider one of these tools:

• sqlcheck - regular expression based (rather than parsing), focuses more on SELECT statements than migrations.

• sqlint - checks that the syntax of a file is valid. Uses the same parsing library as squabble.

• sqlfluff - focused more on style and formatting, seems to still be a work in progress.

Acknowledgments

This project would not be possible without:

• libpg_query - Postgres query parser

• pglast - Python bindings to libpg_query

• Postgres - …obviously

The logo image used in the documentation is created by Gianni - Dolce Merda from the Noun Project.