Skip to main content

SQL queries formatting, syntactic and semantic validation

Project description


Build Status PyPI codecov

SQL queries formatting, syntactic and semantic validation

Only supports SELECT statements

Command line usage

SQL Formatting

def fun():
    return "select col1, column2 from table"

Command line:

$ sqlvalidator --format
reformatted (1 changed SQL)
1 file reformatted (1 changed SQL queries).

def fun():
    return """
FROM table

A nosqlformat comment can be appended to indicate to sqlvalidator that this string should not be formatted.

Check SQL format

One can verify also that the file would be reformatted or not:

$ sqlvalidator --check-format
would reformat (1 changed SQL)
1 file would be reformatted (1 changed SQL queries).

$ sqlvalidator --format
reformatted (1 changed SQL)
1 file reformatted (1 changed SQL queries).

$ sqlvalidator --check-format
No file would be reformatted.

$ sqlvalidator --format
No file reformatted.

--check-format won't write the file back and just return a status code:

  • Status code 0 when nothing would change.
  • Status code 1 when some files would be reformatted.

The option is meant to be used within the CI/CD pipeline and ensure that SQL statements are formatted.

SQL Validation

One can verify that the files SQL is valid:

$ sqlvalidator --validate
invalid queries in (1 invalid SQL)
1 file detected with invalid SQL (1 invalid SQL queries).

# ... do some manual fixes to the SQL ...

$ sqlvalidator --validate
No invalid queries found.

To get more details about the found invalid elements, use --verbose-validate

API / Python code usage

SQL Formatting

import sqlvalidator

formatted_sql = sqlvalidator.format_sql("SELECT * FROM table")

SQL Validation

import sqlvalidator

sql_query = sqlvalidator.parse("SELECT * from table")

if not sql_query.is_valid():

Warning: only a limited set of validation are implemented.

Details about SQL Validation

Validation contains:

  • not using a missing column
  • existing functions
  • correct aggregations
  • schemaless (not assume that table names and columns in those exist)
  • types correctness in functions

(only on SELECT-statements)

SQL Syntax


If you want to contribute to the sqlvalidator, first, thank you for the interest.

Don't hesitate to open an Issue with a snippet of the failing SQL query and what the expected output would be.

However, I don't guarantee that will accept any Pull Request made to the repository. This is not because I don't value the work and energy put into contribution, but more because the project is still early stage, and I want to keep full control of its direction for now.


Run tests



  • python3 sdist bdist_wheel
  • twine upload dist/sqlvalidator-X.Y.Z-py3-none-any.whl dist/sqlvalidator-X.Y.Z.tar.gz

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sqlvalidator, version 0.0.18
Filename, size File type Python version Upload date Hashes
Filename, size sqlvalidator-0.0.18.tar.gz (24.2 kB) File type Source Python version None Upload date Hashes View
Filename, size sqlvalidator-0.0.18-py3-none-any.whl (23.9 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page