Toolbelt.EntityFrameworkCore.IndexAttribute 5.0.1.1

dotnet add package Toolbelt.EntityFrameworkCore.IndexAttribute --version 5.0.1.1
NuGet\Install-Package Toolbelt.EntityFrameworkCore.IndexAttribute -Version 5.0.1.1
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="Toolbelt.EntityFrameworkCore.IndexAttribute" Version="5.0.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Toolbelt.EntityFrameworkCore.IndexAttribute --version 5.0.1.1
#r "nuget: Toolbelt.EntityFrameworkCore.IndexAttribute, 5.0.1.1"
#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.
// Install Toolbelt.EntityFrameworkCore.IndexAttribute as a Cake Addin
#addin nuget:?package=Toolbelt.EntityFrameworkCore.IndexAttribute&version=5.0.1.1

// Install Toolbelt.EntityFrameworkCore.IndexAttribute as a Cake Tool
#tool nuget:?package=Toolbelt.EntityFrameworkCore.IndexAttribute&version=5.0.1.1

IndexColumnAttribute for EntityFramework Core NuGet Package unit tests

What's this?

The [IndexColumn] attribute that is the revival of [Index] attribute for EF Core. (with extension for model building.)

Attention

EF Core also includes the [Index] attribute officially, since ver.5.0.

However, I'm going to continue improving and maintaining these libraries, because these libraries still have advantages as below.

  • You can still create indexes by data annotations even if you have to use a lower version of EF Core.
  • You can create indexes with "included columns" for SQL Server.
  • You can create a clustered index (This means you can also create a non-clustered primary key index).

How to use?

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

Supported Versions

The version of EF Core Version of this package
v.8.0 v.5.0.1 or later (Recommended), v.5.0, v.3.2, v.3.1
v.7.0 v.5.0.1 or later (Recommended), v.5.0, v.3.2, v.3.1
v.6.0 v.5.0.1 or later (Recommended), v.5.0, v.3.2, v.3.1
v.5.0 v.5.0.1 or later (Recommended), v.5.0, v.3.2, v.3.1
v.3.1 v.5.0.1 or later (Recommended), v.5.0, v.3.2, v.3.1
v.3.0 v.5.0.1 or later (Recommended), v.5.0, v.3.2, v.3.1, v.3.0
v.2.0, 2.1, 2.2 v.2.0.x

If you want to use IsClustered=true and/or Includes index features on a SQL Server, you have to add Toolbelt.EntityFrameworkCore.IndexAttribute.SqlServer package to your project, instead.

> dotnet add package Toolbelt.EntityFrameworkCore.IndexAttribute.SqlServer
  1. Annotate your model with [IndexColumn] attribute that lives in Toolbelt.ComponentModel.DataAnnotations.Schema.V5 namespace.

Notice - The attribute name is [IndexColumn], is not [Index] (the attribute name [Index] is used by EFocre v.5.0).

using Toolbelt.ComponentModel.DataAnnotations.Schema.V5;

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

    [IndexColumn] // <- Here!
    public string Name { get; set; }
}
  1. [Important] Override OnModelCreating() method of your DbContext class, and call BuildIndexesFromAnnotations() 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 OnModelCreatin(ModelBuilder modelBuilder)
  {
    base.OnModelCreating(modelBuilder);

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

If you use SQL Server and IsClustered=true and/or Includes = new[]{"Foo", "Bar"} features, you need to call BuildIndexesFromAnnotationsForSqlServer() extension method instead of BuildIndexesFromAnnotations() extension method.

  ...
  // Override "OnModelCreating", ...
  protected override void OnModelCreatingModelBuilder modelBuilder)
  {
    base.OnModelCreating(modelBuilder);

    // Invoke uildIndexesFromAnnotationsForSqlServer"
    // instead of "BuildIndexesFromAnnotations".
    modelBuilder.BuildIndexesFromAnnotationsForSqlServer;
  }

That's all!

BuildIndexesFromAnnotations() (or, BuildIndexesFromAnnotationsForSqlServer()) extension method scans the DbContext with .NET Reflection technology, and detects [IndexColumn] attributes, then build models related to indexing.

After doing that, the database which created by EF Core, contains indexes that are specified by [IndexColumn] attributes.

Appendix A - Suppress "NotSupportedException"

You will run into "NotSupportedException" when you call BuildIndexesFromAnnotations() with the model which is annotated with the [IndexColumn] attribute that's "IsClustered" property is true, or "Includes" property is not empty.

If you have to call BuildIndexesFromAnnotations() in this case (for example, share the model for different Database products), you can suppress this behavior with configuration, like this.

  ...
  protected override void OnModelCreating(ModelBuilder modelBuilder)
  {
    base.OnModelCreating(modelBuilder);

    // Suppress "NotSupportedException" for "IsClustered" and "Includes" feature.
    modelBuilder.BuildIndexesFromAnnotations(options => {
      options.SuppressNotSupportedException.IsClustered = true;
      options.SuppressNotSupportedException.Includes = true;
    });
  }
}

Appendix B - Notice for using "IsClustered=true"

If you annotate the model with "IsClustered=true" index simply like this,

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

  [IndexColumn(IsClustered = true)]
  public string EmployeeCode { get; set; }
}

You will run into 'System.Data.SqlClient.SqlException' like this.

System.Data.SqlClient.SqlException :
Cannot create more than one clustered index on table '(table name)'.
Drop the existing clustered index '(index name)' before creating another.

In this case, you need to annotate a primary key property with [PrimaryKey(IsClustered = false)] attribute explicitly for suppress auto generated primary key to be clustered index.

public class Employee {
  [PrimaryKey(IsClustered = false)] // <- Add this line!
  public int Id { get; set; }

  [IndexColumn(IsClustered = true)]
  public string EmployeeCode { get; set; }
}

Appendix C - If you want to use only "IndexAttribute" without any dependencies...

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

Appendix D - Upgrade an existing project

For more detail on this topic, please visit this link.

Appendix E - If you run into a compile error CS0104...

For more detail on this topic, please visit this link.

For More Detail...

This library is designed to have the same syntax as EF 6.x [Index] annotation.

Please visit document site of EF 6.x and [Index] attribute for EF 6.x.

Limitations

[IndexColumn] attribute with IsClustered=true can apply only not owned entity types.

Release Notes

License

MIT License

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (14)

Showing the top 5 NuGet packages that depend on Toolbelt.EntityFrameworkCore.IndexAttribute:

Package Downloads
CoreMore

Package Description

Bnsights.Core

Package Description

Toolbelt.EntityFrameworkCore.IndexAttribute.SqlServer

The `[IndexColumn]` attribute that is the revival of `[Index]` attribute for EF Core. (with extension for model building.) This package also provides [PrimaryKey] attribute.

Zicard.API.Common

Bases microservices da Zicard API

BinaryBlox.SDK

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.1.1 20,889 11/6/2023
5.0.1 391,776 11/11/2021
5.0.1-preview.1.0 1,566 6/30/2021
5.0.0 400,139 8/14/2020
3.2.0 278,592 3/18/2020
3.1.0 130,159 2/5/2020
3.0.0 58,374 10/9/2019
2.1.0 88,921 9/1/2019
2.0.2.3-beta 454 8/22/2019
2.0.1 4,388 7/26/2019
2.0.0 44,933 2/21/2019
1.0.2.1 9,504 1/22/2019
1.0.1-beta 525 1/18/2019
1.0.0 65,899 12/28/2017

v.5.0.1.1
- Supports EntityFramework Core 7.0, 8.0
- Update README.md