Skip to content

sql-lint

sql-lint documentation

sql-lint - GitHub

Configuration in MegaLinter

Variable Description Default value
SQL_SQL_LINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
SQL_SQL_LINT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src\|lib)
Include every file
SQL_SQL_LINT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test\|examples)
Exclude no file
SQL_SQL_LINT_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
file
SQL_SQL_LINT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".sql"]
SQL_SQL_LINT_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_SQL_LINT_PRE_COMMANDS List of bash commands to run before the linter None
SQL_SQL_LINT_POST_COMMANDS List of bash commands to run after the linter None
SQL_SQL_LINT_CONFIG_FILE sql-lint configuration file name
Use LINTER_DEFAULT to let the linter find it
.sql-config.json
SQL_SQL_LINT_RULES_PATH Path where to find linter configuration file Workspace folder, then MegaLinter default rules
SQL_SQL_LINT_DISABLE_ERRORS Run linter but consider errors as warnings false
SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0

IDE Integration

Use sql-lint in your favorite IDE to catch errors before MegaLinter !

IDE Extension Name Install
vim ale Visit Web Site

MegaLinter Flavours

This linter is available in the following flavours

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

Behind the scenes

How are identified applicable files

  • File extensions: .sql

How the linting is performed

  • sql-lint is called one time by identified file

Example calls

sql-lint myfile.sql
sql-lint --config .sql-config.json myfile.sql

Help content

Usage: sql-lint [options]

Options:
  -V, --version          output the version number
  --fix [string]         The .sql string to fix
  -d, --driver <string>  The driver to use, must be one of ['mysql',
                         'postgres']
  -v, --verbose          Brings back information on the what it's linting and
                         the tokens generated
  --format <string>      The format of the output, can be one of ['simple',
                         'json'] (default: "simple")
  --host <string>        The host for the connection
  --user <string>        The user for the connection
  --password <string>    The password for the connection
  --port <string>        The port for the connection
  --config <string>      The path to the configuration file
  -h, --help             display help for command

Installation on mega-linter Docker image

Example success log

Results of sql-lint linter (version 0.0.15)
See documentation on https://megalinter.github.io/descriptors/sql_sql_lint/
-----------------------------------------------

[SUCCESS] .automation/test/sql/sql_good_1.sql


Example error log

Results of sql-lint linter (version 0.0.15)
See documentation on https://megalinter.github.io/descriptors/sql_sql_lint/
-----------------------------------------------

[ERROR] .automation/test/sql/sql_bad_1.sql
    .automation/test/sql/sql_bad_1.sql:1 [sql-lint: missing-where] DELETE statement missing WHERE clause.