Chaves

Uma chave serve como um identificador exclusivo para cada instância de entidade. A maioria das entidades no EF tem uma única chave, que mapeia para o conceito de chave primária em bancos de dados relacionais (para entidades sem chaves, consulte Entidades sem chave). As entidades podem ter chaves adicionais além da chave primária (consulte Chaves alternativas para obter mais informações).

Configurando uma chave primária

Por convenção, uma propriedade nomeada Id ou <type name>Id será configurada como a chave primária de uma entidade.

internal class Car
{
    public string Id { get; set; }

    public string Make { get; set; }
    public string Model { get; set; }
}

internal class Truck
{
    public string TruckId { get; set; }

    public string Make { get; set; }
    public string Model { get; set; }
}

Você pode configurar uma única propriedade para ser a chave primária de uma entidade da seguinte maneira:

internal class Car
{
    [Key]
    public string LicensePlate { get; set; }

    public string Make { get; set; }
    public string Model { get; set; }
}

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Car>()
        .HasKey(c => c.LicensePlate);
}

Você também pode configurar várias propriedades para serem a chave de uma entidade - isso é conhecido como uma chave composta. As convenções só configurarão uma chave composta em casos específicos - como para uma coleção de tipos próprios.

[PrimaryKey(nameof(State), nameof(LicensePlate))]
internal class Car
{
    public string State { get; set; }
    public string LicensePlate { get; set; }

    public string Make { get; set; }
    public string Model { get; set; }
}

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Car>()
        .HasKey(c => new { c.State, c.LicensePlate });
}

Geração de valor

Para chaves primárias numéricas e GUID não compostas, o EF Core configura automaticamente a geração de valor por convenção. Por exemplo, uma chave primária numérica no SQL Server é configurada automaticamente para ser uma coluna IDENTITY. Para obter mais informações, consulte a documentação sobre geração de valor e orientação para estratégias específicas de mapeamento de herança.

Nome da chave primária

Por convenção, em bancos de dados relacionais, as chaves primárias são criadas com o nome PK_<type name>. Você pode configurar o nome da restrição de chave primária da seguinte maneira:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Blog>()
        .HasKey(b => b.BlogId)
        .HasName("PrimaryKey_BlogId");
}

Tipos e valores chave

Embora o EF Core ofereça suporte ao uso de propriedades de qualquer tipo primitivo como chave primária, incluindo string, Guidbyte[] e outros, nem todos os bancos de dados oferecem suporte a todos os tipos como chaves. Em alguns casos, os valores-chave podem ser convertidos automaticamente para um tipo suportado, caso contrário, a conversão deve ser especificada manualmente.

As propriedades de chave sempre devem ter um valor não padrão ao adicionar uma nova entidade ao contexto, mas alguns tipos serão gerados pelo banco de dados. Nesse caso, a EF tentará gerar um valor temporário quando a entidade for adicionada para fins de rastreamento. Depois que SaveChanges for chamado, o valor temporário será substituído pelo valor gerado pelo banco de dados.

Teclas alternativas

Uma chave alternativa serve como um identificador exclusivo alternativo para cada instância de entidade, além da chave primária; ele pode ser usado como o alvo de um relacionamento. Quando se utiliza um banco de dados relacional, isto corresponde ao conceito de um índice/restrição exclusivo na(s) coluna(s) de chave alternativa e uma ou mais restrições de chave estrangeira que referenciam a(s) coluna(s).

As teclas alternativas são normalmente introduzidas quando necessário e não é necessário configurá-las manualmente. Por convenção, uma chave alternativa é introduzida quando você identifica uma propriedade que não é a chave primária como o destino de um relacionamento.

internal class MyContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }
    public DbSet<Post> Posts { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Post>()
            .HasOne(p => p.Blog)
            .WithMany(b => b.Posts)
            .HasForeignKey(p => p.BlogUrl)
            .HasPrincipalKey(b => b.Url);
    }
}

public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }

    public List<Post> Posts { get; set; }
}

public class Post
{
    public int PostId { get; set; }
    public string Title { get; set; }
    public string Content { get; set; }

    public string BlogUrl { get; set; }
    public Blog Blog { get; set; }
}

Você também pode configurar uma única propriedade para ser uma chave alternativa:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Car>()
        .HasAlternateKey(c => c.LicensePlate);
}

Você também pode configurar várias propriedades para serem uma chave alternativa (conhecida como chave alternativa composta):

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Car>()
        .HasAlternateKey(c => new { c.State, c.LicensePlate });
}

Finalmente, por convenção, o índice e a restrição que são introduzidos para uma chave alternativa serão chamados de AK_<type name>_<property name> (no caso de chaves alternativas compostas, <property name> torna-se uma lista de nomes de propriedade separados por sublinhado). Você pode configurar o nome do índice da chave alternativa e a restrição exclusiva:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Car>()
        .HasAlternateKey(c => c.LicensePlate)
        .HasName("AlternateKey_LicensePlate");
}