在 Entity Framework 6.1（非核心）中，如何使用 IndexAttribute 来定义聚集索引？

Question

Entity Framework 6.1（代码优先）增加了通过IndexAttribute 添加索引的可能性。该属性带有一个参数，用于指定索引是集群还是非集群。

同时，AFAIK，Entity Framework 要求每个实体都有一个主键（用 KeyAttribute 注释），并且该主键始终创建为一个集群键。 p>

因此，当我将IndexAttribute 与IsClustered = true 一起应用时，我会收到一个错误，因为由于键的原因，已经存在 一个聚集索引。

那么，如何使用IndexAttribute 创建一个不是主键的聚集索引？ IndexAttribute 的 IsClustered 属性是否可用？

（更多上下文：我正在映射一个仅用于通过 LINQ 查询读取的表。我不需要从该表中实际插入、更新或删除实体。因此，我不需要一个主键。理想情况下，我想要一个没有主键但有一个非唯一的、为读取而优化的聚集索引的表。）

编辑（2014-04-11）：另见https://entityframework.codeplex.com/workitem/2212。

Answer 1

一张表只能有一个聚集索引，默认情况下Entity Framework/Sql Server将它放在主键上。

那么IsClustered 属性在不是主键的索引上有什么用呢？好问题！ (+1)

这个类：

public class Blog
{
    [Key()]
    public int Id { get; set; }

    [MaxLength(256)]//Need to limit size of column for clustered indexes
    public string Title { get; set; }

    [Index("IdAndRating", IsClustered = true)]
    public int Rating { get; set; }

}

将生成此迁移：

    public override void Up()
    {
        CreateTable(
            "dbo.Blogs",
            c => new
                {
                    Id = c.Int(nullable: false, identity: true),
                    Title = c.String(maxLength: 256),
                    Rating = c.Int(nullable: false),
                });
            .PrimaryKey(t => t.Id)
            .Index(t => t.Rating, clustered: true, name: "IdAndRating");
    }

将迁移更改为：

    public override void Up()
    {
        CreateTable(
            "dbo.Blogs",
            c => new
                {
                    Id = c.Int(nullable: false, identity: true),
                    Title = c.String(maxLength: 256),
                    Rating = c.Int(nullable: false),
                });

        CreateIndex("dbo.Blogs", 
                    new[] { "Rating", "Title" }, 
                    clustered: true, 
                    name: "IdAndRating");

    }

这应该创建没有主键但在其他列上有聚集索引的表

编辑 在您不需要插入、更新或删除数据的场景中，您不需要完整的实体，您可以使用 raw sql queries 来填充类。您需要将自己的 sql 添加到迁移中以创建表，因为 EF 不会自动执行它，但这意味着您可以根据需要创建表和索引。

Answer 2

您可以从 SqlServerMigrationSqlGenerator 派生自己的类 并在那里更改 pk 创建：

public class NonClusteredPrimaryKeySqlMigrationSqlGenerator : SqlServerMigrationSqlGenerator
{
    protected override void Generate(System.Data.Entity.Migrations.Model.AddPrimaryKeyOperation addPrimaryKeyOperation)
    {
        addPrimaryKeyOperation.IsClustered = false;
        base.Generate(addPrimaryKeyOperation);
    }

    protected override void Generate(System.Data.Entity.Migrations.Model.CreateTableOperation createTableOperation)
    {
        createTableOperation.PrimaryKey.IsClustered = false;
        base.Generate(createTableOperation);
    }

