DRN.Framework.EntityFramework 0.5.1-preview002

Prefix Reserved
This is a prerelease version of DRN.Framework.EntityFramework.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DRN.Framework.EntityFramework --version 0.5.1-preview002
                    
NuGet\Install-Package DRN.Framework.EntityFramework -Version 0.5.1-preview002
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DRN.Framework.EntityFramework" Version="0.5.1-preview002" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DRN.Framework.EntityFramework" Version="0.5.1-preview002" />
                    
Directory.Packages.props
<PackageReference Include="DRN.Framework.EntityFramework" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DRN.Framework.EntityFramework --version 0.5.1-preview002
                    
#r "nuget: DRN.Framework.EntityFramework, 0.5.1-preview002"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package DRN.Framework.EntityFramework@0.5.1-preview002
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DRN.Framework.EntityFramework&version=0.5.1-preview002&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DRN.Framework.EntityFramework&version=0.5.1-preview002&prerelease
                    
Install as a Cake Tool

master develop Quality Gate Status

Security Rating Maintainability Rating Reliability Rating Vulnerabilities Bugs Lines of Code Coverage

DRN.Framework.EntityFramework provides DrnContext with conventions to develop rapid and effective domain models.

DRNContext

DrnContext has following unique features:

  • Implements IDesignTimeDbContextFactory to enable migrations from dbContext defining projects.
  • Implements IDesignTimeServices to support multi context projects with default output directories in the context specific folder.
  • Uses HasDrnContextServiceCollectionModule attribute for automatic registration with AddServicesWithAttributes service collection extension method.
  • Uses context name (typeof(TContext).Name) as connection string key by convention.
  • Automatically applies IEntityTypeConfiguration implementations from the assembly whose namespace contains the derived context's namespace.
  • Automatically marks Entities derived from DRN.Framework.SharedKernel.Domain.Entity as created, modified or deleted.
  • Enables DRN.Framework.Testing to create easy and effective integration tests with conventions and automatic registrations.
    • Application modules can be registered without any modification to TestContext
    • TestContext's ContainerContext
      • creates a postgresql container then scans TestContext's service collection for inherited DrnContexts.
      • Adds a connection strings to TestContext's configuration for each DrnContext according to convention.
    • TestContext acts as a ServiceProvider and when a service is requested it can build it from service collection with all dependencies.
namespace DRN.Framework.EntityFramework.Context;

[HasDrnContextServiceCollectionModule]
public abstract class DrnContext<TContext> : DbContext, IDesignTimeDbContextFactory<TContext>, IDesignTimeServices where TContext : DbContext, new()
{ 
...

public class HasDrnContextServiceCollectionModuleAttribute : HasServiceCollectionModuleAttribute
{
    static HasDrnContextServiceCollectionModuleAttribute()
    {
        ModuleMethodInfo = typeof(ServiceCollectionExtensions).GetMethod(nameof(ServiceCollectionExtensions.AddDbContextsWithConventions))!;
    }
}

Example Usage

namespace Sample.Infra;

public static class InfraModule
{
    public static IServiceCollection AddSampleInfraServices(this IServiceCollection sc)
    {
        sc.AddServicesWithAttributes();

        return sc;
    }
}

public class QAContext : DrnContext<QAContext>
{
    public QAContext(DbContextOptions<QAContext> options) : base(options)
    {
    }

    public QAContext() : base(null)
    {
    }

    public DbSet<User> Users { get; set; }
    public DbSet<Question> Questions { get; set; }
    public DbSet<Answer> Answers { get; set; }
    public DbSet<QuestionComment> Comments { get; set; }
    public DbSet<Category> Categories { get; set; }
    public DbSet<Tag> Tags { get; set; }
}

Development Environment Configurations

Following configuration options added to minimize development environment creation efforts:

