sqlfluff

sqlfluff documentation

• Version in MegaLinter: 1.0.0
• Visit Official Web Site
• See How to configure sqlfluff rules
  • If custom .sqlfluff config file is not found, .sqlfluff will be used
• See Index of problems detected by sqlfluff

Configuration in MegaLinter

• Enable sqlfluff by adding SQL_SQLFLUFF in ENABLE_LINTERS variable
• Disable sqlfluff by adding SQL_SQLFLUFF in DISABLE_LINTERS variable

Variable	Description	Default value
SQL_SQLFLUFF_ARGUMENTS	User custom arguments to add in linter CLI call Ex: -s --foo "bar"
SQL_SQLFLUFF_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: (src\|lib)	Include every file
SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: (test\|examples)	Exclude no file
SQL_SQLFLUFF_CLI_LINT_MODE	Override default CLI lint mode - file: Calls the linter for each file - list_of_files: Call the linter with the list of files as argument - project: Call the linter from the root of the project	list_of_files
SQL_SQLFLUFF_FILE_EXTENSIONS	Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files Ex: [".py", ""]	[".sql"]
SQL_SQLFLUFF_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]	Include every file
SQL_SQLFLUFF_PRE_COMMANDS	List of bash commands to run before the linter	None
SQL_SQLFLUFF_POST_COMMANDS	List of bash commands to run after the linter	None
SQL_SQLFLUFF_CONFIG_FILE	sqlfluff configuration file name Use LINTER_DEFAULT to let the linter find it	.sqlfluff
SQL_SQLFLUFF_RULES_PATH	Path where to find linter configuration file	Workspace folder, then MegaLinter default rules
SQL_SQLFLUFF_DISABLE_ERRORS	Run linter but consider errors as warnings	false
SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	0

MegaLinter Flavours

This linter is available in the following flavours

	Flavor	Description	Embedded linters	Info
	all	Default MegaLinter Flavor	97
	dart	Optimized for DART based projects	42
	documentation	MegaLinter for documentation projects	41
	dotnet	Optimized for C, C++, C# or VB based projects	49
	go	Optimized for GO based projects	43
	java	Optimized for JAVA based projects	43
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	50
	php	Optimized for PHP based projects	46
	python	Optimized for PYTHON based projects	49
	ruby	Optimized for RUBY based projects	42
	rust	Optimized for RUST based projects	42
	salesforce	Optimized for Salesforce based projects	44
	scala	Optimized for SCALA based projects	42
	swift	Optimized for SWIFT based projects	42
	terraform	Optimized for TERRAFORM based projects	47

Behind the scenes

How are identified applicable files

• Activated only if one of these files is found: .sqlfluff
• File extensions: .sql

How the linting is performed

• sqlfluff is called once with the list of files as arguments

Example calls

sqlfluff myfile.sql

sqlfluff --config .sqlfluff myfile.sql myfile2.sql

Help content

Usage: sqlfluff [OPTIONS] COMMAND [ARGS]...

  SQLFluff is a modular SQL linter for humans.

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  dialects  Show the current dialects available.
  fix       Fix SQL files.
  lint      Lint SQL files via passing a list of files or using stdin.
  parse     Parse SQL files and just spit out the result.
  rules     Show the current rules in use.
  version   Show the version of sqlfluff.

Installation on mega-linter Docker image

• PIP packages (Python):
  • sqlfluff