CosmosDbContextOptionsBuilder Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Позволяет выполнять DbContextOptionsопределенную конфигурацию Cosmos.
[System.Runtime.CompilerServices.Nullable(0)]
public class CosmosDbContextOptionsBuilder : Microsoft.EntityFrameworkCore.Infrastructure.ICosmosDbContextOptionsBuilderInfrastructure
public class CosmosDbContextOptionsBuilder
public class CosmosDbContextOptionsBuilder : Microsoft.EntityFrameworkCore.Infrastructure.ICosmosDbContextOptionsBuilderInfrastructure
[<System.Runtime.CompilerServices.Nullable(0)>]
type CosmosDbContextOptionsBuilder = class
interface ICosmosDbContextOptionsBuilderInfrastructure
type CosmosDbContextOptionsBuilder = class
type CosmosDbContextOptionsBuilder = class
interface ICosmosDbContextOptionsBuilderInfrastructure
Public Class CosmosDbContextOptionsBuilder
Implements ICosmosDbContextOptionsBuilderInfrastructure
Public Class CosmosDbContextOptionsBuilder
- Наследование
-
CosmosDbContextOptionsBuilder
- Атрибуты
- Реализации
Комментарии
Экземпляры этого класса возвращаются из вызова CosmosDbContextOptionsExtensions.UseCosmos{TContext} и не предназначены для непосредственного создания в коде приложения.
Дополнительные сведения и примеры см. в статье Об использовании DbContextOptions и доступе к Azure Cosmos DB с EF Core.
Конструкторы
| Имя. | Описание |
|---|---|
| CosmosDbContextOptionsBuilder(DbContextOptionsBuilder) |
Инициализирует новый экземпляр класса CosmosDbContextOptionsBuilder. |
Методы
| Имя. | Описание |
|---|---|
| BulkExecutionAllowed(Boolean) |
Задает логическое значение для включения функции массового выполнения пакета SDK Cosmos DB. Включение этой функции может повысить пропускную способность для небольших операций записи, но может увеличить задержку. Рекомендуется использовать только для сценариев с высокой пропускной способностью без задержки. Так как пакетные службы транзакций не могут выполняться в массовом режиме, любые операции, пакетные с помощью EF, не будут использовать массовое выполнение. Чтобы убедиться, что операции выполняются массово, рекомендуется отключить пакетную обработку по параметру Never. Дополнительные сведения см. в разделе "Сохранение данных" — Azure Cosmos DB поставщика. |
| ConnectionMode(ConnectionMode) |
Настраивает контекст для использования предоставленного режима подключения. |
| ContentResponseOnWriteEnabled(Boolean) |
Устаревшие.
Задает логическое значение, чтобы возвращать только заголовки и код состояния в ответе Cosmos DB для операции записи элементов, таких как Create, Upsert, Patch и Replace. Задание параметра false приведет к тому, что ответ будет иметь пустой ресурс. Это снижает нагрузку сети и ЦП, не отправляя ресурс обратно по сети и сериализуя его на клиенте. |
| ExecutionStrategy(Func<ExecutionStrategyDependencies,IExecutionStrategy>) |
Настраивает контекст для использования предоставленного IExecutionStrategy. |
| GatewayModeMaxConnectionLimit(Int32) |
Настраивает максимальное количество одновременных подключений, разрешенных для конечной точки целевой службы в службе Azure Cosmos DB. |
| HttpClientFactory(Func<HttpClient>) |
Настраивает контекст для использования определенной HttpClient фабрики. |
| IdleTcpConnectionTimeout(TimeSpan) |
Настраивает время простоя после закрытия неиспользуемых подключений. |
| LimitToEndpoint(Boolean) |
Ограничивает операции предоставленной конечной точкой. |
| MaxRequestsPerTcpConnection(Int32) |
Настраивает количество запросов, разрешенных одновременно по одному TCP-подключению. При одновременном выполнении дополнительных запросов прямой или TCP-клиент откроет дополнительные подключения. |
| MaxTcpConnectionsPerEndpoint(Int32) |
Настраивает максимальное количество TCP-подключений, которые могут быть открыты для каждой внутренней части Cosmos DB. Вместе с MaxRequestsPerTcpConnection этот параметр ограничивает количество запросов, которые одновременно отправляются в одну серверную часть Cosmos DB (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint). |
| OpenTcpConnectionTimeout(TimeSpan) |
Настраивает время, разрешенное для установки подключения. |
| PreferredRegions(IReadOnlyList<String>) |
Настраивает контекст для использования предоставленных предпочтительных регионов для геореплицированных учетных записей базы данных. |
| Region(String) |
Настраивает контекст для использования предоставленного геореплицированного региона. |
| RequestTimeout(TimeSpan) |
Настраивает время ожидания при подключении к службе Azure Cosmos DB. Номер указывает время ожидания возвращения ответа из однорангового узла сети. |
| SessionTokenManagementMode(SessionTokenManagementMode) |
Задает используемое SessionTokenManagementMode значение. По умолчанию FullyAutomatic будет использоваться. Любой другой режим имеет значение только в том случае, если приложению необходимо вручную управлять маркерами сеанса. Например, если вы используете подсистему балансировки нагрузки с циклическим перебором, которая не поддерживает сходство сеансов между запросами. Управление маркерами сеанса вручную может нарушить согласованность сеансов при неправильной обработке. См. Использование маркеров сеанса дополнительные сведения. |
| WebProxy(IWebProxy) |
Настраивает сведения о прокси-сервере, используемые для веб-запросов. |
| WithOption(Func<CosmosOptionsExtension,CosmosOptionsExtension>) |
Задает параметр путем клонирования расширения, используемого для хранения параметров. Это гарантирует, что построитель не изменяет параметры, которые уже используются в другом месте. |
Явные реализации интерфейса
| Имя. | Описание |
|---|---|
| ICosmosDbContextOptionsBuilderInfrastructure.OptionsBuilder |
Возвращает построитель основных параметров. |