RequestOptions interface

套件:

@azure/cosmos

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

Extends

SharedOptions

屬性

accessCondition	與要求相關聯的條件。
consistencyLevel	用戶端所需的一致性層級。
disableAutomaticIdGeneration	停用自動識別碼產生 (會導致建立失敗，如果識別碼不在定義)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage 可用來啟用/停用要求單位 (RU) /minute 容量，以在一般布建 RU/秒耗盡時提供要求。
enableScriptLogging	啟用或停用 JavaScript 預存程式中的記錄。
indexingDirective	指定索引指示詞 (索引，請勿為 。。etc) 。
offerThroughput	針對容器布建的供應專案輸送量，以測量每個單位的要求。
offerType	建立檔容器時的供應專案類型。 只有在建立檔容器時，此選項才有效。
populateQuotaInfo	啟用/停用取得檔容器讀取要求的檔容器配額相關統計資料。
postTriggerInclude	指出作業之後要叫用的 post 觸發程式是什麼。
preTriggerInclude	指出作業之前要叫用的預先觸發程式是什麼。
resourceTokenExpirySeconds	與許可權 (相關聯之資源權杖) 以秒為單位的到期時間 (僅適用于許可權) 的要求。
urlConnection	(進階使用案例) 要連線的 URL。

繼承的屬性

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()
initialHeaders	(進階使用案例) 將要求傳送至 Cosmos 時開頭的初始標頭
maxIntegratedCacheStalenessInMs	設定與 Azure CosmosDB 服務中要求相關聯的過時值。 對於 為 <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION> 的要求 <xref:com.azure.cosmos.ConsistencyLevel> ，來自整合式快取的回應保證不會超過這個 maxIntegratedCacheStaleness 所指出的值。 如果未設定一致性層級，則會忽略此屬性。 預設值為 Null 快取過時支援毫秒的資料細微性。 將會忽略小於毫秒的任何專案。
priorityLevel	每個要求的優先順序層級 (低/高) 。 低優先順序要求一律會在任何高優先順序要求之前進行節流。 預設值是空值。 根據預設，所有要求都是高優先順序
sessionToken	啟用/停用取得檔容器讀取要求的檔容器配額相關統計資料。

屬性詳細資料

accessCondition

與要求相關聯的條件。

accessCondition?: { condition: string, type: string }

屬性值

{ condition: string, type: string }

consistencyLevel

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

consistencyLevel?: string

屬性值

string

disableAutomaticIdGeneration

停用自動識別碼產生 (會導致建立失敗，如果識別碼不在定義)

disableAutomaticIdGeneration?: boolean

屬性值

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage 可用來啟用/停用要求單位 (RU) /minute 容量，以在一般布建 RU/秒耗盡時提供要求。

disableRUPerMinuteUsage?: boolean

屬性值

boolean

enableScriptLogging

啟用或停用 JavaScript 預存程式中的記錄。

enableScriptLogging?: boolean

屬性值

boolean

indexingDirective

指定索引指示詞 (索引，請勿為 。。etc) 。

indexingDirective?: string

屬性值

string

offerThroughput

針對容器布建的供應專案輸送量，以測量每個單位的要求。

offerThroughput?: number

屬性值

number

offerType

建立檔容器時的供應專案類型。

只有在建立檔容器時，此選項才有效。

offerType?: string

屬性值

string

populateQuotaInfo

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

populateQuotaInfo?: boolean

屬性值

boolean

postTriggerInclude

指出作業之後要叫用的 post 觸發程式是什麼。

postTriggerInclude?: string | string[]

屬性值

string | string[]

preTriggerInclude

指出作業之前要叫用的預先觸發程式是什麼。

preTriggerInclude?: string | string[]

屬性值

string | string[]

resourceTokenExpirySeconds

與許可權 (相關聯之資源權杖) 以秒為單位的到期時間 (僅適用于許可權) 的要求。

resourceTokenExpirySeconds?: number

屬性值

number

urlConnection

(進階使用案例) 要連線的 URL。

urlConnection?: string

屬性值

string

繼承的屬性詳細資料

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

繼承自SharedOptions.abortSignal

initialHeaders

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

initialHeaders?: CosmosHeaders

屬性值

CosmosHeaders

繼承自SharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

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

預設值為 Null

快取過時支援毫秒的資料細微性。 將會忽略小於毫秒的任何專案。

maxIntegratedCacheStalenessInMs?: number

屬性值

number

繼承自SharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

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

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

priorityLevel?: PriorityLevel

屬性值

PriorityLevel

繼承自SharedOptions.priorityLevel

sessionToken

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

sessionToken?: string

屬性值

string

繼承自SharedOptions.sessionToken