QueryMetaData
in package
Interface for retrieving metadata such as errors and metrics generated during N1QL queries.
Table of Contents
- $clientContextId : string
- $errors : array<string|int, mixed>
- $metrics : array<string|int, mixed>|null
- $profile : string|null
- $requestId : string
- $signature : string|null
- $status : string
- $warnings : array<string|int, mixed>
- clientContextId() : string
- Returns the client context id associated with the query
- errors() : array<string|int, mixed>|null
- Returns any errors generated during query execution
- metrics() : array<string|int, mixed>|null
- Returns metrics generated during query execution such as timings and counts.
- profile() : array<string|int, mixed>|null
- Returns the profile of the query if enabled
- requestId() : string|null
- Returns the identifier associated with the query
- signature() : array<string|int, mixed>|null
- Returns the signature of the query
- status() : string|null
- Returns the query execution status
- warnings() : array<string|int, mixed>|null
- Returns any warnings generated during query execution
Properties
$clientContextId
private
string
$clientContextId
$errors
private
array<string|int, mixed>
$errors
$metrics
private
array<string|int, mixed>|null
$metrics
= null
$profile
private
string|null
$profile
= null
$requestId
private
string
$requestId
$signature
private
string|null
$signature
= null
$status
private
string
$status
$warnings
private
array<string|int, mixed>
$warnings
Methods
clientContextId()
Returns the client context id associated with the query
public
clientContextId() : string
Tags
Return values
string —errors()
Returns any errors generated during query execution
public
errors() : array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —metrics()
Returns metrics generated during query execution such as timings and counts.
public
metrics() : array<string|int, mixed>|null
If no metrics were returned then all values will be 0.
Tags
Return values
array<string|int, mixed>|null —profile()
Returns the profile of the query if enabled
public
profile() : array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —requestId()
Returns the identifier associated with the query
public
requestId() : string|null
Tags
Return values
string|null —signature()
Returns the signature of the query
public
signature() : array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|null —status()
Returns the query execution status
public
status() : string|null
Tags
Return values
string|null —warnings()
Returns any warnings generated during query execution
public
warnings() : array<string|int, mixed>|null