Язык

DbContextOptionsBuilder Класс

Определение

Предоставляет простую область API для настройки DbContextOptions. Базы данных (и другие расширения) обычно определяют методы расширения для этого объекта, которые позволяют настроить подключение к базе данных (и другие параметры) для контекста.

public class DbContextOptionsBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IDbContextOptionsBuilderInfrastructure
[System.Runtime.CompilerServices.Nullable(0)]
public class DbContextOptionsBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IDbContextOptionsBuilderInfrastructure
type DbContextOptionsBuilder = class
    interface IDbContextOptionsBuilderInfrastructure
[<System.Runtime.CompilerServices.Nullable(0)>]
type DbContextOptionsBuilder = class
    interface IDbContextOptionsBuilderInfrastructure
Public Class DbContextOptionsBuilder
Implements IDbContextOptionsBuilderInfrastructure
Наследование
DbContextOptionsBuilder
Производный
Атрибуты
Реализации

Комментарии

Можно использовать DbContextOptionsBuilder для настройки контекста, переопределив OnConfiguring(DbContextOptionsBuilder) или создав DbContextOptions внешний конструктор и передав его в конструктор контекста.

Дополнительные сведения и примеры см. в разделе "Использование DbContextOptions ".

Конструкторы

Имя. Описание
DbContextOptionsBuilder()

Инициализирует новый экземпляр DbContextOptionsBuilder класса без набора параметров.

DbContextOptionsBuilder(DbContextOptions)

Инициализирует новый экземпляр DbContextOptionsBuilder класса для дальнейшей настройки заданного DbContextOptions.

Свойства

Имя. Описание
IsConfigured

Возвращает значение, указывающее, настроены ли какие-либо параметры.

Options

Возвращает параметры, настроенные.

Методы

Имя. Описание
AddInterceptors(IEnumerable<IInterceptor>)

Добавляет IInterceptor экземпляры в зарегистрированные в контексте.

AddInterceptors(IInterceptor[])

Добавляет IInterceptor экземпляры в зарегистрированные в контексте.

ConfigureLoggingCacheTime(TimeSpan)

Настраивает, сколько времени EF Core кэширует конфигурацию ведения журнала в определенных высокопроизводительных путях. Это делает EF Core пропускать потенциально дорогостоящие проверки ведения журнала, но означает, что изменения журнала во время выполнения (например, регистрация нового DiagnosticListener не может быть учтена сразу).

ConfigureWarnings(Action<WarningsConfigurationBuilder>)

Настраивает поведение среды выполнения предупреждений, созданных Entity Framework. Вы можете задать поведение и поведение по умолчанию для каждого типа предупреждения.

ConfigureWarnings(Action<WarningsConfigurationBuilder>)

Настраивает поведение среды выполнения предупреждений, созданных Entity Framework. Вы можете задать поведение и поведение по умолчанию для каждого типа предупреждения.

EnableDetailedErrors(Boolean)

Включает подробные ошибки при обработке исключений значений данных, возникающих при обработке результатов запроса хранилища. Такие ошибки чаще всего возникают из-за неправильной настройки свойств сущности. Например, если свойство настроено на тип int, но базовые данные в хранилище фактически имеют тип string, то во время обработки значения данных создается исключение. Если этот параметр включен и возникает ошибка данных, созданное исключение будет содержать сведения о конкретном свойстве сущности, которое вызвало ошибку.

EnableSensitiveDataLogging()

Позволяет включать данные приложения в сообщения об исключениях, ведение журнала и т. д. Это может включать значения, назначенные свойствам экземпляров сущностей, значения параметров для команд, отправляемых в базу данных, и другие такие данные. Этот флаг следует включить только в том случае, если у вас есть соответствующие меры безопасности на основе конфиденциальности этих данных.

EnableSensitiveDataLogging(Boolean)

Позволяет включать данные приложения в сообщения об исключениях, ведение журнала и т. д. Это может включать значения, назначенные свойствам экземпляров сущностей, значения параметров для команд, отправляемых в базу данных, и другие такие данные. Этот флаг следует включить только в том случае, если у вас есть соответствующие меры безопасности на основе конфиденциальности этих данных.

EnableServiceProviderCaching(Boolean)

Включает или отключает кэширование внутренних поставщиков услуг. Отключение кэширования может значительно повлиять на производительность и должно использоваться только в сценариях тестирования, которые создают множество поставщиков услуг для изоляции тестов.

EnableThreadSafetyChecks(Boolean)

Отключает обнаружение параллелизма, которое обнаруживает множество случаев ошибочного параллельного использования экземпляра DbContext и вызывает информативное исключение. Это обеспечивает незначительное улучшение производительности, но если DbContext экземпляр используется одновременно, поведение будет неопределенным, и программа может завершиться непредсказуемой ошибкой.

LogTo(Action<String>, Func<EventId,LogLevel,Boolean>, Nullable<DbContextLoggerOptions>)

Журналы событий, отфильтрованные предоставленным делегатом пользовательского фильтра. Фильтр должен возвращать значение true, чтобы регистрировать сообщение или значение false, чтобы отфильтровать его из журнала.

LogTo(Action<String>, IEnumerable<EventId>, LogLevel, Nullable<DbContextLoggerOptions>)

Регистрирует указанные события с помощью указанного действия. Например, используйте optionsBuilder.LogTo(Console.WriteLine, new[] { CoreEventId.ContextInitialized }) для записи ContextInitialized события в консоль.

LogTo(Action<String>, IEnumerable<String>, LogLevel, Nullable<DbContextLoggerOptions>)

Регистрирует все события в указанных категориях с помощью указанного действия. Например, используйте optionsBuilder.LogTo(Console.WriteLine, new[] { DbLoggerCategory.Infrastructure.Name }) для регистрации всех событий в DbLoggerCategory.Infrastructure категории.

LogTo(Action<String>, LogLevel, Nullable<DbContextLoggerOptions>)

Журналы с помощью указанного действия. Например, используйте optionsBuilder.LogTo(Console.WriteLine) для входа в консоль.

LogTo(Func<EventId,LogLevel,Boolean>, Action<EventData>)

Записывает события в делегат пользовательского средства ведения журнала, отфильтрованный делегатом пользовательского фильтра. Фильтр должен возвращать значение true, чтобы регистрировать сообщение или значение false, чтобы отфильтровать его из журнала.

ReplaceService<TService,TCurrentImplementation,TNewImplementation>()

Заменяет внутреннюю реализацию Entity Framework конкретной реализации контракта службы другой реализацией.

ReplaceService<TService,TImplementation>()

Заменяет все внутренние реализации Entity Framework контракта службы другой реализацией.

UseApplicationServiceProvider(IServiceProvider)

Задает, IServiceProvider из которого будут получены службы приложений. Это выполняется автоматически при использовании AddDbContext или AddDbContextPool, поэтому этот метод должен вызываться редко.

UseAsyncSeeding(Func<DbContext,Boolean,CancellationToken,Task>)

Настраивает метод начального значения для запуска после EnsureCreatedAsync(CancellationToken) вызова или после применения миграции асинхронно. Он будет вызываться даже в том случае, если изменения в хранилище не были выполнены.

UseInternalServiceProvider(IServiceProvider)

Задает, IServiceProvider из этого контекста должен разрешаться все его службы. EF создаст и управляет поставщиком услуг, если он не указан.

UseLoggerFactory(ILoggerFactory)

ILoggerFactory Задает значение, которое будет использоваться для создания ILogger экземпляров для ведения журнала, выполняемого этим контекстом.

UseMemoryCache(IMemoryCache)

Задает используемый IMemoryCache для кэширования запросов этим контекстом.

UseModel(IModel)

Задает модель, используемую для контекста. Если задана модель, OnModelCreating(ModelBuilder) то не будет выполняться.

UseQueryTrackingBehavior(QueryTrackingBehavior)

Задает поведение отслеживания для запросов LINQ, выполняемых в контексте. Отключение отслеживания изменений полезно для сценариев только для чтения, так как это позволяет избежать затрат на настройку отслеживания изменений для каждого экземпляра сущности. Не следует отключать отслеживание изменений, если вы хотите управлять экземплярами сущностей и сохранять эти изменения в базе данных с помощью SaveChanges().

UseRootApplicationServiceProvider()

Разрешает корневой каталог IServiceProvider от поставщика служб приложений с областью действия. Корневой поставщик можно использовать для получения служб однотонных приложений из внутренних служб singleton.

UseRootApplicationServiceProvider(IServiceProvider)

Задает корневой каталог IServiceProvider , из которого можно получить службы однотонных приложений из внутренних служб.

UseSeeding(Action<DbContext,Boolean>)

Настраивает начальный метод для запуска после EnsureCreated() вызова или после применения миграции. Он будет вызываться даже в том случае, если изменения в хранилище не были выполнены.

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

Имя. Описание
IDbContextOptionsBuilderInfrastructure.AddOrUpdateExtension<TExtension>(TExtension)

Добавляет заданное расширение в параметры. Если существующее расширение того же типа уже существует, оно будет заменено.

IDbContextOptionsBuilderInfrastructure.RemoveExtension<TExtension>()

Удаляет расширение заданного типа из параметров. Если расширение данного типа не существует, это no-op.

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

