CreateIndexRequest

Request to create a Mango index

ApacheDatabaseDocument StoreJSONNoSQLOpen SourceReplicationREST

Properties

Name	Type	Description
index	object	Index definition
ddoc	string	Design document name to use for the index
name	string	Index name
type	string	Index type

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-create-index-request-schema.json",
  "title": "CreateIndexRequest",
  "description": "Request to create a Mango index",
  "type": "object",
  "properties": {
    "index": {
      "type": "object",
      "description": "Index definition",
      "properties": {
        "fields": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "object"
              }
            ]
          },
          "description": "Fields to index"
        }
      }
    },
    "ddoc": {
      "type": "string",
      "description": "Design document name to use for the index",
      "example": "idx-status-type"
    },
    "name": {
      "type": "string",
      "description": "Index name",
      "example": "idx-status-type"
    },
    "type": {
      "type": "string",
      "description": "Index type",
      "enum": [
        "json",
        "text"
      ],
      "default": "json",
      "example": "json"
    }
  }
}