Partager via

RequestOptions interface

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 requête.
contentResponseOnWriteEnabled

Si la valeur est false, le service ne retourne pas de charge utile dans la réponse. Il réduit la charge du réseau et du processeur en ne renvoyant pas la charge utile sur le réseau. La valeur par défaut est true.

REMARQUE : Actuellement, cette option n’est prise en charge que pour les opérations en bloc et par lots.
disableAutomaticIdGeneration

Désactiver la génération d’ID automatique (entraîne l’échec de la création si l’ID n’est pas sur la définition)
enableScriptLogging

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

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

Débit d’offre provisionné 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 conteneurs de documents pour les demandes de lecture de conteneur de documents.
postTriggerInclude

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

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

Délai d’expiration (en secondes) pour le 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

abandonnerSignal pour passer à toutes les demandes 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

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});
bypassIntegratedCache

Définit si le cache intégré doit être contourné ou activé pour la requête dans le service Azure CosmosDB.

La valeur par défaut est false. Par défaut, le cache intégré est activé
consistencyLevel

Niveau de cohérence requis par le client.
disableRUPerMinuteUsage

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

Exclut une ou plusieurs régions Azure pour l’opération.

Cette option n’est appliquée que lorsque enableEndPointDiscovery est défini sur true.
initialHeaders

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

Définit la valeur d’obsolescence associée à la requête dans le service Azure CosmosDB. Pour les demandes où l'<xref:com.azure.cosmos.ConsistencyLevel> est <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, les réponses du cache intégré ne sont pas garanties d’être plus staler que la valeur indiquée par ce 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 requêtes de faible priorité sont toujours limitées avant toutes les demandes de priorité élevée.

La valeur par défaut est Null. Par défaut, toutes les requêtes sont de priorité élevée
sessionToken

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

Débit Bucket pour une demande.

La valeur par défaut est Null. Dans ce cas, la demande peut utiliser 100% du débit de la partition.

Pour plus d’informations, consultez [Bucketing de débit Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Détails de la propriété

accessCondition

Conditions associées à la requête.

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

Valeur de propriété

{ condition: string, type: string }

contentResponseOnWriteEnabled

Si la valeur est false, le service ne retourne pas de charge utile dans la réponse. Il réduit la charge du réseau et du processeur en ne renvoyant pas la charge utile sur le réseau. La valeur par défaut est true.

REMARQUE : Actuellement, cette option n’est prise en charge que pour les opérations en bloc et par lots.

contentResponseOnWriteEnabled?: boolean

Valeur de propriété

boolean

disableAutomaticIdGeneration

Désactiver la génération d’ID automatique (entraîne l’échec de la création si l’ID n’est pas sur la définition)

disableAutomaticIdGeneration?: 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, n’indexent pas .. etc.).

indexingDirective?: string

Valeur de propriété

string

offerThroughput

Débit d’offre provisionné 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 conteneurs de documents pour les demandes de lecture de conteneur de documents.

populateQuotaInfo?: boolean

Valeur de propriété

boolean

postTriggerInclude

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

postTriggerInclude?: string | string[]

Valeur de propriété

string | string[]

preTriggerInclude

Indique ce qui 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) pour le 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

abandonnerSignal pour passer à toutes les demandes 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

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

Valeur de propriété

AbortSignal

héritée deSharedOptions.abortSignal

bypassIntegratedCache

Définit si le cache intégré doit être contourné ou activé pour la requête dans le service Azure CosmosDB.

La valeur par défaut est false. Par défaut, le cache intégré est activé

bypassIntegratedCache?: boolean

Valeur de propriété

boolean

héritée deSharedOptions.bypassIntegratedCache

consistencyLevel

Niveau de cohérence requis par le client.

consistencyLevel?: string

Valeur de propriété

string

Hérité deSharedOptions.consistencyLevel

disableRUPerMinuteUsage

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

disableRUPerMinuteUsage?: boolean

Valeur de propriété

boolean

Hérité deSharedOptions.disableRUPerMinuteUsage

excludedLocations

Exclut une ou plusieurs régions Azure pour l’opération.

Cette option n’est appliquée que lorsque enableEndPointDiscovery est défini sur true.

excludedLocations?: string[]

Valeur de propriété

string[]

Hérité deSharedOptions.excludedLocations

initialHeaders

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

initialHeaders?: CosmosHeaders

Valeur de propriété

CosmosHeaders

héritée deSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Définit la valeur d’obsolescence associée à la requête dans le service Azure CosmosDB. Pour les demandes où l'<xref:com.azure.cosmos.ConsistencyLevel> est <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, les réponses du cache intégré ne sont pas garanties d’être plus staler que la valeur indiquée par ce 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ée deSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

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

La valeur par défaut est Null. Par défaut, toutes les requêtes sont de priorité élevée

priorityLevel?: PriorityLevel

Valeur de propriété

PriorityLevel

héritée deSharedOptions.priorityLevel

sessionToken

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

sessionToken?: string

Valeur de propriété

string

héritée deSharedOptions.sessionToken

throughputBucket

Débit Bucket pour une demande.

La valeur par défaut est Null. Dans ce cas, la demande peut utiliser 100% du débit de la partition.

Pour plus d’informations, consultez [Bucketing de débit Cosmos DB](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Valeur de propriété

number

Hérité deSharedOptions.throughputBucket