Documentation

QueryMetaData

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

Table of Contents

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 string|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 array|null

Methods

status()

Returns the query execution status

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

requestId()

Returns the identifier associated with the query

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

clientContextId()

Returns the client context id associated with the query

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

signature()

Returns the signature of the query

public signature( ) : array|null
Return values
array|null

warnings()

Returns any warnings generated during query execution

public warnings( ) : array|null
Return values
array|null

errors()

Returns any errors generated during query execution

public errors( ) : array|null
Return values
array|null

metrics()

Returns metrics generated during query execution such as timings and counts

public metrics( ) : array|null
Return values
array|null

profile()

Returns the profile of the query if enabled

public profile( ) : array|null
Return values
array|null

Search results