QueryRequestOptions.PopulateQueryAdvice Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the PopulateQueryAdvice request option for document query requests in the Azure Cosmos DB service.
public bool? PopulateQueryAdvice { get; set; }member this.PopulateQueryAdvice : Nullable<bool> with get, setPublic Property PopulateQueryAdvice As Nullable(Of Boolean)Property Value
Remarks
PopulateQueryAdvice is used to obtain the query advice to understand aspect of the query that can be optimized. The results will be displayed in FeedResponse.QueryAdvice. Please note that this options will incur overhead, so it should be enabled only when debugging queries.
var queryRequestOptions = new QueryRequestOptions { PopulateQueryAdvice = true};
// View results in FeedResponse.QueryAdvice
string queryAdvice = null;
while (itemQuery.HasMoreResults)
{
FeedResponse<CosmosElement> page = itemQuery.ReadNextAsync().Result;
// query advice is the same across pages so we only need to log it once
if (queryAdvice == null)
{
queryAdvice = page.QueryAdvice;
}
}
