RequestOptions interface
Az Azure Cosmos DB-kiszolgálóknak kiadott kért kiadáshoz megadható beállítások.=
- Extends
Tulajdonságok
access |
A kérelemhez társított feltételek. |
consistency |
Az ügyfél által megkövetelt konzisztenciaszint. |
disable |
Az automatikus azonosítólétrehozás letiltása (a létrehozás sikertelen lesz, ha az azonosító nem szerepel a definícióban) |
disable |
A DisableRUPerMinuteUsage a kérelemegységek(kérelemegységek)/perc kapacitás engedélyezésére/letiltására szolgál a kérés kiszolgálásához, ha a rendszeres kiosztott kérelemegységek/másodpercek kimerültek. |
enable |
Engedélyezi vagy letiltja a naplózást a JavaScript által tárolt eljárásokban. |
indexing |
Indexelési irányelveket (indexelés, indexelés stb.) határoz meg. |
offer |
Egy tárolóhoz kiosztott ajánlat átviteli sebessége a Requests-per-Unit mértékegységben. |
offer |
Ajánlat típusa dokumentumtárolók létrehozásakor. Ez a beállítás csak dokumentumtároló létrehozásakor érvényes. |
populate |
Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez. |
post |
Azt jelzi, hogy mi az a post trigger, amelyet a művelet után meg kell hívni. |
pre |
Azt jelzi, hogy mi a művelet előtt meghívandó eseményindító. |
resource |
Az engedélyhez társított erőforrás-jogkivonat lejárati ideje (másodpercben) (csak az engedélykérésekre vonatkozik). |
url |
(Speciális használati eset) A csatlakozáshoz használt URL-cím. |
Örökölt tulajdonságok
abort |
abortSignal az ezzel a metódushívással létrehozott összes mögöttes hálózati kérésnek való továbbításhoz. Lásd: https://developer.mozilla.org/en-US/docs/Web/API/AbortController Példa Olvasási kérelem megszakítása
|
initial |
(Speciális használati eset) A kezdeti fejlécek, amelyeket a kérések Cosmosba való küldésekor kell kezdeni |
max |
Beállítja a kérelemhez társított elavultsági értéket az Azure CosmosDB szolgáltatásban. Az olyan kérések esetében, ahol a vagy <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, az <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> integrált gyorsítótárból érkező válaszok garantáltan nem lesznek elavultak, mint a maxIntegratedCacheStaleness által jelzett érték. Ha a konzisztenciaszint nincs beállítva, a rendszer figyelmen kívül hagyja ezt a tulajdonságot. Az alapértelmezett érték null A gyorsítótár elavultsága ezredmásodpercben támogatott. A rendszer figyelmen kívül hagy minden ezredmásodpercnél kisebbet. |
priority |
Prioritási szint (alacsony/magas) minden kéréshez. Az alacsony prioritású kérések mindig szabályozva vannak a magas prioritású kérések előtt. Az alapértelmezett érték null. Alapértelmezés szerint minden kérés magas prioritású |
session |
Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez. |
Tulajdonság adatai
accessCondition
A kérelemhez társított feltételek.
accessCondition?: { condition: string, type: string }
Tulajdonság értéke
{ condition: string, type: string }
consistencyLevel
Az ügyfél által megkövetelt konzisztenciaszint.
consistencyLevel?: string
Tulajdonság értéke
string
disableAutomaticIdGeneration
Az automatikus azonosítólétrehozás letiltása (a létrehozás sikertelen lesz, ha az azonosító nem szerepel a definícióban)
disableAutomaticIdGeneration?: boolean
Tulajdonság értéke
boolean
disableRUPerMinuteUsage
A DisableRUPerMinuteUsage a kérelemegységek(kérelemegységek)/perc kapacitás engedélyezésére/letiltására szolgál a kérés kiszolgálásához, ha a rendszeres kiosztott kérelemegységek/másodpercek kimerültek.
disableRUPerMinuteUsage?: boolean
Tulajdonság értéke
boolean
enableScriptLogging
Engedélyezi vagy letiltja a naplózást a JavaScript által tárolt eljárásokban.
enableScriptLogging?: boolean
Tulajdonság értéke
boolean
indexingDirective
Indexelési irányelveket (indexelés, indexelés stb.) határoz meg.
indexingDirective?: string
Tulajdonság értéke
string
offerThroughput
Egy tárolóhoz kiosztott ajánlat átviteli sebessége a Requests-per-Unit mértékegységben.
offerThroughput?: number
Tulajdonság értéke
number
offerType
Ajánlat típusa dokumentumtárolók létrehozásakor.
Ez a beállítás csak dokumentumtároló létrehozásakor érvényes.
offerType?: string
Tulajdonság értéke
string
populateQuotaInfo
Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez.
populateQuotaInfo?: boolean
Tulajdonság értéke
boolean
postTriggerInclude
Azt jelzi, hogy mi az a post trigger, amelyet a művelet után meg kell hívni.
postTriggerInclude?: string | string[]
Tulajdonság értéke
string | string[]
preTriggerInclude
Azt jelzi, hogy mi a művelet előtt meghívandó eseményindító.
preTriggerInclude?: string | string[]
Tulajdonság értéke
string | string[]
resourceTokenExpirySeconds
Az engedélyhez társított erőforrás-jogkivonat lejárati ideje (másodpercben) (csak az engedélykérésekre vonatkozik).
resourceTokenExpirySeconds?: number
Tulajdonság értéke
number
urlConnection
(Speciális használati eset) A csatlakozáshoz használt URL-cím.
urlConnection?: string
Tulajdonság értéke
string
Örökölt tulajdonság részletei
abortSignal
abortSignal az ezzel a metódushívással létrehozott összes mögöttes hálózati kérésnek való továbbításhoz. Lásd: https://developer.mozilla.org/en-US/docs/Web/API/AbortController
Példa
Olvasási kérelem megszakítása
const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
abortSignal?: AbortSignal
Tulajdonság értéke
AbortSignal
ÖrököltsharedOptions.abortSignal
initialHeaders
(Speciális használati eset) A kezdeti fejlécek, amelyeket a kérések Cosmosba való küldésekor kell kezdeni
initialHeaders?: CosmosHeaders
Tulajdonság értéke
ÖrököltsharedOptions.initialHeaders
maxIntegratedCacheStalenessInMs
Beállítja a kérelemhez társított elavultsági értéket az Azure CosmosDB szolgáltatásban. Az olyan kérések esetében, ahol a vagy <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, az <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> integrált gyorsítótárból érkező válaszok garantáltan nem lesznek elavultak, mint a maxIntegratedCacheStaleness által jelzett érték. Ha a konzisztenciaszint nincs beállítva, a rendszer figyelmen kívül hagyja ezt a tulajdonságot.
Az alapértelmezett érték null
A gyorsítótár elavultsága ezredmásodpercben támogatott. A rendszer figyelmen kívül hagy minden ezredmásodpercnél kisebbet.
maxIntegratedCacheStalenessInMs?: number
Tulajdonság értéke
number
priorityLevel
Prioritási szint (alacsony/magas) minden kéréshez. Az alacsony prioritású kérések mindig szabályozva vannak a magas prioritású kérések előtt.
Az alapértelmezett érték null. Alapértelmezés szerint minden kérés magas prioritású
priorityLevel?: PriorityLevel
Tulajdonság értéke
Örökölt a SharedOptions.priorityLevelfájlból
sessionToken
Engedélyezi/letiltja a dokumentumtárolók kvótával kapcsolatos statisztikáinak lekérését a dokumentumtároló olvasási kérelmeihez.
sessionToken?: string
Tulajdonság értéke
string
Örökölt a SharedOptions.sessionTokenfájlból