    protected override void Generate(System.Data.Entity.Migrations.Model.MoveTableOperation moveTableOperation)
    {
        moveTableOperation.CreateTableOperation.PrimaryKey.IsClustered = false;
        base.Generate(moveTableOperation);
    }

这里有完整的例子 https://entityframework.codeplex.com/workitem/2163

Answer 3

以下是基于 raditch 对我有用的答案的代码。这允许主键默认为集群。它可能需要调整，因为我们不使用内置的 ef 迁移来实际处理更改

public class NonClusteredPrimaryKeySqlMigrationSqlGenerator : SqlServerMigrationSqlGenerator
{
    public override IEnumerable<System.Data.Entity.Migrations.Sql.MigrationStatement> Generate(IEnumerable<MigrationOperation> migrationOperations, string providerManifestToken)
    {
        var primaries = migrationOperations.OfType<CreateTableOperation>().Where(x => x.PrimaryKey.IsClustered).Select(x => x.PrimaryKey).ToList();
        var indexes = migrationOperations.OfType<CreateIndexOperation>().Where(x => x.IsClustered).ToList();
        foreach (var index in indexes)
        {
            var primary = primaries.Where(x => x.Table == index.Table).SingleOrDefault();
            if (primary != null)
            {
                primary.IsClustered = false;
            }
        }
        return base.Generate(migrationOperations, providerManifestToken);
    }
}
public class EFCustomConfiguration : DbConfiguration
{
    public EFCustomConfiguration()
    {
        SetMigrationSqlGenerator("System.Data.SqlClient", () => new NonClusteredPrimaryKeySqlMigrationSqlGenerator());
    }
}

Answer 4

实话告诉你——IndexAttribute 完全是多余的，不适合专业开发。他们缺乏核心功能，专注于毫无意义的事情。

为什么？因为它永远不会也应该像构建脚本一样灵活。聚集索引只是一件事 - 我会错过的下一件事是过滤索引，主要是字段上的“非空的唯一索引，空的非唯一索引”的形式，我碰巧经常使用它作为可选唯一代码（因为在 SQL Server 中，一个 NULL 等于 SQL 生成中的另一个 NULL，因此在唯一索引中一次只能有一个 NULL）。

如果我是你，我会远离数据库生成 - 和迁移 - 并使用经典的设置/迁移脚本方法。 Thta 是您可以进行更复杂的多步骤迁移而不会丢失数据的地方。 EF 只处理最基本的场景——在这些领域我怀疑这是否足够。可能是因为我也主要在大型数据库上工作，在这些数据库中我们非常仔细地进行更改 - 当您达到数十亿行 (!0+) 的两位数时，添加索引可能需要一些时间。

我希望开发人员能够专注于她的一些无法轻松更好地解决的缺失领域，例如性能，例如核心 ORM 功能（更好的枚举、二级缓存、批量删除 API、更多性能插入和更新 -所有可行的事情）。代码优先很好。 Code First 生成和维护数据库是非常简单的场景之外的痛苦。

Answer 5

如果有人仍然对此主题感兴趣，我会在这里写下我的解决方案。 下面的代码更改了 add-migration 命令的输出。

public class CustomMigrationCodeGenerator : CSharpMigrationCodeGenerator
{
    protected override void Generate(CreateTableOperation createTableOperation, IndentedTextWriter writer)
    {
        if (createTableOperation.Columns.Any(x => x.Name == "Index") &&
             createTableOperation.Columns.Any(x => x.Name == "Id"))
        {
            if (createTableOperation.PrimaryKey != null)
            {
                createTableOperation.PrimaryKey.IsClustered = false;
            }
        }
        base.Generate(createTableOperation, writer);
    }
}

您可以在迁移配置中注册此生成器：

internal sealed class Configuration : DbMigrationsConfiguration<Ubrasoft.Freeman.WebApi.Db.MainDb>
{
    public Configuration()
    {
        AutomaticMigrationsEnabled = false;
        CodeGenerator = new CustomMigrationCodeGenerator();  
        SetSqlGenerator("System.Data.SqlClient", new CustomMigrationSqlGenerator());        
    }

    protected override void Seed(Ubrasoft.Freeman.WebApi.Db.MainDb context)
    {

    }
}

这里是生成的迁移代码：

public override void Up()
    {
        CreateTable(
            "Tenant.Tenant",
            c => new
                {
                    Id = c.Guid(nullable: false),
                    TenantNo = c.Byte(nullable: false),
                    Name = c.String(nullable: false, maxLength: 20),
                    Index = c.Int(nullable: false, identity: true),
                    CreatedDate = c.DateTime(nullable: false, precision: 0, storeType: "datetime2"),
                    UpdatedDate = c.DateTime(nullable: false, precision: 0, storeType: "datetime2"),
                    IsDeleted = c.Boolean(nullable: false),
                })
            .PrimaryKey(t => t.Id, clustered: false)
            .Index(t => t.Index, unique: true, clustered: true);

    } 

Here 是关于自定义 MigrationCodeGenerator 的文章。