ReplicationRequest

Replication task parameters

ApacheDatabaseDocument StoreJSONNoSQLOpen SourceReplicationREST

Properties

Name	Type	Description
source	string	Source database URL or name
target	string	Target database URL or name
continuous	boolean	Keep the replication running continuously
create_target	boolean	Create the target database if it does not exist
filter	string	Filter function name to limit replicated documents
doc_ids	array	List of document IDs to replicate

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-replication-request-schema.json",
  "title": "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"
  ]
}