Skip to main content

ai-sql-reviewer

CLI-инструмент для schema-aware ревью изменённых PostgreSQL-запросов в CI.

Возможности

  • Извлекает изменённые statements из Git diff и сохраняет номера строк.
  • Проверяет синтаксис через SQLGlot до любых модельных вызовов.
  • Восстанавливает схему миграциями во временном PostgreSQL-контейнере.
  • Запускает независимые performance, architecture и correctness reviews, critic и final reviewer.
  • Валидирует все ответы Pydantic-моделями и показывает безопасные предложения как diff.
  • Поддерживает console, Markdown и JSON; исходные SQL-файлы не изменяет.

Требования

Python 3.12+, uv, Docker и доступный из shell migration command.

Установка

uv tool install ai-sql-reviewer==0.1.0

Конфигурация

dialect: postgres
migrations:
  command: ./scripts/migrate.sh
  postgres_version: "17"
  timeout_seconds: 120
llm:
  model: openai/example-model
  api_key_env: OPENAI_API_KEY
  api_base: null
  temperature: 0
  timeout_seconds: 60
  max_retries: 2
review:
  agents: [performance, architecture, correctness]
  minimum_confidence: 0.65
  max_findings: 10
output:
  format: markdown

Секрет хранится только в environment variable, имя которой задаёт api_key_env.

CLI

ai-sql-review review-diff --base origin/main --head HEAD --format markdown
ai-sql-review review-file path/to/query.sql --format console
ai-sql-review review-sql "SELECT * FROM users" --format json

--debug включает технические сообщения orchestration и parser без публикации внутренних model responses.

GitHub Actions

- uses: astral-sh/setup-uv@v9.0.0
- env:
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
  run: uvx --from ai-sql-reviewer==0.1.0 ai-sql-review review-diff --base "${{ github.event.pull_request.base.sha }}" --head "${{ github.sha }}" --format markdown

Полный пример: examples/github-actions/sql-review.yml.

Ограничения MVP

  • Поддерживается только PostgreSQL и миграции, запускаемые одной shell-командой.
  • Нет GitHub App, публикации PR-комментариев, query-plan execution и автоматического применения fixes.
  • Качество выводов зависит от выбранной через LiteLLM модели и предоставленной схемы.

Разработка

uv sync
uv run ruff check .
uv run mypy src
uv build

Download files

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

Source Distribution

ai_sql_reviewer-0.1.0.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_sql_reviewer-0.1.0-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file ai_sql_reviewer-0.1.0.tar.gz.

File metadata

  • Download URL: ai_sql_reviewer-0.1.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ai_sql_reviewer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8505b32c38a4fc3557469b0f5422b434fc467c82e45bfb59cdd691241cb04fa9
MD5 edf1599dfde69b6996a4fdac6bfaff9b
BLAKE2b-256 deaad57290655059a5b1bafbeaf8939030d1538b3ea5fdb400434efd2abd5674

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_sql_reviewer-0.1.0.tar.gz:

Publisher: release.yml on not2exe/ai-sql-reviewer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai_sql_reviewer-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_sql_reviewer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 26f530424e2efc8ffc609cdd1d7053e30b768fb181c848a355cb8bd228e59b16
MD5 201829d9b95068f74dd00b930124bcda
BLAKE2b-256 df2dc62692c258a24c809b2d3f119d0a51c92ed0dc88a5f466e3f25fc5769b23

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_sql_reviewer-0.1.0-py3-none-any.whl:

Publisher: release.yml on not2exe/ai-sql-reviewer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page