ИИ-инструменты и скрипты
Database Schema Handbook: словарь данных и ERD по вашей схеме
Для команд, которые получают базу данных по наследству или передают её другим: скрипт разбирает файлы схемы или миграции, а агент составляет словарь данных, ERD, руководство по связям и замечания со ссылками на строки исходника, которые вы проверяете. Словарь данных и диаграмма связей по файлам вашей базы данных.
Что вы получите: 1 файл · 109.22 KB · ZIP
Варианты покупкиОписание товара
Описание
Для разработчиков, агентств и команд, которые получают базу данных по наследству, передают её другим или должны объяснить её новому коллеге или клиенту.
Передайте своему агенту файлы схемы самой базы данных. Агент составит справочник по схеме, который вы проверите: словарь данных, диаграмму, описание связей словами и список замечаний.
Он читает schema.sql, файл pg_dump --schema-only, дамп MySQL, схему SQLite или папку SQL-миграций, применяемых по порядку. Подключения к базе данных не происходит.
Значения, которые агент выводит сам, помечаются как предполагаемые и остаются непроверенными, пока ваша команда их не подтвердит. Представления, функции и триггеры перечисляются, но не описываются.
Что агент пишет при каждом запуске
data-dictionary.mdиdata-dictionary.csv: каждая таблица и столбец с типом, допустимостью null, значением по умолчанию и ключами, смысл простым языком и основание этого смысла: комментарий в схеме, ограничение, вывод из названия, ваши слова или неизвестно.erd.mmd: диаграмма Mermaid, которую можно вставить в вики или README.relationships.md: каждый внешний ключ словами с указанием строки в исходнике, связи многие-ко-многим и примеры соединений для самых связанных таблиц.findings.md: фактические наблюдения, в каждом из которых названы таблица или столбец и указаны файл и строка. Примеры: таблицы без первичного ключа, внешние ключи без поддерживающего индекса, несовпадение типов по внешнему ключу, денежные столбцы с типом числа с плавающей точкой, столбцы даты и времени без часового пояса, дублирующиеся индексы.handbook.html: одна самодостаточная страница со встроенной диаграммой, всеми таблицами, связями, замечаниями и открытыми вопросами. Печатается как есть.
Читает скрипт, объясняет агент
Входящий в комплект скрипт разбирает DDL для PostgreSQL, MySQL и SQLite, применяет операторы ALTER и миграции по порядку и записывает файл и строку каждой таблицы, столбца, ключа и индекса. Затем агент пишет, что означают каждая таблица и столбец. Команда check отклоняет словарь с пропущенной таблицей или столбцом, устаревшим типом или пустым описанием смысла.
Только ваша схема
Навык велит агенту помечать каждое выведенное значение и то, чего он знать не может, оформлять как вопрос [NEEDS: ...] для вашей команды, а не заполнять самому.
Честно об ограничениях
Он документирует структуру так, как она объявлена в файлах. Количество строк, качество данных, использование индексов и то, что приложение делает во время работы, в этих файлах отсутствуют, поэтому их нет и в справочнике. Значения, выведенные из названий, - это черновики для подтверждения. Представления, функции, процедуры, триггеры и ограничения исключения перечисляются с указанием строк и не описываются. Парсер терпимый, но не полный: файлы SQL Server и Oracle не пробовали. Замечания по названиям - это эвристики, и каждое может быть осознанным выбором. Чтение ORM-моделей (Prisma, Django, Rails) выполняет агент по шаблону, и как тестовый случай оно не прогонялось. HTML-страницу и её диаграмму проверяли как разметку, а не в браузере; на большой схеме диаграмма получается высокой, а линии могут пересекаться.
Арабский язык
По запросу справочник пишется на арабском со страницей справа налево; названия таблиц и столбцов остаются слева направо.
В комплекте: SKILL.md, скрипты на Python со стандартной библиотекой, справочные материалы (чтение схем, написание описаний смысла, руководство по замечаниям, заметки по арабскому), шаблоны и разобранный пример, который можно прочитать до покупки: база данных записи на приём в клинику на PostgreSQL с 15 таблицами, 116 столбцами и 19 внешними ключами, дающая 35 наблюдений и 33 открытых вопроса.
Проверено на двух случаях (дамп PostgreSQL на английском; магазин на MySQL из 8 миграций на арабском). У скриптов 52 модульных теста.
Кратко
Для разработчиков, агентств и команд, которые получают базу данных, передают её или должны объяснить новому коллеге либо клиенту.
Передайте своему агенту файлы схемы базы данных (schema.sql, дамп или папку миграций). Он составит черновик справочника, который вы проверите: словарь данных, диаграмму связей, описание связей и список замечаний. К базе данных он не подключается вообще.
Что пишет агент
- Файл
data-dictionary: каждая таблица и столбец с типом, ключами и смыслом, а также источник этого смысла. - Файл
erd.mmd: диаграмма связей в формате Mermaid. - Файл
relationships.md: каждая связь, описанная словами, с примерами соединений. - Файл
findings.md: фактические замечания, при каждом из которых указаны имя файла и номер строки. - Файл
handbook.html: одна страница, готовая к печати.
Ограничения
Справочник документирует структуру только так, как она записана в файлах, и не видит самих данных и того, что делает приложение. Значения, выведенные из названий, - это черновики, требующие вашего подтверждения, а то, что неизвестно, записывается вопросом для вашей команды. Поддерживаются PostgreSQL, MySQL и SQLite. Справочник можно запросить на арабском; это пробовали на одном тестовом случае.
Вопросы
Подключается ли он к моей базе данных?
Нет. Он читает файлы схемы на вашем диске и больше ничего.
Какие базы данных он читает?
Файлы схем PostgreSQL, MySQL и SQLite или папку SQL-миграций, применяемых по порядку. SQL Server и Oracle не пробовали.
У меня только миграции, файла схемы нет.
Укажите папку. Скрипт применит миграции по порядку, включая переименования и удалённые столбцы, и сохранит краткую историю.
Как он узнаёт, что означает столбец?
Из комментариев в схеме, ограничений и названий либо из ваших слов. Каждое значение помечается основанием, а то, что остаётся неизвестным, записывается как вопрос.
Скажет ли он, что моя схема неправильная?
Он перечисляет наблюдения с указанием строк в исходнике, чтобы ваша команда их проверила. Каждое из них может быть осознанным выбором.
Может ли справочник быть на арабском?
Да, со страницей справа налево и идентификаторами, которые остаются слева направо. Это пробовали на одном тестовом случае.
Что вы получите
1 файл · 109.22 KB
- schema-handbook-1.0.0.zipZIP · 109.22 KB
ИИ-инструменты и скрипты
Database Schema Handbook: словарь данных и ERD по вашей схеме
Для команд, которые получают базу данных по наследству или передают её другим: скрипт разбирает файлы схемы или миграции, а агент составляет словарь данных, ERD, руководство по связям и замечания со ссылками на строки исходника, которые вы проверяете. Словарь данных и диаграмма связей по файлам вашей базы данных.
Getly открыл загруженные файлы и не нашёл ничего, что помешало бы их открыть. Это не проверка на вирусы и не оценка качества.
Теги
Частые вопросы
Доступ открывается сразу?
Да. Это цифровой товар - скачать его можно сразу после оплаты, прямо из своей библиотеки.
Можно ли использовать в коммерческих проектах?
Да. Коммерческое использование разрешено: в своём бизнесе и в том, что вы продаёте. Перепродавать и распространять сам файл нельзя.
Какие условия возврата?
Запросить возврат можно в течение 30 дней. Если что-то не так, оформите заявку в своём заказе - её рассмотрит команда Getly.
Какие форматы и размеры файлов я получу?
Вы скачаете 1 файл - ZIP - всего 109.22 KB.
Обновления бесплатны?
Да - когда продавец выпускает новую версию, вы можете бесплатно скачать актуальные файлы из своей библиотеки. Последние изменения смотрите в истории версий.
Цена
$7.00



