SharedOptions interface

參考

套件:: @azure/cosmos

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

屬性

abortSignal	abortSignal 以傳遞至這個方法呼叫所建立的所有基礎網路要求。請參閱 https://developer.mozilla.org/en-US/docs/Web/API/AbortController 範例取消讀取要求 `const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()`
bypassIntegratedCache	設定是否應該略過或啟用 Azure CosmosDB 服務中要求的整合式快取。默認值為 false。默認會啟用整合式快取
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	啟用/停用取得檔容器讀取要求的檔容器配額相關統計數據。

屬性詳細資料

abortSignal

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

範例

取消讀取要求

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

屬性值

AbortSignal

bypassIntegratedCache

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

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

bypassIntegratedCache?: boolean

屬性值

boolean

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

屬性值

string

共用方式為