Analytics Query Parameters
Common Parameters
The Couchbase Analytics Service API supports the following parameters in common with the N1QL for Query REST API.
For more information on these common parameters, refer to Request-Level Parameters.
Common Parameters
Name | Description | Schema |
---|---|---|
statement |
Specifies at least one valid N1QL for Analytics statement to run. |
string |
client_context_id |
An identifier passed by the client that is returned verbatim in the query response. Useful for matching a particular query to a specific caller. |
string |
format |
Desired format for the query results. |
enum (JSON, application/x-adm, application/json, application/json;lossless, text/csv) |
pretty |
If |
boolean |
readonly |
If |
boolean |
scan_consistency |
The consistency guarantee constraint for index scanning. If |
enum (not_bounded, request_plus) |
scan_wait |
The maximum time to wait for datasets to be updated before the query is executed. The format includes an amount and a unit: |
string |
timeout |
Maximum time to spend on the request before timing out. The format includes an amount and a unit: |
string |
args |
An array of positional parameter values. |
< object > array |
$identifier |
A named parameter value. |
string |
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.
Analytics Parameters
Name | Description | Schema |
---|---|---|
plan-format |
The plan format. |
enum (JSON, STRING) |
logical-plan |
If |
boolean |
optimized-logical-plan |
If |
boolean |
expression-tree |
If |
boolean |
rewritten-expression-tree |
If |
boolean |
job |
If |
boolean |
max-warnings |
An integer specifying the maximum number of warning messages to be included in the query response. |
integer (int32) |