Couchbase · Schema

AllDocsResponse

Response for _all_docs request

AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name	Type	Description
rows	array	Array of document entries
total_rows	integer	Total number of rows
update_seq	integer	Current update sequence

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AllDocsResponse",
  "title": "AllDocsResponse",
  "type": "object",
  "description": "Response for _all_docs request",
  "properties": {
    "rows": {
      "type": "array",
      "description": "Array of document entries",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Document ID"
          },
          "key": {
            "type": "string",
            "description": "Document key"
          },
          "value": {
            "type": "object",
            "properties": {
              "rev": {
                "type": "string",
                "description": "Current revision ID"
              }
            }
          },
          "doc": {
            "type": "object",
            "description": "Full document body (if include_docs=true)"
          }
        }
      }
    },
    "total_rows": {
      "type": "integer",
      "description": "Total number of rows"
    },
    "update_seq": {
      "type": "integer",
      "description": "Current update sequence"
    }
  }
}