IConventionModel インターフェイス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
エンティティの形状、エンティティ間のリレーションシップ、およびエンティティがデータベースにマップされる方法に関するメタデータ。 モデルは通常、派生DbContextでOnModelCreating(ModelBuilder) メソッドをオーバーライドすることによって作成されます。
[System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")]
public interface IConventionModel : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModelpublic interface IConventionModel : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IModelpublic interface IConventionModel : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel[<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")>]
type IConventionModel = interface
interface IReadOnlyModel
interface IReadOnlyAnnotatable
interface IConventionAnnotatabletype IConventionModel = interface
interface IModel
interface IAnnotatable
interface IConventionAnnotatabletype IConventionModel = interface
interface IReadOnlyModel
interface IReadOnlyAnnotatable
interface IConventionAnnotatablePublic Interface IConventionModel
Implements IConventionAnnotatable, IReadOnlyModelPublic Interface IConventionModel
Implements IConventionAnnotatable, IModel- 属性
- 実装
注釈
このインターフェイスは、モデルの作成時に使用され、メタデータを変更できます。 モデルが構築されると、 IModel は同じメタデータの読み取り専用ビューを表します。
詳細と例については、「 モデル構築規則 」を参照してください。
プロパティ
| Name | 説明 |
|---|---|
| Builder |
このモデルの構成に使用できるビルダーを取得します。 |
| IsInModel |
このオブジェクトがモデル内にあるかどうか、つまり、モデルから削除されていないかどうかを示します。 (継承元 IConventionAnnotatable) |
| Item[String] |
指定した名前の値注釈を取得し、存在しない場合は |
| ModelDependencies |
ランタイム サービスの依存関係。 (継承元 IModel) |
| ModelId |
これは、パブリック API と同じ互換性標準の対象ではなく、Entity Framework Core インフラストラクチャをサポートする内部 API です。 これは、任意のリリースで予告なしに変更または削除される可能性があります。 コード内で直接使用する場合は、細心の注意を払う必要があります。これを行うと、新しいEntity Framework Core リリースに更新するときにアプリケーションのエラーが発生する可能性があることを認識してください。 (継承元 IReadOnlyModel) |
メソッド
| Name | 説明 |
|---|---|
| AddAnnotation(String, Object, Boolean) |
このオブジェクトに注釈を追加します。 指定した名前の注釈が既に存在する場合にスローします。 (継承元 IConventionAnnotatable) |
| AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean) |
オブジェクトに注釈を追加します。 (継承元 IConventionAnnotatable) |
| AddEntityType(String, Boolean) |
既定の型の状態エンティティ型をモデルに追加します。 |
| AddEntityType(String, String, IConventionEntityType, Boolean) |
古い.
モデルへのナビゲーションを定義する所有エンティティ型を追加します。 |
| AddEntityType(String, Type, Boolean) |
共有型エンティティ型をモデルに追加します。 |
| AddEntityType(Type, Boolean) |
エンティティ型をモデルに追加します。 |
| AddEntityType(Type, String, IConventionEntityType, Boolean) |
古い.
モデルへのナビゲーションを定義する所有エンティティ型を追加します。 |
| AddIgnored(String, Boolean) |
指定されたエンティティ型名を無視としてマークします。 |
| AddIgnored(Type, Boolean) |
指定されたエンティティ型を無視としてマークします。 |
| AddOwned(Type, Boolean) |
特定のエンティティ型を所有済みとしてマークし、特定の型を使用して検出されたエンティティ型を所有として構成する必要があることを示します。 |
| AddOwnedEntityType(String, Boolean) |
既定の型の所有エンティティ型をモデルに追加します。 |
| AddOwnedEntityType(String, Type, Boolean) |
所有されている共有型エンティティ型をモデルに追加します。 |
| AddOwnedEntityType(Type, Boolean) |
所有エンティティ型をモデルに追加します。 |
| AddRuntimeAnnotation(String, Object) |
このオブジェクトにランタイム注釈を追加します。 指定した名前の注釈が既に存在する場合にスローします。 (継承元 IAnnotatable) |
| AddShared(Type, Boolean) |
特定のエンティティ型を共有としてマークし、検出された一致するエンティティ型を共有型エンティティ型として構成する必要があることを示します。 |
| AnnotationsToDebugString(Int32) |
オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。 (継承元 IReadOnlyAnnotatable) |
| DelayConventions() |
メタデータの側面が変更されたときに、規則が直ちに実行されないようにします。 すべての遅延規則は、返されたオブジェクトが破棄された後に実行されます。 |
| FinalizeModel() |
ランタイムで使用できる状態になるように、モデルの後処理を強制します。 この後処理は、 OnModelCreating(ModelBuilder)を使用する場合に自動的に行われます。このメソッドでは、自動実行が不可能な場合に明示的に実行できます。 |
| FindAnnotation(String) |
指定した名前の注釈を取得し、存在しない場合は |
| FindEntityType(String, String, IConventionEntityType) |
ナビゲーション名と定義エンティティ型を定義する、指定された名前のエンティティ型を取得します。 一致するエンティティ型が見つからない場合は |
| FindEntityType(String, String, IEntityType) |
ナビゲーション名と定義エンティティ型を定義する、指定された名前のエンティティ型を取得します。 一致するエンティティ型が見つからない場合は |
| FindEntityType(String, String, IReadOnlyEntityType) |
ナビゲーション名と定義エンティティ型を定義する、指定されたベース名のエンティティ型を取得します。 一致するエンティティ型が見つからない場合は |
| FindEntityType(String) |
指定した名前のエンティティを取得します。 指定した名前のエンティティ型が見つからない場合、または指定された CLR 型が共有型エンティティ型で使用されている場合、またはエンティティ型に定義ナビゲーションがある場合は、 |
| FindEntityType(Type, String, IConventionEntityType) |
ナビゲーション名と定義エンティティ型を定義する、指定された名前のエンティティ型を取得します。 一致するエンティティ型が見つからない場合は |
| FindEntityType(Type, String, IEntityType) |
ナビゲーション名と定義エンティティ型を定義する、指定された名前のエンティティ型を取得します。 一致するエンティティ型が見つからない場合は |
| FindEntityType(Type, String, IReadOnlyEntityType) |
ナビゲーション名と定義エンティティ型を定義する、指定された型のエンティティ型を取得します。 一致するエンティティ型が見つからない場合は |
| FindEntityType(Type) |
指定されたエンティティ クラスをマップするエンティティを取得します。 指定した名前のエンティティ型が見つからない場合は、 |
| FindEntityTypes(Type) |
指定した型に一致するエンティティ型を取得します。 |
| FindIgnoredConfigurationSource(String) |
指定されたエンティティ型名が無視されるかどうかを示します。 |
| FindIgnoredConfigurationSource(Type) |
指定されたエンティティ型が無視されるかどうかを示します。 |
| FindIsOwnedConfigurationSource(Type) |
指定された型が所有済みとしてマークされている場合は、構成ソースを返します。 |
| FindIsSharedConfigurationSource(Type) |
指定された型が共有としてマークされている場合は、構成ソースを返します。 |
| FindLeastDerivedEntityTypes(Type, Func<IReadOnlyEntityType,Boolean>) |
指定された型から派生した最小の型に対応するエンティティ型を返します。 |
| FindRuntimeAnnotation(String) |
指定された名前のランタイム注釈を取得し、存在しない場合は |
| FindRuntimeAnnotationValue(String) |
指定した名前のランタイム注釈の値を取得し、存在しない場合は |
| FindRuntimeEntityType(Type) |
指定されたエンティティ クラスをマップするエンティティを取得します。このエンティティ クラスは、実際のエンティティ型から派生したプロキシである可能性があります。 指定した CLR 型を持つエンティティ型が見つからない場合、または指定された CLR 型が共有型エンティティ型で使用されている場合、またはエンティティ型に定義ナビゲーションがある場合は、 |
| FindTypeMappingConfiguration(Type) |
特定のスカラー Typeの規則前の構成を検索します。 (継承元 IModel) |
| GetAnnotation(String) |
指定した名前の注釈を取得し、存在しない場合はスローします。 (継承元 IConventionAnnotatable) |
| GetAnnotations() |
現在のオブジェクトのすべての注釈を取得します。 (継承元 IAnnotatable) |
| GetChangeTrackingStrategy() |
モデル内のエンティティに使用されている既定の変更追跡戦略を取得します。 この戦略は、エンティティ型のインスタンスのプロパティへの変更をコンテキストが検出する方法を示します。 (継承元 IReadOnlyModel) |
| GetChangeTrackingStrategyConfigurationSource() |
GetChangeTrackingStrategy()の構成ソースを返します。 |
| GetEmbeddedDiscriminatorName() |
JSON ドキュメントに埋め込まれた識別子プロパティに使用する名前を取得します。 既定値は "$type" です。 (継承元 IReadOnlyModel) |
| GetEmbeddedDiscriminatorNameConfigurationSource() |
GetEmbeddedDiscriminatorName()の構成ソースを返します。 |
| GetEntityTypes() |
モデルで定義されているすべてのエンティティ型を取得します。 |
| GetModelDependencies() |
ランタイム サービスの依存関係を取得します。 (継承元 IModel) |
| GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg) |
指定された名前を持つランタイム注釈の値を取得し、存在しない場合は追加します。 (継承元 IAnnotatable) |
| GetProductVersion() |
このモデルのビルドに使用される EF Core アセンブリ バージョンを取得します。 (継承元 IReadOnlyModel) |
| GetPropertyAccessMode() |
このモデルのエンティティ型のプロパティに使用される PropertyAccessMode を取得します。 (継承元 IReadOnlyModel) |
| GetPropertyAccessModeConfigurationSource() |
GetPropertyAccessMode()の構成ソースを返します。 |
| GetRuntimeAnnotations() |
現在のオブジェクトのすべてのランタイム注釈を取得します。 (継承元 IAnnotatable) |
| GetTypeMappingConfigurations() |
すべての規則前の構成を取得します。 (継承元 IModel) |
| IsIgnored(String) |
指定されたエンティティ型名が無視されるかどうかを示します。 |
| IsIgnored(Type) |
指定されたエンティティ型が無視されるかどうかを示します。 |
| IsIgnoredType(Type) |
指定した型のエンティティ型とプロパティを無視するかどうかを示します。 この構成は、〘 IsIgnored(Type) |
| IsIndexerMethod(MethodInfo) |
指定した MethodInfo がインデクサー アクセスを表すかどうかを示す値を取得します。 (継承元 IModel) |
| IsOwned(Type) |
特定の型を使用するエンティティ型を検出時に所有型として構成する必要があるかどうかを示す値を返します。 |
| IsShared(Type) |
CLR 型がモデル内の共有型エンティティによって使用されるかどうかを取得します。 |
| RemoveAnnotation(String) |
指定した名前の注釈をこのオブジェクトから削除します。 (継承元 IConventionAnnotatable) |
| RemoveEntityType(IConventionEntityType) |
モデルからエンティティ型を削除します。 |
| RemoveEntityType(String, String, IConventionEntityType) |
ナビゲーション名と定義エンティティ型を定義して、指定された型を持つエンティティ型を削除します。 |
| RemoveEntityType(String) |
モデルからナビゲーションを定義せずにエンティティ型を削除します。 |
| RemoveEntityType(Type, String, IConventionEntityType) |
ナビゲーション名と定義エンティティ型を定義して、指定された型を持つエンティティ型を削除します。 |
| RemoveEntityType(Type) |
モデルからエンティティ型を削除します。 |
| RemoveIgnored(String) |
無視されたエンティティ型名を削除します。 |
| RemoveOwned(Type) |
特定の所有型を削除します。検出された場合、一致するエンティティ型を所有型として構成しないことを示します。 |
| RemoveRuntimeAnnotation(String) |
指定されたランタイム注釈をこのオブジェクトから削除します。 (継承元 IAnnotatable) |
| RemoveShared(Type) |
指定された型を共有されていないとマークします。検出された場合、一致するエンティティ型を共有型エンティティ型として構成しないでください。 |
| SetAnnotation(String, Object, Boolean) |
指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IConventionAnnotatable) |
| SetChangeTrackingStrategy(Nullable<ChangeTrackingStrategy>, Boolean) |
モデル内のエンティティに使用する既定の変更追跡戦略を設定します。 この戦略は、エンティティ型のインスタンスのプロパティへの変更をコンテキストが検出する方法を示します。 |
| SetEmbeddedDiscriminatorName(String, Boolean) |
JSON ドキュメントに埋め込まれた識別子プロパティに使用する名前を設定します。 既定値は "$type" です。 |
| SetOrRemoveAnnotation(String, Object, Boolean) |
指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。
|
| SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean) |
このモデルのすべてのエンティティ型のプロパティに使用する PropertyAccessMode を設定します。 |
| SetRuntimeAnnotation(String, Object) |
指定されたキーの下に格納されているランタイム注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IAnnotatable) |
| ToDebugString(MetadataDebugStringOptions, Int32) |
指定されたメタデータの人間が判読できる表現を作成します。 警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 (継承元 IReadOnlyModel) |
