SQLFluff is configured using a configuration file.

Flyway ships with a default configuration file in the conf/ folder of the Flyway installation called sqlfluff.cfg.example. In order to turn this into a project policy we recommend putting a copy of this as sqlfluff.cfg under version control for your project and directing Flyway where to find this using the rulesConfig parameter

Enabling and Disabling Rules

There are a number of ways to enable and disable rules in the SQLFluff configuration file SQLFluff Rules configuration

The example configuration that Flyway ships with globally disables all SQLFluff rules to avoid flooding you with warnings the moment you run code analysis. If you comment out the exclude_rules line, all rules will be enabled.

[sqlfluff]
#exclude_rules = all

Configuring Rules

Severity

By default, rules are enabled and violations are regarded as errors.

Whether Flyway will fail or not if there is an error is governed by the check.code.failOnError setting

Parameters

Many rules have configurable options that allow you to customize their behavior. For the standard SQLFluff rules you will see these defined in each rule in a section labelled "Configuration"

For the Redgate SQLFluff rules you will also find a "Configuration" section for rules where this is applicable.

In order to configure these rules you would edit the SQLFluff configuration file

As an example, if we take the rule: CV09 - Block a list of configurable words from being used. This offers the following configuration parameters blocked_regex, blocked_words and match_source

We could configure the rule to trigger a violation on the use of TODO in the SQL by configuring the it in sqlfluff.cfg like this

[sqlfluff:rules:convention.blocked_words]
blocked_words = TODO