SharedOptions interface

套件:: @azure/cosmos

可針對向 Azure Cosmos DB 伺服器發出的要求指定選項。=

屬性

abortSignal	abortSignal 以傳遞至這個方法呼叫所建立的所有基礎網路要求。請參閱 https://developer.mozilla.org/en-US/docs/Web/API/AbortController 範例取消讀取要求 import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const controller = new AbortController(); const results = container.items.query("SELECT * from c", { abortSignal: controller.signal, });
bypassIntegratedCache	設定是否應該略過或啟用 Azure CosmosDB 服務中要求的整合式快取。默認值為 false。默認會啟用整合式快取
consistencyLevel	用戶端所需的一致性層級。
disableRUPerMinuteUsage	DisableRUPerMinuteUsage 可用來啟用/停用要求單位（RU）/分鐘容量，以在一般布建 RU/秒用盡時提供要求。
excludedLocations	排除作業的一或多個 Azure 區域。只有在 enableEndPointDiscovery 設定為 true 時，才會套用此選項。
initialHeaders	（進階使用案例）將要求傳送至 Cosmos 時要以開頭的初始標頭
maxIntegratedCacheStalenessInMs	設定與 Azure CosmosDB 服務中要求相關聯的過時值。對於 <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>的要求，整合式快取的回應保證不會超過這個 maxIntegratedCacheStaleness 所指示的值。未設定一致性層級時，會忽略這個屬性。預設值為 null 快取過時是以毫秒為單位支持的數據粒度。任何小於毫秒的任何項目都會被忽略。
priorityLevel	每個要求的優先順序層級（低/高）。低優先順序要求一律會在任何高優先順序要求之前進行節流處理。預設值為 null。根據預設，所有要求都是高優先順序
sessionToken	啟用/停用取得檔容器讀取要求的檔容器配額相關統計數據。
throughputBucket	輸送量請求 Bucket 的儲存段。預設值為 null。在這種情況下，請求可以使用 100% 的分區輸送量。有關詳細資訊，請訪問 [Cosmos DB 輸送量分桶]（https://aka.ms/cosmsodb-bucketing).

屬性詳細資料

abortSignal

abortSignal 以傳遞至這個方法呼叫所建立的所有基礎網路要求。請參閱 https://developer.mozilla.org/en-US/docs/Web/API/AbortController

範例

取消讀取要求

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

屬性值

AbortSignal

bypassIntegratedCache

設定是否應該略過或啟用 Azure CosmosDB 服務中要求的整合式快取。

默認值為 false。默認會啟用整合式快取

bypassIntegratedCache?: boolean

屬性值

boolean

consistencyLevel

用戶端所需的一致性層級。

consistencyLevel?: string

屬性值

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage 可用來啟用/停用要求單位（RU）/分鐘容量，以在一般布建 RU/秒用盡時提供要求。

disableRUPerMinuteUsage?: boolean

屬性值

boolean

excludedLocations

排除作業的一或多個 Azure 區域。

只有在 enableEndPointDiscovery 設定為 true 時，才會套用此選項。

excludedLocations?: string[]

屬性值

string[]

initialHeaders

（進階使用案例）將要求傳送至 Cosmos 時要以開頭的初始標頭

initialHeaders?: CosmosHeaders

屬性值

CosmosHeaders

maxIntegratedCacheStalenessInMs

設定與 Azure CosmosDB 服務中要求相關聯的過時值。對於 <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>的要求，整合式快取的回應保證不會超過這個 maxIntegratedCacheStaleness 所指示的值。未設定一致性層級時，會忽略這個屬性。

預設值為 null

快取過時是以毫秒為單位支持的數據粒度。任何小於毫秒的任何項目都會被忽略。

maxIntegratedCacheStalenessInMs?: number

屬性值

number

priorityLevel

每個要求的優先順序層級（低/高）。低優先順序要求一律會在任何高優先順序要求之前進行節流處理。

預設值為 null。根據預設，所有要求都是高優先順序

priorityLevel?: PriorityLevel

屬性值

PriorityLevel

sessionToken

啟用/停用取得檔容器讀取要求的檔容器配額相關統計數據。

sessionToken?: string

屬性值