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)	傳回值，指出索引鍵是否已叢集化。