Skip to main content
S

dsh-db-tool-ru

steelunicorn/dsh-db-tool-ru

A fork of mengqi1436/dsh-db-tool with a Russian interface and English server messages, per-grant database allowlists that open only the databases you tick, and export_to_file / execute_file actions that move query results and statements between the project folder and the database byte for byte. Replaces the original plugin; the tool name and the shared data directory (Documents/DSH/db-tool) are the same, so do not install both together.

Install

dsh plugin --profile web add github:steelunicorn/dsh-db-tool-ru

README

dsh-db-tool-ru

English | 简体中文 | Русский

Плагин хоста DSH. Безопасная работа с базами данных прямо из чата: девять СУБД, проектные точечные разрешения, подтверждение опасных операций, полный аудит, а также админ-панель и SQL-консоль в правой боковой панели.

Это форк dsh-db-tool (Apache-2.0): интерфейс переведён на русский, английский и китайский, а каждое разрешение можно сузить до отдельных баз данных внутри одного подключения. Плагин распространяется только через GitHub, в npm не публикуется.

Поток выполнения

Полный путь одной операции с базой данных — от точки входа до записи в аудит. Оба входа (чат-инструмент и правая боковая панель) используют одну и ту же семантику и обязаны пройти через двое ворот: проектное разрешение и классификацию риска на уровне инструкции.

Поток выполнения dsh-db-tool

Открыть интерактивную версию — поддерживает масштабирование, перетаскивание, подсветку пути и просмотр исходного кода по каждому узлу.

Вопросы или предложения? Создайте issue.


Поддерживаемые базы данных

КатегорияБазы данных
РеляционныеMySQL, PostgreSQL, GaussDB, SQLite, Oracle, Dameng DM, SQL Server
NoSQLRedis, MongoDB

Подключения, просмотр метаданных, запросы и предпросмотр покрывают все девять баз. Перенос данных разделён по возможностям: восемь баз (MySQL / PostgreSQL / GaussDB / SQLite / MongoDB / Oracle / Dameng / SQL Server) переносят данные нативно, таблица в таблицу, а Redis участвует через фиксированную таблицу-конверт __redis_keys. Полное воспроизведение пространства ключей Redis сверх этого не входит в область поддержки (группы потребителей stream, межверсионный DUMP, логические базы dbN).

Различия диалектов обрабатываются внутри адаптеров; верхние слои видят единый плейсхолдер ? и стандартный набор результатов.


Основные возможности

Инструмент модели DatabaseManager

Один инструмент с несколькими действиями — меньше неоднозначности при выборе инструмента:

actionНазначение
list_connectionsСписок доступных подключений (без учётных данных)
queryВыполнить запрос только на чтение, вернуть столбцы и строки
executeВыполнить инструкцию записи; опасные операции требуют подтверждения
schemaПросмотр структуры базы / таблицы / столбцов
previewПредпросмотр данных таблицы (постранично, до 50 строк на страницу)
run_scriptВыполнить скрипт в песочнице с повторными вызовами db.query / db.execute
export_to_fileВыгрузить результат запроса в файл внутри папки проекта (текст / JSON / CSV)
execute_fileВыполнить инструкцию из файла внутри папки проекта (guard, подтверждение и аудит — как у execute)

Граница изоляции run_script: отдельный дочерний процесс и песочница node:vm, принудительное завершение через 60 секунд, внутрь передаётся только ограниченный дескриптор db.{query,execute} — без файловой системы, сети и require. Если в конфигурации плагина включён scriptFileBridge, в песочницу добавляется единственный метод file.save(путь, текст): файл пишет родительский процесс по тем же правилам, что и export_to_file, а сам скрипт доступа к файловой системе не получает.

Файловый обмен: результаты и тела функций

