IConventionForeignKey Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Représente une relation dans laquelle une ou plusieurs propriétés de clé étrangère dans un type d’entité dépendant référencent une clé primaire ou secondaire correspondante dans un type d’entité principal.

public interface IConventionForeignKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyForeignKey

type IConventionForeignKey = interface
    interface IReadOnlyForeignKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionForeignKey
Implements IConventionAnnotatable, IReadOnlyForeignKey

Implémente

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyForeignKey

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é, IForeignKey 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é étrangère.
DeclaringEntityType	Obtient le type d’entité dépendante. Cela peut être différent du type défini Properties sur lorsque la relation 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).
DeleteBehavior	Obtient une valeur indiquant comment une opération de suppression est appliquée aux entités dépendantes de la relation lorsque le principal est supprimé ou que la relation est coupée. (Hérité de IReadOnlyForeignKey)
DependentToPrincipal	Obtient la propriété de navigation sur le type d’entité dépendant qui pointe vers l’entité principale.
IsInModel	Indique si cet objet se trouve dans un modèle, c’est-à-dire s’il n’a pas été supprimé d’un modèle. (Hérité de IConventionAnnotatable)
IsOwnership	Obtient une valeur indiquant si cette relation définit une propriété. Si la valeur est true, l’entité dépendante doit toujours être accessible via la navigation à partir de l’entité principale. (Hérité de IReadOnlyForeignKey)
IsRequired	Obtient une valeur indiquant si l’entité principale est requise. Si la valeur est true, l’entité dépendante doit toujours être affectée à une entité de principal valide. (Hérité de IReadOnlyForeignKey)
IsRequiredDependent	Obtient une valeur indiquant si l’entité dépendante est requise. Si la valeur est true, l’entité principale doit toujours avoir une entité dépendante valide affectée. (Hérité de IReadOnlyForeignKey)
IsUnique	Obtient une valeur indiquant si les valeurs affectées aux propriétés de clé étrangère sont uniques. (Hérité de IReadOnlyForeignKey)
Item[String]	Obtient la valeur de l’annotation portant le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
PrincipalEntityType	Obtient le type d’entité principal que cette relation cible. Cela peut être différent du type défini sur lorsque la relation cible un type dérivé dans une hiérarchie d’héritage (étant donné que PrincipalKey la clé est définie sur le type de base de la hiérarchie).
PrincipalKey	Obtient la clé primaire ou secondaire ciblée par la relation.
PrincipalToDependent	Obtient la propriété de navigation sur le type d’entité principal qui pointe vers l’entité dépendante.
Properties	Obtient les propriétés de clé étrangère dans l’entité dépendante.

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)
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)
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)
GetConfigurationSource()	Retourne la source de configuration pour cette propriété.
GetDeleteBehaviorConfigurationSource()	Retourne la source de configuration pour DeleteBehavior.
GetDependentToPrincipalConfigurationSource()	Retourne la source de configuration pour DependentToPrincipal.
GetIsOwnershipConfigurationSource()	Retourne la source de configuration pour IsOwnership.
GetIsRequiredConfigurationSource()	Retourne la source de configuration pour IsRequired.
GetIsRequiredDependentConfigurationSource()	Retourne la source de configuration pour IsRequiredDependent.
GetIsUniqueConfigurationSource()	Retourne la source de configuration pour IsUnique.
GetNavigation(Boolean)	Retourne une navigation associée à cette clé étrangère.
GetPrincipalEndConfigurationSource()	Retourne la source de configuration pour PrincipalEntityType.
GetPrincipalKeyConfigurationSource()	Retourne la source de configuration pour PrincipalKey.
GetPrincipalToDependentConfigurationSource()	Retourne la source de configuration pour PrincipalToDependent.
GetPropertiesConfigurationSource()	Retourne la source de configuration pour Properties.
GetReferencingSkipNavigations()	Obtient toutes les navigations ignorées à l’aide de cette clé étrangère.
GetRelatedEntityType(IReadOnlyEntityType)	Obtient le type d’entité associé au donné.
IsBaseLinking()	Retourne une valeur indiquant si la clé étrangère est définie sur la clé primaire et pointe vers la même clé primaire. (Hérité de IReadOnlyForeignKey)
RemoveAnnotation(String)	Supprime l’annotation portant le nom donné de cet objet. (Hérité de IConventionAnnotatable)
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)
SetDeleteBehavior(Nullable<DeleteBehavior>, Boolean)	Définit une valeur indiquant comment une opération de suppression est appliquée aux entités dépendantes de la relation lorsque le principal est supprimé ou que la relation est coupée.
SetDependentToPrincipal(MemberInfo, Boolean)	Définit la propriété de navigation sur le type d’entité dépendant qui pointe vers l’entité principale.
SetDependentToPrincipal(String, Boolean)	Définit la propriété de navigation sur le type d’entité dépendant qui pointe vers l’entité principale.
SetIsOwnership(Nullable<Boolean>, Boolean)	Définit une valeur indiquant si cette relation définit une propriété. Si la valeur est true, l’entité dépendante doit toujours être accessible via la navigation à partir de l’entité principale.
SetIsRequired(Nullable<Boolean>, Boolean)	Définit une valeur indiquant si l’entité principale est requise. Si la valeur est true, l’entité dépendante doit toujours être affectée à une entité de principal valide.
SetIsRequiredDependent(Nullable<Boolean>, Boolean)	Définit une valeur indiquant si l’entité dépendante est requise. Si la valeur est true, l’entité principale doit toujours avoir une entité dépendante valide affectée.
SetIsUnique(Nullable<Boolean>, Boolean)	Définit une valeur indiquant si les valeurs affectées aux propriétés de clé étrangère sont uniques.
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)
SetPrincipalToDependent(MemberInfo, Boolean)	Définit la propriété de navigation sur le type d’entité principal qui pointe vers l’entité dépendante.
SetPrincipalToDependent(String, Boolean)	Définit la propriété de navigation sur le type d’entité principal qui pointe vers l’entité dépendante.
SetProperties(IReadOnlyList<IConventionProperty>, IConventionKey, Boolean)	Définit les propriétés de clé étrangère et cette clé principale cible.
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 IReadOnlyForeignKey)

Méthodes d’extension

FindSharedObjectRootForeignKey(IConventionForeignKey, StoreObjectIdentifier)	Recherche la première IConventionForeignKey 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.
FindSharedObjectRootForeignKey(IReadOnlyForeignKey, StoreObjectIdentifier)	Recherche la première IForeignKey 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.
GetConstraintName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	Retourne le nom de la contrainte de clé étrangère.
GetConstraintName(IReadOnlyForeignKey)	Retourne le nom de la contrainte de clé étrangère.
GetConstraintNameConfigurationSource(IConventionForeignKey)	Obtient le ConfigurationSource pour le nom de la contrainte.
GetDefaultName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	Retourne le nom de contrainte par défaut qui serait utilisé pour cette clé étrangère.
GetDefaultName(IReadOnlyForeignKey)	Retourne le nom de contrainte par défaut qui serait utilisé pour cette clé étrangère.
IsRowInternal(IReadOnlyForeignKey, StoreObjectIdentifier)	Retourne une valeur indiquant si cette clé étrangère se trouve entre deux types d’entités partageant le même objet de magasin de type table.
SetConstraintName(IConventionForeignKey, String, Boolean)	Définit le nom de la contrainte de clé étrangère.