Apache CouchDB · JSON Structure

Apache Couchdb Replication Request Structure

Replication task parameters

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

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

Properties

source target continuous create_target filter doc_ids

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-replication-request-structure.json",
  "name": "ReplicationRequest",
  "description": "Replication task parameters",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "description": "Source database URL or name",
      "example": "http://localhost:5984/sourcedb"
    },
    "target": {
      "type": "string",
      "description": "Target database URL or name",
      "example": "http://remotehost:5984/targetdb"
    },
    "continuous": {
      "type": "boolean",
      "description": "Keep the replication running continuously",
      "default": false,
      "example": false
    },
    "create_target": {
      "type": "boolean",
      "description": "Create the target database if it does not exist",
      "default": false,
      "example": true
    },
    "filter": {
      "type": "string",
      "description": "Filter function name to limit replicated documents",
      "example": "myapp/by_type"
    },
    "doc_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of document IDs to replicate"
    }
  },
  "required": [
    "source",
    "target"
  ]
}