QueryRequestOptions.PopulateIndexMetrics Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.39.0
Source:
QueryRequestOptions.cs

Gets or sets the PopulateIndexMetrics request option for document query requests in the Azure Cosmos DB service.

public bool? PopulateIndexMetrics { get; set; }
member this.PopulateIndexMetrics : Nullable<bool> with get, set
Public Property PopulateIndexMetrics As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

Remarks

PopulateIndexMetrics is used to obtain the index metrics to understand how the query engine used existing indexes and how it could use potential new indexes. The results will be displayed in FeedResponse.IndexMetrics. Please note that this options will incur overhead, so it should be enabled only when debugging slow queries.

Applies to