DbContext 類別

定義

命名空間:

Microsoft.EntityFrameworkCore

組件:

Microsoft.EntityFrameworkCore.dll

套件:

Microsoft.EntityFrameworkCore v10.0.0

來源:

DbContext.cs

DbContext 實例代表與資料庫的會話，可以用來查詢和儲存實體的實例。 DbContext 結合了工作單元（Unit Of Work）與儲存庫（Repository）模式。

[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 儲存資料 。

建構函式

名稱	Description
DbContext()	初始化 DbContext 類別的新執行個體。 OnConfiguring(DbContextOptionsBuilder)此方法將被呼叫來設定資料庫（及其他選項）以適用於此情境。
DbContext(DbContextOptions)	使用指定的選項初始化該 DbContext 類別的新實例。 OnConfiguring(DbContextOptionsBuilder)該方法仍會被呼叫以進一步配置選項。

屬性

名稱	Description
ChangeTracker	提供本上下文追蹤實體實例的資訊與操作存取。
ContextId	上下文實例與池租約（若有）的唯一識別碼。
Database	提供資料庫相關資訊與操作的存取，適用於此情境。
Model	關於實體形狀、彼此關係，以及它們如何映射到資料庫的元資料。 可能不包含初始化資料庫所需的全部資訊。

方法

名稱	Description
Add(Object)	開始追蹤指定實體及尚未被追蹤 Added 的其他可達實體，使其在呼叫時 SaveChanges() 插入資料庫。
Add<TEntity>(TEntity)	開始追蹤指定實體及尚未被追蹤 Added 的其他可達實體，使其在呼叫時 SaveChanges() 插入資料庫。
AddAsync(Object, CancellationToken)	開始追蹤指定實體及尚未被追蹤 Added 的其他可達實體，使其在呼叫時 SaveChanges() 插入資料庫。
AddAsync<TEntity>(TEntity, CancellationToken)	開始追蹤指定實體及尚未被追蹤 Added 的其他可達實體，使其在呼叫時 SaveChanges() 插入資料庫。
AddRange(IEnumerable<Object>)	開始追蹤給定實體及尚未被追蹤的其他可達實體，使其 Added 在呼叫時 SaveChanges() 會入資料庫。
AddRange(Object[])	開始追蹤給定實體及尚未被追蹤的其他可達實體，使其 Added 在呼叫時 SaveChanges() 會入資料庫。
AddRangeAsync(IEnumerable<Object>, CancellationToken)	開始追蹤指定實體及尚未被追蹤 Added 的其他可達實體，使其在呼叫時 SaveChanges() 插入資料庫。
AddRangeAsync(Object[])	開始追蹤指定實體及尚未被追蹤 Added 的其他可達實體，使其在呼叫時 SaveChanges() 插入資料庫。
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)	開始追蹤該州的實體 Deleted ，使其在呼叫時 SaveChanges() 從資料庫中移除。
Remove<TEntity>(TEntity)	開始追蹤該州的實體 Deleted ，使其在呼叫時 SaveChanges() 從資料庫中移除。
RemoveRange(IEnumerable<Object>)	開始追蹤該州的實體 Deleted ，使其在呼叫時 SaveChanges() 從資料庫中移除。
RemoveRange(Object[])	開始追蹤該州的實體 Deleted ，使其在呼叫時 SaveChanges() 從資料庫中移除。
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 該狀態，但下文說明使用不同狀態的情況。

事件

名稱	Description
SaveChangesFailed	當呼叫 或 SaveChangesSaveChangesAsync 失敗（但有例外）時觸發事件。
SavedChanges	呼叫結束時觸發 SaveChanges 的事件 SaveChangesAsync
SavingChanges	呼叫開始 SaveChanges 時觸發的事件 SaveChangesAsync

明確介面實作

名稱	Description
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 版本時應用程式失敗。

擴充方法

名稱	Description
CreateProxy(DbContext, Type, Object[])	如果已開啟代理建立，會為某個實體類型建立代理實例。
CreateProxy<TEntity>(DbContext, Action<TEntity>, Object[])	如果已開啟代理建立，會為某個實體類型建立代理實例。
CreateProxy<TEntity>(DbContext, Object[])	如果已開啟代理建立，會為某個實體類型建立代理實例。
GetInfrastructure<T>(IInfrastructure<T>)	從一個被隱藏的屬性中取得價值 IInfrastructure<T>。 此方法通常由資料庫提供者（及其他擴充）使用。 它通常不被用於應用程式程式碼中。