Common Parameters
The Couchbase Analytics Service API supports the following parameters in common with the N1QL for Query REST API.
Parameter | Default | Values |
---|---|---|
|
Specifies at least one valid N1QL for Analytics statement to run. (Required.) |
|
|
An identifier passed by the client that is returned verbatim in the query response. Useful for matching a particular query to a specific caller. (Optional.) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(no timeout) |
An amount and a unit: |
|
(no timeout) |
An amount and a unit: |
|
An array of positional parameter values. |
|
|
A named parameter value. |
For more information on these common parameters, see Request-Level Parameters.
The Analytics Service API does not support the prepared parameter.
|
The Analytics Service API does not support the at_plus or
statement_plus settings for scan consistency.
|
Analytics Parameters
In addition, the Service API supports the following parameters which are unique to Analytics.
Parameter | Default | Values |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
An integer specifying the maximum number of warning messages to be included in the query response. |