Имя. Описание
ConfigureSqlEngine(DbContextOptionsBuilder, Action<SqlEngineDbContextOptionsBuilder>)

Настраивает контекст для подключения к любой из SQL Server, Azure SQL, Azure Synapse базах данных, но без первоначального задания каких-либо DbConnection или строка подключения.

UseAzureSql(DbContextOptionsBuilder, Action<AzureSqlDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure SQL, но без первоначальной настройки любого DbConnection или строка подключения.

UseAzureSql(DbContextOptionsBuilder, DbConnection, Action<AzureSqlDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure SQL.

UseAzureSql(DbContextOptionsBuilder, DbConnection, Boolean, Action<AzureSqlDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure SQL.

UseAzureSql(DbContextOptionsBuilder, String, Action<AzureSqlDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure SQL.

UseAzureSynapse(DbContextOptionsBuilder, Action<AzureSynapseDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Synapse, но без первоначальной настройки каких-либо DbConnection или строка подключения.

UseAzureSynapse(DbContextOptionsBuilder, DbConnection, Action<AzureSynapseDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Synapse.

UseAzureSynapse(DbContextOptionsBuilder, DbConnection, Boolean, Action<AzureSynapseDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Synapse.

UseAzureSynapse(DbContextOptionsBuilder, String, Action<AzureSynapseDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Synapse.

UseChangeTrackingProxies(DbContextOptionsBuilder, Boolean, Boolean)

Включает создание прокси-серверов отслеживания изменений.

UseCosmos(DbContextOptionsBuilder, Action<CosmosDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Cosmos. Сведения о подключении необходимо указать в отдельном вызове.

UseCosmos(DbContextOptionsBuilder, String, String, Action<CosmosDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Cosmos.

UseCosmos(DbContextOptionsBuilder, String, String, String, Action<CosmosDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Cosmos.

UseCosmos(DbContextOptionsBuilder, String, TokenCredential, String, Action<CosmosDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных Azure Cosmos.

UseInMemoryDatabase(DbContextOptionsBuilder, Action<InMemoryDbContextOptionsBuilder>)
Устаревшие.
Устаревшие.

Настраивает контекст для подключения к устаревшей общей базе данных в памяти. Этот метод устарел. Вместо этого используйте UseInMemoryDatabase(DbContextOptionsBuilder, String, Action<InMemoryDbContextOptionsBuilder>).

UseInMemoryDatabase(DbContextOptionsBuilder, String, Action<InMemoryDbContextOptionsBuilder>)

Настраивает контекст для подключения к именованной базе данных в памяти. База данных в памяти используется в любом месте, где используется то же имя, но только для данного поставщика услуг. Чтобы использовать одну и ту же базу данных в памяти между поставщиками услуг, вызовите UseInMemoryDatabase(DbContextOptionsBuilder, String, InMemoryDatabaseRoot, Action<InMemoryDbContextOptionsBuilder>) общий доступ InMemoryDatabaseRoot к базе данных, в которой следует корень базы данных.

UseInMemoryDatabase(DbContextOptionsBuilder, String, InMemoryDatabaseRoot, Action<InMemoryDbContextOptionsBuilder>)

Настраивает контекст для подключения к именованной базе данных в памяти. База данных в памяти используется в любом месте, где используется то же имя, но только для данного поставщика услуг.

UseLazyLoadingProxies(DbContextOptionsBuilder, Action<LazyLoadingProxiesOptionsBuilder>)

Включает создание отложенных прокси-серверов.

UseLazyLoadingProxies(DbContextOptionsBuilder, Boolean)

Включает создание отложенных прокси-серверов.

UseSqlite(DbContextOptionsBuilder, Action<SqliteDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQLite, но без первоначальной настройки любого DbConnection или строка подключения.

UseSqlite(DbContextOptionsBuilder, DbConnection, Action<SqliteDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQLite.

UseSqlite(DbContextOptionsBuilder, DbConnection, Boolean, Action<SqliteDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQLite.

UseSqlite(DbContextOptionsBuilder, String, Action<SqliteDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQLite.

UseSqlServer(DbContextOptionsBuilder, Action<SqlServerDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQL Server, но без первоначальной настройки любого DbConnection или строка подключения.

UseSqlServer(DbContextOptionsBuilder, DbConnection, Action<SqlServerDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQL Server.

UseSqlServer(DbContextOptionsBuilder, DbConnection, Boolean, Action<SqlServerDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQL Server.

UseSqlServer(DbContextOptionsBuilder, String, Action<SqlServerDbContextOptionsBuilder>)

Настраивает контекст для подключения к базе данных SQL Server.

Применяется к