Couchbase · Schema

QueryResult

SQL++ query execution result

AnalyticsApp ServicesBackupCapellaCloudDatabaseDatabase-as-a-ServiceEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name Type Description
requestID string Unique identifier for the request
clientContextID string Client-provided context identifier
signature object Schema signature of the results
results array Array of result documents
status string Query execution status
metrics object Query execution metrics
errors array List of errors if any occurred
warnings array List of warnings if any
View JSON Schema on GitHub

JSON Schema

couchbase-queryresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QueryResult",
  "title": "QueryResult",
  "type": "object",
  "description": "SQL++ query execution result",
  "properties": {
    "requestID": {
      "type": "string",
      "description": "Unique identifier for the request"
    },
    "clientContextID": {
      "type": "string",
      "description": "Client-provided context identifier"
    },
    "signature": {
      "type": "object",
      "description": "Schema signature of the results"
    },
    "results": {
      "type": "array",
      "description": "Array of result documents",
      "items": {}
    },
    "status": {
      "type": "string",
      "description": "Query execution status",
      "enum": [
        "success",
        "running",
        "errors",
        "completed",
        "stopped",
        "timeout",
        "fatal"
      ]
    },
    "metrics": {
      "type": "object",
      "description": "Query execution metrics",
      "properties": {
        "elapsedTime": {
          "type": "string",
          "description": "Total elapsed time"
        },
        "executionTime": {
          "type": "string",
          "description": "Execution time excluding fetch"
        },
        "resultCount": {
          "type": "integer",
          "description": "Number of results returned"
        },
        "resultSize": {
          "type": "integer",
          "description": "Size of results in bytes"
        },
        "mutationCount": {
          "type": "integer",
          "description": "Number of mutations performed"
        },
        "errorCount": {
          "type": "integer",
          "description": "Number of errors encountered"
        },
        "warningCount": {
          "type": "integer",
          "description": "Number of warnings generated"
        }
      }
    },
    "errors": {
      "type": "array",
      "description": "List of errors if any occurred",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "Error code"
          },
          "msg": {
            "type": "string",
            "description": "Error message"
          }
        }
      }
    },
    "warnings": {
      "type": "array",
      "description": "List of warnings if any",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "Warning code"
          },
          "msg": {
            "type": "string",
            "description": "Warning message"
          }
        }
      }
    }
  }
}

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-queryresult"
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.