Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Analytics Query Parameters

      +

      Common Parameters

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

      For more information on these common parameters, refer to Request-Level Parameters.

      Property Schema

      statement
      required

      Specifies at least one valid SQL++ for Analytics statement to run.

      String

      client_context_id
      optional

      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
      optional

      Desired format for the query results.

      Note that the only possible format is JSON.

      Values: "JSON"
      Default: "JSON"

      String

      pretty
      optional

      If true, the result is indented.

      Default: false

      Boolean

      query_context
      optional

      A scope for the statement. The value of this parameter must start with default:, followed by an Analytics scope name. The default: prefix is a dummy and is ignored when resolving an Analytics collection name or synonym name.

      Default: "default:Default"

      String

      readonly
      optional

      If true, then DDL statements are not allowed.

      Default: false

      Boolean

      scan_consistency
      optional

      The consistency guarantee constraint for index scanning. If not_bounded, the query is executed immediately. If request_plus, the required datasets are updated with data available from the Data service at the time of the request before the query is executed.

      Values: "not_bounded", "request_plus"
      Default: "not_bounded"

      String

      scan_wait
      optional

      The maximum time to wait for datasets to be updated before the query is executed. The format includes an amount and a unit: ns, us, ms, s, m, or h. The default is "" (no timeout).

      String

      timeout
      optional

      Maximum time to spend on the request before timing out. The format includes an amount and a unit: ns, us, ms, s, m, or h. The default is "" (no timeout).

      String

      args
      optional

      An array of positional parameter values.

      Object list

      additional
      property

      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.

      Property Schema

      plan-format
      optional

      The plan format.

      Values: "JSON", "STRING"
      Default: "JSON"

      String

      logical-plan
      optional

      If true, the logical plan is included in the query response.

      Default: false

      Boolean

      optimized-logical-plan
      optional

      If true, the optimized logical plan is included in the query response.

      Default: true

      Boolean

      expression-tree
      optional

      If true, the expression tree is included in the query response.

      Default: false

      Boolean

      rewritten-expression-tree
      optional

      If true, the rewritten expression tree is included in the query response.

      Default: false

      Boolean

      job
      optional

      If true, the job details are included in the query response.

      Default: false

      Boolean

      max-warnings
      optional

      An integer specifying the maximum number of warning messages to be included in the query response.

      Default: 0

      Integer (int32)