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)	キーがクラスター化されているかどうかを示す値を返します。