Apache CouchDB · Schema

ViewResponse

MapReduce view query results

ApacheDatabaseDocument StoreJSONNoSQLOpen SourceReplicationREST

Properties

Name Type Description
total_rows integer Total number of rows in the view
offset integer Number of skipped rows
rows array
View JSON Schema on GitHub

JSON Schema

apache-couchdb-view-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-couchdb/refs/heads/main/json-schema/apache-couchdb-view-response-schema.json",
  "title": "ViewResponse",
  "description": "MapReduce view query results",
  "type": "object",
  "properties": {
    "total_rows": {
      "type": "integer",
      "description": "Total number of rows in the view",
      "example": 150
    },
    "offset": {
      "type": "integer",
      "description": "Number of skipped rows",
      "example": 0
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "doc001"
          },
          "key": {
            "description": "Emitted key from the map function",
            "example": "active"
          },
          "value": {
            "description": "Emitted value from the map or reduce function",
            "example": 1
          },
          "doc": {
            "title": "Document",
            "type": "object",
            "description": "A CouchDB document with system fields and user-defined fields",
            "properties": {
              "_id": {
                "type": "string",
                "description": "Document ID",
                "example": "doc001"
              },
              "_rev": {
                "type": "string",
                "description": "Current revision ID (major-hash format)",
                "example": "1-abc123def456"
              },
              "_deleted": {
                "type": "boolean",
                "description": "Present and true for deleted (tombstone) documents",
                "example": false
              }
            }
          }
        }
      }
    }
  }
}