Базовые режимы документирования БД

Первое, что можно попробовать, — это примеры SchemaCrawler. Затем изучить командную строку SchemaCrawler с помощью онлайн-руководства. Это учебное пособие работает в любом браузере без необходимости в дополнительном программном обеспечении или плагинах (SchemaCrawler - How-to ). Также SchemaCrawler предоставляет подробную справку по командной строке. Например:

schemacrawler -h commands

Для целей документирования и визуализации схемы БД важнейшими являются:

• brief — показывает основную информацию о схеме для таблиц, представлений и процедур, столбцов, первичных ключей и внешних ключей
• count — показывает количество строк в таблицах,
• details — показывает максимально возможную детализацию схемы, включая привилегии и сведения о привилегиях, триггерах и ограничениях проверки,
• dump — показывает данные из всех строк в таблицах,
• lint — показывает lints (несоблюдение стандартов и соглашений по кодированию) в схеме базы данных
• schema — показывает часто необходимые сведения о схеме, включая подробности о таблицах, представлениях и процедурах, столбцах, первичных ключах, индексах, внешних ключах и триггерах
• script — выполняет файл сценария, например JavaScript, для обработки схемы базы данных

Например:

Здесь параметр --url обеспечивает соединение с базой данных СУБД Ред БазаДанных на сервере с указанным IP. Параметры --user и --password задают имя пользователя БД и его пароль входа. Указывать пароль в командной строке категорически неправильно. Тогда можно воспользоваться заданием переменной окружения со значением пароля и подставлять ее значение при запуске, как сделано в примере ниже:

Важный параметр --info-level задает степень подробности выделяемой информации. Команда List выдает более компактный список:

а команда count — количество записей в каждой таблице

С помощью команды dump легко получить содержимое – все записи таблиц,

но с помощью дополнительного параметра --tables=COUNTRY ограничить набор таблиц для дампа:

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

А это вариант, допускающий регистронезависимый (case insensitive) поиск.

schemacrawler --url=jdbc:firebirdsql://192.168.1.74:3050/C:/_Data/employee.fdb \
  --user=sysdba --password:env=ISC_PASSWORD \
  --info-level=standard --no-info \
  --grep-columns="(?i).*pho.*" \
  --command=list

Параметры --parents и --children позволяют задавать глубину связей рассматриваемых таблиц для документирования и построения диаграмм.

Вывод в разных форматах

Для выдачи отчета может быть назначен один из нескольких форматов выдачи. Для разных команд доступны разные наборы форматов. Lint и некоторые другие могут выдать отчет в JSON, YAML, TXT и т.п. Для command=schema доступны только TXT и HTML.

schemacrawler --url=jdbc:firebirdsql://192.168.1.74:3050/C:/_Data/employee.fdb \
  --user=sysdba --password:env=ISC_PASSWORD \
  --info-level=standard --no-info \
  --parents=1 --children=2  \
  --command=schema \
  --output-format=html --output-file=/home/schcrwlr/share/idx.html

Чаще всего параметры --output-format и --output-file используются для выдачи графических диаграмм схем БД

Дата последнего изменения: 11.09.2026

Если вы нашли ошибку, пожалуйста, выделите текст и нажмите Ctrl+Enter.