RequestOptions interface
Alternativ som kan anges för en begärd utfärdad till Azure Cosmos DB-servrarna.=
- Extends
Egenskaper
access |
Villkor som är associerade med begäran. |
consistency |
Konsekvensnivå som krävs av klienten. |
disable |
Inaktivera automatisk ID-generering (leder till att skaparen misslyckas om ID inte finns i definitionen) |
disable |
DisableRUPerMinuteUsage används för att aktivera/inaktivera kapacitet för begärandeenheter/minutkapacitet för att hantera begäran om regelbundna etablerade RU:er/sekund är slut. |
enable |
Aktiverar eller inaktiverar loggning i JavaScript-lagrade procedurer. |
indexing |
Anger indexeringsdirektiv (index, indexera inte .. osv.). |
offer |
Erbjudandets dataflöde har etablerats för en container i mätning av Begäranden per enhet. |
offer |
Erbjudandetyp när du skapar dokumentcontainrar. Det här alternativet är endast giltigt när du skapar en dokumentcontainer. |
populate |
Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer. |
post |
Anger vilken postutlösare som ska anropas efter åtgärden. |
pre |
Anger vad som är den förutlösare som ska anropas före åtgärden. |
resource |
Förfallotid (i sekunder) för resurstoken som är associerad med behörighet (gäller endast för begäranden om behörigheter). |
url |
(Avancerat användningsfall) Url:en som ska anslutas till. |
Ärvda egenskaper
abort |
abortSignal för att skicka till alla underliggande nätverksbegäranden som skapats av det här metodanropet. Se https://developer.mozilla.org/en-US/docs/Web/API/AbortController Exempel Avbryt en läsbegäran
|
bypass |
Anger om integrerad cache ska kringgås eller aktiveras för begäran i Azure CosmosDB-tjänsten. Standardvärdet är falskt. Som standard är integrerad cache aktiverad |
initial |
(Avancerat användningsfall) Inledande rubriker att börja med när begäranden skickas till Cosmos |
max |
Anger det föråldringsvärde som är associerat med begäran i Azure CosmosDB-tjänsten. För begäranden där <xref:com.azure.cosmos.ConsistencyLevel> är <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> eller <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>är svaren från den integrerade cachen garanterat inte inaktuella än det värde som anges av den här maxIntegratedCacheStaleness. När konsekvensnivån inte har angetts ignoreras den här egenskapen. Standardvärdet är null Cacheföråldring stöds i millisekunders kornighet. Allt som är mindre än millisekunder ignoreras. |
priority |
Prioritetsnivå (låg/hög) för varje begäran. Begäranden med låg prioritet begränsas alltid före alla begäranden med hög prioritet. Standardvärdet är null. Som standard har alla begäranden hög prioritet |
session |
Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer. |
Egenskapsinformation
accessCondition
Villkor som är associerade med begäran.
accessCondition?: { condition: string, type: string }
Egenskapsvärde
{ condition: string, type: string }
consistencyLevel
Konsekvensnivå som krävs av klienten.
consistencyLevel?: string
Egenskapsvärde
string
disableAutomaticIdGeneration
Inaktivera automatisk ID-generering (leder till att skaparen misslyckas om ID inte finns i definitionen)
disableAutomaticIdGeneration?: boolean
Egenskapsvärde
boolean
disableRUPerMinuteUsage
DisableRUPerMinuteUsage används för att aktivera/inaktivera kapacitet för begärandeenheter/minutkapacitet för att hantera begäran om regelbundna etablerade RU:er/sekund är slut.
disableRUPerMinuteUsage?: boolean
Egenskapsvärde
boolean
enableScriptLogging
Aktiverar eller inaktiverar loggning i JavaScript-lagrade procedurer.
enableScriptLogging?: boolean
Egenskapsvärde
boolean
indexingDirective
Anger indexeringsdirektiv (index, indexera inte .. osv.).
indexingDirective?: string
Egenskapsvärde
string
offerThroughput
Erbjudandets dataflöde har etablerats för en container i mätning av Begäranden per enhet.
offerThroughput?: number
Egenskapsvärde
number
offerType
Erbjudandetyp när du skapar dokumentcontainrar.
Det här alternativet är endast giltigt när du skapar en dokumentcontainer.
offerType?: string
Egenskapsvärde
string
populateQuotaInfo
Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer.
populateQuotaInfo?: boolean
Egenskapsvärde
boolean
postTriggerInclude
Anger vilken postutlösare som ska anropas efter åtgärden.
postTriggerInclude?: string | string[]
Egenskapsvärde
string | string[]
preTriggerInclude
Anger vad som är den förutlösare som ska anropas före åtgärden.
preTriggerInclude?: string | string[]
Egenskapsvärde
string | string[]
resourceTokenExpirySeconds
Förfallotid (i sekunder) för resurstoken som är associerad med behörighet (gäller endast för begäranden om behörigheter).
resourceTokenExpirySeconds?: number
Egenskapsvärde
number
urlConnection
(Avancerat användningsfall) Url:en som ska anslutas till.
urlConnection?: string
Egenskapsvärde
string
Information om ärvda egenskaper
abortSignal
abortSignal för att skicka till alla underliggande nätverksbegäranden som skapats av det här metodanropet. Se https://developer.mozilla.org/en-US/docs/Web/API/AbortController
Exempel
Avbryt en läsbegäran
const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
abortSignal?: AbortSignal
Egenskapsvärde
AbortSignal
ärvd frånSharedOptions.abortSignal
bypassIntegratedCache
Anger om integrerad cache ska kringgås eller aktiveras för begäran i Azure CosmosDB-tjänsten.
Standardvärdet är falskt. Som standard är integrerad cache aktiverad
bypassIntegratedCache?: boolean
Egenskapsvärde
boolean
ärvd frånSharedOptions.bypassIntegratedCache
initialHeaders
(Avancerat användningsfall) Inledande rubriker att börja med när begäranden skickas till Cosmos
initialHeaders?: CosmosHeaders
Egenskapsvärde
ärvs frånSharedOptions.initialHeaders
maxIntegratedCacheStalenessInMs
Anger det föråldringsvärde som är associerat med begäran i Azure CosmosDB-tjänsten. För begäranden där <xref:com.azure.cosmos.ConsistencyLevel> är <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> eller <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>är svaren från den integrerade cachen garanterat inte inaktuella än det värde som anges av den här maxIntegratedCacheStaleness. När konsekvensnivån inte har angetts ignoreras den här egenskapen.
Standardvärdet är null
Cacheföråldring stöds i millisekunders kornighet. Allt som är mindre än millisekunder ignoreras.
maxIntegratedCacheStalenessInMs?: number
Egenskapsvärde
number
priorityLevel
Prioritetsnivå (låg/hög) för varje begäran. Begäranden med låg prioritet begränsas alltid före alla begäranden med hög prioritet.
Standardvärdet är null. Som standard har alla begäranden hög prioritet
priorityLevel?: PriorityLevel
Egenskapsvärde
ärvs frånSharedOptions.priorityLevel
sessionToken
Aktiverar/inaktiverar hämtar dokumentcontainerkvotrelaterad statistik för läsbegäranden för dokumentcontainer.
sessionToken?: string
Egenskapsvärde
string
ärvd frånSharedOptions.sessionToken