RequestOptions interface
Options qui peuvent être spécifiées pour une demande émise sur les serveurs Azure Cosmos DB.=
- Extends
Propriétés
access |
Conditions associées à la requête. |
consistency |
Niveau de cohérence requis par le client. |
disable |
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) |
disable |
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. |
enable |
Active ou désactive la journalisation dans les procédures stockées JavaScript. |
indexing |
Spécifie les directives d’indexation (index, n’indexent pas .. etc.). |
offer |
Débit d’offre provisionné pour un conteneur dans la mesure des requêtes par unité. |
offer |
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. |
populate |
Active/désactive l’obtention des statistiques relatives au quota de conteneurs de documents pour les demandes de lecture de conteneur de documents. |
post |
Indique quel est le déclencheur de publication à appeler après l’opération. |
pre |
Indique ce qui est le pré déclencheur à appeler avant l’opération. |
resource |
Délai d’expiration (en secondes) pour le jeton de ressource associé à l’autorisation (applicable uniquement aux demandes d’autorisations). |
url |
(Cas d’usage avancé) URL à laquelle se connecter. |
Propriétés héritées
abort |
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 de Annuler une demande de lecture
|
bypass |
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é |
initial |
(Cas d’usage avancé) En-têtes initiaux à démarrer lors de l’envoi de requêtes à Cosmos |
max |
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é. |
priority |
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 |
session |
Active/désactive l’obtention des statistiques relatives au quota de conteneurs de documents pour les demandes de lecture de conteneur de documents. |
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 }
consistencyLevel
Niveau de cohérence requis par le client.
consistencyLevel?: string
Valeur de propriété
string
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
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
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 de
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é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
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é
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
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é
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