RuntimeKey 类

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

程序包:

Microsoft.EntityFrameworkCore v10.0.0

Source:

RuntimeKey.cs

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

[System.Runtime.CompilerServices.Nullable(0)]
public class RuntimeKey : Microsoft.EntityFrameworkCore.Infrastructure.RuntimeAnnotatableBase, Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeKey

[<System.Runtime.CompilerServices.Nullable(0)>]
type RuntimeKey = class
    inherit RuntimeAnnotatableBase
    interface IRuntimeKey
    interface IKey
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Class RuntimeKey
Inherits RuntimeAnnotatableBase
Implements IRuntimeKey

继承

Object

RuntimeAnnotatableBase

RuntimeKey

特性

NullableAttribute

实现

IAnnotatable IReadOnlyAnnotatable IKey Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeKey IReadOnlyKey

注解

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

构造函数

名称	说明
RuntimeKey(IReadOnlyList<RuntimeProperty>)	这是一个内部 API，支持Entity Framework Core基础结构，不受与公共 API 相同的兼容性标准的约束。 可以在任何版本中更改或删除它，而不通知。 只需在代码中直接使用它，并非常谨慎地知道这样做可能会导致应用程序在更新到新的Entity Framework Core版本时失败。

属性

名称	说明
DebugView	这是一个内部 API，支持Entity Framework Core基础结构，不受与公共 API 相同的兼容性标准的约束。 可以在任何版本中更改或删除它，而不通知。 只需在代码中直接使用它，并非常谨慎地知道这样做可能会导致应用程序在更新到新的Entity Framework Core版本时失败。
DeclaringEntityType	获取键所定义的实体类型。 这可能与在继承层次结构中定义密钥派生类型时定义的类型 Properties 不同（因为属性可能在基类型上定义）。
Item[String]	获取具有给定名称的值批注，如果不存在，则 null 返回该值。 (继承自 RuntimeAnnotatableBase)
Properties	获取构成键的属性。
ReferencingForeignKeys	这是一个内部 API，支持Entity Framework Core基础结构，不受与公共 API 相同的兼容性标准的约束。 可以在任何版本中更改或删除它，而不通知。 只需在代码中直接使用它，并非常谨慎地知道这样做可能会导致应用程序在更新到新的Entity Framework Core版本时失败。

方法

名称	说明
AddAnnotation(String, Object)	向此对象添加批注。 如果具有指定名称的批注已存在，则引发。 (继承自 RuntimeAnnotatableBase)
AddAnnotations(IEnumerable<IAnnotation>)	向此对象添加批注，重写具有相同名称的任何现有批注。 (继承自 RuntimeAnnotatableBase)
AddAnnotations(IReadOnlyDictionary<String,Object>)	向此对象添加批注，重写具有相同名称的任何现有批注。 (继承自 RuntimeAnnotatableBase)
AddRuntimeAnnotation(String, Annotation)	向此对象添加运行时批注。 如果具有指定名称的批注已存在，则引发。 (继承自 RuntimeAnnotatableBase)
AddRuntimeAnnotation(String, Object)	向此对象添加运行时批注。 如果具有指定名称的批注已存在，则引发。 (继承自 RuntimeAnnotatableBase)
AddRuntimeAnnotations(IEnumerable<Annotation>)	向此对象添加运行时批注。 (继承自 RuntimeAnnotatableBase)
AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>)	向此对象添加运行时批注。 (继承自 RuntimeAnnotatableBase)
CreateAnnotation(String, Object)	创建新的批注。 (继承自 RuntimeAnnotatableBase)
CreateRuntimeAnnotation(String, Object)	创建新的运行时批注。 (继承自 RuntimeAnnotatableBase)
FindAnnotation(String)	获取具有给定名称的批注，如果不存在，则 null 返回。 (继承自 RuntimeAnnotatableBase)
FindRuntimeAnnotation(String)	获取具有给定名称的运行时批注，如果不存在，则 null 返回。 (继承自 RuntimeAnnotatableBase)
GetAnnotation(String)	获取具有给定名称的批注，如果不存在，则引发该批注。 (继承自 RuntimeAnnotatableBase)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	获取具有给定名称的运行时批注的值，如果不存在，则添加它。 (继承自 RuntimeAnnotatableBase)
GetRuntimeAnnotations()	获取当前对象上的所有运行时批注。 (继承自 RuntimeAnnotatableBase)
RemoveAnnotation(String)	从此对象中删除给定批注。 (继承自 RuntimeAnnotatableBase)
RemoveRuntimeAnnotation(String)	从此对象中删除给定的运行时批注。 (继承自 RuntimeAnnotatableBase)
SetAnnotation(String, Object)	设置存储在给定键下的批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 (继承自 RuntimeAnnotatableBase)
SetIdentityMapFactory(Func<Boolean,IIdentityMap>)	这是一个内部 API，支持Entity Framework Core基础结构，不受与公共 API 相同的兼容性标准的约束。 可以在任何版本中更改或删除它，而不通知。 只需在代码中直接使用它，并非常谨慎地知道这样做可能会导致应用程序在更新到新的Entity Framework Core版本时失败。
SetPrincipalKeyValueFactory<TKey>(IPrincipalKeyValueFactory<TKey>)	这是一个内部 API，支持Entity Framework Core基础结构，不受与公共 API 相同的兼容性标准的约束。 可以在任何版本中更改或删除它，而不通知。 只需在代码中直接使用它，并非常谨慎地知道这样做可能会导致应用程序在更新到新的Entity Framework Core版本时失败。
SetRuntimeAnnotation(String, Annotation, Annotation)	设置存储在给定密钥下的运行时批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 (继承自 RuntimeAnnotatableBase)
SetRuntimeAnnotation(String, Object)	设置存储在给定密钥下的运行时批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 (继承自 RuntimeAnnotatableBase)
ToString()	返回一个表示当前对象的字符串。

