FeedOptions.PopulateIndexMetrics Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents.Client
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

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

public bool PopulateIndexMetrics { get; set; }
member this.PopulateIndexMetrics : bool with get, set
Public Property PopulateIndexMetrics As Boolean

Property Value

Boolean

Remarks

PopulateIndexMetrics is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes. This requires PopulateQueryMetrics as the result is displayed in QueryMetrics. Please note that this options will incurs overhead, so it should be enabled when debuging slow queries.

Applies to