sarj-sql-lint
Custom SQL lint rules for Postgres migrations. AST-based via sqlfluff for the SARJ101 rule + zero-dependency pygrep regex hooks for migration-hygiene checks. Designed for pre-commit.
uv tool install sarj-sql-lint
Rules
| Code | id | Flags |
|---|---|---|
| SARJ101 | enforce-timestamptz |
TIMESTAMP without WITH TIME ZONE — use TIMESTAMPTZ |
| SARJ102 | idempotent-ddl |
CREATE TABLE/INDEX/EXTENSION/SCHEMA/SEQUENCE/TYPE, ADD COLUMN, DROP TABLE/INDEX without IF [NOT] EXISTS |
| SARJ103 | no-pg-enum |
CREATE TYPE ... AS ENUM / ALTER TYPE ... ADD VALUE — use TEXT + CHECK constraint |
| SARJ104 | prefer-text-over-varchar |
VARCHAR(n) / CHARACTER VARYING(n) — use TEXT (+ CHECK length if needed) |
| SARJ105 | insert-requires-on-conflict |
INSERT INTO statement (multi-line aware) with no ON CONFLICT clause |
| SARJ106 | prefer-jsonb |
JSON column type or ::json cast — use JSONB |
| SARJ107 | no-limit-offset |
OFFSET keyword — use cursor pagination (WHERE id > :cursor ... LIMIT n) |
| SARJ108 | index-concurrently |
CREATE INDEX without CONCURRENTLY — locks the table against writes |
| SARJ109 | prefer-uuidv7-default |
gen_random_uuid() (random UUIDv4) — use uuidv7() so keys are time-ordered |
All scanning runs over a comment/string/dollar-quote-masked view of the source, so keywords inside --//* */ comments, '...' literals, $tag$...$tag$ bodies and "..." identifiers never match.
Suppression
Add a -- sarj-noqa comment on the offending line to silence a diagnostic; scope it to specific codes with -- sarj-noqa: SARJ101, SARJ108.
Pre-commit
- repo: https://github.com/sarj-ai/standards
rev: sql-v0.1.0
hooks:
- id: sarj-enforce-timestamptz
files: '\.sql$'
- id: sarj-idempotent-ddl
files: '\.sql$'
- id: sarj-ban-postgres-enums
files: '\.sql$'
- id: sarj-ban-create-trigger
files: '\.sql$'
- id: sarj-prefer-text-over-varchar
files: '\.sql$'
- id: sarj-insert-requires-on-conflict
files: '\.sql$'
- id: sarj-prefer-jsonb
files: '\.sql$'
- id: sarj-no-limit-offset
files: '\.sql$'
- id: sarj-prefer-uuidv7-default
files: '\.sql$'
CLI
sarj-sql-lint check --rule enforce-timestamptz svcs/db/db/migrations/*.sql
sarj-sql-lint list-rules
Diagnostic format is path:line:col: CODE message — Ruff-compatible.
Each rule's source under src/sarj_sql_lint/rules/ carries its own description and diagnostic message.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sarj_sql_lint-0.6.4-py3-none-any.whl.
File metadata
- Download URL: sarj_sql_lint-0.6.4-py3-none-any.whl
- Upload date:
- Size: 29.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c3b3bb2faacb69abe1abd25d5523e67470b655ca99de6be5b4e1c26fb86ea6ad
|
|
| MD5 |
37b0026b0229ae079142d3f8efb03b1c
|
|
| BLAKE2b-256 |
5d961004a5650fc0a83e2697fe0e1b0af640e7b73e275275216aca063f661e76
|
Provenance
The following attestation bundles were made for sarj_sql_lint-0.6.4-py3-none-any.whl:
Publisher:
release.yml on sarj-ai/standards
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sarj_sql_lint-0.6.4-py3-none-any.whl -
Subject digest:
c3b3bb2faacb69abe1abd25d5523e67470b655ca99de6be5b4e1c26fb86ea6ad - Sigstore transparency entry: 2361199568
- Sigstore integration time:
-
Permalink:
sarj-ai/standards@b9ae34abdee59c1d7408062880a614bcc1820d8e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/sarj-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@b9ae34abdee59c1d7408062880a614bcc1820d8e -
Trigger Event:
push
-
Statement type:
