Oihana PHP Arango

ExecutionStats

Read onlyYes

A typed view over the execution statistics returned in a cursor's `extra.stats` (populated for a profiled run, i.e. when the query ran with the `profile` option).

Surfaces the numbers you actually look at when a query is slow — how much was scanned from indexes vs. full collections, how much was filtered, how long it took, and the peak memory used.

Tags
see
ProfileResult
Statistic
since
1.1.0
author

Marc Alcaraz

Table of Contents

Properties

$data  : array<string|int, mixed>

Methods

__construct()  : mixed
cacheHits()  : int
Number of index entries served from an in-memory index cache.
cacheMisses()  : int
Number of index lookups that missed the in-memory index cache.
documentLookups()  : int
Number of documents looked up by their `_id` / `_key` after an index scan.
executionTime()  : float
Total query execution time, in seconds.
filtered()  : int
Number of documents removed by `FILTER` conditions after being read.
fullCount()  : int|null
The total result count ignoring `LIMIT`, or null when `fullCount` was not requested.
get()  : mixed
A raw statistic by key (see {@see Statistic}), with a fallback default.
httpRequests()  : int
Number of HTTP requests the coordinator made to DB-servers (cluster).
peakMemoryUsage()  : int
Peak memory usage of the query, in bytes.
raw()  : array<string, mixed>
The raw, unmodified `extra.stats` array.
scannedFull()  : int
Number of documents read by scanning collections in full (no index).
scannedIndex()  : int
Number of documents read by scanning index ranges.
writesExecuted()  : int
Number of documents inserted/updated/replaced/removed.
writesIgnored()  : int
Number of write operations ignored (e.g. `ignoreErrors`).

Properties

Methods

__construct()

public __construct(array<string, mixed> $data) : mixed
Parameters
$data : array<string, mixed>

The raw extra.stats array.

cacheHits()

Number of index entries served from an in-memory index cache.

public cacheHits() : int
Return values
int

cacheMisses()

Number of index lookups that missed the in-memory index cache.

public cacheMisses() : int
Return values
int

documentLookups()

Number of documents looked up by their `_id` / `_key` after an index scan.

public documentLookups() : int
Return values
int

executionTime()

Total query execution time, in seconds.

public executionTime() : float
Return values
float

filtered()

Number of documents removed by `FILTER` conditions after being read.

public filtered() : int
Return values
int

fullCount()

The total result count ignoring `LIMIT`, or null when `fullCount` was not requested.

public fullCount() : int|null
Return values
int|null

get()

A raw statistic by key (see {@see Statistic}), with a fallback default.

public get(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

httpRequests()

Number of HTTP requests the coordinator made to DB-servers (cluster).

public httpRequests() : int
Return values
int

peakMemoryUsage()

Peak memory usage of the query, in bytes.

public peakMemoryUsage() : int
Return values
int

raw()

The raw, unmodified `extra.stats` array.

public raw() : array<string, mixed>
Return values
array<string, mixed>

scannedFull()

Number of documents read by scanning collections in full (no index).

public scannedFull() : int
Return values
int

scannedIndex()

Number of documents read by scanning index ranges.

public scannedIndex() : int
Return values
int

writesExecuted()

Number of documents inserted/updated/replaced/removed.

public writesExecuted() : int
Return values
int

writesIgnored()

Number of write operations ignored (e.g. `ignoreErrors`).

public writesIgnored() : int
Return values
int
On this page

Search results