DbContext クラス

定義

名前空間:

Microsoft.EntityFrameworkCore

アセンブリ:

Microsoft.EntityFrameworkCore.dll

パッケージ:

Microsoft.EntityFrameworkCore v8.0.0

DbContext インスタンスはデータベースとのセッションを表し、エンティティのインスタンスのクエリと保存に使用できます。 DbContext は、作業単位パターンとリポジトリ パターンの組み合わせです。

public class DbContext : IAsyncDisposable, IDisposable, Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<IServiceProvider>, Microsoft.EntityFrameworkCore.Internal.IDbContextDependencies, Microsoft.EntityFrameworkCore.Internal.IDbContextPoolable, Microsoft.EntityFrameworkCore.Internal.IDbSetCache

type DbContext = class
    interface IInfrastructure<IServiceProvider>
    interface IDbContextDependencies
    interface IDbSetCache
    interface IDbContextPoolable
    interface IResettableService
    interface IDisposable
    interface IAsyncDisposable

Public Class DbContext
Implements IAsyncDisposable, IDbContextDependencies, IDbContextPoolable, IDbSetCache, IDisposable, IInfrastructure(Of IServiceProvider)

継承

Object

DbContext

実装

IInfrastructure<IServiceProvider> IDisposable Microsoft.EntityFrameworkCore.Internal.IDbContextDependencies Microsoft.EntityFrameworkCore.Internal.IDbContextPoolable Microsoft.EntityFrameworkCore.Internal.IDbSetCache IResettableService IAsyncDisposable

注釈

Entity Framework Core では、同じ DbContext インスタンスで複数の並列操作を実行することはできません。 これには、非同期クエリの並列実行と、複数のスレッドからの明示的な同時使用の両方が含まれます。 そのため、非同期呼び出しは常にすぐに待機するか、並列で実行される操作には個別の DbContext インスタンスを使用します。 詳細と例については、「 DbContext スレッドの問題を回避する 」を参照してください。

通常は、DbContext から派生し、モデル内の各エンティティのプロパティを DbSet<TEntity> 含むクラスを作成します。 プロパティに DbSet<TEntity> パブリック セッターがある場合は、派生コンテキストのインスタンスの作成時に自動的に初期化されます。

メソッドを OnConfiguring(DbContextOptionsBuilder) オーバーライドして、コンテキストに使用するデータベース (およびその他のオプション) を構成します。 または、コンテキスト内でインラインではなく外部で構成を実行する場合は、 (または DbContextOptionsBuilder) を使用DbContextOptionsBuilder<TContext>して外部で のDbContextOptionsインスタンスを作成し、 のDbContextOptions<TContext>DbContext基本コンストラクターに渡すことができます。

モデルは、派生コンテキストの プロパティにあるエンティティ クラスに対して一連の規則を DbSet<TEntity> 実行することによって検出されます。 規則によって検出されるモデルをさらに構成するには、 メソッドを OnModelCreating(ModelBuilder) オーバーライドします。

詳細と例については、「 DbContext の有効期間、構成、初期化」、「 EF Core を使用したデータのクエリ」、「 追跡の変更」、「 EF Core を使用したデータの保存 」を参照してください。

コンストラクター

DbContext()	DbContext クラスの新しいインスタンスを初期化します。 OnConfiguring(DbContextOptionsBuilder)このコンテキストに使用するデータベース (およびその他のオプション) を構成するために、 メソッドが呼び出されます。
DbContext(DbContextOptions)	指定したオプションを使用して、 クラスの DbContext 新しいインスタンスを初期化します。 メソッドは OnConfiguring(DbContextOptionsBuilder) 引き続き呼び出され、オプションをさらに構成できます。

プロパティ

ChangeTracker	このコンテキストが追跡しているエンティティ インスタンスの情報と操作へのアクセスを提供します。
ContextId	コンテキスト インスタンスとプール リースの一意識別子 (存在する場合)。
Database	このコンテキストのデータベース関連情報と操作へのアクセスを提供します。
Model	エンティティの形状、エンティティ間のリレーションシップ、およびそれらがデータベースにマップされる方法に関するメタデータ。 データベースの初期化に必要なすべての情報が含まれていない場合があります。

メソッド

