Langue

IConventionKey Interface

Définition

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

public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey
public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IKey
type IConventionKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable
type IConventionKey = interface
    interface IConventionAnnotatable
    interface IAnnotatable
    interface IKey
Public Interface IConventionKey
Implements IConventionAnnotatable, IReadOnlyKey
Public Interface IConventionKey
Implements IConventionAnnotatable, IKey
Implémente

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 les conventions de génération de modèles.

Propriétés

Nom Description
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 Properties défini lorsque la clé est définie comme type dérivé dans une hiérarchie d’héritage (dans la mesure où 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 qu’il n’a pas été supprimé d’un modèle.

(Hérité de IConventionAnnotatable)
Item[String]

Obtient l’annotation de valeur avec le nom donné, en retournant null s’il n’existe pas.

(Hérité de IAnnotatable)
Properties

Obtient les propriétés qui composent la clé.

Méthodes

Nom Description
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 runtime à 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 portant le nom donné, en retournant null s’il n’existe pas.

(Hérité de IAnnotatable)
FindRuntimeAnnotation(String)

Obtient l’annotation runtime avec le nom donné, en retournant null s’il n’existe pas.

(Hérité de IAnnotatable)
FindRuntimeAnnotationValue(String)

Obtient la valeur de l’annotation runtime avec le nom donné, en retournant null s’il n’existe pas.

(Hérité de IAnnotatable)
GetAnnotation(String)

Obtient l’annotation portant le nom donné, levée s’il n’existe pas.

(Hérité de IConventionAnnotatable)
GetAnnotations()

Obtient toutes les annotations sur l’objet actuel.

(Hérité de IAnnotatable)
GetConfigurationSource()

Retourne la source de configuration de cette clé.

GetKeyType()

Retourne le type de la propriété de clé 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’existe pas.

(Hérité de IAnnotatable)
GetPrincipalKeyValueFactory()

Obtient une fabrique pour les valeurs de clé en fonction des valeurs de clé issues 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é issues 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 alternative donnée.

GetRuntimeAnnotations()

Obtient toutes les annotations runtime sur l’objet actuel.

(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 runtime 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 elle est fournie.

(Hérité de IConventionAnnotatable)
SetRuntimeAnnotation(String, Object)

Définit l’annotation runtime 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 entre les versions.

(Hérité de IReadOnlyKey)

Méthodes d’extension

Nom Description
AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

Ajoute des annotations à un objet.

AnnotationsToDebugString(IAnnotatable, Int32)

Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet.

FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier)

Recherche le premier IConventionKey mappé à 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 le premier IConventionKey mappé à 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 le premier IKey mappé à 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.

GetAnnotation(IAnnotatable, String)

Obtient l’annotation portant le nom donné, levée s’il n’existe pas.

GetAnnotation(IConventionAnnotatable, String)

Obtient l’annotation portant le nom donné, levée s’il n’existe pas.

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(IKey)

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.

GetDefaultName(IReadOnlyKey)

Retourne le nom de contrainte de clé par défaut qui serait utilisé pour cette clé.

GetFillFactor(IReadOnlyKey, StoreObjectIdentifier)

Retourne le facteur de remplissage que la clé utilise.

GetFillFactor(IReadOnlyKey)

Retourne le facteur de remplissage que la clé utilise.

GetFillFactorConfigurationSource(IConventionKey)

Retourne si ConfigurationSource la clé utilise le facteur de remplissage.

GetIsClusteredConfigurationSource(IConventionKey)

Obtient la ConfigurationSource valeur pour déterminer si la clé est en cluster.

GetKeyType(IKey)

Retourne le type de la propriété de clé pour les clés simples ou un tableau d’objets pour les clés composites.

GetMappedConstraints(IKey)

Obtient les contraintes uniques auxquelles la clé est mappée.

GetName(IKey, StoreObjectIdentifier)

Retourne le nom de la contrainte de clé pour cette clé pour une table particulière.

GetName(IKey)

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.

GetName(IReadOnlyKey)

Retourne le nom de la contrainte de clé pour cette clé.

GetNameConfigurationSource(IConventionKey)

Obtient le ConfigurationSource nom de la contrainte.

GetPrincipalKeyValueFactory<TKey>(IKey)

Obtient une fabrique pour les valeurs de clé en fonction des valeurs de clé d’index 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 d’application.

GetReferencingForeignKeys(IConventionKey)

Obtient toutes les clés étrangères qui ciblent une clé primaire ou alternative donnée.

GetReferencingForeignKeys(IKey)

Obtient toutes les clés étrangères qui ciblent une clé primaire ou alternative donnée.

IsClustered(IKey, StoreObjectIdentifier)

Retourne une valeur indiquant si la clé est en cluster.

IsClustered(IKey)

Retourne une valeur indiquant si la clé est en cluster.

IsClustered(IReadOnlyKey, StoreObjectIdentifier)

Retourne une valeur indiquant si la clé est en cluster.

IsClustered(IReadOnlyKey)

Retourne une valeur indiquant si la clé est en cluster.

IsPrimaryKey(IKey)

Retourne une valeur indiquant si la clé est la clé primaire.

SetFillFactor(IConventionKey, Nullable<Int32>, Boolean)

Définit une valeur pour le facteur de remplissage que la clé utilise.

SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)

Définit une valeur indiquant si la clé est en cluster.

SetName(IConventionKey, String, Boolean)

Définit le nom de la contrainte de clé pour cette clé.

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 elle est fournie.

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 entre les versions.

S’applique à