DbContext 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
DbContext 实例表示工作单元模式和存储库模式的组合,以便可用于从数据库进行查询,并将更改组合在一起,然后将更改写回到存储区作为一个单元。 DbContext 在概念上类似于 ObjectContext。
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", Justification="Casing is intentional")]
public class DbContext : IDisposable, System.Data.Entity.Infrastructure.IObjectContextAdapter
public class DbContext : IDisposable, System.Data.Entity.Infrastructure.IObjectContextAdapter
type DbContext = class
interface IDisposable
interface IObjectContextAdapter
Public Class DbContext
Implements IDisposable, IObjectContextAdapter
- 继承
-
DbContext
- 派生
- 特性
- 实现
注解
DbContext 通常用于包含模型根实体的属性的派生类型 DbSet<TEntity> 。 创建派生类的实例时,会自动初始化这些集。 通过将特性应用于 SuppressDbSetInitializationAttribute 整个派生上下文类或类上的单个属性,可以修改此行为。 可以通过多种方式指定支持上下文的实体数据模型。 使用 Code First 方法时, DbSet<TEntity> 派生上下文上的属性用于按约定生成模型。 可以重写受保护的 OnModelCreating 方法以调整此模型。 通过显式创建DbCompiledModelDbModelBuilder模型并将其传递给 DbContext 构造函数之一,可以更好地控制用于 Model First 方法的模型。 使用 Database First 或 Model First 方法时,可以使用实体设计器(或通过创建 EDMX 文件手动创建)创建实体数据模型,然后可以使用实体连接字符串或EntityConnection对象指定此模型。 可以通过多种方式指定与数据库的连接(包括数据库的名称)。 如果从派生上下文调用无参数 DbContext 构造函数,则派生上下文的名称用于在 app.config 或 web.config 文件中查找连接字符串。 如果未找到连接字符串,则名称将传递给在类上注册的 Database DefaultConnectionFactory。 然后,连接工厂使用上下文名称作为默认连接字符串中的数据库名称。 (此默认连接字符串指向本地计算机上的 .\SQLEXPRESS,除非注册了其他 DefaultConnectionFactory。还可以通过将名称传递给采用字符串的 DbContext 构造函数之一来显式指定连接/数据库名称,而不是使用派生的上下文名称。 该名称也可以以“name=myname”的形式传递,在这种情况下,必须在配置文件中找到该名称,否则将引发异常。 请注意,在 app.config 或 web.config 文件中找到的连接可以是普通数据库连接字符串(而不是特殊实体框架连接字符串),在这种情况下,DbContext 将使用 Code First。 但是,如果在配置文件中找到的连接是特殊的 Entity Framework 连接字符串,则 DbContext 将使用数据库/模型优先,并且将使用在连接字符串中指定的模型。 还可以使用现有或显式创建的 DbConnection,而不是数据库/连接名称。 可以将 A DbModelBuilderVersionAttribute 应用于派生自 DbContext 的类,以设置上下文在创建模型时使用的约定版本。 如果未应用任何属性,则将使用最新版本的约定。
构造函数
| 名称 | 说明 |
|---|---|
| DbContext() |
使用约定构造一个新的上下文实例,以创建要连接到的数据库的名称。 按约定名称是派生上下文类的全名(命名空间 + 类名)。 请参阅类备注,了解如何使用它来创建连接。 |
| DbContext(DbCompiledModel) |
使用约定构造一个新的上下文实例,以创建要建立连接的数据库的名称,并从给定的模型初始化它。 按约定名称是派生上下文类的全名(命名空间 + 类名)。 请参阅类备注,了解如何使用它来创建连接。 |
| DbContext(DbConnection, Boolean) |
使用现有连接构造新的上下文实例以连接到数据库。
如果为上下文,则不会释放 |
| DbContext(DbConnection, DbCompiledModel, Boolean) |
使用现有连接构造一个新的上下文实例以连接到数据库,并从给定的模型初始化它。
如果为上下文,则不会释放 |
| DbContext(ObjectContext, Boolean) |
围绕现有 ObjectContext 构造一个新的上下文实例。 |
| DbContext(ObjectContext, Boolean) |
围绕现有 ObjectContext 构造一个新的上下文实例。 <param name=“objectContext”>要用新上下文包装的现有 ObjectContext。</param param><name=“dbContextOwnsObjectContext”>如果在释放 DbContext 时释放到true ObjectContext,则调用方必须释放连接。</param>
|
| DbContext(String, DbCompiledModel) |
使用给定字符串作为要建立连接的数据库的名称或连接字符串构造一个新的上下文实例,并从给定模型初始化它。 请参阅类备注,了解如何使用它来创建连接。 |
| DbContext(String) |
使用给定字符串作为要连接到的数据库的名称或连接字符串构造新的上下文实例。 请参阅类备注,了解如何使用它来创建连接。 |
属性
| 名称 | 说明 |
|---|---|
| ChangeTracker |
提供对处理实体更改跟踪的上下文功能的访问权限。 |
| Configuration |
提供对上下文的配置选项的访问权限。 |
| Database |
为此上下文创建一个数据库实例,用于创建/删除/存在对基础数据库的检查。 |
方法
| 名称 | 说明 |
|---|---|
| Dispose() |
调用受保护的 Dispose 方法。 |
| Dispose(Boolean) |
释放上下文。 如果创建基础 ObjectContext 是由此上下文创建的,则基础也会被释放,或者在创建此上下文时传递给此上下文。 如果创建数据库(DbConnection 对象)的连接由此上下文创建,则也会释放该连接,或者在创建此上下文时将所有权传递给此上下文。 |
| Entry(Object) |
DbEntityEntry获取给定实体的对象,该对象提供对有关实体的信息以及对实体执行操作的能力。 |
| Entry<TEntity>(TEntity) |
DbEntityEntry<TEntity>获取给定实体的对象,该对象提供对有关实体的信息以及对实体执行操作的能力。 |
| Equals(Object) |
DbContext 实例表示工作单元模式和存储库模式的组合,以便可用于从数据库进行查询,并将更改组合在一起,然后将更改写回到存储区作为一个单元。 DbContext 在概念上类似于 ObjectContext。 |
| GetHashCode() |
DbContext 实例表示工作单元模式和存储库模式的组合,以便可用于从数据库进行查询,并将更改组合在一起,然后将更改写回到存储区作为一个单元。 DbContext 在概念上类似于 ObjectContext。 |
| GetType() |
DbContext 实例表示工作单元模式和存储库模式的组合,以便可用于从数据库进行查询,并将更改组合在一起,然后将更改写回到存储区作为一个单元。 DbContext 在概念上类似于 ObjectContext。 |
| GetValidationErrors() |
验证跟踪的实体并返回包含验证结果的 DbEntityValidationResult 集合。 |
| OnModelCreating(DbModelBuilder) |
当已初始化派生上下文的模型,但在模型被锁定并用于初始化上下文之前,将调用此方法。 此方法的默认实现不执行任何操作,但可以在派生类中重写它,以便可以在锁定模型之前对其进行进一步配置。 |
| SaveChanges() |
将此上下文中所做的所有更改保存到基础数据库。 |
| SaveChangesAsync() |
将在此上下文中所做的所有更改异步保存到基础数据库。 |
| SaveChangesAsync(CancellationToken) |
将在此上下文中所做的所有更改异步保存到基础数据库。 |
| Set(Type) |
返回一个非泛型 DbSet 实例,用于访问上下文和基础存储中给定类型的实体。 |
| Set<TEntity>() |
返回一个 DbSet<TEntity> 实例,用于访问上下文和基础存储中给定类型的实体。 |
| ShouldValidateEntity(DbEntityEntry) |
扩展点允许用户替代仅验证添加和修改的实体的默认行为。 |
| ToString() |
DbContext 实例表示工作单元模式和存储库模式的组合,以便可用于从数据库进行查询,并将更改组合在一起,然后将更改写回到存储区作为一个单元。 DbContext 在概念上类似于 ObjectContext。 |
| ValidateEntity(DbEntityEntry, IDictionary<Object,Object>) |
扩展点允许用户自定义实体的验证或筛选出验证结果。 由 GetValidationErrors() 调用。 |
显式接口实现
| 名称 | 说明 |
|---|---|
| IObjectContextAdapter.ObjectContext |
返回此上下文基础的 Entity Framework ObjectContext。 |