Class QueryMetrics

constructor

• new QueryMetrics(retrievedDocumentCount, retrievedDocumentSize, outputDocumentCount, outputDocumentSize, indexHitDocumentCount, totalQueryExecutionTime, queryPreparationTimes, indexLookupTime, documentLoadTime, vmExecutionTime, runtimeExecutionTimes, documentWriteTime, clientSideMetrics): QueryMetrics

• 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

  Returns QueryMetrics

ReadonlyclientSideMetrics

ReadonlydocumentLoadTime

ReadonlydocumentWriteTime

ReadonlyindexHitDocumentCount

ReadonlyindexLookupTime

ReadonlyoutputDocumentCount

ReadonlyoutputDocumentSize

ReadonlyqueryPreparationTimes

ReadonlyretrievedDocumentCount

ReadonlyretrievedDocumentSize

ReadonlyruntimeExecutionTimes

ReadonlytotalQueryExecutionTime

ReadonlyvmExecutionTime

Static Readonlyzero

add

• add(queryMetricsArray): QueryMetrics

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

  Parameters

  • queryMetricsArray: QueryMetrics[]

  Returns QueryMetrics

StaticcreateFromArray

• createFromArray(queryMetricsArray): QueryMetrics

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

  Parameters

  • queryMetricsArray: QueryMetrics[]

  Returns QueryMetrics

StaticcreateFromDelimitedString

• createFromDelimitedString(delimitedString, clientSideMetrics?): QueryMetrics

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

  Parameters

  • delimitedString: string
  • OptionalclientSideMetrics: ClientSideMetrics

  Returns QueryMetrics