Документация по генератору баз данных V1.0; после распаковки дважды щелкните по exe-файлу для запуска. При возникновении вопросов просьба обращаться к сообществу.

Документация по структуре таблиц баз данных является важнейшим материалом для программистов при понимании бизнес-систем. В процессе приемки проекта также требуется предоставление технической документации по словарю баз данных. Для крупных бизнес-систем количество таблиц может достигать сотен или даже тысяч. В повседневной разработке все таблицы могут быть хорошо известны, поэтому был создан этот открытый генератор документов по базам данных, который удобен в использовании — достаточно открыть exe-файл, чтобы он начал работать. Любопытствующие могут бесплатно скачать и использовать его, а также общаться друг с другом!

1. Описание программы

Сегодня мы представляем вам нашу разработку — генератор документов по структуре таблиц баз данных. Это позволяет легко экспортировать структуру таблиц бизнес-системы и использовать её как часть документации по проектированию баз данных при приемке проекта. Это значительно экономит время на создание документов по структуре таблиц баз данных. Все заинтересованные лица могут скачать или связаться для обсуждения!## 2. Технологическая платформа

• Язык программирования: C# (.NET Framework 4.5.5)
• Разработка: Visual Studio 2015
• Технология работы с базами данных: Dapper
• Экспорт в Word: NPOI
• Метод доступа: поскольку это Windows Forms приложение, Windows операционная система может запустить его напрямую

3. Описание функциональности (в разработке)

• Поддерживает четыре типа данных: SQL Server, MySQL (версии 5.7 и 8.0), SQLite, PostgreSQL
• Поддерживает экспорт в три формата документов: Word, HTML, Markdown
• Экспорт включает информацию о таблицах (подробности полей, описание полей, длину, значения по умолчанию и т.д.), скрипт создания таблиц, представлений и скриптов представлений, хранимых процедур и скриптов
• Поддерживает открытие сгенерированного документа по базам данных непосредственно через редактор по умолчанию
• Поддерживает резервное копирование баз данных (на данный момент поддерживаются только SQL Server bak-файлы)

4. Процесс реализации

На основе технологии Dapper для работы с базами данных, программа динамически получает строки соединения для установления соединения с базой данных,
далее она собирает структуру таблиц для различных типов баз данных (сбор информации о списках баз данных, списков таблиц, полей таблиц, представлений, хранимых процедур, скриптов создания таблиц),
затем использует технологию NPOI для экспорта в Word, а также строит HTML и Markdown документы путём конкатенации строк.

5. Пример выполнения задачи

Сначала откройте главное окно программы, как показано ниже, затем продолжайте оптимизацию.

Программа поддерживает четыре типа генерируемых документов: можно выбрать только один тип документа за раз. Рекомендуется использовать формат Markdown.

Ниже представлен пример сгенерированного Word-документа.

Пример сгенерированного HTML-документа.

Пример сгенерированного документа в формате Markdown.