QueryMetrics Class

Reference

Definition

Namespace:: Microsoft.Azure.Documents

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

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.

Query metrics in the Azure Cosmos database service. This metric represents a moving average for a set of queries whose metrics have been aggregated together.

public sealed class QueryMetrics

type QueryMetrics = class

Public NotInheritable Class QueryMetrics

Inheritance: Object
QueryMetrics

Properties

IndexHitRatio	Gets the index hit ratio by query in the Azure Cosmos database service.
OutputDocumentCount	Gets the number of documents returned by query in the Azure Cosmos DB service.
QueryEngineTimes	Gets the QueryEngineTimes instance in the Azure Cosmos database service.
QueryPreparationTimes	Gets the query QueryPreparationTimes in the Azure Cosmos database service.
Retries	Gets number of reties in the Azure Cosmos database service.
RetrievedDocumentCount	Gets the number of documents retrieved during query in the Azure Cosmos database service.
RetrievedDocumentSize	Gets the size of documents retrieved in bytes during query in the Azure Cosmos DB service.
TotalTime	Gets the total query time in the Azure Cosmos database service.

Methods

ToString()

Gets the stringified QueryMetrics instance in the Azure Cosmos database service.

Operators

Addition(QueryMetrics, QueryMetrics)

Add two specified QueryMetrics instances

Applies to