sqlvalidator

SQL queries formatting, syntactic and semantic validation

Only supports SELECT statements

Command line usage

SQL Formatting

sql.py

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

Command line:

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

sql.py

def fun():
    return """
SELECT
 col1,
 column2
FROM table
"""  # sqlformat

The sqlformat comment is required to indicated to sqlvalidator that this string is a SQL statement and should be formatted.

Check SQL format

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

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


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


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


$ sqlvalidator --format sql.py
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

TODO, no CLI option has been implemented yet.

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():
    print(sql_query.errors)

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)

Internals

Run tests

pytest

Publishing

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