IKey 接口

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

包:

Microsoft.EntityFrameworkCore v8.0.0

表示实体类型上的主键或备用键。

public interface IKey : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey

type IKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Interface IKey
Implements IAnnotatable, IReadOnlyKey

派生

Microsoft.EntityFrameworkCore.Metadata.RuntimeKey

实现

IAnnotatable IReadOnlyAnnotatable IReadOnlyKey

注解

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

属性

DeclaringEntityType	获取定义密钥的实体类型。 这可能不同于在继承层次结构中定义密钥派生类型时定义的类型 Properties (，因为属性可以在基类型上定义) 。
Item[String]	获取具有给定名称的批注的值，如果不存在，则返回 null 该值。 (继承自 IReadOnlyAnnotatable)
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)
GetKeyType()	返回简单键的键属性的类型，或复合键的对象数组。
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	获取具有给定名称的运行时注释的值，如果不存在，请添加该值。 (继承自 IAnnotatable)
GetPrincipalKeyValueFactory()	根据从各种形式的实体数据中提取的键值获取键值的工厂。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetPrincipalKeyValueFactory<TKey>()	根据从各种形式的实体数据中提取的键值获取键值的工厂。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetReferencingForeignKeys()	获取面向给定主键或备用键的所有外键。
GetRuntimeAnnotations()	获取当前 对象上的所有运行时注释。 (继承自 IAnnotatable)
IsPrimaryKey()	返回一个值，该值指示键是否为主键。 (继承自 IReadOnlyKey)
RemoveRuntimeAnnotation(String)	从此对象中删除给定的运行时注释。 (继承自 IAnnotatable)
SetRuntimeAnnotation(String, Object)	设置存储在给定键下的运行时注释。 如果具有指定名称的注释已存在，则覆盖现有批注。 (继承自 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	创建给定元数据的可读表示形式。 警告：不要依赖于返回的字符串的格式。 它仅用于调试，可能会在发布之间任意更改。 (继承自 IReadOnlyKey)

扩展方法

FindSharedObjectRootKey(IKey, StoreObjectIdentifier)	查找映射到类似共享表的 对象中的同一约束的第 IConventionKey 一个 。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	查找映射到类似共享表的 对象中的同一约束的第 IKey 一个 。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetDefaultName(IReadOnlyKey)	返回将用于此键的默认键约束名称。
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	返回将用于特定表的此键的默认键约束名称。
GetMappedConstraints(IKey)	获取键映射到的唯一约束。
GetName(IReadOnlyKey)	返回此键的键约束名称。
GetName(IReadOnlyKey, StoreObjectIdentifier)	返回特定表的此键的键约束名称。
GetFluentApiCalls(IKey, IAnnotationCodeGenerator)	获取用于配置密钥的 fluent API 调用。
IsHandledByConvention(IKey)	获取一个值，该值指示密钥是否按约定进行配置。
IsClustered(IReadOnlyKey)	返回一个值，该值指示密钥是否聚集。
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	返回一个值，该值指示密钥是否聚集。