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<TContext> (или DbContextOptionsBuilder) для внешнего создания экземпляра DbContextOptions<TContext> (или DbContextOptions) и передачи его в базовый 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)	Начинает отслеживание заданной сущности и любых других доступных сущностей, которые еще не отслеживаются, в 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[])	Обнаруживает сущность с указанными значениями первичного ключа. Если сущность с заданными значениями первичного ключа отслеживается контекстом, она возвращается немедленно без запроса к базе данных. В противном случае выполняется запрос к базе данных для сущности с заданными значениями первичного ключа, и эта сущность, если она найдена, присоединяется к контексту и возвращается. Если сущность не найдена, возвращается значение NULL.
FindAsync(Type, Object[], CancellationToken)	Обнаруживает сущность с указанными значениями первичного ключа. Если сущность с заданными значениями первичного ключа отслеживается контекстом, она возвращается немедленно без запроса к базе данных. В противном случае выполняется запрос к базе данных для сущности с заданными значениями первичного ключа, и эта сущность, если она найдена, присоединяется к контексту и возвращается. Если сущность не найдена, возвращается значение NULL.
FindAsync<TEntity>(Object[])	Обнаруживает сущность с указанными значениями первичного ключа. Если сущность с заданными значениями первичного ключа отслеживается контекстом, она возвращается немедленно без запроса к базе данных. В противном случае выполняется запрос к базе данных для сущности с заданными значениями первичного ключа, и эта сущность, если она найдена, присоединяется к контексту и возвращается. Если сущность не найдена, возвращается значение NULL.
FindAsync<TEntity>(Object[], CancellationToken)	Обнаруживает сущность с указанными значениями первичного ключа. Если сущность с заданными значениями первичного ключа отслеживается контекстом, она возвращается немедленно без запроса к базе данных. В противном случае выполняется запрос к базе данных для сущности с заданными значениями первичного ключа, и эта сущность, если она найдена, присоединяется к контексту и возвращается. Если сущность не найдена, возвращается значение 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 состояние по умолчанию, но см. ниже для случаев, когда будет использоваться другое состояние.

События

SaveChangesFailed	Событие, возникающее при вызове SaveChanges или SaveChangesAsync сбое с исключением.
SavedChanges	Событие, сработавшее в конце вызова SaveChanges или SaveChangesAsync
SavingChanges	Событие, сработавшее в начале вызова SaveChanges или SaveChangesAsync

Явные реализации интерфейса

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.

Методы расширения

GetInfrastructure<T>(IInfrastructure<T>)	Возвращает значение из свойства, скрытого с помощью IInfrastructure<T>. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Как правило, он не используется в коде приложения.
CreateProxy(DbContext, Type, Object[])	Создает экземпляр прокси-сервера для типа сущности, если включено создание прокси-сервера.
CreateProxy<TEntity>(DbContext, Action<TEntity>, Object[])	Создает экземпляр прокси-сервера для типа сущности, если включено создание прокси-сервера.
CreateProxy<TEntity>(DbContext, Object[])	Создает экземпляр прокси-сервера для типа сущности, если включено создание прокси-сервера.