CosmosQueryRequestOptions Klasse

public CosmosQueryRequestOptions()

Instanziiert eine neue Abfrageanforderungsoptionen.

public ConsistencyLevel getConsistencyLevel()

Ruft die für die Anforderung erforderliche Konsistenzebene ab.

Returns:

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

Ruft die Optionen für dedizierte Gatewayanforderungen ab.

Returns:

public List getExcludedRegions()

Ruft die Liste der Regionen ab, die für die Anforderung/Wiederholung ausgeschlossen werden sollen. Diese Regionen werden aus der Liste der bevorzugten Regionen ausgeschlossen.

Returns:

public FeedRange getFeedRange()

Ruft die ab FeedRange

Returns:

public int getMaxBufferedItemCount()

Ruft die maximale Anzahl von Elementen ab, die während der parallelen Abfrageausführung auf der Clientseite gepuffert werden können.

Returns:

public int getMaxDegreeOfParallelism()

Ruft die Anzahl gleichzeitiger Vorgänge ab, die clientseitig während der parallelen Abfrageausführung ausgeführt werden.

Returns:

public PartitionKey getPartitionKey()

Ruft den Partitionsschlüssel ab, der zum Identifizieren der Zielpartition der aktuellen Anforderung verwendet wird.

Returns:

public int getResponseContinuationTokenLimitInKb()

Ruft die ResponseContinuationTokenLimitInKb-Anforderungsoption für Elementabfrageanforderungen im Azure Cosmos DB-Dienst ab. Wenn noch nicht festgelegt, wird 0 zurückgegeben.

ResponseContinuationTokenLimitInKb wird verwendet, um die Länge des Fortsetzungstokens in der Abfrageantwort zu begrenzen. Gültige Werte sind >= 1.

Returns:

public String getSessionToken()

Ruft das Sitzungstoken zur Verwendung mit Sitzungskonsistenz ab.

Returns:

public Duration getThresholdForDiagnosticsOnTracer()

Ruft den schwellenwertForDiagnosticsOnTracer ab, wenn die Latenz beim Abfragevorgang größer ist als dieser Diagnose als Ereignisse in der Ablaufverfolgungsspanne der End-to-End-CRUD-API an den geöffneten Telemetrieexporter gesendet wird. Der Standardwert ist 500 ms.

Returns:

public String getThroughputControlGroupName()

Rufen Sie den Namen der Durchsatzsteuerungsgruppe ab.

Returns:

public boolean isIndexMetricsEnabled()

Ruft indexMetricsEnabled ab, das verwendet wird, um die Indexmetriken abzurufen, um zu verstehen, wie die Abfrage-Engine vorhandene Indizes verwendet und potenzielle neue Indizes verwenden kann. Die Ergebnisse werden in QueryMetrics angezeigt. Beachten Sie, dass für diese Optionen ein Mehraufwand entsteht, sodass sie beim Debuggen von langsamen Abfragen aktiviert werden sollte.

Returns:

public boolean isQueryMetricsEnabled()

Ruft die Option zum Aktivieren des Auffüllens von Abfragemetriken ab. Standardmäßig sind Abfragemetriken aktiviert.

Returns:

public Boolean isScanInQueryEnabled()

Ruft die Option ab, die Überprüfung der Abfragen zuzulassen, die nicht bereitgestellt werden konnten, da die Indizierung für die angeforderten Pfade deaktiviert wurde.

Returns:

public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Legt die für die Anforderung erforderliche Konsistenzebene fest. Die effektive Konsistenzebene kann nur für Lese-/Abfrageanforderungen reduziert werden. Wenn also die Standardkonsistenzebene des Kontos z. B. Sitzung ist, können Sie auf einer Anforderungsebene für einzelne Anforderungen angeben, dass letztliche Konsistenz ausreichend ist. Dies könnte die Latenz und RU-Gebühren für diese Anforderung reduzieren, garantiert jedoch nicht mehr die Sitzungskonsistenz (Read-Your-Own-Write).

Parameters:

Returns:

public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)

Legt fest, dass CosmosEndToEndOperationLatencyPolicyConfig für die Anforderung verwendet werden soll. Wenn die Konfiguration bereits auf dem Client festgelegt ist, wird die Konfiguration auf Clientebene für diese Anforderung überschrieben.

Parameters:

Returns:

public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

Legt die Optionen für die Anforderung für dedizierte Gateways fest.

Parameters:

Returns:

public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Ermöglicht das Überschreiben der Diagnoseschwellenwerte für einen bestimmten Vorgang.

