语言

CosmosDbContextOptionsBuilder 类

定义

允许对 Cosmos 特定的配置执行 DbContextOptions。

[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} 返回的,它不设计为直接在应用程序代码中构造。

有关详细信息和示例,请参阅使用 EF Core 使用 DbContextOptions 和访问Azure Cosmos DB。

构造函数

名称 说明
CosmosDbContextOptionsBuilder(DbContextOptionsBuilder)

初始化 CosmosDbContextOptionsBuilder 类的新实例。

方法

名称 说明
BulkExecutionAllowed(Boolean)

设置布尔值以启用 Cosmos DB SDK 批量执行功能。 启用此功能可以提高小型写入操作的吞吐量,但可能会增加延迟。 建议仅用于高吞吐量、非延迟敏感方案。 由于 事务批处理 不能在批量模式下执行,因此 EF 批处理的任何操作都不会使用批量执行。 若要确保批量执行操作,请考虑通过设置 Never禁用批处理。 有关详细信息,请参阅“保存数据 - Azure Cosmos DB提供程序”。

ConnectionMode(ConnectionMode)

将上下文配置为使用提供的连接模式。

ContentResponseOnWriteEnabled(Boolean)
已过时.

将布尔值设置为仅返回 Cosmos DB 响应中的标头和状态代码,用于写入项操作,例如 Create、Upsert、Patch 和 Replace。 将选项设置为 false 将导致响应具有 null 资源。 这减少了网络和 CPU 负载,方法是不通过网络发送资源并将其序列化在客户端上。

ExecutionStrategy(Func<ExecutionStrategyDependencies,IExecutionStrategy>)

将上下文配置为使用提供的 IExecutionStrategy。

GatewayModeMaxConnectionLimit(Int32)

配置Azure Cosmos DB服务中目标服务终结点允许的最大并发连接数。

HttpClientFactory(Func<HttpClient>)

将上下文配置为使用特定 HttpClient 工厂。

IdleTcpConnectionTimeout(TimeSpan)

配置空闲时间,之后未使用的连接关闭。

LimitToEndpoint(Boolean)

将操作限制为提供的终结点。

MaxRequestsPerTcpConnection(Int32)

配置通过单个 TCP 连接同时允许的请求数。 当更多请求同时进行时,直接/TCP 客户端将打开其他连接。

MaxTcpConnectionsPerEndpoint(Int32)

配置可以打开到每个 Cosmos DB 后端的最大 TCP 连接数。 此设置与 MaxRequestsPerTcpConnection 一起限制同时发送到单个 Cosmos DB 后端的请求数(MaxRequestsPerTcpConnection x MaxTcpConnection x MaxTcpConnectionPerEndpoint)。

OpenTcpConnectionTimeout(TimeSpan)

配置尝试建立连接所允许的时间量。

PreferredRegions(IReadOnlyList<String>)

配置上下文,以便为异地复制的数据库帐户使用提供的首选区域。

Region(String)

配置上下文以使用提供的异地复制区域。

RequestTimeout(TimeSpan)

配置连接到Azure Cosmos DB服务时的超时。 该数字指定等待响应从网络对等方返回的时间。

SessionTokenManagementMode(SessionTokenManagementMode)

SessionTokenManagementMode设置要使用的设置。 默认情况下, FullyAutomatic 将使用。 仅当应用程序需要手动管理会话令牌时,任何其他模式才相关。 例如:如果使用轮循机制负载均衡器,该负载均衡器不维护请求之间的会话相关性。 手动会话令牌管理在未正确处理时可能会中断会话一致性。 请参见 利用会话令牌 有关详细信息。

WebProxy(IWebProxy)

配置用于 Web 请求的代理信息。

WithOption(Func<CosmosOptionsExtension,CosmosOptionsExtension>)

通过克隆用于存储设置的扩展来设置选项。 这可确保生成器不会修改已在其他位置使用的选项。

显式接口实现

名称 说明
ICosmosDbContextOptionsBuilderInfrastructure.OptionsBuilder

获取核心选项生成器。

适用于