IConventionKey 介面

定義

命名空間:

Microsoft.EntityFrameworkCore.Metadata

組件:

Microsoft.EntityFrameworkCore.dll

套件:

Microsoft.EntityFrameworkCore v8.0.0

表示實體上的主要或替代索引鍵。

public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey

type IConventionKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionKey
Implements IConventionAnnotatable, IReadOnlyKey

實作

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyKey

備註

此介面會在模型建立期間使用，並允許修改中繼資料。 建置模型之後， IKey 表示相同中繼資料的唯讀檢視。

如需詳細資訊和範例，請參閱 模型建置慣例 。

屬性

Builder	取得可用來設定此索引鍵的產生器。
DeclaringEntityType	取得索引鍵所定義的實體類型。 這可能與在繼承階層中定義衍生型別時所定義的型 Properties 別不同 (，因為屬性可以在基底類型上定義) 。
IsInModel	指出這個物件是否在模型中，亦即尚未從其中一個物件中移除。 (繼承來源 IConventionAnnotatable)
Item[String]	取得具有指定名稱之注釋的值，如果不存在，則傳 null 回 。 (繼承來源 IReadOnlyAnnotatable)
Properties	取得組成索引鍵的屬性。

方法

AddAnnotation(String, Object, Boolean)	將注釋加入至這個物件。 如果具有指定名稱的注釋已經存在，則會擲回 。 (繼承來源 IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	將批註加入物件。 (繼承來源 IConventionAnnotatable)
AnnotationsToDebugString(Int32)	取得 物件上宣告之所有注釋的偵錯字串。 (繼承來源 IReadOnlyAnnotatable)
FindAnnotation(String)	取得具有指定名稱的注釋，如果不存在，則傳 null 回 。 (繼承來源 IReadOnlyAnnotatable)
GetAnnotation(String)	取得具有指定名稱的注釋，如果不存在，則會擲回。 (繼承來源 IReadOnlyAnnotatable)
GetAnnotations()	取得目前 物件上的所有批註。 (繼承來源 IReadOnlyAnnotatable)
GetConfigurationSource()	傳回此金鑰的組態來源。
GetReferencingForeignKeys()	取得以指定的主要或替代索引鍵為目標的所有外鍵。
IsPrimaryKey()	傳回值，指出索引鍵是否為主鍵。 (繼承來源 IReadOnlyKey)
RemoveAnnotation(String)	從這個 物件中移除具有指定名稱的批註。 (繼承來源 IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	設定儲存在指定名稱底下的批註。 如果具有指定名稱的注釋已經存在，則會覆寫現有的批註。 (繼承來源 IConventionAnnotatable)
SetOrRemoveAnnotation(String, Object, Boolean)	設定儲存在指定名稱底下的批註。 如果具有指定名稱的注釋已經存在，則會覆寫現有的批註。 如果 null 已提供，則會移除現有的批註。 (繼承來源 IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	建立人類可讀取的指定中繼資料標記法。 警告：不要依賴傳回字串的格式。 它專為偵錯而設計，而且可能會在發行之間任意變更。 (繼承來源 IReadOnlyKey)

擴充方法

FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier)	尋找對應至共用資料表類似物件中相同條件約束的第一 IConventionKey 個 。 這個方法通常由資料庫提供者使用， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	尋找對應至共用資料表類似物件中相同條件約束的第一 IKey 個 。 這個方法通常由資料庫提供者使用， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。
GetDefaultName(IReadOnlyKey)	傳回將用於此索引鍵的預設索引鍵條件約束名稱。
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	傳回用於特定資料表之此索引鍵的預設索引鍵條件約束名稱。
GetName(IReadOnlyKey)	傳回此索引鍵的索引鍵條件約束名稱。
GetName(IReadOnlyKey, StoreObjectIdentifier)	傳回特定資料表之此索引鍵的索引鍵條件約束名稱。
GetNameConfigurationSource(IConventionKey)	ConfigurationSource取得條件約束名稱的 。
SetName(IConventionKey, String, Boolean)	設定此索引鍵的索引鍵條件約束名稱。
GetIsClusteredConfigurationSource(IConventionKey)	ConfigurationSource取得 金鑰是否為叢集的 。
IsClustered(IReadOnlyKey)	傳回值，指出索引鍵是否為叢集。
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	傳回值，指出索引鍵是否為叢集。
SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)	設定值，指出索引鍵是否為叢集。