Partager via

RequestOptions interface

  • Référence
Paquet:
@azure/cosmos

Options qui peuvent être spécifiées pour une demande émise sur les serveurs Azure Cosmos DB.=

Extends
SharedOptions

Propriétés

accessCondition

Conditions associées à la demande.
consistencyLevel

Niveau de cohérence requis par le client.
disableAutomaticIdGeneration

Désactiver la génération automatique d’id (entraîne l’échec des créations si l’id n’est pas sur la définition)
disableRUPerMinuteUsage

DisableRUPerMinuteUsage permet d’activer/désactiver la capacité unités de requête(RU)/minute pour traiter la requête si les unités de requête approvisionnées/seconde régulières sont épuisées.
enableScriptLogging

Active ou désactive la journalisation dans les procédures stockées JavaScript.
indexingDirective

Spécifie les directives d’indexation (index, ne pas indexer, etc.).
offerThroughput

Débit de l’offre approvisionné pour un conteneur dans la mesure des requêtes par unité.
offerType

Type d’offre lors de la création de conteneurs de documents.

Cette option est valide uniquement lors de la création d’un conteneur de documents.
populateQuotaInfo

Active/désactive l’obtention des statistiques relatives au quota de conteneur de documents pour les demandes de lecture de conteneur de documents.
postTriggerInclude

Indique quel est le post-déclencheur à appeler après l’opération.
preTriggerInclude

Indique quel est le pré-déclencheur à appeler avant l’opération.
resourceTokenExpirySeconds

Délai d’expiration (en secondes) du jeton de ressource associé à l’autorisation (applicable uniquement aux demandes d’autorisations).
urlConnection

(Cas d’usage avancé) URL à laquelle se connecter.

Propriétés héritées

abortSignal

abortSignal pour passer à toutes les requêtes réseau sous-jacentes créées par cet appel de méthode. Voir https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exemple

Annuler une demande de lecture

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

(Cas d’usage avancé) En-têtes initiaux à utiliser lors de l’envoi de demandes à Cosmos
maxIntegratedCacheStalenessInMs

Définit la valeur d’obsolescence associée à la requête dans le service Azure CosmosDB. Pour les <xref:com.azure.cosmos.ConsistencyLevel> demandes pour lesquelles est <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, les réponses du cache intégré ne sont pas plus staler que la valeur indiquée par cette valeur maxIntegratedCacheStaleness. Lorsque le niveau de cohérence n’est pas défini, cette propriété est ignorée.

La valeur par défaut est null

L’obsolescence du cache est prise en charge en millisecondes de granularité. Tout ce qui est inférieur à millisecondes est ignoré.
priorityLevel

Niveau de priorité (faible/élevé) pour chaque requête. Les demandes de faible priorité sont toujours limitées avant toute demande de priorité élevée.

La valeur par défaut est null. Par défaut, toutes les demandes sont de priorité élevée
sessionToken

Active/désactive l’obtention des statistiques relatives au quota de conteneur de documents pour les demandes de lecture de conteneur de documents.

Détails de la propriété

accessCondition

Conditions associées à la demande.

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

Valeur de propriété

{ condition: string, type: string }

consistencyLevel

Niveau de cohérence requis par le client.

consistencyLevel?: string

Valeur de propriété

string

disableAutomaticIdGeneration

Désactiver la génération automatique d’id (entraîne l’échec des créations si l’id n’est pas sur la définition)

disableAutomaticIdGeneration?: boolean

Valeur de propriété

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage permet d’activer/désactiver la capacité unités de requête(RU)/minute pour traiter la requête si les unités de requête approvisionnées/seconde régulières sont épuisées.

disableRUPerMinuteUsage?: boolean

Valeur de propriété

boolean

enableScriptLogging

Active ou désactive la journalisation dans les procédures stockées JavaScript.

enableScriptLogging?: boolean

Valeur de propriété

boolean

indexingDirective

Spécifie les directives d’indexation (index, ne pas indexer, etc.).

indexingDirective?: string

Valeur de propriété

string

offerThroughput

Débit de l’offre approvisionné pour un conteneur dans la mesure des requêtes par unité.

offerThroughput?: number

Valeur de propriété

number

offerType

Type d’offre lors de la création de conteneurs de documents.

Cette option est valide uniquement lors de la création d’un conteneur de documents.

offerType?: string

Valeur de propriété

string

populateQuotaInfo

Active/désactive l’obtention des statistiques relatives au quota de conteneur de documents pour les demandes de lecture de conteneur de documents.

populateQuotaInfo?: boolean

Valeur de propriété

boolean

postTriggerInclude

Indique quel est le post-déclencheur à appeler après l’opération.

postTriggerInclude?: string | string[]

Valeur de propriété

string | string[]

preTriggerInclude

Indique quel est le pré-déclencheur à appeler avant l’opération.

preTriggerInclude?: string | string[]

Valeur de propriété

string | string[]

resourceTokenExpirySeconds

Délai d’expiration (en secondes) du jeton de ressource associé à l’autorisation (applicable uniquement aux demandes d’autorisations).

resourceTokenExpirySeconds?: number

Valeur de propriété

number

urlConnection

(Cas d’usage avancé) URL à laquelle se connecter.

urlConnection?: string

Valeur de propriété

string

Détails de la propriété héritée

abortSignal

abortSignal pour passer à toutes les requêtes réseau sous-jacentes créées par cet appel de méthode. Voir https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exemple

Annuler une demande de lecture

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

abortSignal?: AbortSignal

Valeur de propriété

AbortSignal

Hérité deSharedOptions.abortSignal

initialHeaders

(Cas d’usage avancé) En-têtes initiaux à utiliser lors de l’envoi de demandes à Cosmos

initialHeaders?: CosmosHeaders

Valeur de propriété

CosmosHeaders

Hérité deSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Définit la valeur d’obsolescence associée à la requête dans le service Azure CosmosDB. Pour les <xref:com.azure.cosmos.ConsistencyLevel> demandes pour lesquelles est <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, les réponses du cache intégré ne sont pas plus staler que la valeur indiquée par cette valeur maxIntegratedCacheStaleness. Lorsque le niveau de cohérence n’est pas défini, cette propriété est ignorée.

La valeur par défaut est null

L’obsolescence du cache est prise en charge en millisecondes de granularité. Tout ce qui est inférieur à millisecondes est ignoré.

maxIntegratedCacheStalenessInMs?: number

Valeur de propriété

number

Hérité deSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Niveau de priorité (faible/élevé) pour chaque requête. Les demandes de faible priorité sont toujours limitées avant toute demande de priorité élevée.

La valeur par défaut est null. Par défaut, toutes les demandes sont de priorité élevée

priorityLevel?: PriorityLevel

Valeur de propriété

PriorityLevel

Hérité deSharedOptions.priorityLevel

sessionToken

Active/désactive l’obtention des statistiques relatives au quota de conteneur de documents pour les demandes de lecture de conteneur de documents.

sessionToken?: string

Valeur de propriété

string

Hérité deSharedOptions.sessionToken