Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute 5.0.0

[Decimal(p, s)] attribute for EntityFramework Core.

Install-Package Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute -Version 5.0.0
dotnet add package Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute --version 5.0.0
<PackageReference Include="Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute" Version="5.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute --version 5.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute, 5.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute as a Cake Addin
#addin nuget:?package=Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute&version=5.0.0

// Install Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute as a Cake Tool
#tool nuget:?package=Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute&version=5.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

DecimalAttribute for EntityFramework Core

NuGet Package

What's this?

This class library for Entity Framework Core on .NET Core/.NET Framework provides the ability for you to control the precision and scale of decimal column type, by annotating properties of entity types, like this.

[Decimal(10, 5)] // <-- This!
public decimal Height { get; set; }

How to use?

  1. Add Toolbelt.EntityFrameworkCore.DecimalAttribute package to your project.
> dotnet add package Toolbelt.EntityFrameworkCore.DecimalAttribute

Supported Versions

EF Core version This package version
v.5.0 (Preview) v.3.1, v.5.0 (recommended)
v.3.1 v.3.1, v.5.0
v.3.0 v.3.0, v.3.1, v.5.0
v.2.0, 2.1, 2.2 v.1.0.x
  1. Annotate your model with [Decimal(precision, scale)] attribute that lives in Toolbelt.ComponentModel.DataAnnotations.Schema.V5 namespace.
using Toolbelt.ComponentModel.DataAnnotations.Schema.V5;

public class Person
{
    public int Id { get; set; }

    [Decimal(10, 5)] // <- Here!
    public decimal Height { get; set; }
}
  1. [Important] Override OnModelCreating() method of your DbContext class, and call BuildDecimalColumnTypeFromAnnotations() extension method which lives in Toolbelt.ComponentModel.DataAnnotations namespace.
using Microsoft.EntityFrameworkCore;
using Toolbelt.ComponentModel.DataAnnotations;

public class MyDbContext : DbContext
{
    ...
    // Override "OnModelCreating", ...
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        // .. and invoke "BuildDecimalColumnTypeFromAnnotations"!
        modelBuilder.BuildDecimalColumnTypeFromAnnotations();
    }
}

That's all!

BuildDecimalColumnTypeFromAnnotations() extension method scans the DbContext with .NET Reflection technology, and detects [Decimal] attributes, then build models related to decimal column type.

After doing that, decimal type columns in the database which created by EF Core, is configured with precisions and scales that are specified by [Decimal] attribute.

Appendix

Upgrade an existing project

To upgrade an existing project that uses ver.3 or before to use ver.5 or later of this package:

  1. Please confirm that the version of this package you use is ver.5 or later.
PM> Update-Package Toolbelt.EntityFrameworkCore.DecimalAttribute
  1. Remove using Toolbelt.ComponentModel.DataAnnotations.Schema;, and insert using Toolbelt.ComponentModel.DataAnnotations.Schema.V5; instead.
...
// 👇 Remove this line...
// using Toolbelt.ComponentModel.DataAnnotations.Schema;

// 👇 Insert this line, instead.
using Toolbelt.ComponentModel.DataAnnotations.Schema.V5;
...

If you want to use only "DecimalAttribute" without any dependencies...

If you want to use only "DecimalAttribute" class without any dependencies, you can use Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute NuGet package.

Release Notes

License

MIT License

DecimalAttribute for EntityFramework Core

NuGet Package

What's this?

This class library for Entity Framework Core on .NET Core/.NET Framework provides the ability for you to control the precision and scale of decimal column type, by annotating properties of entity types, like this.

[Decimal(10, 5)] // <-- This!
public decimal Height { get; set; }

How to use?

  1. Add Toolbelt.EntityFrameworkCore.DecimalAttribute package to your project.
> dotnet add package Toolbelt.EntityFrameworkCore.DecimalAttribute

Supported Versions

EF Core version This package version
v.5.0 (Preview) v.3.1, v.5.0 (recommended)
v.3.1 v.3.1, v.5.0
v.3.0 v.3.0, v.3.1, v.5.0
v.2.0, 2.1, 2.2 v.1.0.x
  1. Annotate your model with [Decimal(precision, scale)] attribute that lives in Toolbelt.ComponentModel.DataAnnotations.Schema.V5 namespace.
using Toolbelt.ComponentModel.DataAnnotations.Schema.V5;

public class Person
{
    public int Id { get; set; }

    [Decimal(10, 5)] // <- Here!
    public decimal Height { get; set; }
}
  1. [Important] Override OnModelCreating() method of your DbContext class, and call BuildDecimalColumnTypeFromAnnotations() extension method which lives in Toolbelt.ComponentModel.DataAnnotations namespace.
using Microsoft.EntityFrameworkCore;
using Toolbelt.ComponentModel.DataAnnotations;

public class MyDbContext : DbContext
{
    ...
    // Override "OnModelCreating", ...
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        // .. and invoke "BuildDecimalColumnTypeFromAnnotations"!
        modelBuilder.BuildDecimalColumnTypeFromAnnotations();
    }
}

That's all!

BuildDecimalColumnTypeFromAnnotations() extension method scans the DbContext with .NET Reflection technology, and detects [Decimal] attributes, then build models related to decimal column type.

After doing that, decimal type columns in the database which created by EF Core, is configured with precisions and scales that are specified by [Decimal] attribute.

Appendix

Upgrade an existing project

To upgrade an existing project that uses ver.3 or before to use ver.5 or later of this package:

  1. Please confirm that the version of this package you use is ver.5 or later.
PM> Update-Package Toolbelt.EntityFrameworkCore.DecimalAttribute
  1. Remove using Toolbelt.ComponentModel.DataAnnotations.Schema;, and insert using Toolbelt.ComponentModel.DataAnnotations.Schema.V5; instead.
...
// 👇 Remove this line...
// using Toolbelt.ComponentModel.DataAnnotations.Schema;

// 👇 Insert this line, instead.
using Toolbelt.ComponentModel.DataAnnotations.Schema.V5;
...

If you want to use only "DecimalAttribute" without any dependencies...

If you want to use only "DecimalAttribute" class without any dependencies, you can use Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute NuGet package.

Release Notes

License

MIT License

Release Notes

v.5.0.0
- Change namespace of [Decimal] attribute to avoid conflict with EFCore v5.

  • .NETStandard 2.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Toolbelt.EntityFrameworkCore.DecimalAttribute.Attribute:

Package Downloads
Toolbelt.EntityFrameworkCore.DecimalAttribute
[Decimal(p, s)] attribute and model builder extension for EntityFramework Core.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
5.0.0 790 8/14/2020
1.0.0 733 2/21/2019