ConnectionPolicy interface
表示与 Azure Cosmos DB 数据库服务中的 CosmosClient 关联的连接策略。
属性
| connection |
确定要连接到 Cosmos 的模式。 (目前仅支持网关选项) |
| enable |
用于启用/禁用终结点后台刷新的标志。 默认值为 true。
使用 |
| enable |
用于基于读/写作启用/禁用请求的自动重定向的标志。 默认值为 true。 在销毁另一个进程或浏览器中的 CosmosClient 后,需要调用 client.dispose()。 |
| enable |
启用/禁用每个分区级别断路器 (PPCB) 的标志。 默认值为 false。
注意:需要 |
| enable |
用于启用/禁用每个分区级别故障转移 (PPAF) 的标志。 默认值为 true。
当分区不可用时,自动故障转移到其他可用分区。
启用后,enablePartitionLevelCircuitBreaker 也将设置为 true。
注意:动态启用需要同时 |
| endpoint |
客户端将在后台刷新终结点列表的速率(以毫秒为单位) |
| preferred |
要用作读取请求的首选位置的 Azure 区域列表。 |
| request |
请求超时(等待网络对等方响应的时间)。 以毫秒为单位表示。 |
| retry |
RetryOptions 对象,该对象定义重试期间使用的多个可配置属性。 |
| use |
为 Azure Cosmos DB 服务中的异地复制数据库帐户启用对任何位置(区域)的写入的标志。
默认值为 |
属性详细信息
connectionMode
enableBackgroundEndpointRefreshing
用于启用/禁用终结点后台刷新的标志。 默认值为 true。
使用 enableEndpointsDiscovery 的终结点发现仍适用于失败的请求。
enableBackgroundEndpointRefreshing?: boolean
属性值
boolean
enableEndpointDiscovery
用于基于读/写作启用/禁用请求的自动重定向的标志。 默认值为 true。 在销毁另一个进程或浏览器中的 CosmosClient 后,需要调用 client.dispose()。
enableEndpointDiscovery?: boolean
属性值
boolean
enablePartitionLevelCircuitBreaker
启用/禁用每个分区级别断路器 (PPCB) 的标志。 默认值为 false。
注意:需要 enableEndpointDiscovery 是 true。 如果禁用了终结点发现,则此设置无效。
enablePartitionLevelCircuitBreaker?: boolean
属性值
boolean
enablePartitionLevelFailover
用于启用/禁用每个分区级别故障转移 (PPAF) 的标志。 默认值为 true。
当分区不可用时,自动故障转移到其他可用分区。
启用后,enablePartitionLevelCircuitBreaker 也将设置为 true。
注意:动态启用需要同时enableEndpointDiscovery是 true和 enableBackgroundEndpointRefreshing 。 如果禁用了终结点发现,则此设置无效。
enablePartitionLevelFailover?: boolean
属性值
boolean
endpointRefreshRateInMs
客户端将在后台刷新终结点列表的速率(以毫秒为单位)
endpointRefreshRateInMs?: number
属性值
number
preferredLocations
要用作读取请求的首选位置的 Azure 区域列表。
preferredLocations?: string[]
属性值
string[]
requestTimeout
请求超时(等待网络对等方响应的时间)。 以毫秒为单位表示。
requestTimeout?: number
属性值
number
retryOptions
useMultipleWriteLocations
为 Azure Cosmos DB 服务中的异地复制数据库帐户启用对任何位置(区域)的写入的标志。
默认值为 true。
useMultipleWriteLocations?: boolean
属性值
boolean