IForeignKey Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Représente une relation où une clé étrangère composée de propriétés sur le type d’entité dépendant fait référence à une clé primaire ou alternative correspondante sur le type d’entité principal.

public interface IForeignKey : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyForeignKey

type IForeignKey = interface
    interface IReadOnlyForeignKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Interface IForeignKey
Implements IAnnotatable, IReadOnlyForeignKey

Dérivé

Microsoft.EntityFrameworkCore.Metadata.RuntimeForeignKey

Implémente

IAnnotatable IReadOnlyAnnotatable IReadOnlyForeignKey

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é dépendant. Cela peut être différent du type défini Properties sur lorsque la relation est définie comme un type dérivé dans une hiérarchie d’héritage (car les propriétés peuvent être définies sur un type de base).
DependentToPrincipal	Obtient la propriété de navigation sur le type d’entité dépendant qui pointe vers l’entité principale.
Item[String]	Obtient la valeur de l’annotation avec 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 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é primaire ou alternative 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

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)
GetDependentKeyValueFactory()	Crée une fabrique pour les valeurs de clé basées sur les valeurs de clé étrangère 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.
GetDependentKeyValueFactory<TKey>()	Crée une fabrique pour les valeurs de clé basées sur les valeurs de clé étrangère 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.
GetNavigation(Boolean)	Retourne une navigation associée à cette clé étrangère.
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)
GetReferencingSkipNavigations()	Obtient toutes les navigations d’ignorer à l’aide de cette clé étrangère.
GetRelatedEntityType(IReadOnlyEntityType)	Obtient le type d’entité lié au donné.
GetRuntimeAnnotations()	Obtient toutes les annotations d’exécution sur l’objet actif. (Hérité de IAnnotatable)
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)
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 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 IReadOnlyForeignKey)

Méthodes d’extension

FindSharedObjectRootForeignKey(IForeignKey, 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 d’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 d’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.
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.
GetMappedConstraints(IForeignKey)	Obtient les contraintes de clé étrangère auxquelles la clé étrangère est mappée.
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.
GetFluentApiCalls(IForeignKey, IAnnotationCodeGenerator, Boolean)	Obtient les appels d’API Fluent pour configurer une clé étrangère.