IKey Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Représente une clé primaire ou secondaire sur un type d’entité.

public interface IKey : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey

type IKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Interface IKey
Implements IAnnotatable, IReadOnlyKey

Dérivé

Microsoft.EntityFrameworkCore.Metadata.RuntimeKey

Implémente

IAnnotatable IReadOnlyAnnotatable IReadOnlyKey

Remarques

Pour plus d’informations et d’exemples, consultez Modélisation des types d’entités et des relations .

Propriétés

DeclaringEntityType	Obtient le type d’entité sur lequel la clé est définie. Cela peut être différent du type défini Properties sur lorsque la clé est définie comme type dérivé dans une hiérarchie d’héritage (car les propriétés peuvent être définies sur un type de base).
Item[String]	Obtient la valeur de l’annotation portant le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
Properties	Obtient les propriétés qui composent la clé.

Méthodes

AddRuntimeAnnotation(String, Object)	Ajoute une annotation d’exécution à cet objet. Lève si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable)
AnnotationsToDebugString(Int32)	Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet . (Hérité de IReadOnlyAnnotatable)
FindAnnotation(String)	Obtient l’annotation avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)	Obtient l’annotation d’exécution avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IAnnotatable)
FindRuntimeAnnotationValue(String)	Obtient la valeur de l’annotation runtime avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IAnnotatable)
GetAnnotation(String)	Obtient l’annotation portant le nom donné, en lisant si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
GetAnnotations()	Obtient toutes les annotations sur l’objet actuel. (Hérité de IReadOnlyAnnotatable)
GetKeyType()	Retourne le type de la propriété key pour les clés simples, ou un tableau d’objets pour les clés composites.
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Obtient la valeur de l’annotation runtime avec le nom donné, en l’ajoutant si elle n’existe pas. (Hérité de IAnnotatable)
GetPrincipalKeyValueFactory()	Obtient une fabrique pour les valeurs de clé basées sur les valeurs de clé extraites de différentes formes de données d’entité. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetPrincipalKeyValueFactory<TKey>()	Obtient une fabrique pour les valeurs de clé basées sur les valeurs de clé extraites de différentes formes de données d’entité. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetReferencingForeignKeys()	Obtient toutes les clés étrangères qui ciblent une clé primaire ou secondaire donnée.
GetRuntimeAnnotations()	Obtient toutes les annotations d’exécution sur l’objet actuel. (Hérité de IAnnotatable)
IsPrimaryKey()	Retourne une valeur indiquant si la clé est la clé primaire. (Hérité de IReadOnlyKey)
RemoveRuntimeAnnotation(String)	Supprime l’annotation d’exécution donnée de cet objet. (Hérité de IAnnotatable)
SetRuntimeAnnotation(String, Object)	Définit l’annotation d’exécution stockée sous la clé donnée. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Crée une représentation lisible des métadonnées données. Avertissement : ne vous fiez pas au format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement entre les versions. (Hérité de IReadOnlyKey)

Méthodes d’extension

FindSharedObjectRootKey(IKey, StoreObjectIdentifier)	Recherche la première IConventionKey qui est mappée à la même contrainte dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	Recherche la première IKey qui est mappée à la même contrainte dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetDefaultName(IReadOnlyKey)	Retourne le nom de la contrainte de clé par défaut qui serait utilisé pour cette clé.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	Retourne le nom de contrainte de clé par défaut qui serait utilisé pour cette clé pour une table particulière.
GetMappedConstraints(IKey)	Obtient les contraintes uniques auxquelles la clé est mappée.
GetName(IReadOnlyKey)	Retourne le nom de la contrainte de clé pour cette clé.
GetName(IReadOnlyKey, StoreObjectIdentifier)	Retourne le nom de la contrainte de clé pour cette clé pour une table particulière.
GetFluentApiCalls(IKey, IAnnotationCodeGenerator)	Obtient les appels d’API Fluent pour configurer une clé.
IsHandledByConvention(IKey)	Obtient une valeur indiquant si la clé est configurée par des conventions.
IsClustered(IReadOnlyKey)	Retourne une valeur indiquant si la clé est en cluster.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	Retourne une valeur indiquant si la clé est en cluster.