Couchbase · Schema

QueryRequest

SQL++ query execution request

AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name	Type	Description
statement	string	The SQL++ statement to execute
timeout	string	Maximum execution time (e.g., 10s, 5m)
readonly	boolean	Whether to restrict to read-only operations
pretty	boolean	Whether to format results with indentation
scan_consistency	string	Consistency requirement for the query
args	array	Positional parameters for the query
prepared	string	Name of a prepared statement to execute
client_context_id	string	Client-provided context identifier for tracking
max_parallelism	string	Maximum parallelism for the query
metrics	boolean	Whether to include metrics in the response

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QueryRequest",
  "title": "QueryRequest",
  "type": "object",
  "description": "SQL++ query execution request",
  "required": [
    "statement"
  ],
  "properties": {
    "statement": {
      "type": "string",
      "description": "The SQL++ statement to execute"
    },
    "timeout": {
      "type": "string",
      "description": "Maximum execution time (e.g., 10s, 5m)"
    },
    "readonly": {
      "type": "boolean",
      "description": "Whether to restrict to read-only operations"
    },
    "pretty": {
      "type": "boolean",
      "description": "Whether to format results with indentation"
    },
    "scan_consistency": {
      "type": "string",
      "description": "Consistency requirement for the query",
      "enum": [
        "not_bounded",
        "at_plus",
        "request_plus",
        "statement_plus"
      ]
    },
    "args": {
      "type": "array",
      "description": "Positional parameters for the query",
      "items": {}
    },
    "prepared": {
      "type": "string",
      "description": "Name of a prepared statement to execute"
    },
    "client_context_id": {
      "type": "string",
      "description": "Client-provided context identifier for tracking"
    },
    "max_parallelism": {
      "type": "string",
      "description": "Maximum parallelism for the query"
    },
    "metrics": {
      "type": "boolean",
      "description": "Whether to include metrics in the response"
    }
  }
}