CosmosQueryRequestOptions Classe
- java.
lang. Object - com.
azure. cosmos. models. CosmosQueryRequestOptions
- com.
public class CosmosQueryRequestOptions
Spécifie les options associées aux méthodes de requête (opérations d’énumération) dans le service de base de données Azure Cosmos DB.
| Constructeur | Description |
|---|---|
|
Cosmos |
Instancie une nouvelle option de requête. |
| Modificateur et type | Méthode et description |
|---|---|
|
Consistency |
get Obtient le niveau de cohérence requis pour la demande. |
|
Dedicated |
get Obtient les options de demande de passerelle dédiée |
| List<String> |
get Obtient la liste des régions à exclure pour la requête/les nouvelles tentatives. |
|
Feed |
get Obtient le FeedRange |
| int |
get Obtient le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle. |
| int |
get Obtient le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle. |
|
Partition |
get Obtient la clé de partition utilisée pour identifier la partition cible de la requête actuelle. |
| int |
get Obtient l’option de requête InKb limite |
| String |
get Obtient le jeton de session à utiliser avec la cohérence de session. |
| Duration |
get Obtient le seuil |
| String |
get Obtenir le nom du groupe de contrôle de débit. |
| boolean |
is Obtient les métriques d’index |
| boolean |
is Obtient l’option permettant d’activer le remplissage des métriques de requête. |
| Boolean |
is Obtient l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins demandés. |
|
Cosmos |
set Définit le niveau de cohérence requis pour la demande. |
|
Cosmos |
set Définit le CosmosEndToEndOperationLatencyPolicyConfig à utiliser pour la demande. |
|
Cosmos |
set Définit les options de demande de passerelle dédiée |
|
Cosmos |
set Permet de remplacer les seuils de diagnostic pour une opération spécifique. |
|
Cosmos |
set Liste des régions à exclure pour la demande/les nouvelles tentatives. |
|
Cosmos |
set Définit le FeedRange que nous voulons interroger |
|
Cosmos |
set Définit les métriques |
|
Cosmos |
set Définit le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle. |
|
Cosmos |
set Définit le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle. |
|
Cosmos |
set Définit la clé de partition utilisée pour identifier la partition cible de la requête actuelle. |
|
Cosmos |
set Définit l’option permettant d’activer/désactiver l’obtention de métriques relatives à l’exécution de requête sur les demandes de requête d’élément. |
|
Cosmos |
set Définit le nom de la requête logique : cet identificateur est utilisé uniquement pour les métriques et les journaux afin de distinguer différentes requêtes dans les données de télémétrie. |
|
Cosmos |
set Définit l’option |
|
Cosmos |
set Définit l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins d’accès demandés. |
|
Cosmos |
set Définit le jeton de session à utiliser avec la cohérence de session. |
|
Cosmos |
set Définit le seuil |
|
Cosmos |
set Définissez le nom du groupe de contrôle de débit. |
Méthodes héritées de java.lang.Object
CosmosQueryRequestOptions
public CosmosQueryRequestOptions()
Instancie une nouvelle option de requête.
getConsistencyLevel
public ConsistencyLevel getConsistencyLevel()
Obtient le niveau de cohérence requis pour la demande.
Returns:
getDedicatedGatewayRequestOptions
public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()
Obtient les options de demande de passerelle dédiée
Returns:
getExcludedRegions
public List
Obtient la liste des régions à exclure pour la requête/les nouvelles tentatives. Ces régions sont exclues de la liste des régions par défaut.
Returns:
getMaxBufferedItemCount
public int getMaxBufferedItemCount()
Obtient le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle.
Returns:
getMaxDegreeOfParallelism
public int getMaxDegreeOfParallelism()
Obtient le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle.
Returns:
getPartitionKey
public PartitionKey getPartitionKey()
Obtient la clé de partition utilisée pour identifier la partition cible de la requête actuelle.
Returns:
getResponseContinuationTokenLimitInKb
public int getResponseContinuationTokenLimitInKb()
Obtient l’option de requête ResponseContinuationTokenLimitInKb pour les demandes de requête d’élément dans le service Azure Cosmos DB. Si ce n’est pas déjà défini, retourne 0.
ResponseContinuationTokenLimitInKb est utilisé pour limiter la longueur du jeton de continuation dans la réponse de requête. Les valeurs valides sont >= 1.
Returns:
getSessionToken
public String getSessionToken()
Obtient le jeton de session à utiliser avec la cohérence de session.
Returns:
getThresholdForDiagnosticsOnTracer
public Duration getThresholdForDiagnosticsOnTracer()
Obtient le thresholdForDiagnosticsOnTracer, si la latence sur l’opération de requête est supérieure à ce diagnostics sera envoyé à l’exportateur de télémétrie ouvert en tant qu’événements dans l’étendue de suivi de l’API CRUD de bout en bout. La valeur par défaut est de 500 ms.
Returns:
getThroughputControlGroupName
public String getThroughputControlGroupName()
Obtenir le nom du groupe de contrôle de débit.
Returns:
isIndexMetricsEnabled
public boolean isIndexMetricsEnabled()
Obtient indexMetricsEnabled, qui est utilisé pour obtenir les métriques d’index afin de comprendre comment le moteur de requête a utilisé des index existants et peut utiliser de nouveaux index potentiels. Les résultats s’affichent dans QueryMetrics. Notez que ces options entraînent une surcharge. Elles doivent donc être activées lors du débogage des requêtes lentes.
Returns:
isQueryMetricsEnabled
public boolean isQueryMetricsEnabled()
Obtient l’option permettant d’activer le remplissage des métriques de requête. Par défaut, les métriques de requête sont activées.
Returns:
isScanInQueryEnabled
public Boolean isScanInQueryEnabled()
Obtient l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins demandés.
Returns:
setConsistencyLevel
public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)
Définit le niveau de cohérence requis pour la demande. Le niveau de cohérence effectif ne peut être réduit que pour les demandes de lecture/requête. Ainsi, lorsque le niveau de cohérence par défaut du compte est par exemple session, vous pouvez spécifier sur un niveau requête par demande pour les requêtes individuelles que la cohérence éventuelle est suffisante, ce qui peut réduire les frais de latence et de RU pour cette demande, mais ne garantit plus la cohérence de session (lecture de votre propre écriture)
Parameters:
Returns:
setCosmosEndToEndOperationLatencyPolicyConfig
public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)
Définit le CosmosEndToEndOperationLatencyPolicyConfig à utiliser pour la demande. Si la configuration est déjà définie * sur le client, cela remplacera la configuration au niveau du client pour cette demande
Parameters:
Returns:
setDedicatedGatewayRequestOptions
public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)
Définit les options de demande de passerelle dédiée
Parameters:
Returns:
setDiagnosticsThresholds
public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
Permet de remplacer les seuils de diagnostic pour une opération spécifique.
Parameters:
Returns:
setExcludedRegions
public CosmosQueryRequestOptions setExcludedRegions(List
Liste des régions à exclure pour la demande/les nouvelles tentatives. Exemple « USA Est » ou « USA Est, USA Ouest » Ces régions seront exclues de la liste des régions préférées
Parameters:
Returns:
setFeedRange
setIndexMetricsEnabled
public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)
Définit indexMetricsEnabled, qui est utilisé pour obtenir les métriques d’index afin de comprendre comment le moteur de requête a utilisé des index existants et peut utiliser de nouveaux index potentiels. Les résultats s’affichent dans QueryMetrics. Notez que ces options entraînent une surcharge. Elles doivent donc être activées lors du débogage de requêtes lentes. Par défaut, indexMetrics est désactivé.
Parameters:
Returns:
setMaxBufferedItemCount
public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)
Définit le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle.
Parameters:
Returns:
setMaxDegreeOfParallelism
public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)
Définit le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle.
Parameters:
Returns:
setPartitionKey
public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)
Définit la clé de partition utilisée pour identifier la partition cible de la requête actuelle.
Parameters:
Returns:
setQueryMetricsEnabled
public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)
Définit l’option permettant d’activer/désactiver l’obtention de métriques relatives à l’exécution de requête sur les demandes de requête d’élément. Par défaut, les métriques de requête sont activées.
Parameters:
Returns:
setQueryName
public CosmosQueryRequestOptions setQueryName(String queryName)
Définit le nom de la requête logique : cet identificateur est utilisé uniquement pour les métriques et les journaux afin de distinguer différentes requêtes dans les données de télémétrie. La cardinalité des valeurs uniques pour queryName doit être raisonnablement faible, comme beaucoup plus petite que 100.
Parameters:
Returns:
setResponseContinuationTokenLimitInKb
public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)
Définit l’option de requête ResponseContinuationTokenLimitInKb pour les demandes de requête d’élément dans le service Azure Cosmos DB.
ResponseContinuationTokenLimitInKb est utilisé pour limiter la longueur du jeton de continuation dans la réponse à la requête. Les valeurs valides sont >= 1.
Le jeton de continuation contient à la fois les champs obligatoires et facultatifs. Les champs obligatoires sont nécessaires pour reprendre l’exécution à partir de laquelle elle a été mise en place. Les champs facultatifs peuvent contenir un travail de recherche d’index sérialisé qui a été effectué mais qui n’a pas encore été utilisé. Cela évite de refaire le travail dans les continuations suivantes et, par conséquent, améliore les performances des requêtes. Si vous définissez la taille de continuation maximale sur 1 Ko, le service Azure Cosmos DB sérialise uniquement les champs obligatoires. À partir de 2 Ko, le service Azure Cosmos DB sérialise autant qu’il peut le faire jusqu’à ce qu’il atteigne la taille maximale spécifiée.
Parameters:
Returns:
setScanInQueryEnabled
public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)
Définit l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins d’accès demandés.
Parameters:
Returns:
setSessionToken
public CosmosQueryRequestOptions setSessionToken(String sessionToken)
Définit le jeton de session à utiliser avec la cohérence de session.
Parameters:
Returns:
setThresholdForDiagnosticsOnTracer
public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)
Définit le paramètre thresholdForDiagnosticsOnTracer, si la latence sur l’opération de requête est supérieure à ce diagnostics sera envoyé à l’exportateur de télémétrie ouvert en tant qu’événements dans l’étendue de suivi de l’API CRUD de bout en bout. La valeur par défaut est 500 ms
Parameters:
Returns:
setThroughputControlGroupName
public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)
Définissez le nom du groupe de contrôle de débit.
Parameters:
Returns:
Commentaires sur Azure SDK for Java
Azure SDK for Java est un projet open source. Sélectionnez un lien pour fournir des commentaires :