IConventionKey Interface

Référence

Définition

Espace de noms:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.dll

Paquet:: Microsoft.EntityFrameworkCore v3.0.0

Paquet:: Microsoft.EntityFrameworkCore v3.1.0

Paquet:: Microsoft.EntityFrameworkCore v5.0.0

Paquet:: Microsoft.EntityFrameworkCore v6.0.0

Paquet:: Microsoft.EntityFrameworkCore v7.0.0

Paquet:: Microsoft.EntityFrameworkCore v8.0.0

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Représente une clé primaire ou secondaire sur une entité.

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

Implémente: IAnnotatable IConventionAnnotatable IKey IReadOnlyAnnotatable IReadOnlyKey

Remarques

Cette interface est utilisée lors de la création du modèle et permet de modifier les métadonnées. Une fois le modèle généré, IKey représente une vue en lecture seule des mêmes métadonnées.

Pour plus d’informations et d’exemples, consultez Conventions de génération de modèles.

Propriétés

Builder	Obtient le générateur qui peut être utilisé pour configurer cette clé.
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).
IsInModel	Indique si cet objet se trouve dans un modèle, c’est-à-dire s’il n’en a pas été supprimé. (Hérité de IConventionAnnotatable)
Item[String]	Obtient la valeur de l’annotation avec 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

AddAnnotation(String, Object, Boolean)	Ajoute une annotation à cet objet. Lève si une annotation portant le nom spécifié existe déjà. (Hérité de IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Ajoute des annotations à un objet. (Hérité de IConventionAnnotatable)
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é, retournée `null` si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)	Obtient l’annotation du runtime 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 avec le nom donné, en lisant si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
GetAnnotations()	Obtient toutes les annotations sur l’objet actif. (Hérité de IReadOnlyAnnotatable)
GetConfigurationSource()	Retourne la source de configuration pour cette clé.
GetKeyType()	Retourne le type de la propriété key pour les clés simples ou un tableau d’objets pour les clés composites. (Hérité de IKey)
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’en existe pas. (Hérité de IAnnotatable)
GetPrincipalKeyValueFactory()	Obtient une fabrique pour les valeurs de clé en fonction des valeurs de clé prises à partir 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 d’application. (Hérité de IKey)
GetPrincipalKeyValueFactory<TKey>()	Obtient une fabrique pour les valeurs de clé en fonction des valeurs de clé prises à partir 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 d’application. (Hérité de IKey)
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 actif. (Hérité de IAnnotatable)
IsPrimaryKey()	Retourne une valeur indiquant si la clé est la clé primaire. (Hérité de IReadOnlyKey)
RemoveAnnotation(String)	Supprime l’annotation portant le nom donné de cet objet. (Hérité de IConventionAnnotatable)
RemoveRuntimeAnnotation(String)	Supprime l’annotation d’exécution donnée de cet objet. (Hérité de IAnnotatable)
SetAnnotation(String, Object, Boolean)	Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. (Hérité de IConventionAnnotatable)
SetOrRemoveAnnotation(String, Object, Boolean)	Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. Supprime l’annotation existante si `null` est fournie. (Hérité de IConventionAnnotatable)
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 par l’homme des métadonnées données. Avertissement : ne vous appuyez pas sur le format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement d’une version à l’autre. (Hérité de IReadOnlyKey)

Méthodes d’extension

AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)	Ajoute des annotations à un objet.
GetAnnotation(IConventionAnnotatable, String)	Obtient l’annotation avec le nom donné, en lisant si elle n’existe pas.
SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)	Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. Supprime l’annotation existante si `null` est fournie.
GetReferencingForeignKeys(IConventionKey)	Obtient toutes les clés étrangères qui ciblent une clé primaire ou secondaire donnée.
AnnotationsToDebugString(IAnnotatable, Int32)	Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet.
GetAnnotation(IAnnotatable, String)	Obtient l’annotation avec le nom donné, en lisant si elle n’existe pas.
GetKeyType(IKey)	Retourne le type de la propriété key pour les clés simples ou un tableau d’objets pour les clés composites.
GetPrincipalKeyValueFactory<TKey>(IKey)	Obtient une fabrique pour les valeurs de clé en fonction des valeurs de clé d’index prises à partir 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 d’application.
GetReferencingForeignKeys(IKey)	Obtient toutes les clés étrangères qui ciblent une clé primaire ou secondaire donnée.
IsPrimaryKey(IKey)	Retourne une valeur indiquant si la clé est la clé primaire.
ToDebugString(IKey, MetadataDebugStringOptions, Int32)	Crée une représentation lisible par l’homme des métadonnées données. Avertissement : ne vous appuyez pas sur le format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement d’une version à l’autre.
FindSharedObjectRootKey(IConventionKey, 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 d’application.
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 d’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 d’application.
GetDefaultName(IKey)	Retourne le nom de contrainte de clé par défaut qui serait utilisé pour cette clé.
GetDefaultName(IKey, StoreObjectIdentifier)	Retourne le nom de contrainte de clé par défaut qui serait utilisé pour cette clé pour une table particulière.
GetDefaultName(IReadOnlyKey)	Retourne le nom de 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(IKey)	Retourne le nom de la contrainte de clé pour cette clé.
GetName(IKey, StoreObjectIdentifier)	Retourne le nom de la contrainte de clé pour cette clé pour une table particulière.
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.
GetNameConfigurationSource(IConventionKey)	Obtient le ConfigurationSource pour le nom de la contrainte.
SetName(IConventionKey, String, Boolean)	Définit le nom de la contrainte de clé pour cette clé.
GetIsClusteredConfigurationSource(IConventionKey)	Obtient le ConfigurationSource indiquant si la clé est en cluster.
IsClustered(IKey)	Retourne une valeur indiquant si la clé est en cluster.
IsClustered(IKey, StoreObjectIdentifier)	Retourne une valeur indiquant si la clé est en cluster.
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.
SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)	Définit une valeur indiquant si la clé est en cluster.

S’applique à