RequestOptions interface
Možnosti, které lze zadat pro požadované vydané servery Azure Cosmos DB.=
- Extends
Vlastnosti
access |
Podmínky přidružené k žádosti. |
consistency |
Úroveň konzistence vyžadovaná klientem |
disable |
Zakázání automatického generování ID (způsobí selhání vytváření, pokud id není v definici) |
disable |
DisableRUPerMinuteUsage se používá k povolení nebo zakázání kapacity jednotek žádostí (RU) nebo minut, aby se žádost obsloužila, pokud dojde k vyčerpání pravidelných zřízených RU za sekundu. |
enable |
Povolí nebo zakáže protokolování v uložených procedurách JavaScriptu. |
indexing |
Určuje direktivy indexování (index, ne index atd.). |
offer |
Nabídka propustnosti zřízená pro kontejner v měření požadavků na jednotku. |
offer |
Typ nabídky při vytváření kontejnerů dokumentů Tato možnost je platná pouze při vytváření kontejneru dokumentů. |
populate |
Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů. |
post |
Označuje, co je trigger post, který se má vyvolat po operaci. |
pre |
Určuje, co je pre trigger, který se má vyvolat před operací. |
resource |
Doba vypršení platnosti tokenu prostředku přidruženého k oprávnění (platí jenom pro žádosti o oprávnění). |
url |
(Případ rozšířeného použití) Adresa URL, ke které se chcete připojit. |
Zděděné vlastnosti
abort |
abortSignal předat všem podkladovým síťovým požadavkům vytvořeným tímto voláním metody. Viz https://developer.mozilla.org/en-US/docs/Web/API/AbortController příklad Zrušení žádosti o čtení
|
bypass |
Nastaví, jestli se má integrovaná mezipaměť obejít nebo povolit pro požadavek ve službě Azure CosmosDB. Výchozí hodnota je false. Ve výchozím nastavení je povolená integrovaná mezipaměť. |
initial |
(Případ rozšířeného použití) Počáteční hlavičky, se kterými začnete při odesílání požadavků do Cosmos |
max |
Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, kde je <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, jsou zaručeny, že odpovědi z integrované mezipaměti nebudou zastaralé než hodnota určená tímto maxIntegratedCacheStaleness. Pokud úroveň konzistence není nastavena, bude tato vlastnost ignorována. Výchozí hodnota je null Zastaralost mezipaměti se podporuje v milisekundách členitosti. Bude ignorováno cokoli menšího než milisekundy. |
priority |
Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou. Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu. |
session |
Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů. |
Podrobnosti vlastnosti
accessCondition
Podmínky přidružené k žádosti.
accessCondition?: { condition: string, type: string }
Hodnota vlastnosti
{ condition: string, type: string }
consistencyLevel
Úroveň konzistence vyžadovaná klientem
consistencyLevel?: string
Hodnota vlastnosti
string
disableAutomaticIdGeneration
Zakázání automatického generování ID (způsobí selhání vytváření, pokud id není v definici)
disableAutomaticIdGeneration?: boolean
Hodnota vlastnosti
boolean
disableRUPerMinuteUsage
DisableRUPerMinuteUsage se používá k povolení nebo zakázání kapacity jednotek žádostí (RU) nebo minut, aby se žádost obsloužila, pokud dojde k vyčerpání pravidelných zřízených RU za sekundu.
disableRUPerMinuteUsage?: boolean
Hodnota vlastnosti
boolean
enableScriptLogging
Povolí nebo zakáže protokolování v uložených procedurách JavaScriptu.
enableScriptLogging?: boolean
Hodnota vlastnosti
boolean
indexingDirective
Určuje direktivy indexování (index, ne index atd.).
indexingDirective?: string
Hodnota vlastnosti
string
offerThroughput
Nabídka propustnosti zřízená pro kontejner v měření požadavků na jednotku.
offerThroughput?: number
Hodnota vlastnosti
number
offerType
Typ nabídky při vytváření kontejnerů dokumentů
Tato možnost je platná pouze při vytváření kontejneru dokumentů.
offerType?: string
Hodnota vlastnosti
string
populateQuotaInfo
Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.
populateQuotaInfo?: boolean
Hodnota vlastnosti
boolean
postTriggerInclude
Označuje, co je trigger post, který se má vyvolat po operaci.
postTriggerInclude?: string | string[]
Hodnota vlastnosti
string | string[]
preTriggerInclude
Určuje, co je pre trigger, který se má vyvolat před operací.
preTriggerInclude?: string | string[]
Hodnota vlastnosti
string | string[]
resourceTokenExpirySeconds
Doba vypršení platnosti tokenu prostředku přidruženého k oprávnění (platí jenom pro žádosti o oprávnění).
resourceTokenExpirySeconds?: number
Hodnota vlastnosti
number
urlConnection
(Případ rozšířeného použití) Adresa URL, ke které se chcete připojit.
urlConnection?: string
Hodnota vlastnosti
string
Podrobnosti zděděných vlastností
abortSignal
abortSignal předat všem podkladovým síťovým požadavkům vytvořeným tímto voláním metody. Viz https://developer.mozilla.org/en-US/docs/Web/API/AbortController
příklad
Zrušení žádosti o čtení
const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
abortSignal?: AbortSignal
Hodnota vlastnosti
AbortSignal
zděděno zeSharedOptions.abortSignal
bypassIntegratedCache
Nastaví, jestli se má integrovaná mezipaměť obejít nebo povolit pro požadavek ve službě Azure CosmosDB.
Výchozí hodnota je false. Ve výchozím nastavení je povolená integrovaná mezipaměť.
bypassIntegratedCache?: boolean
Hodnota vlastnosti
boolean
zděděno zeSharedOptions.bypassIntegratedCache
initialHeaders
(Případ rozšířeného použití) Počáteční hlavičky, se kterými začnete při odesílání požadavků do Cosmos
initialHeaders?: CosmosHeaders
Hodnota vlastnosti
zděděno zeSharedOptions.initialHeaders
maxIntegratedCacheStalenessInMs
Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, kde je <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, jsou zaručeny, že odpovědi z integrované mezipaměti nebudou zastaralé než hodnota určená tímto maxIntegratedCacheStaleness. Pokud úroveň konzistence není nastavena, bude tato vlastnost ignorována.
Výchozí hodnota je null
Zastaralost mezipaměti se podporuje v milisekundách členitosti. Bude ignorováno cokoli menšího než milisekundy.
maxIntegratedCacheStalenessInMs?: number
Hodnota vlastnosti
number
priorityLevel
Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou.
Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.
priorityLevel?: PriorityLevel
Hodnota vlastnosti
zděděno zeSharedOptions.priorityLevel
sessionToken
Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.
sessionToken?: string
Hodnota vlastnosti
string
zděděno zeSharedOptions.sessionToken