DRN.Framework.EntityFramework 0.5.0-preview009

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
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.0-preview009
                    


                    

                
NuGet\Install-Package DRN.Framework.EntityFramework -Version 0.5.0-preview009
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.0-preview009" />
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.0-preview009" />
                    


                            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.0-preview009
                    


                    

                
#r "nuget: DRN.Framework.EntityFramework, 0.5.0-preview009"
#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. 
#addin nuget:?package=DRN.Framework.EntityFramework&version=0.5.0-preview009&prerelease
                    


                            Install DRN.Framework.EntityFramework as a Cake Addin
                        

                    

                
#tool nuget:?package=DRN.Framework.EntityFramework&version=0.5.0-preview009&prerelease
                    


                            Install DRN.Framework.EntityFramework 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-08-08 15:52:15 +0300
Hash: 54931c25f3ef51beb7eac20e3f25c2bc716d1a1b

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. 
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-03-23 12:44:05 +0300 Hash: 2de70c28af18b89ba624448e2cc80072695d983a

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.7.0-preview019 136 17 days ago
0.7.0-preview018 93 a month ago
0.7.0-preview017 97 2 months ago
0.7.0-preview016 87 2 months ago
0.7.0-preview015 84 2 months ago
0.7.0-preview014 94 2 months ago
0.7.0-preview013 96 2 months ago
0.7.0-preview012 90 2 months ago
0.7.0-preview011 94 2 months ago
0.7.0-preview010 78 3 months ago
0.7.0-preview009 76 3 months ago
0.7.0-preview008 76 3 months ago
0.7.0-preview007 87 3 months ago
0.7.0-preview006 89 4 months ago
0.7.0-preview005 78 4 months ago
0.7.0-preview004 91 5 months ago
0.7.0-preview003 89 5 months ago
0.7.0-preview002 86 5 months ago
0.7.0-preview001 86 5 months ago
0.6.0 117 5 months ago
0.6.0-preview002 98 5 months ago
0.6.0-preview001 97 5 months ago
0.5.1-preview002 86 6 months ago
0.5.1-preview001 88 7 months ago
0.5.0 129 7 months ago
0.5.0-preview011 92 7 months ago
0.5.0-preview010 119 7 months ago
0.5.0-preview009 111 8 months ago
0.5.0-preview008 109 8 months ago
0.5.0-preview007 75 8 months ago
0.5.0-preview006 74 8 months ago
0.5.0-preview005 103 8 months ago
0.5.0-preview004 93 9 months ago
0.5.0-preview003 113 6/6/2024
0.5.0-preview002 106 6/5/2024
0.5.0-preview001 101 6/4/2024
0.4.0 102 5/19/2024
0.4.0-preview006 83 5/19/2024
0.4.0-preview005 109 5/12/2024
0.4.0-preview004 104 5/12/2024
0.4.0-preview003 109 5/11/2024
0.4.0-preview002 127 5/8/2024
0.4.0-preview001 116 5/5/2024
0.3.1-preview001 102 4/26/2024
0.3.0 119 4/23/2024
0.3.0-preview002 100 4/23/2024
0.3.0-preview001 113 4/23/2024
0.2.2-preview010 119 4/11/2024
0.2.2-preview009 100 3/18/2024
0.2.2-preview008 98 3/18/2024
0.2.2-preview007 113 3/16/2024
0.2.2-preview006 91 3/11/2024
0.2.2-preview005 97 3/10/2024
0.2.2-preview004 97 3/10/2024
0.2.2-preview003 144 1/22/2024
0.2.2-preview002 112 1/18/2024
0.2.2-preview001 115 1/14/2024
0.2.1 195 1/7/2024
0.2.0 119 12/31/2023
0.2.0-preview009 92 12/31/2023
0.2.0-preview008 93 12/30/2023
0.2.0-preview007 100 12/28/2023
0.2.0-preview006 91 12/27/2023
0.2.0-preview005 92 12/25/2023
0.2.0-preview004 101 12/23/2023
0.2.0-preview003 101 12/20/2023
0.2.0-preview002 91 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.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 added 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.

### Breaking Changes

### 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

### Bug Fixes

## Version 0.2.0

### Breaking Changes

### New Features

* DrnContext added
   * 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.

### Bug Fixes

---
**Semper Progredi: Always Progressive**  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-08-08 15:52:15 +0300  
Hash: 54931c25f3ef51beb7eac20e3f25c2bc716d1a1b