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-файлы не изменяет.
  • Публикует краткий GitHub PR summary и все inline findings одним review.

Требования

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

Установка

uv tool install ai-sql-reviewer==0.2.1

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

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
- id: review
  continue-on-error: true
  env:
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
  run: uvx --from ai-sql-reviewer==0.2.1 ai-sql-review review-diff --base "${{ github.event.pull_request.base.sha }}" --head "${{ github.event.pull_request.head.sha }}" --format json > sql-review.json
- if: always()
  env:
    GITHUB_TOKEN: ${{ github.token }}
  run: uvx --from ai-sql-reviewer==0.2.1 ai-sql-review publish-github sql-review.json --base "${{ github.event.pull_request.base.sha }}" --head "${{ github.event.pull_request.head.sha }}" --repository "${{ github.repository }}" --pull-request "${{ github.event.pull_request.number }}"

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

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

  • Поддерживается только PostgreSQL и миграции, запускаемые одной shell-командой.
  • Нет GitHub App, 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.2.1.tar.gz (22.5 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.2.1-py3-none-any.whl (34.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ai_sql_reviewer-0.2.1.tar.gz
  • Upload date:
  • Size: 22.5 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.2.1.tar.gz
Algorithm Hash digest
SHA256 6b81ad56441f4ca7501576c850179fc5b7cd98c044c7f7e6a2a1fdae0c4d9261
MD5 d5cc0321dcceb7eec321b8af87ea951e
BLAKE2b-256 293b384db23a0a0f91736252c2f921d5ef3046e2a47eb94cdb20b757ac6b412a

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_sql_reviewer-0.2.1.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.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_sql_reviewer-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9b5706d1bf05a72c947f22282f9053ee12838cffe802bad4dcdcde47ee7edc9a
MD5 d4a6195d629c31927d1f0de12f6b2c4e
BLAKE2b-256 42c5e35f8f731e9d45eec390b7f13a788df9c0651cedbf01775a592bc3021854

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_sql_reviewer-0.2.1-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