IConventionForeignKey インターフェイス

定義

名前空間:

Microsoft.EntityFrameworkCore.Metadata

アセンブリ:

Microsoft.EntityFrameworkCore.dll

パッケージ:

Microsoft.EntityFrameworkCore v8.0.0

依存エンティティ型の外部キー プロパティが、プリンシパル エンティティ型の対応する主キーまたは代替キーを参照するリレーションシップを表します。

public interface IConventionForeignKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyForeignKey

type IConventionForeignKey = interface
    interface IReadOnlyForeignKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionForeignKey
Implements IConventionAnnotatable, IReadOnlyForeignKey

実装

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyForeignKey

注釈

このインターフェイスはモデルの作成時に使用され、メタデータを変更できます。 モデルがビルドされると、 IForeignKey は同じメタデータの読み取り専用ビューを表します。

詳細と例については、「 モデル構築規則 」を参照してください。

プロパティ

Builder	この外部キーの構成に使用できるビルダーを取得します。
DeclaringEntityType	依存エンティティ型を取得します。 これは、リレーションシップが Properties 継承階層で派生型を定義するときに定義される型とは異なる場合があります (プロパティは基本型で定義される可能性があるため)。
DeleteBehavior	プリンシパルが削除されたとき、またはリレーションシップが切断された場合に、リレーションシップ内の依存エンティティに削除操作がどのように適用されるかを示す値を取得します。 (継承元 IReadOnlyForeignKey)
DependentToPrincipal	プリンシパル エンティティを指す依存エンティティ型のナビゲーション プロパティを取得します。
IsInModel	このオブジェクトがモデル内にあるかどうか、つまり、モデルから削除されていないかどうかを示します。 (継承元 IConventionAnnotatable)
IsOwnership	このリレーションシップが所有権を定義するかどうかを示す値を取得します。 の場合 true、依存エンティティには、プリンシパル エンティティからのナビゲーションを介して常にアクセスする必要があります。 (継承元 IReadOnlyForeignKey)
IsRequired	プリンシパル エンティティが必要かどうかを示す値を取得します。 の場合 true、依存エンティティは常に有効なプリンシパル エンティティに割り当てる必要があります。 (継承元 IReadOnlyForeignKey)
IsRequiredDependent	依存エンティティが必要かどうかを示す値を取得します。 の場合 true、プリンシパル エンティティには常に有効な依存エンティティが割り当てられている必要があります。 (継承元 IReadOnlyForeignKey)
IsUnique	外部キー プロパティに割り当てられた値が一意かどうかを示す値を取得します。 (継承元 IReadOnlyForeignKey)
Item[String]	指定した名前の注釈の値を取得し、存在しない場合は を null 返します。 (継承元 IReadOnlyAnnotatable)
PrincipalEntityType	このリレーションシップが対象とするプリンシパル エンティティ型を取得します。 これは、リレーションシップが PrincipalKey 継承階層の派生型を対象とする場合に定義される型とは異なる場合があります (キーは階層の基本型で定義されているため)。
PrincipalKey	リレーションシップが対象とする主キーまたは代替キーを取得します。
PrincipalToDependent	依存エンティティを指すプリンシパル エンティティ型のナビゲーション プロパティを取得します。
Properties	依存エンティティの外部キー プロパティを取得します。

メソッド

