HyperDev.Data 1.2.4

HyperDev.Data

Data access library built on Entity Framework Core, part of the HyperDev Fatum framework. It adds attribute-based mapping, named connections and a provider-independent Database API; the database engines are supported by separate provider packages.

• DataContext: an EF Core DbContext built from a ModelDescriptor (the list of mapped types), with ADO.NET helpers (ExecuteScalar, ExecuteNonQuery, ExecuteReader) and query hints (WithNoLock, WithReadOnly)
• Mapping attributes in HyperDev.Data.Annotations: TableMap, ViewMap, ColumnMap, PrimaryKeyMap, ForeignKeyMap, IndexMap, SequenceGenerate, Encrypted, ...
• Named connections read from configuration (IConnectionManager, IDataContextFactory), with aliases (Redirect) and runtime resolution
• Database API per connection: commands and transactions, bulk copy, sequences, temporary tables, stored procedures
• Data copy between databases, data readers and files (DataCopy); graph queries that load an entity tree in one round trip (GraphQueryBuilder<TRoot>)
• SQL tracing (AddQueryTracer) and a database logger provider (AddDatabaseLogger)

Installation

dotnet add package HyperDev.Data
dotnet add package HyperDev.Data.SqlServer   # or another provider package

Quick start

appsettings.json:

{
  "Database": {
    "Connections": [
      { "Name": "Shop", "Provider": "Microsoft.Data.SqlClient", "ConnectionString": "Server=.;Database=Shop;Integrated Security=True;TrustServerCertificate=True", "DefaultSchema": "dbo" }
    ]
  }
}

using HyperDev.Data;
using HyperDev.Data.Annotations;
using HyperDev.Data.SqlServer;
using HyperDev.DependencyInjection;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

// Startup: register the providers in use, then the named connections
DatabaseProviderFactories.Register(SqlServerProvider.Instance);
services.AddConnectionFactory(options => configuration.GetSection("Database").Bind(options));

// Usage
var factory = services.BuildServiceProvider().GetRequiredService<IDataContextFactory>();
using var ctx = factory.CreateContext<ShopContext>("Shop");
var customers = ctx.Customers.Where(c => c.City == "Rome").ToList();

[TableMap(Name = "Customers", Schema = "dbo")]
[PrimaryKeyMap(nameof(Id))]
public class Customer
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string City { get; set; }
}

public class ShopContext : DataContext
{
    static readonly ModelDescriptor Descriptor = new(new[] { typeof(Customer) });
    public ShopContext(ConnectionInfo connectionInfo) : base(connectionInfo) { }
    public DbSet<Customer> Customers => Set<Customer>();
    protected override IModel GetModel(string providerName) => Descriptor.GetModel(providerName);
}

services and configuration are the host's IServiceCollection and IConfiguration. In ASP.NET Core projects ConnectionInfo also exists in Microsoft.AspNetCore.Http: add using ConnectionInfo = HyperDev.Data.ConnectionInfo;.

Providers

Target frameworks

.NET 8.0, .NET 10.0

License

MIT, © Ivan Senatore, Wemake Informatica srl. Third-party dependencies keep their own licenses (Entity Framework Core and Microsoft.Extensions.*: MIT).