Apache CouchDB · Schema

DocRow

A row in an _all_docs response

ApacheDatabaseDocument StoreJSONNoSQLOpen SourceReplicationREST

Properties

Name Type Description
id string Document ID
key string Row key
value object Row value containing revision info
doc object A CouchDB document with system fields and user-defined fields
View JSON Schema on GitHub

JSON Schema

apache-couchdb-doc-row-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-doc-row-schema.json",
  "title": "DocRow",
  "description": "A row in an _all_docs response",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Document ID",
      "example": "doc001"
    },
    "key": {
      "type": "string",
      "description": "Row key",
      "example": "doc001"
    },
    "value": {
      "type": "object",
      "description": "Row value containing revision info",
      "properties": {
        "rev": {
          "type": "string",
          "example": "1-abc123"
        }
      }
    },
    "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
        }
      }
    }
  }
}