FindRequest

Mango query request

ApacheDatabaseDocument StoreJSONNoSQLOpen SourceReplicationREST

Properties

Name	Type	Description
selector	object	Mango selector (JSON query expression)
fields	array	Fields to return in results
limit	integer	Maximum number of results
skip	integer	Number of results to skip
sort	array	Sort order specification
bookmark	string	Bookmark for pagination from previous query

View JSON Schema on GitHub

JSON Schema

{
  "$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-find-request-schema.json",
  "title": "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": "integer",
      "description": "Maximum number of results",
      "default": 25,
      "example": 25
    },
    "skip": {
      "type": "integer",
      "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"
  ]
}