Parameters:

Returns:

public CosmosQueryRequestOptions setExcludedRegions(List excludeRegions)

Liste der Regionen, die für die Anforderung/Wiederholung ausgeschlossen werden sollen. Beispiel "USA, Osten" oder "USA, Osten, USA, Westen" Diese Regionen werden aus der Liste der bevorzugten Regionen ausgeschlossen.

Parameters:

Returns:

public CosmosQueryRequestOptions setFeedRange(FeedRange feedRange)

Legt die fest, die FeedRange wir abfragen möchten.

Parameters:

Returns:

public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)

Legt indexMetricsEnabled fest, mit dem die Indexmetriken abgerufen werden, um zu verstehen, wie die Abfrage-Engine vorhandene Indizes verwendet und potenzielle neue Indizes verwenden kann. Die Ergebnisse werden in QueryMetrics angezeigt. Beachten Sie, dass diese Optionen einen Mehraufwand verursachen, sodass sie beim Debuggen von langsamen Abfragen aktiviert werden sollten. Standardmäßig sind indexMetrics deaktiviert.

Parameters:

Returns:

public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)

Legt die maximale Anzahl von Elementen fest, die clientseitig während der parallelen Abfrageausführung gepuffert werden können.

Parameters:

Returns:

public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

Legt die Anzahl gleichzeitiger Vorgänge fest, die clientseitig während der parallelen Abfrageausführung ausgeführt werden.

Parameters:

Returns:

public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)

Legt den Partitionsschlüssel fest, der zum Identifizieren der Zielpartition der aktuellen Anforderung verwendet wird.

Parameters:

Returns:

public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)

Legt die Option zum Aktivieren/Deaktivieren des Abrufens von Metriken im Zusammenhang mit der Abfrageausführung für Elementabfrageanforderungen fest. Standardmäßig sind Abfragemetriken aktiviert.

Parameters:

Returns:

public CosmosQueryRequestOptions setQueryName(String queryName)

Legt den Namen der logischen Abfrage fest. Dieser Bezeichner wird nur für Metriken und Protokolle verwendet, um verschiedene Abfragen in Telemetriedaten zu unterscheiden. Die Kardinalität eindeutiger Werte für queryName sollte relativ niedrig sein , z. B. deutlich kleiner als 100.

Parameters:

Returns:

public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)

Legt die Anforderungsoption ResponseContinuationTokenLimitInKb für Elementabfrageanforderungen im Azure Cosmos DB-Dienst fest.

ResponseContinuationTokenLimitInKb wird verwendet, um die Länge des Fortsetzungstokens in der Abfrageantwort zu begrenzen. Gültige Werte sind >= 1.

Das Fortsetzungstoken enthält sowohl erforderliche als auch optionale Felder. Die erforderlichen Felder sind erforderlich, um die Ausführung an der Stelle fortzusetzen, von der aus sie gestochen wurde. Die optionalen Felder können serialisierte Indexsuchevorgänge enthalten, die abgeschlossen, aber noch nicht verwendet wurden. Dadurch wird vermieden, dass die Arbeit in nachfolgenden Fortsetzungen erneut ausgeführt wird und somit die Abfrageleistung verbessert wird. Wenn Sie die maximale Fortsetzungsgröße auf 1 KB festlegen, serialisiert der Azure Cosmos DB-Dienst nur erforderliche Felder. Ab 2 KB würde der Azure Cosmos DB-Dienst so viel serialisieren, wie er passen könnte, bis er die maximale angegebene Größe erreicht.

Parameters:

Returns:

public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)

Legt die Option fest, um die Überprüfung der Abfragen zuzulassen, die nicht bereitgestellt werden konnten, da die Indizierung für die angeforderten Pfade deaktiviert wurde.

Parameters:

Returns:

public CosmosQueryRequestOptions setSessionToken(String sessionToken)

Legt das Sitzungstoken für die Verwendung mit Sitzungskonsistenz fest.

Parameters:

Returns:

public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

Legt den schwellenwertForDiagnosticsOnTracer fest, wenn die Latenz beim Abfragevorgang größer ist als dieser Diagnose als Ereignisse in der Ablaufverfolgungsspanne der End-to-End-CRUD-API an den geöffneten Telemetrieexporter gesendet werden. Der Standardwert ist 500 ms.

Parameters:

Returns:

public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Legen Sie den Namen der Durchsatzsteuerungsgruppe fest.

Parameters:

Returns: