Partilhar via


IConventionKey Interface

Definição

Representa uma chave primária ou alternativa em uma entidade.

public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IKey
public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey
type IConventionKey = interface
    interface IConventionAnnotatable
    interface IAnnotatable
    interface IKey
type IConventionKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable
Public Interface IConventionKey
Implements IConventionAnnotatable, IKey
Public Interface IConventionKey
Implements IConventionAnnotatable, IReadOnlyKey
Implementações

Comentários

Essa interface é usada durante a criação do modelo e permite que os metadados sejam modificados. Depois que o modelo é criado, IKey representa uma exibição somente leitura dos mesmos metadados.

Consulte Convenções de criação de modelo para obter mais informações e exemplos.

Propriedades

Builder

Obtém o construtor que pode ser usado para configurar essa chave.

DeclaringEntityType

Obtém o tipo de entidade em que a chave está definida. Isso pode ser diferente do tipo definido em quando a chave é definida como um tipo derivado em uma hierarquia de herança (uma vez que Properties as propriedades podem ser definidas em um tipo base).

IsInModel

Indica se esse objeto está em um modelo, ou seja, não foi removido de um.

(Herdado de IConventionAnnotatable)
Item[String]

Obtém o valor da anotação com o nome fornecido, retornando null se ela não existir.

(Herdado de IReadOnlyAnnotatable)
Properties

Obtém as propriedades que compõem a chave.

Métodos

AddAnnotation(String, Object, Boolean)

Adiciona uma anotação a esse objeto. Gerará se já existir uma anotação com o nome especificado.

(Herdado de IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)

Adiciona anotações a um objeto .

(Herdado de IConventionAnnotatable)
AddRuntimeAnnotation(String, Object)

Adiciona uma anotação de runtime a esse objeto. Gerará se já existir uma anotação com o nome especificado.

(Herdado de IAnnotatable)
AnnotationsToDebugString(Int32)

Obtém a cadeia de caracteres de depuração para todas as anotações declaradas no objeto .

(Herdado de IReadOnlyAnnotatable)
FindAnnotation(String)

Obtém a anotação com o nome fornecido, retornando null se ela não existir.

(Herdado de IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)

Obtém a anotação de runtime com o nome fornecido, retornando null se ela não existir.

(Herdado de IAnnotatable)
FindRuntimeAnnotationValue(String)

Obtém o valor da anotação de runtime com o nome fornecido, retornando null se ela não existir.

(Herdado de IAnnotatable)
GetAnnotation(String)

Obtém a anotação com o nome fornecido, lançando se ela não existir.

(Herdado de IReadOnlyAnnotatable)
GetAnnotations()

Obtém todas as anotações no objeto atual.

(Herdado de IReadOnlyAnnotatable)
GetConfigurationSource()

Retorna a fonte de configuração dessa chave.

GetKeyType()

Retorna o tipo da propriedade key para chaves simples ou uma matriz de objetos para chaves compostas.

(Herdado de IKey)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

Obtém o valor da anotação de runtime com o nome fornecido, adicionando-o se um não existir.

(Herdado de IAnnotatable)
GetPrincipalKeyValueFactory()

Obtém uma fábrica para valores de chave com base nos valores de chave obtidos de várias formas de dados de entidade.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

(Herdado de IKey)
GetPrincipalKeyValueFactory<TKey>()

Obtém uma fábrica para valores de chave com base nos valores de chave obtidos de várias formas de dados de entidade.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

(Herdado de IKey)
GetReferencingForeignKeys()

Obtém todas as chaves estrangeiras direcionadas a uma determinada chave primária ou alternativa.

GetRuntimeAnnotations()

Obtém todas as anotações de runtime no objeto atual.

(Herdado de IAnnotatable)
IsPrimaryKey()

Retorna um valor que indica se a chave é a chave primária.

(Herdado de IReadOnlyKey)
RemoveAnnotation(String)

Remove a anotação com o nome fornecido desse objeto.

(Herdado de IConventionAnnotatable)
RemoveRuntimeAnnotation(String)

Remove a anotação de runtime fornecida desse objeto.

(Herdado de IAnnotatable)
SetAnnotation(String, Object, Boolean)

Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se já existir uma anotação com o nome especificado.

(Herdado de IConventionAnnotatable)
SetOrRemoveAnnotation(String, Object, Boolean)

Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se já existir uma anotação com o nome especificado. Remove a anotação existente se null for fornecida.

