Документация SQL Agent CLI

Полный справочник команд и руководство пользователя

Начало работы

После скачивания и установки SQL Agent CLI откройте терминал и выполните следующие шаги:

  1. Проверьте установку: sql-agent --help
  2. Войдите с вашим лицензионным ключом: sql-agent login YOUR-API-KEY
  3. Настройте вашего ИИ-провайдера: sql-agent setup-ai
  4. Подключитесь к базе данных: sql-agent connect --url "postgresql://user:pass@host/db"

Аутентификация

sql-agent login <api-key>

Авторизуйтесь с помощью API-ключа для активации функций SQL Agent.

$ sql-agent login XXXX-XXXX-XXXX-XXXX

Ваш API-ключ можно найти в вашем личном кабинете после покупки лицензии.

sql-agent logout

Удалить сохранённый API-ключ и выйти из SQL Agent.

$ sql-agent logout

Настройка ИИ-провайдера

sql-agent setup-ai

Интерактивный мастер для настройки ИИ-провайдера и модели.

$ sql-agent setup-ai
# Следуйте подсказкам для выбора провайдера и модели

Поддерживаемые провайдеры:

  • OpenAI — GPT-4o, GPT-4, GPT-3.5-turbo
  • Anthropic — Claude Opus, Claude Sonnet, Claude Haiku
  • DeepSeek — DeepSeek Chat, DeepSeek Coder
  • Groq — Llama 3.3 70B, Llama 3.1 8B
  • Ollama — Локальные модели (API-ключ не требуется)

Ручная настройка

Вы также можете настроить ИИ-провайдера вручную:

$ sql-agent configuration llm.provider --value openai
$ sql-agent configuration llm.model --value gpt-4o
$ sql-agent configuration llm.api_key_env --value OPENAI_API_KEY

Подключение к базе данных

sql-agent connect --url <database-url>

Подключиться к базе данных и начать интерактивную сессию.

Параметры:

  • --url, -u — URL подключения к базе данных (обязательно)
  • --profile, -p — Сохранить подключение как именованный профиль
  • --read-only — Подключиться в режиме только для чтения (по умолчанию)
  • --write — Включить операции записи

Примеры:

# PostgreSQL
$ sql-agent connect --url "postgresql://user:pass@localhost:5432/mydb"
# MySQL
$ sql-agent connect --url "mysql://user:pass@localhost:3306/mydb"
# SQLite
$ sql-agent connect --url "sqlite:///path/to/database.db"
# Сохранить как профиль
$ sql-agent connect --url "postgresql://..." --profile prod_db

sql-agent use-profile <name>

Подключиться к базе данных используя ранее сохранённый профиль.

$ sql-agent use-profile prod_db

Управление профилями

sql-agent profiles

Показать все сохранённые профили подключения к базам данных.

$ sql-agent profiles

sql-agent delete-profile <name>

Удалить сохранённый профиль базы данных.

$ sql-agent delete-profile prod_db

sql-agent export-profiles

Экспортировать все сохранённые профили в JSON-файл.

$ sql-agent export-profiles --output backup.json
$ sql-agent export-profiles --include-credentials

Настройки конфигурации

sql-agent configuration [key] [--value value]

Просмотр и изменение настроек конфигурации.

Основные настройки:

# Показать все настройки
$ sql-agent configuration --list
# Установить LLM-провайдера
$ sql-agent configuration llm.provider --value openai
# Установить LLM-модель
$ sql-agent configuration llm.model --value gpt-4o
# Установить тайм-аут запроса (секунды)
$ sql-agent configuration query_timeout --value 60
# Установить режим истории диалога
$ sql-agent configuration conversation.history_mode --value long

Режимы истории:

  • short — ~5 обменов сообщениями
  • medium — ~10 обменов сообщениями (по умолчанию)
  • long — ~15 обменов сообщениями
  • unlimited — Без ограничения сообщений

Команды интерактивной сессии

Эти команды доступны после подключения к базе данных:

Команда Описание
help Показать доступные интерактивные команды
schema Показать полную схему базы данных со всеми таблицами и столбцами
/insights <table> Получить ИИ-анализ конкретной таблицы
/explain <query> Показать план выполнения запроса с рекомендациями по оптимизации
/analyze <query> ИИ-анализ производительности запроса с рекомендациями
history Показать недавнюю историю запросов
clear Очистить историю диалога и начать заново
exit Выйти из интерактивной сессии

Запросы на естественном языке

Просто введите ваш вопрос на обычном языке:

Prompt> Show me all users created in the last week
Prompt> What's the average order value by month?
Prompt> Find customers with no orders

История запросов

sql-agent history

Просмотр или очистка истории выполнения запросов.

Параметры:

  • --limit, -n — Количество записей для отображения (по умолчанию: 20)
  • --clear — Очистить всю историю запросов
$ sql-agent history --limit 50
$ sql-agent history --clear

Функции безопасности

Режим только для чтения

По умолчанию SQL Agent подключается в режиме только для чтения для защиты ваших данных. Следующие операции заблокированы:

  • INSERT, UPDATE, DELETE
  • DROP, TRUNCATE, CREATE, ALTER

Чтобы включить операции записи, используйте --write флаг при подключении.

Зашифрованное хранилище

Все конфиденциальные данные (API-ключи, учётные данные базы данных) шифруются с использованием Fernet и хранятся локально на вашем компьютере. Ваши данные никогда не передаются на наши серверы.

Тайм-аут запроса

Запросы автоматически прерываются через 30 секунд (настраивается) для предотвращения зависших запросов.

Нужна помощь?

Проверьте наш FAQ или свяжитесь с нашей службой поддержки для получения помощи.

Посмотреть FAQ Связаться с поддержкой