Delen via

RequestOptions interface

  • Referentie
Pakket:
@azure/cosmos

Opties die kunnen worden opgegeven voor een aangevraagde aanvraag die is uitgegeven aan de Azure Cosmos DB-servers.=

Uitbreiding
SharedOptions

Eigenschappen

accessCondition

Voorwaarden die aan de aanvraag zijn gekoppeld.
consistencyLevel

Consistentieniveau dat door de client is vereist.
disableAutomaticIdGeneration

Automatische id-generatie uitschakelen (veroorzaakt dat er een fout optreedt als de id zich niet in de definitie bevindt)
disableRUPerMinuteUsage

DisableRUPerMinuteUsage wordt gebruikt om aanvraageenheden (RU's)/minuutcapaciteit in te schakelen om de aanvraag te verwerken als de reguliere ingerichte RU's/seconde uitgeput zijn.
enableScriptLogging

Hiermee schakelt u logboekregistratie in opgeslagen JavaScript-procedures in of uit.
indexingDirective

Hiermee geeft u indexeringsrichtlijnen op (index, index niet indexeren .. enzovoort).
offerThroughput

De aanbiedingsdoorvoer die is ingericht voor een container in de meting van aanvragen per eenheid.
offerType

Aanbiedingstype bij het maken van documentcontainers.

Deze optie is alleen geldig bij het maken van een documentcontainer.
populateQuotaInfo

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.
postTriggerInclude

Geeft aan wat de posttrigger is die na de bewerking moet worden aangeroepen.
preTriggerInclude

Geeft aan wat de pretrigger is die moet worden aangeroepen vóór de bewerking.
resourceTokenExpirySeconds

Verlooptijd (in seconden) voor resourcetoken dat is gekoppeld aan de machtiging (alleen van toepassing op aanvragen voor machtigingen).
urlConnection

(Geavanceerd gebruiksvoorbeeld) De URL waarmee u verbinding wilt maken.

Overgenomen eigenschappen

abortSignal

abortSignal om alle onderliggende netwerkaanvragen door te geven die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController

voorbeeld van

Een leesaanvraag annuleren

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

Sets als geïntegreerde cache moet worden overgeslagen of ingeschakeld voor de aanvraag in de Azure CosmosDB-service.

De standaardwaarde is onwaar. Standaard is geïntegreerde cache ingeschakeld
initialHeaders

(Geavanceerd gebruiksvoorbeeld) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos
maxIntegratedCacheStalenessInMs

Hiermee stelt u de verouderingswaarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, zijn reacties van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde die wordt aangegeven door deze maxIntegratedCacheStaleness. Als het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd.

De standaardwaarde is null

Cache veroudering wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden, wordt genegeerd.
priorityLevel

Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt voordat aanvragen met een hoge prioriteit worden ingediend.

De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit
sessionToken

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.

Eigenschapdetails

accessCondition

Voorwaarden die aan de aanvraag zijn gekoppeld.

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

Waarde van eigenschap

{ condition: string, type: string }

consistencyLevel

Consistentieniveau dat door de client is vereist.

consistencyLevel?: string

Waarde van eigenschap

string

disableAutomaticIdGeneration

Automatische id-generatie uitschakelen (veroorzaakt dat er een fout optreedt als de id zich niet in de definitie bevindt)

disableAutomaticIdGeneration?: boolean

Waarde van eigenschap

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage wordt gebruikt om aanvraageenheden (RU's)/minuutcapaciteit in te schakelen om de aanvraag te verwerken als de reguliere ingerichte RU's/seconde uitgeput zijn.

disableRUPerMinuteUsage?: boolean

Waarde van eigenschap

boolean

enableScriptLogging

Hiermee schakelt u logboekregistratie in opgeslagen JavaScript-procedures in of uit.

enableScriptLogging?: boolean

Waarde van eigenschap

boolean

indexingDirective

Hiermee geeft u indexeringsrichtlijnen op (index, index niet indexeren .. enzovoort).

indexingDirective?: string

Waarde van eigenschap

string

offerThroughput

De aanbiedingsdoorvoer die is ingericht voor een container in de meting van aanvragen per eenheid.

offerThroughput?: number

Waarde van eigenschap

number

offerType

Aanbiedingstype bij het maken van documentcontainers.

Deze optie is alleen geldig bij het maken van een documentcontainer.

offerType?: string

Waarde van eigenschap

string

populateQuotaInfo

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.

populateQuotaInfo?: boolean

Waarde van eigenschap

boolean

postTriggerInclude

Geeft aan wat de posttrigger is die na de bewerking moet worden aangeroepen.

postTriggerInclude?: string | string[]

Waarde van eigenschap

string | string[]

preTriggerInclude

Geeft aan wat de pretrigger is die moet worden aangeroepen vóór de bewerking.

preTriggerInclude?: string | string[]

Waarde van eigenschap

string | string[]

resourceTokenExpirySeconds

Verlooptijd (in seconden) voor resourcetoken dat is gekoppeld aan de machtiging (alleen van toepassing op aanvragen voor machtigingen).

resourceTokenExpirySeconds?: number

Waarde van eigenschap

number

urlConnection

(Geavanceerd gebruiksvoorbeeld) De URL waarmee u verbinding wilt maken.

urlConnection?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

abortSignal

abortSignal om alle onderliggende netwerkaanvragen door te geven die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController

voorbeeld van

Een leesaanvraag annuleren

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

abortSignal?: AbortSignal

Waarde van eigenschap

AbortSignal

overgenomen vanSharedOptions.abortSignal-

bypassIntegratedCache

Sets als geïntegreerde cache moet worden overgeslagen of ingeschakeld voor de aanvraag in de Azure CosmosDB-service.

De standaardwaarde is onwaar. Standaard is geïntegreerde cache ingeschakeld

bypassIntegratedCache?: boolean

Waarde van eigenschap

boolean

overgenomen vanSharedOptions.bypassIntegratedCache

initialHeaders

(Geavanceerd gebruiksvoorbeeld) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos

initialHeaders?: CosmosHeaders

Waarde van eigenschap

CosmosHeaders

overgenomen vanSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Hiermee stelt u de verouderingswaarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, zijn reacties van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde die wordt aangegeven door deze maxIntegratedCacheStaleness. Als het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd.

De standaardwaarde is null

Cache veroudering wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden, wordt genegeerd.

maxIntegratedCacheStalenessInMs?: number

Waarde van eigenschap

number

overgenomen vanSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt voordat aanvragen met een hoge prioriteit worden ingediend.

De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit

priorityLevel?: PriorityLevel

Waarde van eigenschap

PriorityLevel

overgenomen vanSharedOptions.priorityLevel

sessionToken

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.

sessionToken?: string

Waarde van eigenschap

string

overgenomen vanSharedOptions.sessionToken