There is a newer version of this package available.
See the version list below for details.
dotnet add package Toolbelt.EntityFrameworkCore.IndexAttribute --version
NuGet\Install-Package Toolbelt.EntityFrameworkCore.IndexAttribute -Version
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="" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Toolbelt.EntityFrameworkCore.IndexAttribute --version
#r "nuget: Toolbelt.EntityFrameworkCore.IndexAttribute,"
#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=

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

IndexAttribute for EntityFramework Core

Build status NuGet Package

What's this?

Revival of [Index] attribute for EF Core. (with extension for model building.)


EF Core team said:

"We didn't bring this (= IndexAttribute) over from EF6.x because it had a lot of issues"

Therefore, you should consider well before use this package.

How to use?

  1. Annotate your model with [Index] attribute that lives in Toolbelt.ComponentModel.DataAnnotations.Schema namespace.
using Toolbelt.ComponentModel.DataAnnotations.Schema;

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

    [Index] // <- 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 OnModelCreating(ModelBuilder modelBuilder)

        // .. and invoke "BuildIndexesFromAnnotations"!

That's all!

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

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

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.

Not Supported Feature

IsClustered property is not supported at this version.


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 was computed. 
.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

Package Description


Package Description


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


Bases microservices da Zicard API


Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated 18,800 11/6/2023
5.0.1 389,478 11/11/2021
5.0.1-preview.1.0 1,482 6/30/2021
5.0.0 399,576 8/14/2020
3.2.0 277,404 3/18/2020
3.1.0 130,123 2/5/2020
3.0.0 58,371 10/9/2019
2.1.0 88,567 9/1/2019 454 8/22/2019
2.0.1 4,386 7/26/2019
2.0.0 44,875 2/21/2019 9,504 1/22/2019
1.0.1-beta 525 1/18/2019
1.0.0 65,860 12/28/2017

- Added support for Owned Entity Types.
- 1st release.