IForeignKey 接口

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

包:

Microsoft.EntityFrameworkCore v8.0.0

表示一种关系，其中由依赖实体类型上的属性组成的外键引用主体实体类型上的相应主键或备用键。

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

派生

Microsoft.EntityFrameworkCore.Metadata.RuntimeForeignKey

实现

IAnnotatable IReadOnlyAnnotatable IReadOnlyForeignKey

注解

有关详细信息和示例，请参阅 为实体类型和关系建模 。

属性

DeclaringEntityType	获取依赖实体类型。 这可能不同于在继承层次结构中定义关系派生类型时定义的类型 Properties (，因为属性可以在基类型上定义) 。
DependentToPrincipal	获取指向主体实体的依赖实体类型上的导航属性。
Item[String]	获取具有给定名称的批注的值，如果不存在，则返回 null 该值。 (继承自 IReadOnlyAnnotatable)
PrincipalEntityType	获取此关系面向的主体实体类型。 这可能不同于关系以继承层次结构 (派生类型为目标时定义的类型 PrincipalKey ，因为键是在层次结构) 基类型上定义的。
PrincipalKey	获取关系面向的主键或备用键。
PrincipalToDependent	获取指向依赖实体的主体实体类型上的导航属性。
Properties	获取依赖实体中的外键属性。

方法

AddRuntimeAnnotation(String, Object)	向此对象添加运行时注释。 如果已存在具有指定名称的批注，则引发 。 (继承自 IAnnotatable)
AnnotationsToDebugString(Int32)	获取对象上声明的所有注释的调试字符串。 (继承自 IReadOnlyAnnotatable)
FindAnnotation(String)	获取具有给定名称的批注，如果不存在，则返回 null 。 (继承自 IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)	获取具有给定名称的运行时注释，如果不存在，则返回 null 。 (继承自 IAnnotatable)
FindRuntimeAnnotationValue(String)	获取具有给定名称的运行时注释的值，如果不存在，则 null 返回该值。 (继承自 IAnnotatable)
GetAnnotation(String)	获取具有给定名称的批注，如果不存在，则引发该批注。 (继承自 IReadOnlyAnnotatable)
GetAnnotations()	获取当前对象上的所有批注。 (继承自 IReadOnlyAnnotatable)
GetDependentKeyValueFactory()	基于从各种形式的实体数据中获取的外键值为键值创建工厂。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetDependentKeyValueFactory<TKey>()	基于从各种形式的实体数据中获取的外键值为键值创建工厂。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetNavigation(Boolean)	返回与此外键关联的导航。
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	获取具有给定名称的运行时注释的值，如果不存在，请添加该值。 (继承自 IAnnotatable)
GetReferencingSkipNavigations()	使用此外键获取所有跳过导航。
GetRelatedEntityType(IReadOnlyEntityType)	获取与给定实体类型相关的实体类型。
GetRuntimeAnnotations()	获取当前 对象上的所有运行时注释。 (继承自 IAnnotatable)
IsBaseLinking()	返回一个值，该值指示外键是否在主键上定义并指向同一主键。 (继承自 IReadOnlyForeignKey)
RemoveRuntimeAnnotation(String)	从此对象中删除给定的运行时注释。 (继承自 IAnnotatable)
SetRuntimeAnnotation(String, Object)	设置存储在给定键下的运行时注释。 如果具有指定名称的注释已存在，则覆盖现有批注。 (继承自 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	创建给定元数据的可读表示形式。 警告：不要依赖于返回的字符串的格式。 它仅用于调试，可能会在发布之间任意更改。 (继承自 IReadOnlyForeignKey)

扩展方法

FindSharedObjectRootForeignKey(IForeignKey, StoreObjectIdentifier)	查找映射到类似共享表的 对象中的同一约束的第 IConventionForeignKey 一个 。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
FindSharedObjectRootForeignKey(IReadOnlyForeignKey, StoreObjectIdentifier)	查找映射到类似共享表的 对象中的同一约束的第 IForeignKey 一个 。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetConstraintName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	返回外键约束名称。
GetConstraintName(IReadOnlyForeignKey)	返回外键约束名称。
GetDefaultName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	返回将用于此外键的默认约束名称。
GetDefaultName(IReadOnlyForeignKey)	返回将用于此外键的默认约束名称。
GetMappedConstraints(IForeignKey)	获取外键映射到的外键约束。
IsRowInternal(IReadOnlyForeignKey, StoreObjectIdentifier)	返回一个值，该值指示此外键是否在共享同一表类似存储对象的两个实体类型之间。
GetFluentApiCalls(IForeignKey, IAnnotationCodeGenerator, Boolean)	获取用于配置外键的 fluent API 调用。