IConventionForeignKey Interface

Définition

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.

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 créé, IForeignKey représente une vue en lecture seule des mêmes métadonnées.

public interface IConventionForeignKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IForeignKey
type IConventionForeignKey = interface
    interface IForeignKey
    interface IAnnotatable
    interface IConventionAnnotatable
Public Interface IConventionForeignKey
Implements IConventionAnnotatable, IForeignKey
Implémente

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 Properties défini sur lorsque la relation est définie sur un type dérivé dans une hiérarchie d’héritage (puisque 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 dans la relation lorsque le principal est supprimé ou lorsque la relation est rompue.

(Hérité de IForeignKey)
DependentToPrincipal

Obtient la propriété de navigation sur le type d’entité dépendant qui pointe vers l’entité principale.

IsOwnership

Obtient ou définit une valeur indiquant si cette relation définit une propriété. Si true la, l’entité dépendante doit toujours être accessible via la navigation à partir de l’entité principale.

(Hérité de IForeignKey)
IsRequired

Obtient une valeur indiquant si l’entité principale est requise. Si true la valeur est, l’entité dépendante doit toujours être assignée à une entité principale valide.

(Hérité de IForeignKey)
IsRequiredDependent

Obtient une valeur indiquant si l’entité dépendante est requise. Si true la, l’entité principale doit toujours avoir une entité dépendante valide affectée.

(Hérité de IForeignKey)
IsUnique

Obtient une valeur indiquant si les valeurs assignées aux propriétés de clé étrangère sont uniques.

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

Obtient l’annotation de valeur portant le nom donné, en retournant null si elle n’existe pas.

(Hérité de IAnnotatable)
PrincipalEntityType

Obtient le type d’entité principal que cette relation cible. Cela peut être différent du type PrincipalKey défini sur lorsque la relation cible un type dérivé dans une hiérarchie d’héritage (puisque la clé est définie sur le type de base de la hiérarchie).

PrincipalKey

Obtient la clé principale ou secondaire que la relation cible.

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 une exception si une annotation portant le nom spécifié existe déjà.

(Hérité de IConventionAnnotatable)
FindAnnotation(String)

Obtient l’annotation portant le nom donné, en retournant null si elle n’existe pas.

(Hérité de IConventionAnnotatable)
GetAnnotations()

Obtient toutes les annotations sur l’objet actuel.

(Hérité de IConventionAnnotatable)
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 .

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.

HasDependentToPrincipal(MemberInfo, Boolean)
Obsolète.

Définit la propriété de navigation sur le type d’entité dépendant qui pointe vers l’entité principale.

HasDependentToPrincipal(String, Boolean)
Obsolète.

Définit la propriété de navigation sur le type d’entité dépendant qui pointe vers l’entité principale.

HasPrincipalToDependent(MemberInfo, Boolean)
Obsolète.

Définit la propriété de navigation sur le type d’entité principal qui pointe vers l’entité dépendante.

HasPrincipalToDependent(String, Boolean)
Obsolète.

Définit la propriété de navigation sur le type d’entité principal qui pointe vers l’entité dépendante.

RemoveAnnotation(String)

Supprime l’annotation portant le nom donné à partir 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 dans la relation lorsque le principal est supprimé ou lorsque la relation est rompue.

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 true la, 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 true la valeur est, l’entité dépendante doit toujours être assignée à une entité principale valide.

SetIsRequiredDependent(Nullable<Boolean>, Boolean)

Définit une valeur indiquant si l’entité dépendante est requise. Si true la, 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.

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 la clé principale cible.

Méthodes d’extension

AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

Ajoute des annotations à un objet.

GetAnnotation(IConventionAnnotatable, String)

Obtient l’annotation portant le nom donné, en levant 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 fourni.

GetNavigation(IConventionForeignKey, Boolean)

Retourne une navigation associée à cette clé étrangère.

GetRelatedEntityType(IConventionForeignKey, IConventionEntityType)

Obtient le type d’entité associé au donné.

GetDependentKeyValueFactory<TKey>(IForeignKey)

Crée une fabrique pour les valeurs de clés en fonction des valeurs de clé étrangère 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 de l’application.

GetNavigation(IForeignKey, Boolean)

Retourne une navigation associée à cette clé étrangère.

GetRelatedEntityType(IForeignKey, IEntityType)

Obtient le type d’entité associé au donné.

IsBaseLinking(IForeignKey)

Retourne une valeur indiquant si la clé étrangère est définie sur la clé primaire et qu’elle pointe vers la même clé primaire.

ToDebugString(IForeignKey, MetadataDebugStringOptions, Int32)

Crée une représentation explicite des métadonnées données.

AVERTISSEMENT : ne comptez 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.

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 portant le nom donné, en levant si elle n’existe pas.

FindSharedObjectRootForeignKey(IConventionForeignKey, StoreObjectIdentifier)

Recherche le premier IConventionForeignKey qui est 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 de l’application.

FindSharedObjectRootForeignKey(IForeignKey, StoreObjectIdentifier)

Recherche le premier IForeignKey qui est 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 de l’application.

GetConstraintName(IForeignKey)

Retourne le nom de la contrainte de clé étrangère.

GetConstraintName(IForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

Retourne le nom de la contrainte de clé étrangère.

GetConstraintNameConfigurationSource(IConventionForeignKey)

Obtient le ConfigurationSource pour le nom de la contrainte.

GetDefaultName(IForeignKey)

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

GetDefaultName(IForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

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

GetMappedConstraints(IForeignKey)

Obtient les contraintes de clé étrangère auxquelles la clé étrangère est mappée.

SetConstraintName(IConventionForeignKey, String, Boolean)

Définit le nom de la contrainte de clé étrangère.

S’applique à