IKey 介面

定義

命名空間:

Microsoft.EntityFrameworkCore.Metadata

組件:

Microsoft.EntityFrameworkCore.dll

套件:

Microsoft.EntityFrameworkCore v10.0.0

來源:

IKey.cs

代表實體類型的主鍵或備用鍵。

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

備註

更多資訊與範例請參閱 建模實體類型與關係 。

屬性

名稱	Description
DeclaringEntityType	取得金鑰所定義的實體類型。 這可能與定義在繼承階層中的衍生型別時所定義的型別 Properties 不同（因為屬性可能定義在基底型態上）。
Item[String]	取得帶有名稱的註解值，若不存在則回 null 傳。 (繼承來源 IReadOnlyAnnotatable)
Properties	取得構成金鑰的屬性。

方法

名稱	Description
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)

擴充方法

名稱	Description
FindSharedObjectRootKey(IKey, StoreObjectIdentifier)	找到第一個 IConventionKey 映射到相同限制的共享資料表類物件。 此方法通常由資料庫提供者（及其他擴充）使用。 它通常不被用於應用程式程式碼中。
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	找到第一個 IKey 映射到相同限制的共享資料表類物件。 此方法通常由資料庫提供者（及其他擴充）使用。 它通常不被用於應用程式程式碼中。
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	回傳該鍵在特定資料表中所使用的預設鍵限制名稱。
GetDefaultName(IReadOnlyKey)	回傳該鍵所用的預設鍵約束名稱。
GetFillFactor(IReadOnlyKey, StoreObjectIdentifier)	回傳金鑰所使用的填充因子。
GetFillFactor(IReadOnlyKey)	回傳金鑰所使用的填充因子。
GetFluentApiCalls(IKey, IAnnotationCodeGenerator)	能取得流暢的 API 呼叫來設定金鑰。
GetMappedConstraints(IKey)	取得該金鑰所映射的唯一限制條件。
GetName(IReadOnlyKey, StoreObjectIdentifier)	回傳該鍵對特定資料表的鍵約束名稱。
GetName(IReadOnlyKey)	回傳該鍵的鍵約束名稱。
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	回傳一個值，表示該金鑰是否為叢集。
IsClustered(IReadOnlyKey)	回傳一個值，表示該金鑰是否為叢集。
IsHandledByConvention(IKey)	會得到一個值，表示該金鑰是否會依照慣例進行配置。