DataDictKit 8.6.0

DataDictKit

Библиотека для автоматической генерации словаря данных (Data Dictionary) в формате Word (.docx) на основе модели EF Core DbContext (.NET 8).

Сценарий использования

Пункт 2 билета -- модель данных / словарь данных. Генерация профессионального Word-документа с описанием всех сущностей базы данных: поля, типы, ключи, ограничения. Документ оформлен шрифтом Times New Roman 12pt с таблицами для каждой сущности.

Установка

dotnet add package DataDictKit

Быстрый старт

using DataDictKit;

// Сгенерировать Word-документ со словарём данных
DataDictionary.GenerateDocx(dbContext, "словарь.docx");

Возможности

• Генерация Word-документа со словарём данных (Times New Roman 12pt)
• Автоматическое определение типов данных SQL Server (C# → SQL маппинг)
• Распознавание первичных ключей (PK) и внешних ключей (FK)
• Автоматический перевод имён свойств на русский язык
• Поддержка атрибутов [Display], [Required], [MaxLength], [Key]
• Экспорт метаданных в DataTable для интеграции с другими библиотеками

Методы

DataDictionary.GenerateDocx

DataDictionary.GenerateDocx(dbContext, "словарь_данных.docx");

Создаёт Word-документ, содержащий таблицу для каждой сущности в DbContext. Документ оформлен шрифтом Times New Roman 12pt. Для каждой сущности создаётся отдельная таблица со столбцами:

DataDictionary.ToDataTables

var tables = DataDictionary.ToDataTables(dbContext);
foreach (var (entityName, dataTable) in tables)
{
    Console.WriteLine($"Сущность: {entityName}, полей: {dataTable.Rows.Count}");
}

Возвращает Dictionary<string, DataTable> -- имя сущности и таблица с метаданными. Подходит для отображения в DataGridView или экспорта.

Пример в приложении

public partial class MainForm : Form
{
    private AppDbContext db = new AppDbContext();

    // Кнопка "Сформировать словарь данных"
    private void btnDataDict_Click(object sender, EventArgs e)
    {
        var saveDialog = new SaveFileDialog
        {
            Filter = "Word документ|*.docx",
            FileName = "словарь_данных.docx"
        };

        if (saveDialog.ShowDialog() == DialogResult.OK)
        {
            DataDictionary.GenerateDocx(db, saveDialog.FileName);
            MessageBox.Show("Словарь данных сохранён!", "Готово",
                MessageBoxButtons.OK, MessageBoxIcon.Information);
        }
    }

    // Просмотр метаданных в DataGridView
    private void btnViewMeta_Click(object sender, EventArgs e)
    {
        var tables = DataDictionary.ToDataTables(db);
        // Показать первую сущность
        var (name, dt) = tables.First();
        dataGridView1.DataSource = dt;
        this.Text = $"Словарь данных: {name}";
    }
}

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

Документ содержит заголовок "Словарь данных" и для каждой сущности таблицу вида:

Vacancy (Вакансия)

Лицензия

MIT