OmniSQL Python Wrapper

This is the Python wrapper for OmniSQL, a blazing-fast SQL linter built in Rust.

For full documentation, visit the main repository.

Usage Guide

Linting Commands

You can run OmniSQL from the command line to lint your SQL files:

• Lint a single file:

  omnisql lint path/to/query.sql
  

• Lint an entire directory:

  omnisql lint ./sql_queries/
  

• Auto-fix violations:

  omnisql lint --fix ./sql_queries/
  

• Lint with a specific configuration file:

  omnisql lint --config path/to/omnisql.yaml ./sql_queries/
  

• Lint with a DDL schema (for semantic validation):

  omnisql lint --schema path/to/schema.sql ./sql_queries/
  

  To apply style fixes while validating against a schema, add the --fix flag:

  omnisql lint --fix --schema path/to/schema.sql ./sql_queries/
  

• Lint with a dbt manifest (for native dbt project validation):

  omnisql lint --dbt-manifest target/manifest.json ./sql_queries/
  

  To apply style fixes while validating against a manifest, add the --fix flag:

  omnisql lint --fix --dbt-manifest target/manifest.json ./sql_queries/
  

• Lint with a specific SQL dialect (e.g., Snowflake): OmniSQL defaults to PostgreSQL. If you are parsing Snowflake-specific syntax (like VARIANT JSON paths or QUALIFY clauses), switch the dialect:

  omnisql lint --dialect snowflake ./sql_queries/
  

⚠️ Disclaimer regarding Auto-Fix (--fix): OmniSQL's auto-fix engine currently only resolves stylistic violations (such as SQL keyword casing and trailing commas). It will not automatically repair semantic, cost, or security errors (e.g., it will not auto-generate missing JOIN conditions or automatically mask PII columns).

Upgrading OmniSQL

To stay up to date with the latest features, performance improvements, and rule additions, you can upgrade OmniSQL via PyPI:

pip install --upgrade omnisql