interface QueryMetaData (View source)

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

Methods

string|null
status()

Returns the query execution status

string|null
requestId()

Returns the identifier associated with the query

string|null
clientContextId()

Returns the client context id associated with the query

array|null
signature()

Returns the signature of the query

array|null
warnings()

Returns any warnings generated during query execution

array|null
errors()

Returns any errors generated during query execution

array|null
metrics()

Returns metrics generated during query execution such as timings and counts

array|null
profile()

Returns the profile of the query if enabled

Details

string|null status()

Returns the query execution status

Return Value

string|null

string|null requestId()

Returns the identifier associated with the query

Return Value

string|null

string|null clientContextId()

Returns the client context id associated with the query

Return Value

string|null

array|null signature()

Returns the signature of the query

Return Value

array|null

array|null warnings()

Returns any warnings generated during query execution

Return Value

array|null

array|null errors()

Returns any errors generated during query execution

Return Value

array|null

array|null metrics()

Returns metrics generated during query execution such as timings and counts

Return Value

array|null

array|null profile()

Returns the profile of the query if enabled

Return Value

array|null