  • DrnContext development connection string will be auto generated when
    • Environment configuration key set as Development and,
    • postgres-password configuration key set and,
    • No other connection string is provided for the DbContexts.
  • Following keys can set optionally according to DbContextConventions;
    • DrnContext_AutoMigrateDevEnvironment
      • When set true applies migrations automatically
    • DrnContext_DevHost
      • default is postgresql
    • DrnContext_DevPort
      • default is 5432
    • DrnContext_DevUsername
      • default is postgres
    • DrnContext_DevDatabase
      • default is drnDb

postgres-password and DrnContext_AutoMigrateDevEnvironment should be enough to start a hosted service that has DrnContext dependencies.

For instance:

  • When a Postgresql helm chart is used for dev environment and it creates a password secret automatically,
  • Then only defining a volume mount should be enough for database configuration.

Global Usings

global using DRN.Framework.EntityFramework.Context;
global using Microsoft.EntityFrameworkCore;
global using DRN.Framework.Utils.DependencyInjection;

Semper Progredi: Always Progressive

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-09-29 20:51:31 +0300
Hash: d83e2f4f0102cd05c27e55dc781bd5b1817abe84

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DRN.Framework.EntityFramework:

Package Downloads
DRN.Framework.Testing

DRN.Framework.Testing package encapsulates testing dependencies and provides practical, effective helpers such as resourceful data attributes and test context. This package enables a new encouraging testing technique called as DTT(Duran's Testing Technique). With DTT, any developer can write clean and hassle-free unit and integration tests without complexity. ## Commit Info Author: Duran Serkan KILIÇ Date: 2025-09-28 22:00:23 +0300 Hash: 9b97bc89d55446d234e3a91d045c2e8094fd1733

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.7.0-preview037 84 9/28/2025
0.7.0-preview036 187 9/22/2025
0.7.0-preview035 175 8/31/2025
0.7.0-preview034 193 8/31/2025
0.7.0-preview033 211 8/28/2025
0.7.0-preview032 209 8/27/2025
0.7.0-preview031 192 8/10/2025
0.7.0-preview030 71 8/1/2025
0.7.0-preview029 88 8/1/2025
0.7.0-preview028 77 8/1/2025
0.7.0-preview027 120 7/31/2025
0.7.0-preview026 115 7/29/2025
0.7.0-preview025 130 7/27/2025
0.7.0-preview024 101 7/11/2025
0.7.0-preview023 114 7/11/2025
0.7.0-preview022 183 6/29/2025
0.7.0-preview021 174 6/23/2025
0.7.0-preview020 133 5/31/2025
0.7.0-preview019 202 3/23/2025
0.7.0-preview018 153 3/2/2025
0.7.0-preview017 146 2/23/2025
0.7.0-preview016 138 2/22/2025
0.7.0-preview015 115 2/21/2025
0.7.0-preview014 137 2/20/2025
0.7.0-preview013 156 2/9/2025
0.7.0-preview012 131 2/8/2025
0.7.0-preview011 137 2/2/2025
0.7.0-preview010 129 1/20/2025
0.7.0-preview009 135 1/19/2025
0.7.0-preview008 105 1/16/2025
0.7.0-preview007 134 12/29/2024
0.7.0-preview006 127 12/23/2024
0.7.0-preview005 127 11/27/2024
0.7.0-preview004 143 11/23/2024
0.7.0-preview003 132 11/20/2024
0.7.0-preview002 137 11/17/2024
0.7.0-preview001 141 11/14/2024
0.6.0 179 11/10/2024
0.6.0-preview002 136 11/10/2024
0.6.0-preview001 151 11/10/2024
0.5.1-preview002 139 9/30/2024
0.5.1-preview001 135 9/22/2024
0.5.0 199 8/30/2024
0.5.0-preview011 134 8/30/2024
0.5.0-preview010 162 8/25/2024
0.5.0-preview009 160 8/8/2024
0.5.0-preview008 152 8/7/2024
0.5.0-preview007 120 8/2/2024
0.5.0-preview006 116 7/30/2024
0.5.0-preview005 145 7/27/2024
0.5.0-preview004 144 7/15/2024
0.5.0-preview003 161 6/6/2024
0.5.0-preview002 147 6/5/2024
0.5.0-preview001 146 6/4/2024
0.4.0 153 5/19/2024
0.4.0-preview006 141 5/19/2024
0.4.0-preview005 157 5/12/2024
0.4.0-preview004 158 5/12/2024
0.4.0-preview003 151 5/11/2024
0.4.0-preview002 161 5/8/2024
0.4.0-preview001 163 5/5/2024
0.3.1-preview001 131 4/26/2024
0.3.0 178 4/23/2024
0.3.0-preview002 150 4/23/2024
0.3.0-preview001 153 4/23/2024
0.2.2-preview010 170 4/11/2024
0.2.2-preview009 143 3/18/2024
0.2.2-preview008 142 3/18/2024
0.2.2-preview007 155 3/16/2024
0.2.2-preview006 129 3/11/2024
0.2.2-preview005 138 3/10/2024
0.2.2-preview004 149 3/10/2024
0.2.2-preview003 225 1/22/2024
0.2.2-preview002 154 1/18/2024
0.2.2-preview001 169 1/14/2024
0.2.1 257 1/7/2024
0.2.0 151 12/31/2023
0.2.0-preview009 126 12/31/2023
0.2.0-preview008 116 12/30/2023
0.2.0-preview007 120 12/28/2023
0.2.0-preview006 121 12/27/2023
0.2.0-preview005 110 12/25/2023
0.2.0-preview004 121 12/23/2023
0.2.0-preview003 122 12/20/2023
0.2.0-preview002 109 12/19/2023

Not every version includes changes, features or bug fixes. This project can increment version to keep consistency with other DRN.Framework projects.

## Version 0.5.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to August 30 Victory Day, a day that marks the decisive victory achieved by the Turkish people against imperialism during the Turkish War of Independence, leading to the establishment of the Republic of Türkiye.

### New Features

* DbContext attributes to make default configurations visible and easier to configure
 * NpgsqlPerformanceSettingsAttribute and its default implementation DrnContextPerformanceDefaultsAttribute added
 * NpgsqlDbContextOptionsAttribute and its default implementation DrnContextDefaultsAttribute added

## Version 0.4.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 19 May Commemoration of Atatürk, Youth and Sports Day.

### Breaking Changes

* DrnContext and DrnContextIdentity MigrationsHistoryTable database schema changes as __entity_migrations
 * Each DbContext's history table is named according to following convention:
   * {contextName.ToSnakeCase()}_history
* DrnContext and DrnContextIdentity applies context name with snake case formatting as default schema name.

### New Features

* DrnContextIdentity to support ASP.NET Core Identity  with DrnContext features
 * DrnContextIdentity to inherits IdentityDbContext

### Bug Fixes

* Microsoft.EntityFrameworkCore.Tools PrivateAssets were preventing migration

## Version 0.3.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 23 April National Sovereignty and Children's Day.

### New Features

* DrnContext development connection string will be auto generated when
   * Environment configuration key set as Development and,
   * postgres-password configuration key set and,
   * No other connection string is provided for the DbContexts.
* Following keys can set optionally according to DbContextConventions;
   * DrnContext_AutoMigrateDevEnvironment
       * When set true applies migrations automatically
   * DrnContext_DevHost
   * DrnContext_DevPort
   * DrnContext_DevUsername
       * default is postgres
   * DrnContext_DevDatabase
       * default is drnDb

## Version 0.2.0

### New Features

*  DrnContext
   * Implemented IDesignTimeDbContextFactory to enable migrations from dbContext defining projects.
   * Implemented IDesignTimeServices to support multi context projects with default output directory in the context specific folder.
   * Uses HasDrnContextServiceCollectionModule to automatic registration with AddServicesWithAttributes service collection extension method.
   * Uses context name (typeof(TContext).Name) as connection string key by convention.
   * Enables DRN.Framework.Testing to create easy and effective integration tests with conventions and automatic registrations.

---

**Semper Progredi: Always Progressive**  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-09-29 20:51:31 +0300  
Hash: d83e2f4f0102cd05c27e55dc781bd5b1817abe84