zyplayer-doc-db

Проект миграции

Для лучшей унификации и поддержки, используя примеры и т. д., этот проект был перенесён по адресу: https://gitee.com/zyplayer/zyplayer-doc. Приглашаем использовать и подписываться на новый проект.

Новые функции:

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

Описание проекта

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

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

• T: таблица, например: XXX (комментарий к полю), T: user_info;
• T: таблица. Связанное ID, например: XXX (комментарий к полю), T: user_info.id;
• T: база данных. Таблица. Связанное ID, например: XXX (комментарий к полю), T: order_db.user_info.id.

Диаграмма отношений является экспериментальной функцией. Если у вас есть лучшие предложения или способы отображения, пожалуйста, поделитесь ими!

В настоящее время поддерживается управление SqlServer и MySQL. В будущем планируется добавить поддержку Oracle и других баз данных.

Использование

1. Добавьте аннотацию: @EnableDocDb.
2. Внедрите Bean.

// Внедрение существующих источников данных
@Resource DataSource orderDatasource;
@Resource DataSource userDatasource;

//....

@Bean
public DatabaseRegistrationBean databaseRegistrationBean() {
    DatabaseRegistrationBean bean = new DatabaseRegistrationBean();
    List<DataSource> dataSourceList = new LinkedList<>();
    // Настройка источников данных для отображения
    dataSourceList.add(orderDatasource);
    dataSourceList.add(userDatasource);
    bean.setDataSourceList(dataSourceList);
    return bean;
}

3. Откройте веб-страницу по адресу домена + doc-db.html, например: http://192.168.0.100:8080/doc-db.html.

Интерфейс

Основной интерфейс:

Базовый интерфейс:

Поиск по шаблону:

Редактирование комментариев к таблице:

Экспорт документации:

Просмотр экспортированной документации:

Диаграмма связей таблиц: