Language

IMutableKey インターフェイス

定義

エンティティの主キーまたは代替キーを表します。

public interface IMutableKey : Microsoft.EntityFrameworkCore.Metadata.IKey, Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable
public interface IMutableKey : Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey
type IMutableKey = interface
    interface IMutableAnnotatable
    interface IAnnotatable
    interface IKey
type IMutableKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IMutableAnnotatable
Public Interface IMutableKey
Implements IKey, IMutableAnnotatable
Public Interface IMutableKey
Implements IMutableAnnotatable, IReadOnlyKey
実装

注釈

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

詳細と例については、 エンティティの型とリレーションシップのモデル化 を参照してください。

プロパティ

Name 説明
DeclaringEntityType

キーが定義されているエンティティ型を取得します。 これは、キーが継承階層で派生型として定義されるときに Properties 定義される型とは異なる場合があります (プロパティは基本型で定義される可能性があるため)。

Item[String]

指定した名前の注釈の値を取得し、存在しない場合は null 返します。

(継承元 IReadOnlyAnnotatable)
Properties

キーを構成するプロパティを取得します。

メソッド

Name 説明
AddAnnotation(String, Object)

このオブジェクトに注釈を追加します。 指定した名前の注釈が既に存在する場合にスローします。

(継承元 IMutableAnnotatable)
AddAnnotations(IEnumerable<IAnnotation>)

オブジェクトに注釈を追加します。

(継承元 IMutableAnnotatable)
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()

単純キーのキー プロパティの型、または複合キーのオブジェクト配列を返します。

(継承元 IKey)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

指定された名前を持つランタイム注釈の値を取得し、存在しない場合は追加します。

(継承元 IAnnotatable)
GetPrincipalKeyValueFactory()

さまざまな形式のエンティティ データから取得されたキー値に基づいて、キー値のファクトリを取得します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

(継承元 IKey)
GetPrincipalKeyValueFactory<TKey>()

さまざまな形式のエンティティ データから取得されたキー値に基づいて、キー値のファクトリを取得します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

(継承元 IKey)
GetReferencingForeignKeys()

特定の主キーまたは代替キーを対象とするすべての外部キーを取得します。

GetRuntimeAnnotations()

現在のオブジェクトのすべてのランタイム注釈を取得します。

(継承元 IAnnotatable)
IsPrimaryKey()

キーが主キーかどうかを示す値を返します。

(継承元 IReadOnlyKey)
RemoveAnnotation(String)

このオブジェクトから指定された注釈を削除します。

(継承元 IMutableAnnotatable)
RemoveRuntimeAnnotation(String)

指定されたランタイム注釈をこのオブジェクトから削除します。

(継承元 IAnnotatable)
SetAnnotation(String, Object)

指定したキーの下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。

(継承元 IMutableAnnotatable)
SetOrRemoveAnnotation(String, Object)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 nullが指定されている場合は、既存の注釈を削除します。

(継承元 IMutableAnnotatable)
SetRuntimeAnnotation(String, Object)

指定されたキーの下に格納されているランタイム注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。

(継承元 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

指定されたメタデータの人間が判読できる表現を作成します。

警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。

(継承元 IReadOnlyKey)

拡張メソッド

Name 説明
AddAnnotations(IMutableAnnotatable, IEnumerable<IAnnotation>)

オブジェクトに注釈を追加します。

AnnotationsToDebugString(IAnnotatable, Int32)

オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。

FindSharedObjectRootKey(IKey, StoreObjectIdentifier)

共有テーブルに似たオブジェクト内の同じ制約にマップされている最初の IConventionKey を検索します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

FindSharedObjectRootKey(IMutableKey, StoreObjectIdentifier)

共有テーブルに似たオブジェクト内の同じ制約にマップされている最初の IMutableKey を検索します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)

共有テーブルに似たオブジェクト内の同じ制約にマップされている最初の IKey を検索します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

GetAnnotation(IAnnotatable, String)

指定した名前の注釈を取得し、存在しない場合はスローします。

GetAnnotation(IMutableAnnotatable, String)

指定した名前の注釈を取得し、存在しない場合はスローします。

GetDefaultName(IKey, StoreObjectIdentifier)

特定のテーブルに対してこのキーに使用される既定のキー制約名を返します。

GetDefaultName(IKey)

このキーに使用される既定のキー制約名を返します。

GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)

特定のテーブルに対してこのキーに使用される既定のキー制約名を返します。

GetDefaultName(IReadOnlyKey)

このキーに使用される既定のキー制約名を返します。

GetFillFactor(IReadOnlyKey, StoreObjectIdentifier)

キーが使用する塗りつぶし係数を返します。

GetFillFactor(IReadOnlyKey)

キーが使用する塗りつぶし係数を返します。

GetKeyType(IKey)

単純キーのキー プロパティの型、または複合キーのオブジェクト配列を返します。

GetMappedConstraints(IKey)

キーがマップされる一意の制約を取得します。

GetName(IKey, StoreObjectIdentifier)

特定のテーブルのこのキーのキー制約名を返します。

GetName(IKey)

このキーのキー制約名を返します。

GetName(IReadOnlyKey, StoreObjectIdentifier)

特定のテーブルのこのキーのキー制約名を返します。

GetName(IReadOnlyKey)

このキーのキー制約名を返します。

GetOrAddAnnotation(IMutableAnnotatable, String, String)

特定のキーを持つ既存の注釈を取得するか、存在しない場合は新しい注釈を追加します。

GetPrincipalKeyValueFactory<TKey>(IKey)

さまざまな形式のエンティティ データから取得されたインデックス キー値に基づいて、キー値のファクトリを取得します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

GetReferencingForeignKeys(IKey)

特定の主キーまたは代替キーを対象とするすべての外部キーを取得します。

GetReferencingForeignKeys(IMutableKey)

特定の主キーまたは代替キーを対象とするすべての外部キーを取得します。

IsClustered(IKey, StoreObjectIdentifier)

キーがクラスター化されているかどうかを示す値を返します。

IsClustered(IKey)

キーがクラスター化されているかどうかを示す値を返します。

IsClustered(IReadOnlyKey, StoreObjectIdentifier)

キーがクラスター化されているかどうかを示す値を返します。

IsClustered(IReadOnlyKey)

キーがクラスター化されているかどうかを示す値を返します。

IsPrimaryKey(IKey)

キーが主キーかどうかを示す値を返します。

Relational(IKey)

キーのリレーショナル データベース固有のメタデータを取得します。

Relational(IMutableKey)

キーのリレーショナル データベース固有のメタデータを取得します。

SetFillFactor(IMutableKey, Nullable<Int32>)

キーで使用される塗りつぶし係数の値を設定します。

SetIsClustered(IMutableKey, Nullable<Boolean>)

キーがクラスター化されているかどうかを示す値を設定します。

SetName(IMutableKey, String)

このキーのキー制約名を設定します。

SetOrRemoveAnnotation(IMutableAnnotatable, String, Object)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 nullが指定されている場合は、既存の注釈を削除します。

Sqlite(IKey)

キーの SQLite 固有のメタデータを取得します。

Sqlite(IMutableKey)

キーの SQLite 固有のメタデータを取得します。

SqlServer(IKey)

キーのSQL Server固有のメタデータを取得します。

SqlServer(IMutableKey)

キーのSQL Server固有のメタデータを取得します。

ToDebugString(IKey, MetadataDebugStringOptions, Int32)

指定されたメタデータの人間が判読できる表現を作成します。

警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。

適用対象