DigitTwin.UniversalContextConnector.Abstractions 0.0.1

DigitTwin.UniversalContextConnector.Abstractions

Описание

DigitTwin.UniversalContextConnector.Abstractions — это универсальная библиотека абстракций для работы с различными типами SQL и NoSQL баз данных в .NET-проектах. Она предоставляет стандартные интерфейсы для репозиториев, миграций и конфигурации подключения, что позволяет реализовать единый подход к работе с разными СУБД в рамках архитектуры Digital Twin.

Основные возможности

• Унифицированные интерфейсы для работы с репозиториями данных (IRepository<TEntity, TKey>)
• Абстракция для управления миграциями БД (IDatabaseMigrator)
• Гибкая конфигурация подключения к БД через класс DatabaseConfiguration
• Поддержка различных типов баз данных через перечисление DatabaseTypeEnum:
  • MS SQL Server
  • PostgreSQL
  • MySQL
  • MongoDB
  • Redis
  • ClickHouse

Структура

DatabaseConfiguration

Класс для описания параметров подключения к базе данных:

• Name — уникальное имя подключения (для DI)
• ConnectionString — строка подключения
• Type — тип базы данных (DatabaseTypeEnum)
• DatabaseName — имя базы данных (актуально для MongoDB/ClickHouse)

DatabaseTypeEnum

Перечисление поддерживаемых типов баз данных:

• SqlServer
• Postgres
• MySql
• MongoDb
• Redis
• ClickHouse

IRepository<TEntity, TKey>

Базовый интерфейс репозитория для CRUD-операций:

• Task<TEntity> GetById(TKey id) — получить сущность по идентификатору
• Task<IEnumerable<TEntity>> GetAll() — получить все сущности
• Task Add(TEntity entity) — добавить сущность
• Task Update(TEntity entity) — обновить сущность
• Task Delete(TKey id) — удалить сущность по идентификатору

IDatabaseMigrator

Интерфейс для управления миграциями:

• Task MigrateAsync() — применить миграции к базе данных

Установка

Добавьте ссылку на пакет в ваш проект (после публикации в NuGet):

dotnet add package DigitTwin.UniversalContextConnector.Abstractions

Или добавьте проект как зависимость в вашей solution:

<ItemGroup>
  <ProjectReference Include="../DigitTwin.UniversalContextConnector.Abstractions/DigitTwin.UniversalContextConnector.Abstractions.csproj" />
</ItemGroup>

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

using DigitTwin.UniversalContextConnector.Abstractions;

public class MyEntityRepository : IRepository<MyEntity, int>
{
    // Реализация методов интерфейса
    public Task<MyEntity> GetById(int id) { /* ... */ }
    public Task<IEnumerable<MyEntity>> GetAll() { /* ... */ }
    public Task Add(MyEntity entity) { /* ... */ }
    public Task Update(MyEntity entity) { /* ... */ }
    public Task Delete(int id) { /* ... */ }
}

// Конфигурация подключения
var config = new DatabaseConfiguration
{
    Name = "Default",
    ConnectionString = "Server=localhost;Database=example;User Id=sa;Password=your_password;",
    Type = DatabaseTypeEnum.SqlServer,
    DatabaseName = "example"
};

Требования

• .NET 8.0 и выше

Лицензия

MIT (уточните при необходимости)

Авторы

• YourName (замените на актуального автора)

Данная библиотека предназначена для использования в составе Digital Twin решений и может быть расширена для поддержки других СУБД и сценариев.