sql-lint
sql-lint documentation
- Version in Mega-Linter: 0.0.19
- Visit Official Web Site
- See How to configure sql-lint rules
- If custom
.sql-config.json
config file is not found, .sql-config.json will be used
- If custom
- See Index of problems detected by sql-lint
Configuration in Mega-Linter
- Enable sql-lint by adding
SQL_SQL_LINT
in ENABLE_LINTERS variable - Disable sql-lint by adding
SQL_SQL_LINT
in DISABLE_LINTERS variable
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 |
{linter.cli_lint_mode} |
SQL_SQL_LINT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".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 nameUse 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 Mega-Linter 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 Mega-Linter !
IDE | Extension Name | Install | |
---|---|---|---|
vim | ale | Visit Web Site |
Mega-Linter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
all | Default Mega-Linter Flavor | 93 | ||
dart | Optimized for DART based projects | 40 | ||
documentation | Mega-Linter for documentation projects | 39 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 46 | ||
go | Optimized for GO based projects | 41 | ||
java | Optimized for JAVA based projects | 41 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 48 | ||
php | Optimized for PHP based projects | 43 | ||
python | Optimized for PYTHON based projects | 48 | ||
ruby | Optimized for RUBY based projects | 40 | ||
rust | Optimized for RUST based projects | 40 | ||
salesforce | Optimized for Salesforce based projects | 42 | ||
scala | Optimized for SCALA based projects | 40 | ||
swift | Optimized for SWIFT based projects | 40 | ||
terraform | Optimized for TERRAFORM based projects | 44 |
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
- NPM packages (node.js):
Example success log
Results of sql-lint linter (version 0.0.15)
See documentation on https://nvuillam.github.io/mega-linter/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://nvuillam.github.io/mega-linter/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.