Add(Object)	が呼び出されたときにSaveChanges()データベースに挿入されるように、指定されたエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
Add<TEntity>(TEntity)	が呼び出されたときにSaveChanges()データベースに挿入されるように、指定されたエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
AddAsync(Object, CancellationToken)	が呼び出されたときにSaveChanges()データベースに挿入されるように、指定されたエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
AddAsync<TEntity>(TEntity, CancellationToken)	が呼び出されたときにSaveChanges()データベースに挿入されるように、指定されたエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
AddRange(IEnumerable<Object>)	が呼び出されたときにSaveChanges()データベースに挿入されるように、特定のエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
AddRange(Object[])	が呼び出されたときにSaveChanges()データベースに挿入されるように、特定のエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
AddRangeAsync(IEnumerable<Object>, CancellationToken)	が呼び出されたときにSaveChanges()データベースに挿入されるように、指定されたエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
AddRangeAsync(Object[])	が呼び出されたときにSaveChanges()データベースに挿入されるように、指定されたエンティティと、Addedまだ追跡されていないその他の到達可能なエンティティの追跡を開始します。
Attach(Object)	既定で状態を使用して、指定されたエンティティから到達可能な特定のエンティティとエントリの追跡を Unchanged 開始しますが、別の状態が使用される場合は以下を参照してください。
Attach<TEntity>(TEntity)	既定で状態を使用して、指定されたエンティティから到達可能な特定のエンティティとエントリの追跡を Unchanged 開始しますが、別の状態が使用される場合は以下を参照してください。
AttachRange(IEnumerable<Object>)	既定で状態を使用して、特定のエンティティから到達可能な特定のエンティティとエントリの追跡を Unchanged 開始しますが、別の状態が使用される場合は以下を参照してください。
AttachRange(Object[])	既定で状態を使用して、特定のエンティティから到達可能な特定のエンティティとエントリの追跡を Unchanged 開始しますが、別の状態が使用される場合は以下を参照してください。
ConfigureConventions(ModelConfigurationBuilder)	このメソッドをオーバーライドして、既定値を設定し、実行前に規則を構成します。 このメソッドは、 の前に OnModelCreating(ModelBuilder)呼び出されます。
Dispose()	このコンテキストに割り当てられたリソースを解放します。
DisposeAsync()	このコンテキストに割り当てられたリソースを解放します。
Entry(Object)	指定した EntityEntry エンティティの を取得します。 エントリは、エンティティの変更追跡情報と操作へのアクセスを提供します。
Entry<TEntity>(TEntity)	指定した EntityEntry<TEntity> エンティティの を取得します。 エントリは、エンティティの変更追跡情報と操作へのアクセスを提供します。
Find(Type, Object[])	指定された主キー値を持つエンティティを検索します。 指定された主キー値を持つエンティティがコンテキストによって追跡されている場合は、データベースに要求を行わずにすぐに返されます。 それ以外の場合は、指定された主キー値を持つエンティティのデータベースに対してクエリが実行され、このエンティティが見つかった場合はコンテキストにアタッチされ、返されます。 エンティティが見つからない場合は、null が返されます。
Find<TEntity>(Object[])	指定された主キー値を持つエンティティを検索します。 指定された主キー値を持つエンティティがコンテキストによって追跡されている場合は、データベースに要求を行わずにすぐに返されます。 それ以外の場合は、指定された主キー値を持つエンティティのデータベースに対してクエリが実行され、このエンティティが見つかった場合はコンテキストにアタッチされ、返されます。 エンティティが見つからない場合は、null が返されます。
FindAsync(Type, Object[], CancellationToken)	指定された主キー値を持つエンティティを検索します。 指定された主キー値を持つエンティティがコンテキストによって追跡されている場合は、データベースに要求を行わずにすぐに返されます。 それ以外の場合は、指定された主キー値を持つエンティティのデータベースに対してクエリが実行され、このエンティティが見つかった場合はコンテキストにアタッチされ、返されます。 エンティティが見つからない場合は、null が返されます。
FindAsync(Type, Object[])	指定された主キー値を持つエンティティを検索します。 指定された主キー値を持つエンティティがコンテキストによって追跡されている場合は、データベースに要求を行わずにすぐに返されます。 それ以外の場合は、指定された主キー値を持つエンティティのデータベースに対してクエリが実行され、このエンティティが見つかった場合はコンテキストにアタッチされ、返されます。 エンティティが見つからない場合は、null が返されます。
FindAsync<TEntity>(Object[], CancellationToken)	指定された主キー値を持つエンティティを検索します。 指定された主キー値を持つエンティティがコンテキストによって追跡されている場合は、データベースに要求を行わずにすぐに返されます。 それ以外の場合は、指定された主キー値を持つエンティティのデータベースに対してクエリが実行され、このエンティティが見つかった場合はコンテキストにアタッチされ、返されます。 エンティティが見つからない場合は、null が返されます。
FindAsync<TEntity>(Object[])	指定された主キー値を持つエンティティを検索します。 指定された主キー値を持つエンティティがコンテキストによって追跡されている場合は、データベースに要求を行わずにすぐに返されます。 それ以外の場合は、指定された主キー値を持つエンティティのデータベースに対してクエリが実行され、このエンティティが見つかった場合はコンテキストにアタッチされ、返されます。 エンティティが見つからない場合は、null が返されます。
FromExpression<TResult>(Expression<Func<IQueryable<TResult>>>)	指定されたクエリ式に対してクエリ可能な を作成します。
OnConfiguring(DbContextOptionsBuilder)	このメソッドをオーバーライドして、このコンテキストに使用するデータベース (およびその他のオプション) を構成します。 このメソッドは、作成されるコンテキストの各インスタンスに対して呼び出されます。 基本実装では何も行いません。
OnModelCreating(ModelBuilder)	派生コンテキストのプロパティで DbSet<TEntity> 公開されているエンティティ型から規則によって検出されたモデルをさらに構成するには、このメソッドをオーバーライドします。 結果のモデルはキャッシュされ、派生コンテキストの後続のインスタンスに再利用される場合があります。
Remove(Object)	が呼び出されたときにSaveChanges()データベースから削除されるように、指定されたエンティティDeletedの状態の追跡を開始します。
Remove<TEntity>(TEntity)	が呼び出されたときにSaveChanges()データベースから削除されるように、指定されたエンティティDeletedの状態の追跡を開始します。
RemoveRange(IEnumerable<Object>)	が呼び出されたときにSaveChanges()データベースから削除されるように、指定されたエンティティDeletedの状態の追跡を開始します。
RemoveRange(Object[])	が呼び出されたときにSaveChanges()データベースから削除されるように、指定されたエンティティDeletedの状態の追跡を開始します。
SaveChanges()	このコンテキストで行われたすべての変更をデータベースに保存します。
SaveChanges(Boolean)	このコンテキストで行われたすべての変更をデータベースに保存します。
SaveChangesAsync(Boolean, CancellationToken)	このコンテキストで行われたすべての変更をデータベースに保存します。
SaveChangesAsync(CancellationToken)	このコンテキストで行われたすべての変更をデータベースに保存します。
Set<TEntity>()	のインスタンスの DbSet<TEntity> クエリと保存に使用できる を TEntity作成します。
Set<TEntity>(String)	DbSet<TEntity>のインスタンスのクエリと保存に使用できる共有型エンティティ型の TEntityを作成します。
Update(Object)	既定で状態を使用して、指定されたエンティティから到達可能な特定のエンティティとエントリの追跡を Modified 開始しますが、別の状態が使用される場合は以下を参照してください。
Update<TEntity>(TEntity)	既定で状態を使用して、指定されたエンティティから到達可能な特定のエンティティとエントリの追跡を Modified 開始しますが、別の状態が使用される場合は以下を参照してください。
UpdateRange(IEnumerable<Object>)	既定で状態を使用して、特定のエンティティから到達可能な特定のエンティティとエントリの追跡を Modified 開始しますが、別の状態が使用される場合は以下を参照してください。
UpdateRange(Object[])	既定で状態を使用して、特定のエンティティから到達可能な特定のエンティティとエントリの追跡を Modified 開始しますが、別の状態が使用される場合は以下を参照してください。

