DataDictKit 8.7.0

DataDictKit

Генерация словаря данных из EF Core DbContext в форматах Word (.docx), JSON и DataTable.

Установка

dotnet add package DataDictKit

API-справочник (класс DataDictionary)

GenerateDocx(DbContext context, string filePath)

Генерирует Word-документ словаря данных из DbContext. Документ содержит заголовок, дату и таблицу для каждой сущности с колонками: Поле, Перевод, Тип данных, Ограничения, Ключ, Примечание.

DataDictionary.GenerateDocx(context, "dictionary.docx");

GenerateJson(DbContext context, string filePath)

Генерирует словарь данных в формате JSON. Каждая сущность представлена как массив объектов с описанием полей.

DataDictionary.GenerateJson(context, "dictionary.json");

ToDataTables(DbContext context)

Возвращает метаданные сущностей DbContext в виде словаря Dictionary<string, DataTable>, где ключ -- имя сущности, значение -- DataTable с колонками: Поле, Перевод, Тип данных, Ограничения, Ключ, Примечание.

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

Особенности

• Автоматический перевод распространенных имен свойств (Name, Salary, Phone, Email и др.) на русский язык.
• Поддержка атрибута [Display(Name = "...")] для пользовательских переводов.
• Определение первичных (PK) и внешних (FK) ключей.
• Вывод SQL-типов данных (nvarchar, int, datetime2 и др.).
• Отображение ограничений (NULL/NOT NULL, MaxLength).

Примеры использования

Генерация словаря данных во всех форматах

using DataDictKit;
using Microsoft.EntityFrameworkCore;

using var context = new MyDbContext();

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

// JSON-файл
DataDictionary.GenerateJson(context, "Словарь_данных.json");

// DataTable для дальнейшей обработки
var tables = DataDictionary.ToDataTables(context);
foreach (var (name, dt) in tables)
{
    Console.WriteLine($"--- {name} ---");
    foreach (DataRow row in dt.Rows)
        Console.WriteLine($"  {row["Поле"]} ({row["Тип данных"]}) - {row["Перевод"]}");
}

Использование DataTable для отображения в DataGridView

var tables = DataDictionary.ToDataTables(context);
foreach (var (entityName, dt) in tables)
{
    dataGridView.DataSource = dt;
}