CosmosQueryRequestOptions Klasse

Paket:

com.azure.cosmos.models

Maven-Artefakt:

com.azure:azure-cosmos:4.54.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosQueryRequestOptions

public class CosmosQueryRequestOptions

Gibt die Optionen an, die Abfragemethoden (Enumerationsvorgänge) im Azure Cosmos DB-Datenbankdienst zugeordnet sind.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
CosmosQueryRequestOptions()	Instanziiert eine neue Abfrageanforderungsoptionen.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
ConsistencyLevel	getConsistencyLevel() Ruft die für die Anforderung erforderliche Konsistenzebene ab.
DedicatedGatewayRequestOptions	getDedicatedGatewayRequestOptions() Ruft die Optionen für dedizierte Gatewayanforderungen ab.
List<String>	getExcludedRegions() Ruft die Liste der Regionen ab, die für die Anforderung/Wiederholung ausgeschlossen werden sollen.
FeedRange	getFeedRange() Ruft die ab FeedRange
int	getMaxBufferedItemCount() Ruft die maximale Anzahl von Elementen ab, die während der parallelen Abfrageausführung auf der Clientseite gepuffert werden können.
int	getMaxDegreeOfParallelism() Ruft die Anzahl gleichzeitiger Vorgänge ab, die clientseitig während der parallelen Abfrageausführung ausgeführt werden.
PartitionKey	getPartitionKey() Ruft den Partitionsschlüssel ab, der zum Identifizieren der Zielpartition der aktuellen Anforderung verwendet wird.
int	getResponseContinuationTokenLimitInKb() Ruft die InKb-Anforderungsoption ResponseContinuationTokenLimitfür Elementabfrageanforderungen im Azure Cosmos DB-Dienst ab.
String	getSessionToken() Ruft das Sitzungstoken zur Verwendung mit Sitzungskonsistenz ab.
Duration	getThresholdForDiagnosticsOnTracer() Ruft den SchwellenwertfürDiagnosticsOnTracer 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.
String	getThroughputControlGroupName() Rufen Sie den Namen der Durchsatzsteuerungsgruppe ab.
boolean	isIndexMetricsEnabled() Ruft aktivierte Indexmetrikenab, die verwendet werden, um die Indexmetriken abzurufen, um zu verstehen, wie die Abfrage-Engine vorhandene Indizes verwendet und potenzielle neue Indizes verwenden kann.
boolean	isQueryMetricsEnabled() Ruft die Option zum Aktivieren des Auffüllens von Abfragemetriken ab.
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.
CosmosQueryRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Legt die für die Anforderung erforderliche Konsistenzebene fest.
CosmosQueryRequestOptions	setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig) Legt fest, dass CosmosEndToEndOperationLatencyPolicyConfig für die Anforderung verwendet werden soll.
CosmosQueryRequestOptions	setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Legt die Optionen für die Anforderung für dedizierte Gateways fest.
CosmosQueryRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Ermöglicht das Überschreiben der Diagnoseschwellenwerte für einen bestimmten Vorgang.
CosmosQueryRequestOptions	setExcludedRegions(List<String> excludeRegions) Liste der Regionen, die für die Anforderung/Wiederholung ausgeschlossen werden sollen.
CosmosQueryRequestOptions	setFeedRange(FeedRange feedRange) Legt die fest, die FeedRange wir abfragen möchten.
CosmosQueryRequestOptions	setIndexMetricsEnabled(boolean indexMetricsEnabled) Legt Indexmetrikenaktiviert fest, die zum Abrufen der Indexmetriken verwendet werden, um zu verstehen, wie die Abfrage-Engine vorhandene Indizes verwendet und potenzielle neue Indizes verwenden kann.
CosmosQueryRequestOptions	setMaxBufferedItemCount(int maxBufferedItemCount) Legt die maximale Anzahl von Elementen fest, die clientseitig während der parallelen Abfrageausführung gepuffert werden können.
CosmosQueryRequestOptions	setMaxDegreeOfParallelism(int maxDegreeOfParallelism) Legt die Anzahl gleichzeitiger Vorgänge fest, die clientseitig während der parallelen Abfrageausführung ausgeführt werden.
CosmosQueryRequestOptions	setPartitionKey(PartitionKey partitionkey) Legt den Partitionsschlüssel fest, der zum Identifizieren der Zielpartition der aktuellen Anforderung verwendet wird.
CosmosQueryRequestOptions	setQueryMetricsEnabled(boolean queryMetricsEnabled) Legt die Option zum Aktivieren/Deaktivieren des Abrufens von Metriken im Zusammenhang mit der Abfrageausführung für Elementabfrageanforderungen fest.
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.
CosmosQueryRequestOptions	setResponseContinuationTokenLimitInKb(int limitInKb) Legt die Option ResponseContinuationTokenLimitInKb request für Elementabfrageanforderungen im Azure Cosmos DB-Dienst fest.
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.
CosmosQueryRequestOptions	setSessionToken(String sessionToken) Legt das Sitzungstoken für die Verwendung mit Sitzungskonsistenz fest.
CosmosQueryRequestOptions	setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) Legt den SchwellenwertfürDiagnoseOnTracer 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 wird.
CosmosQueryRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) Legen Sie den Namen der Durchsatzsteuerungsgruppe fest.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

