Apache CouchDB · JSON Structure

Apache Couchdb Find Request Structure

Mango query request

Type: object Properties: 6 Required: 1
ApacheDatabaseDocument StoreJSONNoSQLOpen SourceReplicationREST

FindRequest is a JSON Structure definition published by Apache CouchDB, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

selector fields limit skip sort bookmark

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-couchdb/refs/heads/main/json-structure/apache-couchdb-find-request-structure.json",
  "name": "FindRequest",
  "description": "Mango query request",
  "type": "object",
  "properties": {
    "selector": {
      "type": "object",
      "description": "Mango selector (JSON query expression)",
      "example": {
        "type": "product",
        "status": "active"
      }
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Fields to return in results",
      "example": [
        "_id",
        "name"
      ]
    },
    "limit": {
      "type": "int32",
      "description": "Maximum number of results",
      "default": 25,
      "example": 25
    },
    "skip": {
      "type": "int32",
      "description": "Number of results to skip",
      "default": 0,
      "example": 0
    },
    "sort": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Sort order specification",
      "example": [
        {
          "name": "asc"
        }
      ]
    },
    "bookmark": {
      "type": "string",
      "description": "Bookmark for pagination from previous query",
      "example": "g1AAAABleJzLYWBg"
    }
  },
  "required": [
    "selector"
  ]
}