export_to_file пишет результат запроса прямо в файл, execute_file читает инструкцию из файла. Агент не перепечатывает текст через свой контекст, поэтому тела функций, определения представлений и большие выгрузки переносятся байт-в-байт.

  • Путь всегда относительный, корень — папка проекта (она же ключ разрешения). Абсолютные пути, .., диски, потоки NTFS, зарезервированные имена (CON, NUL, …) и символьные ссылки отклоняются; выйти за пределы папки проекта нельзя ни при записи, ни при чтении.
  • format=text требует ровно одну строку и один столбец и пишет значение как есть — без нормализации переводов строк и без добавления завершающего \n. Файл, полученный из pg_get_functiondef(...), исполняется execute_file без правок.
  • format=json — массив строк с отступом в два пробела и завершающим переводом строки; format=csv — заголовок из имён столбцов и экранирование по RFC 4180, разделитель ,, концы строк CRLF. Кодировка всегда UTF-8 без BOM.
  • Пустой результат — ошибка EMPTY_RESULT (нет строк или NULL в текстовом режиме), если не передан allow_empty. Существующий файл не перезаписывается без overwrite, родительская папка не создаётся без create_dirs.
  • Лимиты по умолчанию: чтение ≤ 8 МБ, запись ≤ 64 МБ, расширения .sql, .txt, .json, .csv, .tsv, .md, .log. Значения настраиваются в конфигурации плагина (fileIo).
  • execute_file передаёт содержимое целиком, без обрезки пробелов и переводов строк: опасные операции по-прежнему возвращают NEEDS_CONFIRMATION с одноразовым challenge_id, а в аудит попадают направление, путь, размер, md5 и первые 200 символов текста.
  • search_path (необязательный, PostgreSQL): тело функции нередко ссылается на типы и функции без схемы (citext, varlist), а pg_get_functiondef возвращает текст как есть. Тогда укажите search_path="sys, dbo, public" — плагин выполнит файл в одном пакете с set_config('search_path', …, true), то есть путь видимости действует только на этот запуск и не остаётся в соединении. С params параметр несовместим (пакетная инструкция идёт простым протоколом).

Типичный сценарий переноса тела функции:

export_to_file(conn_id="<источник>", sql="select pg_get_functiondef(27896227) as d",
               path="fn/pdt_income_storageobject_t.sql", create_dirs=true)
правка файла в редакторе
execute_file(conn_id="<приёмник>", path="fn/pdt_income_storageobject_t.sql")   → commandtag = CREATE FUNCTION

Проектные разрешения (ro / rw)

Разрешения хранятся тремя уровнями (путь проекта → подключение → режим) в grants.json:

  • ro (только чтение): разрешены запросы и просмотр, любая запись отклоняется
  • rw (чтение и запись): разрешены инструкции, скрипты и транзакции

Проект без разрешения получает отказ по любому подключению. Смена режима разрешения (включая понижение rw → ro) немедленно аннулирует старые сессии, переподключение не требуется.

В Windows пути нормализуются по семантике NTFS (без учёта регистра), поэтому E:\GitHub\MyApp и e:\github\myapp — один и тот же проект.

Список баз данных в разрешении (databases) дополнительно сужает доступ внутри одного подключения. В панели «Доступы проектов» для этого служит раскрывающийся список «Базы данных» с флажками, полем фильтра по имени и кнопками «Выбрать все» / «Снять все» (фильтр сужает только видимый список — «все» и «снять» действуют на видимые базы, а сохранённое значение по-прежнему считается по полному набору). Отметки сохраняются сразу, без отдельной кнопки: доступ открывается только тем базам, которые пользователь сознательно отметил, а при только что выданном разрешении список пуст — доступа нет ни к одной базе, пока не отмечены нужные. Значение databases отсутствует только у разрешений, выданных до появления этого поля (и у программных разрешений без списка) — такие записи по-прежнему означают «все базы»; пустой массив [] означает «ни одной базы». Регистр в именах не важен. Сам список подтягивается без учёта действующего ограничения (GET /api/grant-databases), иначе после сужения гранта нельзя было бы вернуть базу обратно. Для SQLite ограничение не применяется — файл один. Проверка выполняется на всех путях: в чат-инструменте, в боковой панели и при переносе данных (и для источника, и для цели). Целевую базу в чат-инструменте задаёт необязательный аргумент database, в боковой панели — выбор базы в дереве. Список баз в дереве объекта и общий поиск таблиц тоже фильтруются по этому списку: таблицы баз вне разрешения не показываются и не ищутся. Проверка выполняется уже после проектного разрешения и после проверки режима ro, но до установки соединения с базой: при разрешении ro запрет на запись по-прежнему возвращает READ_ONLY, а не DATABASE_NOT_GRANTED.