イベント

SaveChangesFailed	または の呼び出しが例外で失敗した場合にSaveChangesSaveChangesAsync発生するイベント。
SavedChanges	または の呼び出しの最後に発生した SaveChanges イベント SaveChangesAsync
SavingChanges	または の呼び出しの開始時に発生した SaveChanges イベント SaveChangesAsync

明示的なインターフェイスの実装

IDbContextDependencies.ChangeDetector	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.EntityFinderFactory	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.EntityGraphAttacher	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.ExceptionDetector	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.InfrastructureLogger	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.QueryProvider	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.SetSource	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.StateManager	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextDependencies.UpdateLogger	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextPoolable.ClearLease()	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextPoolable.SetLease(DbContextLease)	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextPoolable.SetLeaseAsync(DbContextLease, CancellationToken)	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbContextPoolable.SnapshotConfiguration()	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbSetCache.GetOrAddSet(IDbSetSource, String, Type)	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbSetCache.GetOrAddSet(IDbSetSource, Type)	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IDbSetCache.GetSets()	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IInfrastructure<IServiceProvider>.Instance	サービスの解決に使用されるスコープ IServiceProvider を取得します。 このプロパティは、パブリック API サーフェイスで直接公開されていないサービスを使用する必要がある拡張メソッドで使用することを目的としています。
IResettableService.ResetState()	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。
IResettableService.ResetStateAsync(CancellationToken)	これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。

拡張メソッド

GetInfrastructure<T>(IInfrastructure<T>)	を使用して非表示になっているプロパティから値を IInfrastructure<T>取得します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
CreateProxy(DbContext, Type, Object[])	プロキシの作成が有効になっている場合は、エンティティ型のプロキシ インスタンスを作成します。
CreateProxy<TEntity>(DbContext, Action<TEntity>, Object[])	プロキシの作成が有効になっている場合は、エンティティ型のプロキシ インスタンスを作成します。
CreateProxy<TEntity>(DbContext, Object[])	プロキシの作成が有効になっている場合は、エンティティ型のプロキシ インスタンスを作成します。