AddAnnotation(String, Object, Boolean)	このオブジェクトに注釈を追加します。 指定した名前の注釈が既に存在する場合は をスローします。 (継承元 IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	オブジェクトに注釈を追加します。 (継承元 IConventionAnnotatable)
AnnotationsToDebugString(Int32)	オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。 (継承元 IReadOnlyAnnotatable)
FindAnnotation(String)	指定した名前の注釈を取得し、存在しない場合は を null 返します。 (継承元 IReadOnlyAnnotatable)
GetAnnotation(String)	指定した名前の注釈を取得し、存在しない場合は をスローします。 (継承元 IReadOnlyAnnotatable)
GetAnnotations()	現在の オブジェクトのすべての注釈を取得します。 (継承元 IReadOnlyAnnotatable)
GetConfigurationSource()	このプロパティの構成ソースを返します。
GetDeleteBehaviorConfigurationSource()	の構成ソースを DeleteBehavior返します。
GetDependentToPrincipalConfigurationSource()	の構成ソースを DependentToPrincipal返します。
GetIsOwnershipConfigurationSource()	の構成ソースを IsOwnership返します。
GetIsRequiredConfigurationSource()	の構成ソースを IsRequired返します。
GetIsRequiredDependentConfigurationSource()	の構成ソースを IsRequiredDependent返します。
GetIsUniqueConfigurationSource()	の構成ソースを IsUnique返します。
GetNavigation(Boolean)	この外部キーに関連付けられているナビゲーションを返します。
GetPrincipalEndConfigurationSource()	の構成ソースを PrincipalEntityType返します。
GetPrincipalKeyConfigurationSource()	の構成ソースを PrincipalKey返します。
GetPrincipalToDependentConfigurationSource()	の構成ソースを PrincipalToDependent返します。
GetPropertiesConfigurationSource()	の構成ソースを Properties返します。
GetReferencingSkipNavigations()	この外部キーを使用して、すべてのスキップ ナビゲーションを取得します。
GetRelatedEntityType(IReadOnlyEntityType)	指定されたエンティティに関連するエンティティ型を取得します。
IsBaseLinking()	外部キーが主キーで定義され、同じ主キーを指しているかどうかを示す値を返します。 (継承元 IReadOnlyForeignKey)
RemoveAnnotation(String)	指定した名前の注釈をこのオブジェクトから削除します。 (継承元 IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IConventionAnnotatable)
SetDeleteBehavior(Nullable<DeleteBehavior>, Boolean)	プリンシパルが削除されたとき、またはリレーションシップが切断されたときに、リレーションシップ内の依存エンティティに削除操作を適用する方法を示す値を設定します。
SetDependentToPrincipal(MemberInfo, Boolean)	プリンシパル エンティティを指す依存エンティティ型のナビゲーション プロパティを設定します。
SetDependentToPrincipal(String, Boolean)	プリンシパル エンティティを指す依存エンティティ型のナビゲーション プロパティを設定します。
SetIsOwnership(Nullable<Boolean>, Boolean)	このリレーションシップで所有権を定義するかどうかを示す値を設定します。 の場合 true、依存エンティティには、プリンシパル エンティティからのナビゲーションを介して常にアクセスする必要があります。
SetIsRequired(Nullable<Boolean>, Boolean)	プリンシパル エンティティが必要かどうかを示す値を設定します。 の場合 true、依存エンティティは常に有効なプリンシパル エンティティに割り当てる必要があります。
SetIsRequiredDependent(Nullable<Boolean>, Boolean)	依存エンティティが必要かどうかを示す値を設定します。 の場合 true、プリンシパル エンティティには常に有効な依存エンティティが割り当てられている必要があります。
SetIsUnique(Nullable<Boolean>, Boolean)	外部キー プロパティに割り当てられた値が一意かどうかを示す値を設定します。
SetOrRemoveAnnotation(String, Object, Boolean)	指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 が指定されている場合 null は、既存の注釈を削除します。 (継承元 IConventionAnnotatable)
SetPrincipalToDependent(MemberInfo, Boolean)	依存エンティティを指すプリンシパル エンティティ型のナビゲーション プロパティを設定します。
SetPrincipalToDependent(String, Boolean)	依存エンティティを指すプリンシパル エンティティ型のナビゲーション プロパティを設定します。
SetProperties(IReadOnlyList<IConventionProperty>, IConventionKey, Boolean)	外部キーのプロパティとそのターゲット プリンシパル キーを設定します。
ToDebugString(MetadataDebugStringOptions, Int32)	指定されたメタデータの人間が判読できる表現を作成します。 警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 (継承元 IReadOnlyForeignKey)

拡張メソッド

FindSharedObjectRootForeignKey(IConventionForeignKey, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じ制約にマップされている最初 IConventionForeignKey の 制約を検索します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
FindSharedObjectRootForeignKey(IReadOnlyForeignKey, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じ制約にマップされている最初 IForeignKey の 制約を検索します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
GetConstraintName(IReadOnlyForeignKey)	外部キー制約名を返します。
GetConstraintName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	外部キー制約名を返します。
GetConstraintNameConfigurationSource(IConventionForeignKey)	制約名の を ConfigurationSource 取得します。
GetDefaultName(IReadOnlyForeignKey)	この外部キーに使用される既定の制約名を返します。
GetDefaultName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	この外部キーに使用される既定の制約名を返します。
IsRowInternal(IReadOnlyForeignKey, StoreObjectIdentifier)	この外部キーが同じテーブルに似たストア オブジェクトを共有する 2 つのエンティティ型の間にあるかどうかを示す値を返します。
SetConstraintName(IConventionForeignKey, String, Boolean)	外部キー制約名を設定します。