A newer version of this documentation is available.

View Latest

Analytics Query Parameters

    +

    Common Parameters

    The Couchbase Analytics Service API supports the following parameters in common with the N1QL for Query REST API.

    Parameter Default Values

    statement

    Specifies at least one valid N1QL for Analytics statement to run. (Required.)

    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. (Optional.)

    format

    JSON

    JSON, application/x-adm, application/json, application/json;lossless, or text/csv

    NOTE: The values: application/x-adm, application/json, application/json;lossless, text/csv are planned to be deprecated and will no longer be supported in the future.

    pretty

    FALSE

    TRUE or FALSE. If TRUE, the result will be indented. (Optional.)

    timeout

    (no timeout)

    An amount and a unit: ns, us, ms, s, m, or h.

    args

    An array of positional parameter values.

    $<identifier>

    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.

    Analytics Parameters

    In addition, the Service API supports the following parameters which are unique to Analytics.

    Parameter Default Values

    plan-format

    JSON

    JSON, STRING

    logical-plan

    FALSE

    TRUE, FALSE

    optimized-logical-plan

    TRUE

    TRUE, FALSE

    expression-tree

    FALSE

    TRUE, FALSE

    rewritten-expression-tree

    FALSE

    TRUE, FALSE

    job

    FALSE

    TRUE, FALSE