(Herdado de IConventionAnnotatable)
SetRuntimeAnnotation(String, Object)

Define a anotação de runtime armazenada sob a chave fornecida. Substitui a anotação existente se já existir uma anotação com o nome especificado.

(Herdado de IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

Cria uma representação legível por humanos dos metadados especificados.

Aviso: não dependa do formato da cadeia de caracteres retornada. Ele foi projetado apenas para depuração e pode mudar arbitrariamente entre as versões.

(Herdado de IReadOnlyKey)

Métodos de Extensão

AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

Adiciona anotações a um objeto .

GetAnnotation(IConventionAnnotatable, String)

Obtém a anotação com o nome fornecido, lançando se ela não existir.

SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)

Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se já existir uma anotação com o nome especificado. Remove a anotação existente se null for fornecida.

GetReferencingForeignKeys(IConventionKey)

Obtém todas as chaves estrangeiras direcionadas a uma determinada chave primária ou alternativa.

AnnotationsToDebugString(IAnnotatable, Int32)

Obtém a cadeia de caracteres de depuração para todas as anotações declaradas no objeto .

GetAnnotation(IAnnotatable, String)

Obtém a anotação com o nome fornecido, lançando se ela não existir.

GetKeyType(IKey)

Retorna o tipo da propriedade key para chaves simples ou uma matriz de objetos para chaves compostas.

GetPrincipalKeyValueFactory<TKey>(IKey)

Obtém uma fábrica para valores de chave com base nos valores de chave de índice obtidos de várias formas de dados de entidade.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

GetReferencingForeignKeys(IKey)

Obtém todas as chaves estrangeiras direcionadas a uma determinada chave primária ou alternativa.

IsPrimaryKey(IKey)

Retorna um valor que indica se a chave é a chave primária.

ToDebugString(IKey, MetadataDebugStringOptions, Int32)

Cria uma representação legível por humanos dos metadados especificados.

Aviso: não dependa do formato da cadeia de caracteres retornada. Ele foi projetado apenas para depuração e pode mudar arbitrariamente entre as versões.

FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier)

Localiza o primeiro IConventionKey mapeado para a mesma restrição em um objeto semelhante a uma tabela compartilhada.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

FindSharedObjectRootKey(IKey, StoreObjectIdentifier)

Localiza o primeiro IConventionKey mapeado para a mesma restrição em um objeto semelhante a uma tabela compartilhada.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)

Localiza o primeiro IKey mapeado para a mesma restrição em um objeto semelhante a uma tabela compartilhada.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

GetDefaultName(IKey)

Retorna o nome de restrição de chave padrão que seria usado para essa chave.

GetDefaultName(IKey, StoreObjectIdentifier)

Retorna o nome de restrição de chave padrão que seria usado para essa chave para uma tabela específica.

GetDefaultName(IReadOnlyKey)

Retorna o nome de restrição de chave padrão que seria usado para essa chave.

GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)

Retorna o nome de restrição de chave padrão que seria usado para essa chave para uma tabela específica.

GetMappedConstraints(IKey)

Obtém as restrições exclusivas para as quais a chave é mapeada.

GetName(IKey)

Retorna o nome da restrição de chave para essa chave.

GetName(IKey, StoreObjectIdentifier)

Retorna o nome da restrição de chave para essa chave para uma tabela específica.

GetName(IReadOnlyKey)

Retorna o nome da restrição de chave para essa chave.

GetName(IReadOnlyKey, StoreObjectIdentifier)

Retorna o nome da restrição de chave para essa chave para uma tabela específica.

GetNameConfigurationSource(IConventionKey)

Obtém o ConfigurationSource para o nome da restrição.

SetName(IConventionKey, String, Boolean)

Define o nome da restrição de chave para essa chave.

GetIsClusteredConfigurationSource(IConventionKey)

Obtém o ConfigurationSource para saber se a chave está clusterizado.

IsClustered(IKey)

Retorna um valor que indica se a chave está agrupada.

IsClustered(IKey, StoreObjectIdentifier)

Retorna um valor que indica se a chave está agrupada.

IsClustered(IReadOnlyKey)

Retorna um valor que indica se a chave está agrupada.

IsClustered(IReadOnlyKey, StoreObjectIdentifier)

Retorna um valor que indica se a chave está agrupada.

SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)

Define um valor que indica se a chave está agrupada.

Aplica-se a