CosmosQueryRequestOptions クラス

public CosmosQueryRequestOptions()

新しいクエリ要求オプションをインスタンス化します。

public ConsistencyLevel getConsistencyLevel()

要求に必要な整合性レベルを取得します。

Returns:

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

専用ゲートウェイ要求オプションを取得します

Returns:

public List getExcludedRegions()

要求/再試行に対して除外するリージョンの一覧を取得します。 これらのリージョンは、優先リージョンの一覧から除外されます。

Returns:

public FeedRange getFeedRange()

FeedRange を取得します

Returns:

public int getMaxBufferedItemCount()

並列クエリの実行中にクライアント側でバッファーに格納できるアイテムの最大数を取得します。

Returns:

public int getMaxDegreeOfParallelism()

並列クエリの実行中にクライアント側で実行される同時実行操作の数を取得します。

Returns:

public PartitionKey getPartitionKey()

現在の要求のターゲット パーティションを識別するために使用されるパーティション キーを取得します。

Returns:

public int getResponseContinuationTokenLimitInKb()

Azure Cosmos DB サービスの項目クエリ要求の ResponseContinuationTokenLimitInKb 要求オプションを取得します。 まだ設定していない場合は、0 を返します。

ResponseContinuationTokenLimitInKb は、クエリ応答の継続トークンの長さを制限するために使用されます。 有効な値は >= 1 です。

Returns:

public String getSessionToken()

セッション整合性で使用するセッション トークンを取得します。

Returns:

public Duration getThresholdForDiagnosticsOnTracer()

クエリ操作の待機時間がこの診断を超える場合は、end to end CRUD api のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される thresholdForDiagnosticsOnTracer を取得します。 既定値は 500 ミリ秒です。

Returns:

public String getThroughputControlGroupName()

スループット制御グループ名を取得します。

Returns:

public boolean isIndexMetricsEnabled()

indexMetricsEnabled を取得します。これは、クエリ エンジンが既存のインデックスをどのように使用し、潜在的な新しいインデックスを使用できるかを理解するためにインデックス メトリックを取得するために使用されます。 結果は QueryMetrics に表示されます。 このオプションではオーバーヘッドが発生するため、低速クエリをデバッグするときに有効にする必要があることに注意してください。

Returns:

public boolean isQueryMetricsEnabled()

クエリ メトリックの設定を有効にするオプションを取得します。 既定では、クエリ メトリックが有効になっています。

Returns:

public Boolean isScanInQueryEnabled()

要求されたパスでインデックス作成がオプトアウトされたクエリでスキャンを許可するオプションを取得します。

Returns:

public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

要求に必要な整合性レベルを設定します。 有効な整合性レベルは、読み取り/クエリ要求に対してのみ削減できます。 そのため、アカウントの既定の整合性レベルがたとえば [セッション] である場合は、個々の要求に対して要求ごとのレベルで、最終的な整合性で十分であることを指定できます。これにより、この要求の待機時間と RU の料金が削減される可能性がありますが、セッション整合性 (読み取り独自の書き込み) は保証されません

Parameters:

Returns:

public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)

要求に CosmosEndToEndOperationLatencyPolicyConfig 使用する を設定します。 構成が既にクライアントで * に設定されている場合は、この要求のクライアント レベルの構成がオーバーライドされます

Parameters:

Returns:

public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

専用ゲートウェイ要求オプションを設定します

Parameters:

Returns:

public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

特定の操作の診断しきい値をオーバーライドできます。

Parameters:

Returns:

public CosmosQueryRequestOptions setExcludedRegions(List excludeRegions)

要求/再試行のために除外するリージョンの一覧。 例 "米国東部" または "米国東部、米国西部" これらのリージョンは、優先リージョンの一覧から除外されます

Parameters:

Returns:

public CosmosQueryRequestOptions setFeedRange(FeedRange feedRange)

クエリを実行する を設定します。FeedRange

Parameters:

Returns:

public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)

indexMetricsEnabled を設定します。これは、クエリ エンジンが既存のインデックスをどのように使用し、潜在的な新しいインデックスを使用できるかを理解するためにインデックス メトリックを取得するために使用されます。 結果は QueryMetrics に表示されます。 このオプションではオーバーヘッドが発生するため、低速クエリのデバッグ時に有効にする必要があることに注意してください。 既定では、indexMetrics は無効になっています。

Parameters:

Returns:

public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)

並列クエリの実行中にクライアント側でバッファーに格納できるアイテムの最大数を設定します。

Parameters:

Returns:

public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

並列クエリの実行中にクライアント側で実行される同時実行操作の数を設定します。

Parameters:

Returns:

public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)

現在の要求のターゲット パーティションを識別するために使用されるパーティション キーを設定します。

Parameters:

Returns:

public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)

項目クエリ要求でのクエリ実行に関連するメトリックの取得を有効または無効にするオプションを設定します。 既定では、クエリ メトリックが有効になっています。

Parameters:

Returns:

public CosmosQueryRequestOptions setQueryName(String queryName)

論理クエリ名を設定します。この識別子は、テレメトリ内のさまざまなクエリを区別するためにメトリックとログにのみ使用されます。 queryName の一意の値のカーディナリティは、100 より大幅に小さいように、かなり低くする必要があります。

Parameters:

Returns:

public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)

Azure Cosmos DB サービスの項目クエリ要求の ResponseContinuationTokenLimitInKb 要求オプションを設定します。

ResponseContinuationTokenLimitInKb は、クエリ応答の継続トークンの長さを制限するために使用されます。 有効な値は >= 1 です。

継続トークンには、必須フィールドと省略可能フィールドの両方が含まれます。 必要なフィールドは、実行がストゥープされた場所から再開するために必要です。 省略可能なフィールドには、行われたが、まだ使用されていないシリアル化されたインデックス検索作業が含まれている場合があります。 これにより、後続の継続で作業をやり直すのが回避され、クエリのパフォーマンスが向上します。 最大継続サイズを 1 KB に設定すると、Azure Cosmos DB サービスは必須フィールドのみをシリアル化します。 2 KB 以降、Azure Cosmos DB サービスは、指定された最大サイズに達するまで収まる限りシリアル化します。

Parameters:

Returns:

public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)

要求されたパスでインデックス作成がオプトアウトされたクエリでスキャンを許可するオプションを設定します。

Parameters:

Returns:

public CosmosQueryRequestOptions setSessionToken(String sessionToken)

セッション整合性で使用するセッション トークンを設定します。

Parameters:

Returns:

public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

クエリ操作の待機時間がこの診断を超える場合は、end to end CRUD api のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される thresholdForDiagnosticsOnTracer を設定します。 既定値は 500 ミリ秒です

Parameters:

Returns:

public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

スループット制御グループ名を設定します。

Parameters:

Returns: