QueryMetrics class

Package:

@azure/cosmos

Constructors

QueryMetrics(number, number, number, number, number, TimeSpan, QueryPreparationTimes, TimeSpan, TimeSpan, TimeSpan, RuntimeExecutionTimes, TimeSpan, ClientSideMetrics)

Properties

clientSideMetrics
documentLoadTime
documentWriteTime
indexHitDocumentCount
indexLookupTime
outputDocumentCount
outputDocumentSize
queryPreparationTimes
retrievedDocumentCount
retrievedDocumentSize
runtimeExecutionTimes
totalQueryExecutionTime
vmExecutionTime
zero

Methods

add(QueryMetrics[])	returns a new QueryMetrics instance that is the addition of this and the arguments.
createFromArray(QueryMetrics[])	Returns a new instance of the QueryMetrics class that is the aggregation of an array of query metrics.
createFromDelimitedString(string, ClientSideMetrics)	Returns a new instance of the QueryMetrics class this is deserialized from a delimited string.

Constructor Details

QueryMetrics(number, number, number, number, number, TimeSpan, QueryPreparationTimes, TimeSpan, TimeSpan, TimeSpan, RuntimeExecutionTimes, TimeSpan, ClientSideMetrics)

new QueryMetrics(retrievedDocumentCount: number, retrievedDocumentSize: number, outputDocumentCount: number, outputDocumentSize: number, indexHitDocumentCount: number, totalQueryExecutionTime: TimeSpan, queryPreparationTimes: QueryPreparationTimes, indexLookupTime: TimeSpan, documentLoadTime: TimeSpan, vmExecutionTime: TimeSpan, runtimeExecutionTimes: RuntimeExecutionTimes, documentWriteTime: TimeSpan, clientSideMetrics: ClientSideMetrics)

Parameters

retrievedDocumentCount

number

retrievedDocumentSize

number

outputDocumentCount

number

outputDocumentSize

number

indexHitDocumentCount

number

totalQueryExecutionTime

TimeSpan

queryPreparationTimes

QueryPreparationTimes

indexLookupTime

TimeSpan

documentLoadTime

TimeSpan

vmExecutionTime

TimeSpan

runtimeExecutionTimes

RuntimeExecutionTimes

documentWriteTime

TimeSpan

clientSideMetrics

ClientSideMetrics

Property Details

clientSideMetrics

clientSideMetrics: ClientSideMetrics

Property Value

ClientSideMetrics

documentLoadTime

documentLoadTime: TimeSpan

Property Value

TimeSpan

documentWriteTime

documentWriteTime: TimeSpan

Property Value

TimeSpan

indexHitDocumentCount

indexHitDocumentCount: number

Property Value

number

indexLookupTime

indexLookupTime: TimeSpan

Property Value

TimeSpan

outputDocumentCount

outputDocumentCount: number

Property Value

number

outputDocumentSize

outputDocumentSize: number

Property Value

number

queryPreparationTimes

queryPreparationTimes: QueryPreparationTimes

Property Value

QueryPreparationTimes

retrievedDocumentCount

retrievedDocumentCount: number

Property Value

number

retrievedDocumentSize

retrievedDocumentSize: number

Property Value

number

runtimeExecutionTimes

runtimeExecutionTimes: RuntimeExecutionTimes

Property Value

RuntimeExecutionTimes

totalQueryExecutionTime

totalQueryExecutionTime: TimeSpan

Property Value

TimeSpan

vmExecutionTime

vmExecutionTime: TimeSpan

Property Value

TimeSpan

zero

static zero: QueryMetrics

Property Value

QueryMetrics

Method Details

add(QueryMetrics[])

returns a new QueryMetrics instance that is the addition of this and the arguments.

function add(queryMetricsArray: QueryMetrics[]): QueryMetrics

Parameters

queryMetricsArray

QueryMetrics[]

Returns

QueryMetrics

createFromArray(QueryMetrics[])

Returns a new instance of the QueryMetrics class that is the aggregation of an array of query metrics.

static function createFromArray(queryMetricsArray: QueryMetrics[]): QueryMetrics

Parameters

queryMetricsArray

QueryMetrics[]

Returns

QueryMetrics

createFromDelimitedString(string, ClientSideMetrics)

Returns a new instance of the QueryMetrics class this is deserialized from a delimited string.

static function createFromDelimitedString(delimitedString: string, clientSideMetrics?: ClientSideMetrics): QueryMetrics

Parameters

delimitedString

string

clientSideMetrics

ClientSideMetrics

Returns

QueryMetrics