RequestOptions interface

Balíček:

@azure/cosmos

Možnosti, které je možné zadat pro požadovaný server vydaný pro servery Azure Cosmos DB.=

Extends

SharedOptions

Vlastnosti

accessCondition	Podmínky přidružené k požadavku.
consistencyLevel	Úroveň konzistence vyžadovaná klientem.
disableAutomaticIdGeneration	Zakázat automatické generování ID (způsobí selhání vytváření, pokud ID není v definici)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage se používá k povolení/zakázání kapacity žádostí (RU)/minutu, aby bylo možné požadavek obsloužit, pokud dojde k vyčerpání pravidelných zřízených RU za sekundu.
enableScriptLogging	Povolí nebo zakáže protokolování v uložených procedurách JavaScriptu.
indexingDirective	Určuje direktivy indexování (index, neindexovat atd.).
offerThroughput	Nabídka propustnosti zřízená pro kontejner v měrné hodnotě Požadavků na jednotku
offerType	Typ nabídky při vytváření kontejnerů dokumentů Tato možnost je platná pouze při vytváření kontejneru dokumentů.
populateQuotaInfo	Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro žádosti o čtení kontejneru dokumentů.
postTriggerInclude	Určuje, jaký je trigger post, který se má vyvolat po operaci.
preTriggerInclude	Určuje, jaký aktivační událost se má před operací vyvolat.
resourceTokenExpirySeconds	Doba vypršení platnosti (v sekundách) tokenu prostředku přidruženého k oprávněním (platí jenom pro požadavky na oprávnění).
urlConnection	(Upřesňující případ použití) Adresa URL, ke které se chcete připojit.

Zděděné vlastnosti

abortSignal	abortSignal pro předání do všech podkladových síťových požadavků vytvořených voláním této 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()
initialHeaders	(Upřesňující případ použití) Počáteční hlavičky, které se mají začít používat při odesílání požadavků do Služby Cosmos
maxIntegratedCacheStalenessInMs	Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, u kterých <xref:com.azure.cosmos.ConsistencyLevel> je <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, je zaručeno, že odpovědi z integrované mezipaměti nebudou zastaralá než hodnota uvedená tímto maxIntegratedCacheStaleness. Pokud není nastavena úroveň konzistence, je tato vlastnost ignorována. Výchozí hodnota je null. Nekalost mezipaměti se podporuje v milisekundách. Cokoli menšího než milisekundy bude ignorováno.
priorityLevel	Úroveň priority (nízká/vysoká) pro každou žádost. Požadavky s nízkou prioritou se vždy omezují před požadavky s vysokou prioritou. Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.
sessionToken	Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro žádosti o čtení kontejneru dokumentů.

Podrobnosti vlastnosti

accessCondition

Podmínky přidružené k požadavku.

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

Hodnota vlastnosti

{ condition: string, type: string }

consistencyLevel

Úroveň konzistence vyžadovaná klientem.

consistencyLevel?: string

Hodnota vlastnosti

string

disableAutomaticIdGeneration

Zakázat automatické 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í/zakázání kapacity žádostí (RU)/minutu, aby bylo možné požadavek obsloužit, 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, neindexovat atd.).

indexingDirective?: string

Hodnota vlastnosti

string

offerThroughput

Nabídka propustnosti zřízená pro kontejner v měrné hodnotě 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 žádosti o čtení kontejneru dokumentů.

populateQuotaInfo?: boolean

Hodnota vlastnosti

boolean

postTriggerInclude

Určuje, jaký je trigger post, který se má vyvolat po operaci.

postTriggerInclude?: string | string[]

Hodnota vlastnosti

string | string[]

preTriggerInclude

Určuje, jaký aktivační událost se má před operací vyvolat.

preTriggerInclude?: string | string[]

Hodnota vlastnosti

string | string[]

resourceTokenExpirySeconds

Doba vypršení platnosti (v sekundách) tokenu prostředku přidruženého k oprávněním (platí jenom pro požadavky na oprávnění).

resourceTokenExpirySeconds?: number

Hodnota vlastnosti

number

urlConnection

(Upřesňující případ použití) Adresa URL, ke které se chcete připojit.

urlConnection?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

abortSignal

abortSignal pro předání do všech podkladových síťových požadavků vytvořených voláním této 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

initialHeaders

(Upřesňující případ použití) Počáteční hlavičky, které se mají začít používat při odesílání požadavků do Služby Cosmos

initialHeaders?: CosmosHeaders

Hodnota vlastnosti

CosmosHeaders

Zděděno zeSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, u kterých <xref:com.azure.cosmos.ConsistencyLevel> je <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, je zaručeno, že odpovědi z integrované mezipaměti nebudou zastaralá než hodnota uvedená tímto maxIntegratedCacheStaleness. Pokud není nastavena úroveň konzistence, je tato vlastnost ignorována.

Výchozí hodnota je null.

Nekalost mezipaměti se podporuje v milisekundách. Cokoli menšího než milisekundy bude ignorováno.

maxIntegratedCacheStalenessInMs?: number

Hodnota vlastnosti

number

Zděděno zeSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Úroveň priority (nízká/vysoká) pro každou žádost. Požadavky s nízkou prioritou se vždy omezují před 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

PriorityLevel

Zděděno zeSharedOptions.priorityLevel

sessionToken

Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro žádosti o čtení kontejneru dokumentů.

sessionToken?: string

Hodnota vlastnosti

string

Zděděno zeSharedOptions.sessionToken