显式接口实现

名称	说明
IAnnotatable.AddRuntimeAnnotation(String, Object)	向此对象添加运行时批注。 如果具有指定名称的批注已存在，则引发。 (继承自 RuntimeAnnotatableBase)
IAnnotatable.FindRuntimeAnnotation(String)	获取具有给定名称的运行时批注，如果不存在，则 null 返回。 (继承自 RuntimeAnnotatableBase)
IAnnotatable.GetRuntimeAnnotations()	获取当前对象上的所有运行时批注。 (继承自 RuntimeAnnotatableBase)
IAnnotatable.RemoveRuntimeAnnotation(String)	从此对象中删除给定的运行时批注。 (继承自 RuntimeAnnotatableBase)
IAnnotatable.SetRuntimeAnnotation(String, Object)	设置存储在给定密钥下的运行时批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 (继承自 RuntimeAnnotatableBase)
IKey.DeclaringEntityType	获取键所定义的实体类型。 这可能与在继承层次结构中定义密钥派生类型时定义的类型 Properties 不同（因为属性可能在基类型上定义）。
IKey.GetPrincipalKeyValueFactory()	根据从各种实体数据形式获取的键值获取键值的工厂。 此方法通常由数据库提供程序（和其他扩展）使用。 它通常不用于应用程序代码。
IKey.GetPrincipalKeyValueFactory<TKey>()	根据从各种实体数据形式获取的键值获取键值的工厂。 此方法通常由数据库提供程序（和其他扩展）使用。 它通常不用于应用程序代码。
IKey.Properties	获取构成键的属性。
IReadOnlyAnnotatable.FindAnnotation(String)	获取具有给定名称的批注，如果不存在，则 null 返回。 (继承自 RuntimeAnnotatableBase)
IReadOnlyAnnotatable.GetAnnotations()	获取当前对象上的所有批注。 (继承自 RuntimeAnnotatableBase)
IReadOnlyAnnotatable.Item[String]	获取具有给定名称的批注的值，如果不存在，则 null 返回该值。 (继承自 RuntimeAnnotatableBase)
IReadOnlyKey.DeclaringEntityType	获取键所定义的实体类型。 这可能与在继承层次结构中定义密钥派生类型时定义的类型 Properties 不同（因为属性可能在基类型上定义）。
IReadOnlyKey.GetReferencingForeignKeys()	获取面向给定主键或备用键的所有外键。
IReadOnlyKey.Properties	获取构成键的属性。
IRuntimeKey.GetIdentityMapFactory()	表示实体类型的主键或备用键。

扩展方法

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