IForeignKey 介面

定義

命名空間:

Microsoft.EntityFrameworkCore.Metadata

組件:

Microsoft.EntityFrameworkCore.dll

套件:

Microsoft.EntityFrameworkCore v10.0.0

來源:

IForeignKey.cs

代表一種關係，由依賴實體類型上的屬性組成的外鍵，參考主實體類型中對應的主鍵或備用鍵。

public interface IForeignKey : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyForeignKey

type IForeignKey = interface
    interface IReadOnlyForeignKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Interface IForeignKey
Implements IAnnotatable, IReadOnlyForeignKey

衍生

Microsoft.EntityFrameworkCore.Metadata.RuntimeForeignKey

實作

IAnnotatable IReadOnlyAnnotatable IReadOnlyForeignKey

備註

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

屬性

名稱	Description
DeclaringEntityType	取得受依存實體類型。 這可能與定義在繼承階層中的衍生型態時所定義的型別 Properties 不同（因為屬性可能定義在基底型態上）。
DependentToPrincipal	取得指向主要實體的依賴實體類型上的導航屬性。
IsConstrained	獲得一個值，表示該關係是否受約束，即有保證（例如資料庫外鍵約束）支持，確保每個外鍵值都存在匹配的主鍵。 當 false時，不會建立資料庫外鍵限制，查詢仍將該關係視為可選，即使外鍵屬性不可空——主鍵會被載入左連接，且不會假定其存在。 這不影響變更追蹤：必要的（IsRequired）關係在被切斷時仍會連鎖反應或產生概念空值，不論該值為何。 (繼承來源 IReadOnlyForeignKey)
Item[String]	取得帶有名稱的註解值，若不存在則回 null 傳。 (繼承來源 IReadOnlyAnnotatable)
PrincipalEntityType	取得此關係所針對的主要實體類型。 這可能與當關係針對繼承階層中的衍生型別時所定義的型 PrincipalKey 別不同（因為金鑰定義在階層的基底型態上）。
PrincipalKey	他會得到這段關係的主要或替代關鍵。
PrincipalToDependent	取得指向依賴實體的主實體類型上的導航屬性。
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)
GetDependentKeyValueFactory()	根據從各種實體資料取得的外鍵值，建立一個金鑰工廠。 此方法通常由資料庫提供者（及其他擴充）使用。 它通常不被用於應用程式程式碼中。
GetDependentKeyValueFactory<TKey>()	根據從各種實體資料取得的外鍵值，建立一個金鑰工廠。 此方法通常由資料庫提供者（及其他擴充）使用。 它通常不被用於應用程式程式碼中。
GetNavigation(Boolean)	回傳與此外鍵相關的導覽。
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	取得帶有名稱的執行時註解值，若不存在則加入該註解。 (繼承來源 IAnnotatable)
GetReferencingSkipNavigations()	所有跳過導航都用這個外鍵。
GetRelatedEntityType(IReadOnlyEntityType)	取得與該實體相關的實體類型。
GetRuntimeAnnotations()	取得目前物件上的所有執行時註解。 (繼承來源 IAnnotatable)
IsBaseLinking()	回傳一個值，表示外鍵是否定義在主鍵上，且指向同一主鍵。 (繼承來源 IReadOnlyForeignKey)
IsEffectivelyRequired()	回傳一個值，表示該外鍵的集合值是否保證會參考現有的主體——也就是說，該關係同時是必要（IsRequired）且受約束（IsConstrained）。 查詢會參考此參數，以判斷依賴到主體的導覽是否可以用內部連接來擴展（以及此類連接是否可以被修剪）;即使其外鍵屬性不可空，無約束關係仍被視為可選關係。 (繼承來源 IReadOnlyForeignKey)
RemoveRuntimeAnnotation(String)	移除該物件中給定的執行時註解。 (繼承來源 IAnnotatable)
SetRuntimeAnnotation(String, Object)	設定在指定鍵值下儲存的執行時註解。 若已有指定名稱的註解存在，則會覆寫現有註解。 (繼承來源 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	建立給定元資料的可讀表示法。 警告：請勿依賴回傳字串的格式。 它僅設計用於除錯，且可能在不同版本間任意變動。 (繼承來源 IReadOnlyForeignKey)

擴充方法

名稱	Description
FindSharedObjectRootForeignKey(IForeignKey, StoreObjectIdentifier)	找到第一個 IForeignKey 映射到相同限制的共享資料表類物件。 此方法通常由資料庫提供者（及其他擴充）使用。 它通常不被用於應用程式程式碼中。
FindSharedObjectRootForeignKey(IReadOnlyForeignKey, StoreObjectIdentifier)	找到第一個 IForeignKey 映射到相同限制的共享資料表類物件。 此方法通常由資料庫提供者（及其他擴充）使用。 它通常不被用於應用程式程式碼中。
GetConstraintName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	回傳外鍵約束名稱。
GetConstraintName(IReadOnlyForeignKey)	回傳外鍵約束名稱。
GetDefaultName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	回傳該外鍵所用的預設約束名稱。
GetDefaultName(IReadOnlyForeignKey)	回傳該外鍵所用的預設約束名稱。
GetFluentApiCalls(IForeignKey, IAnnotationCodeGenerator, Boolean)	能取得流暢的 API 呼叫來配置外鍵。
GetMappedConstraints(IForeignKey)	取得外鍵所映射的外鍵約束條件。
IsRowInternal(IReadOnlyForeignKey, StoreObjectIdentifier)	回傳一個值，表示此外鍵是否存在於兩個共用相同資料表類儲存物件的實體類型之間。