DbContext クラス

定義

名前空間:

Microsoft.EntityFrameworkCore

アセンブリ:

Microsoft.EntityFrameworkCore.dll

パッケージ:

Microsoft.EntityFrameworkCore v10.0.0

ソース:

DbContext.cs

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

[System.Runtime.CompilerServices.Nullable(0)]
public class DbContext : IAsyncDisposable, IDisposable, Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<IServiceProvider>, Microsoft.EntityFrameworkCore.Internal.IDbContextDependencies, Microsoft.EntityFrameworkCore.Internal.IDbContextPoolable, Microsoft.EntityFrameworkCore.Internal.IDbSetCache

[<System.Runtime.CompilerServices.Nullable(0)>]
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

属性

NullableAttribute

実装

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

注釈

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

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

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

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

詳細と例については、「DbContext の有効期間、構成、初期化」、EF Core を使用したデータの照会、EF Core でのデータの変更、および保存に関する説明を参照してください。

コンストラクター

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

プロパティ

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

メソッド

Name	説明
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>()	TEntityのインスタンスのクエリと保存に使用できるDbSet<TEntity>を作成します。
Set<TEntity>(String)	TEntityのインスタンスのクエリと保存に使用できる共有型エンティティ型のDbSet<TEntity>を作成します。
Update(Object)	既定では、 Modified 状態を使用して、指定されたエンティティと特定のエンティティから到達可能なエントリの追跡を開始しますが、別の状態が使用される場合は以下を参照してください。
Update<TEntity>(TEntity)	既定では、 Modified 状態を使用して、指定されたエンティティと特定のエンティティから到達可能なエントリの追跡を開始しますが、別の状態が使用される場合は以下を参照してください。
UpdateRange(IEnumerable<Object>)	既定では、 Modified 状態を使用して、特定のエンティティから到達可能な特定のエンティティとエントリの追跡を開始しますが、別の状態が使用される場合は以下を参照してください。
UpdateRange(Object[])	既定では、 Modified 状態を使用して、特定のエンティティから到達可能な特定のエンティティとエントリの追跡を開始しますが、別の状態が使用される場合は以下を参照してください。

イベント

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

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

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

拡張メソッド

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