CosmosQueryRequestOptions

public CosmosQueryRequestOptions()

Instanziiert eine neue Abfrageanforderungsoptionen.

Details zur Methode

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Ruft die für die Anforderung erforderliche Konsistenzebene ab.

Returns:

die Konsistenzebene.

getDedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

Ruft die Optionen für dedizierte Gatewayanforderungen ab.

Returns:

Die Optionen für dedizierte Gatewayanforderungen

getExcludedRegions

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:

Liste der ausgeschlossenen Regionen

getFeedRange

public FeedRange getFeedRange()

Ruft die ab FeedRange

Returns:

das FeedRange

getMaxBufferedItemCount

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:

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

getMaxDegreeOfParallelism

public int getMaxDegreeOfParallelism()

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

Returns:

Anzahl gleichzeitiger Vorgänge, die während der parallelen Abfrageausführung auf der Clientseite ausgeführt werden.

getPartitionKey

public PartitionKey getPartitionKey()

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

Returns:

der Partitionsschlüssel.

getResponseContinuationTokenLimitInKb

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:

return set ResponseContinuationTokenLimitInKb, oder 0, wenn nicht festgelegt

getSessionToken

public String getSessionToken()

Ruft das Sitzungstoken zur Verwendung mit Sitzungskonsistenz ab.

Returns:

das Sitzungstoken.

getThresholdForDiagnosticsOnTracer

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:

thresholdForDiagnosticsOnTracer der Latenzschwellenwert für Diagnose in der Ablaufverfolgung.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Rufen Sie den Namen der Durchsatzsteuerungsgruppe ab.

Returns:

Der Name der Durchsatzsteuerungsgruppe.

isIndexMetricsEnabled

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:

indexMetricsEnabled (Standard: false)

isQueryMetricsEnabled

public boolean isQueryMetricsEnabled()

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

Returns:

ob das Auffüllen von Abfragemetriken aktiviert werden soll (Standard: true)

isScanInQueryEnabled

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:

die Option zum Aktivieren der Überprüfung in der Abfrage.

setConsistencyLevel

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:

consistencyLevel - die Konsistenzebene.

Returns:

cosmosItemRequestOptions.

setCosmosEndToEndOperationLatencyPolicyConfig

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:

cosmosEndToEndOperationLatencyPolicyConfig - das CosmosEndToEndOperationLatencyPolicyConfig

Returns:

CosmosQueryRequestOptions

setDedicatedGatewayRequestOptions

public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

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

Parameters:

dedicatedGatewayRequestOptions - Optionen für dedizierte Gatewayanforderungen

Returns:

CosmosQueryRequestOptions

setDiagnosticsThresholds

public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

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

Parameters:

operationSpecificThresholds - Die Außerkraftsetzung des Diagnoseschwellenwerts für diesen Vorgang

Returns:

cosmosQueryRequestOptions.

setExcludedRegions

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:

excludeRegions - die auszuschließenden Regionen

Returns:

das CosmosQueryRequestOptions

setFeedRange

public CosmosQueryRequestOptions setFeedRange(FeedRange feedRange)

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

Parameters:

feedRange - das FeedRange

Returns:

cosmosQueryRequestOptions.

setIndexMetricsEnabled

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:

indexMetricsEnabled - ein boolescher Wert, der zum Abrufen der Indexmetriken verwendet wird

Returns:

indexMetricsEnabled

setMaxBufferedItemCount

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:

maxBufferedItemCount - maximale Anzahl von Elementen.

Returns:

cosmosQueryRequestOptions.

setMaxDegreeOfParallelism

public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

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

Parameters:

maxDegreeOfParallelism - Anzahl gleichzeitiger Vorgänge.

Returns:

cosmosQueryRequestOptions.

setPartitionKey

public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)

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

Parameters:

partitionkey - der Partitionsschlüsselwert.

Returns:

cosmosQueryRequestOptions.

setQueryMetricsEnabled

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:

queryMetricsEnabled - Ob Abfragemetriken aktiviert oder deaktiviert werden sollen

Returns:

cosmosQueryRequestOptions.

setQueryName

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:

queryName - einen logischen Abfragenamen, um dieses Abfragemuster von anderen zu unterscheiden

Returns:

der Name der logischen Abfrage

setResponseContinuationTokenLimitInKb

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:

limitInKb - Größenbeschränkung für Fortsetzungstoken.

Returns:

cosmosQueryRequestOptions.

setScanInQueryEnabled

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:

scanInQueryEnabled - die Option zum Aktivieren der Überprüfung in der Abfrage.

Returns:

cosmosQueryRequestOptions.

setSessionToken

public CosmosQueryRequestOptions setSessionToken(String sessionToken)

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

Parameters:

sessionToken - das Sitzungstoken.

Returns:

cosmosQueryRequestOptions.

setThresholdForDiagnosticsOnTracer

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:

thresholdForDiagnosticsOnTracer - der Latenzschwellenwert für Diagnose in der Ablaufverfolgung.

Returns:

CosmosQueryRequestOptions

setThroughputControlGroupName

public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Legen Sie den Namen der Durchsatzsteuerungsgruppe fest.

Parameters:

throughputControlGroupName - Der Name der Durchsatzsteuerungsgruppe.

Returns:

einen CosmosQueryRequestOptions