Подтверждение опасных операций

DDL, FLUSHALL, dropDatabase и подобные инструкции сначала возвращают NEEDS_CONFIRMATION вместо выполнения:

  1. Первый вызов возвращает состояние ожидания подтверждения и одноразовый challengeId
  2. challengeId привязан к SHA256 инструкции, действует 5 минут и используется один раз
  3. Выполнение происходит только после того, как пользователь подтвердит и повторит вызов с тем же challengeId

В чат-инструменте подтверждение идёт через диалог, в SQL-консоли — через окно; оба пути используют одну и ту же семантику, и ни один нельзя обойти.

Полный аудит

Каждое выполнение (включая отклонённые запросы) добавляет строку в audit.jsonl: инструкция, уровень опасности, факт подтверждения, результат и длительность. Правая боковая панель показывает журнал в реальном времени.

Просмотр данных

  • Дерево из четырёх уровней: подключение → база → схема → таблица
  • Фильтр по базам и поиск имён таблиц по всем базам (MySQL / PostgreSQL / GaussDB запрашивают information_schema напрямую, остальные типы фильтруют в памяти)
  • Просмотр структуры таблиц и предпросмотр данных; сетка результатов поддерживает сортировку, постраничный вывод и копирование ячеек

SQL-консоль

Многотабличный редактор в правой боковой панели в стиле Navicat (CodeMirror 6):

  • Несколько вкладок: у каждой вкладки свой SQL, свои результаты и своя история (50 записей, клик восстанавливает)
  • Подсветка и автодополнение: диалект переключается автоматически (MySQL / PostgreSQL / SQLite / PL-SQL / T-SQL), метаданные таблиц и столбцов питают автодополнение
  • Горячие клавиши: Ctrl/Cmd+Enter — выполнить всё, Ctrl/Cmd+Shift+Enter — выполнить выделенное
  • Форматирование: sql-formatter по диалекту, при ошибке разбора возвращается исходный текст
  • Пошаговое выполнение: клиент заранее классифицирует инструкции чтения и записи и направляет их в каналы query и execute; при разрешении ro инструкции записи пропускаются и помечаются
  • Разделитель пакетов GO: поддержка GO и GO n (семантика sqlcmd, GO 0 / GO 1 — по одному разу), с потолком повторов 1000, чтобы исключить усиление
  • Транзакции: при разрешении rw можно начать / зафиксировать / откатить на закреплённом серверном соединении; простаивающие сессии автоматически откатываются через 5 минут с записью в аудит
  • Сетка результатов: трёхпозиционная сортировка, 50 строк на страницу, экспорт в CSV / JSON

Перенос данных

Перемещение данных таблиц между базами одного или разных типов:

  • Режимы записи: insert (дописать), ignore (пропустить конфликты), replace (перезаписать), truncate (сначала очистить)
  • Автоматическое создание таблиц: DDL генерируется по структуре исходной таблицы, если целевой таблицы нет
  • Порядок по зависимостям: если в целевой схеме уже есть внешние ключи, операции упорядочиваются автоматически — дочерние таблицы удаляются и очищаются первыми, родительские загружаются первыми; группы взаимно ссылающихся таблиц удаляются целиком средствами самой базы (порядок их загрузки не гарантируется, конфликты внешних ключей возвращаются как есть); если на целевую таблицу ссылается таблица вне выборки, перезапись падает сразу с понятным сообщением
  • Перенос структуры вместе с данными: вторичные индексы (включая уникальные), внешние ключи с действиями ссылок и автоинкрементные столбцы переносятся вместе с данными; индексы создаются после загрузки всех данных, внешние ключи — после того как все таблицы заполнены; повторный перенос не даёт шума об уже существующих объектах; Oracle и DM автопринкремент пока не переносят
  • Постраничное чтение: стратегии упорядоченного курсора (keyset), диапазона и смещения
  • Прогресс и история: живая отправка прогресса и история переносов по каждому проекту
  • Конфигурация переноса: сохраняется по проекту, автосохранение, восстановление после перезапуска, очистка при недействительном подключении
  • Промежуточная модель типов: неоднородные столбцы сначала приводятся к общему промежуточному типу, затем отображаются на целевой столбец — без попарных преобразований между девятью базами
  • Проверка разрешений на обоих концах: у источника и у цели проверяются и разрешение подключения, и список баз данных в нём
  • Резервный путь через конверт Redis: Redis участвует через фиксированную таблицу __redis_keys с шестью столбцами
СтолбецСмысл
keyИмя ключа
typestring / hash / list / set / zset / stream и т. д.
ttl_msОставшийся TTL в миллисекундах, 0 — срока жизни нет
encodingДиагностическое значение кодировки памяти OBJECT ENCODING, не связано с сериализацией payload
payloadЗначение, развёрнутое по типу, всегда строка JSON в UTF-8
dumpБайты RDB-сериализации DUMP, используются только однотипным Redis через RESTORE

Экспорт / импорт подключений

Экспорт всех подключений (включая пароли) в файл, зашифрованный парольной фразой, для переноса между машинами:

  • Ключ, производный через scrypt, и AES-256-GCM на весь payload; при открытии файла в нём нет открытого текста
  • Минимальная длина парольной фразы — 8 символов, проверяется на сервере
  • При импорте существующие id подключений пропускаются и никогда не перезаписываются; сводка сообщает импортированные / пропущенные / неудачные

Правая боковая панель

Регистрирует одну вкладку через официальную правую панель DSH (@deepseek-ai/dsh-client-ui-sidebar-right), без сторонних зависимостей для боковой панели. Вкладка содержит пять панелей (интерфейс на русском, английском и китайском):

ПанельНазначение
ПодключенияСоздание / редактирование / удаление подключений, карточный адаптивный список, проверка одного соединения или всех сразу одной кнопкой, экспорт и импорт
Доступы проектовОтметки ro / rw по каждому подключению для текущего проекта и список баз данных в разрешении
Просмотр данныхДерево, поиск, предпросмотр данных
SQL-консольМноготабличный редактор, транзакции, история, сетка результатов
Перенос данныхПеремещение на уровне таблиц с опциями пакетов / параллельности и журналом переноса

Серверные сообщения об ошибках приходят на английском и выводятся в интерфейсе как есть — они не переводятся.

Примечания

Оба пункта — контракт официальной правой панели, их легко принять за дефект плагина:

  • Если сессия не выбрана, панель базы данных не отображается. Официальная правая панель хранит состояние раскладки по id сессии; без сессии нет поверхности для закрепления, а значит нет ни карточки входа, ни вкладки — сначала выберите сессию, затем разверните правую панель.
  • Если у DSH ровно одна готовая карточка входа, ячейка «+» открывает сразу вкладку базы данных, а не страницу-руководство. Так работает правило официальной страницы по умолчанию — руководство не пропущено.

Модель безопасности

