Documentation

QueryMetaData

Interface for retrieving metadata such as errors and metrics generated during N1QL queries.

Table of Contents

clientContextId()  : string|null
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

Methods

clientContextId()

Returns the client context id associated with the query

public clientContextId() : string|null
Return values
string|null

errors()

Returns any errors generated during query execution

public errors() : array<string|int, mixed>|null
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
Return values
array<string|int, mixed>|null

profile()

Returns the profile of the query if enabled

public profile() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

requestId()

Returns the identifier associated with the query

public requestId() : string|null
Return values
string|null

signature()

Returns the signature of the query

public signature() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

status()

Returns the query execution status

public status() : string|null
Return values
string|null

warnings()

Returns any warnings generated during query execution

public warnings() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

Search results