Couchbase · Schema

QueryRequest

SQL++ query execution request

AnalyticsApp ServicesBackupCapellaCloudDatabaseDatabase-as-a-ServiceEventingFull-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

couchbase-queryrequest-schema.json Raw ↑
{
  "$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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/couchbase-queryrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.