Skip to main content

SQL queries formatting, syntactic and semantic validation

Project description

sqlvalidator

Build Status PyPI codecov

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"

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
"""

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 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)

SQL Syntax

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

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.13
Filename, size File type Python version Upload date Hashes
Filename, size sqlvalidator-0.0.13-py2.py3-none-any.whl (20.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sqlvalidator-0.0.13.tar.gz (19.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page