УровеньМеханизм
ХранениеПароли и полные URL лежат в secrets.json (0600) и никогда не возвращаются модели; информация о подключении, которую видит интерфейс, всегда маскируется как ***
АвторизацияПроектный белый список ro / rw и необязательный список баз данных внутри разрешения; нет разрешения — отказ
Уровень инструкцииКлассификация риска (danger / warning / none) и одноразовое подтверждение
Принудительное чтениеMySQL / PostgreSQL используют серверный SET TRANSACTION READ ONLY; SQL Server деградирует до пяти проверок на уровне приложения
Шифрование транспортаСначала открытый текст, повышение только когда сервер настаивает; см. «Шифрование транспорта»
Сокрытие ошибокПри сбое разбора строки подключения userinfo в тексте ошибки скрывается; открытые пароли никогда не выводятся
Изоляция скриптовОтдельный дочерний процесс + песочница vm + принудительное завершение через 60 секунд + внутрь передаётся только дескриптор db

Принудительное чтение в SQL Server слабее, чем в MySQL / PostgreSQL: эквивалентной серверной инструкции «только чтение» у SQL Server нет, поэтому при разрешении ro действуют пять проверок на уровне приложения — белый список первого слова, запрет нескольких инструкций, запрет SELECT ... INTO, запрет WITH ... (INSERT|UPDATE|DELETE|MERGE) и запрет OPENQUERY / OPENROWSET / OPENDATASOURCE. Это по-прежнему перехват на уровне приложения; для жёсткой изоляции настройте на стороне базы учётную запись только для чтения и используйте её в подключении.

Шифрование транспорта

Сначала подключение, шифрование только при необходимости. В SQL Server по умолчанию encrypt=auto: сначала подключение без шифрования; только когда сервер требует шифрование, происходит повышение и одна повторная попытка с доверием сертификату сервера — одна повторная попытка, только по этой причине и никогда при явно указанном encrypt. Dameng ведёт себя так же: только когда сервер согласует алгоритм, удалённый из локального OpenSSL ([6071]), шифрование транспорта отключается и выполняется одна повторная попытка.

Открытый текст — цена этой политики: auto / encrypt=false в SQL Server и loginEncrypt=false в Dameng отправляют учётные данные и результаты в открытом виде. Для доверенной внутренней сети это приемлемо; для публичных и недоверенных сетей требуйте шифрование явно и решайте проблемы сертификатов или алгоритмов, которые оно приносит.


Установка

Требования к окружению: Node.js ≥ 22 (требуется частью драйверов баз данных); хост DSH должен предоставлять официальную правую боковую панель.

# Из GitHub — единственный способ распространения, в npm плагин не публикуется
dsh plugin --profile desktop add "github:steelunicorn/dsh-db-tool-ru"

# Локальная разработка
dsh plugin --profile desktop add "link:D:\Projects\dsh-db-tool"

Если команда dsh недоступна в PATH в десктопном приложении, откройте строку меню и нажмите Manage dsh command, чтобы зарегистрировать её. После установки перезапустите десктопное приложение DSH, чтобы плагин загрузился.

Не включайте одновременно апстримный dsh-db-tool. Оба плагина используют одно и то же имя инструмента DatabaseManager и один каталог данных, поэтому сначала удалите или отключите апстрим, а затем устанавливайте этот пакет.

Данные при переходе сохраняются: подключения, разрешения и аудит лежат в прежнем каталоге <Документы>/DSH/db-tool/, поэтому после замены апстрима на этот форк подключения и разрешения остаются на месте.

Про oracledb: его установочный скрипт по умолчанию блокируется pnpm, поэтому первая установка сообщает о сбое. Нажмите Allow these scripts and retry в интерфейсе установки плагинов DSH — скрипт только проверяет версию Node и печатает баннер, а одобрение сохраняется в профиле.

Куда монтируется фронтенд: панель базы данных монтируется во встроенную правую панель DSH, отдельный плагин боковой панели не нужен. dsh.client.inject уже объявляет @deepseek-ai/dsh-client-ui-sidebar-right как предварительное условие загрузки.


