Codacy SQLFluff

This is the docker engine we use at Codacy to have SQLFluff support. You can also create a docker to integrate the tool and language of your choice! See the codacy-engine-scala-seed repository for more information.

Python compatibility

Compatible with Python 3.13

Dialects compatibility

• ansi
• athena
• bigquery
• clickhouse
• databricks
• db2
• duckdb
• exasol
• greenplum
• hive
• impala
• mariadb
• materialize
• mysql
• oracle
• postgres
• redshift
• snowflake
• soql
• sparksql
• sqlite
• starrocks
• teradata
• trino
• tsql
• vertica

Configuration files supported (it follows the same order)

• setup.cfg
• tox.ini
• pep8.ini
• .sqlfluff
• pyproject.toml

What happens if I have multiple configuration files in my repository?

The configuration file at the root of the repository defines the main configuration for the project. Configuration files located in subdirectories can override or extend this main configuration, but they cannot relax or revert any restrictions defined at the root level.

For example, if a pattern is ignored in the root configuration, it remains ignored in all subdirectories. Subdirectory configurations can ignore additional patterns, but cannot re-enable those that were disabled at the root.

This ensures consistent baseline behavior across the project, while still allowing directory-specific customization when needed.

How to run SQLFluff for the dialect of my codebase

By default, we run SQLFluff with the dialect Postgres because the flag --dialect is mandatory. If your codebase is based on another dialect above, please create a simple .sqlfluff config file in the root of your repository with the following content (let's use Oracle as an example):

[sqlfluff]
dialect = oracle

It will run for all existing rules for the dialect Oracle

If you want to ignore some of the rules, please use the same configuration file:

[sqlfluff]
dialect = oracle
exclude_rules = LT01,RF01

It will run for all existing rules, excluding LT01 and RF01, for the dialect Oracle

Usage

You can create the docker by doing:

docker build --no-cache -t codacy-sqlfluff:latest .

The docker is ran with the following command:

docker run -it -v $srcDir:/src codacy-sqlfluff:latest

Generate Docs

1. Update the version in requirements.txt

2. Run the DocGenerator to update all the patterns/descriptions and the patterns.xml (from all-patterns test)

   python<version> src/doc_generator.py

Test

We use the codacy-plugins-test to test our external tools integration. You can follow the instructions there to make sure your tool is working as expected.

What is Codacy?

Codacy is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.

Among Codacy’s features:

• Identify new Static Analysis issues
• Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
• Auto-comments on Commits and Pull Requests
• Integrations with Slack, HipChat, Jira, YouTrack
• Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories

Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.

Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.

Free for Open Source

Codacy is free for Open Source projects.