CosmosDbContextOptionsBuilder 類別
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
允許在 上執行 DbContextOptionsCosmos 專屬配置。
[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 及 Access Azure Cosmos DB with EF Core。
建構函式
| 名稱 | Description |
|---|---|
| CosmosDbContextOptionsBuilder(DbContextOptionsBuilder) |
初始化 CosmosDbContextOptionsBuilder 類別的新執行個體。 |
方法
| 名稱 | Description |
|---|---|
| BulkExecutionAllowed(Boolean) |
設定布林值以啟用 Cosmos DB SDK 的批量執行功能。 啟用此功能可提升小寫入操作的吞吐量,但可能會增加延遲。 僅建議用於高吞吐量、非延遲敏感的情境。 由於 交易批次 無法在批量模式下執行,因此由 EF 批次處理的任何操作都不會使用批量執行。 為確保操作能批量執行,請考慮透過設定 Never來停用批次處理。 欲了解更多資訊,請參閱 Saving Data - Azure Cosmos DB Provider。 |
| 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 MaxTcpConnectionPerEndpoint)的請求數量。 |
| OpenTcpConnectionTimeout(TimeSpan) |
設定嘗試建立連線的時間。 |
| PreferredRegions(IReadOnlyList<String>) |
設定上下文以使用地理複製資料庫帳號所提供的優先區域。 |
| Region(String) |
設定上下文以使用所提供的地理複製區域。 |
| RequestTimeout(TimeSpan) |
在連接 Azure Cosmos DB 服務時設定逾時。 這個數字表示等待網路對端回應的時間。 |
| SessionTokenManagementMode(SessionTokenManagementMode) |
設定 SessionTokenManagementMode to 使用。 預設情況下,將使用 FullyAutomatic。 其他模式只有在你的應用程式需要手動管理會話令牌時才有意義。 舉例來說:如果你使用的是輪詢負載平衡器,且不維持請求間的會話親和性。 手動會話令牌管理若處理不當,可能會破壞會話一致性。 請參閱 利用會話標記 請參閱更多詳細資料。 |
| WebProxy(IWebProxy) |
配置用於網頁請求的代理資訊。 |
| WithOption(Func<CosmosOptionsExtension,CosmosOptionsExtension>) |
透過複製儲存設定的擴充功能來設定一個選項。 這確保建商不會修改其他地方已在使用的選項。 |
明確介面實作
| 名稱 | Description |
|---|---|
| ICosmosDbContextOptionsBuilderInfrastructure.OptionsBuilder |
獲得核心選項建構器。 |