ASP.NET Core Entity Framework Core cannot find IndexAttribute

Question

I receive the following from Visual Studio Code on my Mac, both in IDE and console window after executing "dotnet run":

The type or namespace name 'IndexAttribute' could not be found

I have a class called Story which I want to use for generating a database with Code First. This class has a primary key marked with KeyAttribute and Author string marked with MaxLengthAttribute, so both of those work (using System.ComponentModel.DataAnnotations). Two more fields, DateTime Date and bool IsPublished, have IndexAttribute applied (it's a two-column index). I explicitly named it IX_DatePublished, IsUnique = false, and use Order = 1 for the Date field and Order = 2 for the IsPublished field.

What do I put in project.json before running "dotnet restore" to have it pull in the right stuff for IndexAttribute to work?
Does EF included with ASPCore1 for Mac/Linux not have the right namespace included?

Thank you!

01 Binary · Accepted Answer · 2018-01-16 16:34:16Z

I am still in the process of getting familiar with Core tools; further research revealed that this feature is not supported but they would consider a pull request.

https://github.com/aspnet/EntityFrameworkCore/issues/4050

The work-around

The recommended way to add indexes to Code First models in the absence of IndexAttribute is to use Entity Framework Fluent API. For example the following could be added to your context (derived from DbContext):

    /// <summary>
    /// Creates database structure not supported with Annotations using Fluent syntax.
    /// </summary>
    /// <param name="optionsBuilder">The configuration interface.</param>
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Story>().HasIndex(
            story => new { story.Date, story.Published }).IsUnique(false);
    }

This creates a two-column index for Story.Date and Story.Published that's not unique. Following this change, use:

dotnet ef migrations add <name>
dotnet ef database update

It's interesting to note what kind of Migration code is generated to create this index (you could use this directly to customize your migrations to create index instead of adding code to your Context class):

protected override void Up(MigrationBuilder migrationBuilder)
{
    migrationBuilder.CreateTable(
        name: "Stories",
        columns: table => new
        {
            Id = table.Column<int>(nullable: false)
                .Annotation("Autoincrement", true),
            Author = table.Column<string>(maxLength: 64, nullable: true),
            Date = table.Column<DateTime>(nullable: false),
            Published = table.Column<bool>(nullable: false),
            Title = table.Column<string>(nullable: true)
        },
        constraints: table =>
        {
            table.PrimaryKey("PK_Stories", x => x.Id);
        });

    migrationBuilder.CreateIndex(
        name: "IX_Stories_Date_Published",
        table: "Stories",
        columns: new[] { "Date", "Published" });
}

The fruit of such labors:

Demodave · Accepted Answer · 2019-03-11 13:19:23Z

13

This seems to have changed since you asked the question. jsakamoto has implemented NuGet package that allows you to keep your [Index] attribute. The only difference is order of variables; you can no longer have Order=0 as your last variable but rather do:

[Index("IX_TreeFiddy", 0, IsUnique = false)]
public string LochNessMonster { get; set; }

[Index("IX_TreeFiddy", 1, IsUnique = false)]
public int CentsGiven { get; set; }

Override OnModelCreating()

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

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

Here is link to: IndexAttribute for .NET Core NuGet package

edited Mar 11, 2019 at 13:19

Demodave

6,7007 gold badges47 silver badges63 bronze badges

answered Jun 20, 2018 at 19:39

nikib3ro

20.7k25 gold badges124 silver badges185 bronze badges

Comments

Tawab Wakil · Accepted Answer · 2022-06-08 21:05:23Z

3

This is now supported natively with EF Core 5.0 and the standard namespace:

using Microsoft.EntityFrameworkCore;

You define the index via attribute at the class level:

[Index(nameof(Date), nameof(Published), IsUnique = false)]
public class Story
{
    public int Id { get; set; }
    public DateTime Date { get; set; }
    public bool Published { get; set; }
}

You can specify one column for the index, or multiple as shown above to create a composite key. More info here.

edited Jun 8, 2022 at 21:05

answered Jun 8, 2022 at 20:59

Tawab Wakil

2,42328 silver badges43 bronze badges

Collectives™ on Stack Overflow

ASP.NET Core Entity Framework Core cannot find IndexAttribute

3 Answers 3

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related