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.2.tar.gz (18.6 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.2-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ai_sql_reviewer-0.1.2.tar.gz
  • Upload date:
  • Size: 18.6 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.2.tar.gz
Algorithm Hash digest
SHA256 16aec8bc05039876fbcf1fe353e8514c8634ba3436877b5d62f5aba010f539aa
MD5 ee7bc4a72593dbe1991b82430af46d08
BLAKE2b-256 1c268d6adb963a9873293c53b0fbbc0b5c32de19bcec2357b7e5aeaeb4c18478

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ai_sql_reviewer-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9230515e04a5d225da8ebe643fa4094d4fe5aff8379f7cec684356414d8a2507
MD5 1975305a01f5c45ae34c3f88b2541735
BLAKE2b-256 4fb39cad9f0524d66ad98eca8dccbd7066a37d5372e9a624f215578bf4eb9b20

See more details on using hashes here.

Provenance

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