QueryMetrics class
Constructors
Query |
Properties
Methods
add(Query |
returns a new QueryMetrics instance that is the addition of this and the arguments. |
create |
Returns a new instance of the QueryMetrics class that is the aggregation of an array of query metrics. |
create |
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
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
retrievedDocumentCount
retrievedDocumentCount: number
Property Value
number
retrievedDocumentSize
retrievedDocumentSize: number
Property Value
number
runtimeExecutionTimes
totalQueryExecutionTime
totalQueryExecutionTime: TimeSpan
Property Value
TimeSpan
vmExecutionTime
vmExecutionTime: TimeSpan
Property Value
TimeSpan
zero
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
Returns
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
Returns
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