Хранение данных

<Документы>/DSH/db-tool/ (режим каталога 0700; общий корень с журналом переносов, чтобы пользователь мог открыть его напрямую):

ФайлСодержимое
connections.jsonОпределения подключений (urlSafe маскирует пароли как ***)
secrets.json0600, пароли и полные URL, никогда не возвращаются модели
grants.jsonРазрешения проектов (нормализованный путь → connId → ro / rw, при необходимости список баз данных)
transfer-config.json0600, подключение и параметры страницы переноса по проекту
audit.jsonlАудит-журнал только на дописывание, один объект JSON на строку

Рядом лежит transfer-log.jsonl (журнал процесса переноса и история). Приоритет разрешения пути: явная инъекция (тесты) > DSH_DB_TOOL_DIR > <Документы>/DSH. В Windows «Документы» определяются через Shell API и следуют перенаправлению (OneDrive и т. п.); в остальных системах используется XDG_DOCUMENTS_DIR или ~/Documents. Данные старых версий из $DSH_HOME/db-tool/ переносятся пофайлово при первом запуске (если целевой файл уже есть — пропуск; старые файлы сохраняются).


Разработка

npm ci
npm run build        # компиляция + сборка бандлов vendor (mongodb / sqlserver / codemirror)
npm test             # полный прогон vitest
npm run typecheck    # tsc --noEmit

Дымовые тесты на реальных базах включаются переменными окружения и выполняются только при их наличии:

DBT_TEST_MYSQL_URL / DBT_TEST_PG_URL / DBT_TEST_REDIS_URL / DBT_TEST_DM_CONNECT
DBT_TEST_MONGO_URL / DBT_TEST_ORACLE_CONNECT / DBT_TEST_SQLSERVER_URL

CI находится в .github/workflows/ci.yml: Node 22 и 24, шаги npm ci → build → typecheck → test.

Структура репозитория

lib/          тело плагина
  adapters/   9 адаптеров баз данных + реализации переноса
  store/      хранение подключений / разрешений / аудита / секретов
  guard/      классификация риска инструкций
  manager.ts  бизнес-оркестрация (авторизация, диспетчеризация, подтверждение, аудит)
  http/       HTTP-маршруты правой боковой панели
  script/     песочница run_script и дочерний процесс
client/       однофайловый бандл правой боковой панели
skills/       skill db-admin
scripts/      скрипты сборки и инструментов
patches/      патчи горячего исправления хоста DSH
tests/        vitest (офлайн-моки + тесты на реальных базах под флагом)
assets/       схема потока выполнения
vendor/       бандлы драйверов и редактора (артефакты сборки, попадают в публикацию)

Контрибьюторы

Благодарим всех внешних контрибьюторов, чьи изменения вошли в master апстрима; подробности по каждому — в CONTRIBUTORS.md:

  • a19920714liou — PR #1: зависание хука ro-подключения и расхождение регистра путей Windows в разрешениях
  • weicy98 — PR #12: сбой подключения к Dameng DM при шифровании обмена DES_CFB
  • Автор апстрима: mengqi1436 — dsh-db-tool
  • Форк с русской локализацией: steelunicorn/dsh-db-tool-ru — issues

Исправления дефектов и поддержка адаптеров приветствуются; правила участия — в CONTRIBUTORS.md.


Лицензия

Apache License 2.0 © 2026 mengqi1436

Можно свободно использовать в коммерческих целях, изменять, распространять и сублицензировать при сохранении уведомлений об авторских правах и лицензии и с отметкой об изменённых файлах. Прилагаемая патентная лицензия безотзывна, но прекращается, если вы подадите патентный иск по этому произведению.

Этот форк распространяется под той же лицензией; исходный проект — mengqi1436/dsh-db-tool.

Related plugins