Class QueryMetrics

Namespace

Microsoft.Azure.Documents

Assembly

Microsoft.Azure.Documents.Client.dll

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

Inheritance

object

QueryMetrics

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TypeCheckFunctionsExtensions.IsArray(object)

TypeCheckFunctionsExtensions.IsBool(object)

TypeCheckFunctionsExtensions.IsDefined(object)

TypeCheckFunctionsExtensions.IsNull(object)

TypeCheckFunctionsExtensions.IsNumber(object)

TypeCheckFunctionsExtensions.IsObject(object)

TypeCheckFunctionsExtensions.IsPrimitive(object)

TypeCheckFunctionsExtensions.IsString(object)

Properties

IndexHitRatio

Gets the index hit ratio by query in the Azure Cosmos database service.

public double IndexHitRatio { get; }

Property Value

double

OutputDocumentCount

Gets the number of documents returned by query in the Azure Cosmos DB service.

public long OutputDocumentCount { get; }

Property Value

long

QueryEngineTimes

Gets the QueryEngineTimes instance in the Azure Cosmos database service.

public QueryEngineTimes QueryEngineTimes { get; }

Property Value

QueryEngineTimes

QueryPreparationTimes

Gets the query QueryPreparationTimes in the Azure Cosmos database service.

public QueryPreparationTimes QueryPreparationTimes { get; }

Property Value

QueryPreparationTimes

Retries

Gets number of reties in the Azure Cosmos database service.

public long Retries { get; }

Property Value

long

RetrievedDocumentCount

Gets the number of documents retrieved during query in the Azure Cosmos database service.

public long RetrievedDocumentCount { get; }

Property Value

long

RetrievedDocumentSize

Gets the size of documents retrieved in bytes during query in the Azure Cosmos DB service.

public long RetrievedDocumentSize { get; }

Property Value

long

TotalTime

Gets the total query time in the Azure Cosmos database service.

public TimeSpan TotalTime { get; }

Property Value

TimeSpan

Methods

ToString()

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

public override string ToString()

Returns

string

The stringified QueryMetrics instance in the Azure Cosmos database service.

Operators

operator +(QueryMetrics, QueryMetrics)

Add two specified QueryMetrics instances

public static QueryMetrics operator +(QueryMetrics queryMetrics1, QueryMetrics queryMetrics2)

Parameters

queryMetrics1 QueryMetrics

The first QueryMetrics instance

queryMetrics2 QueryMetrics

The second QueryMetrics instance

Returns

QueryMetrics

A new QueryMetrics instance that is the sum of two QueryMetrics instances