Couchbase · Schema

ReplicationCreateRequest

Request to create an XDCR replication

AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name Type Description
fromBucket string Name of the source bucket
toCluster string Name of the remote cluster reference
toBucket string Name of the target bucket on the remote cluster
replicationType string Type of replication
filterExpression string Regular expression filter for document IDs
compressionType string Compression type for replication data
priority string Replication priority
View JSON Schema on GitHub

JSON Schema

couchbase-replicationcreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReplicationCreateRequest",
  "title": "ReplicationCreateRequest",
  "type": "object",
  "description": "Request to create an XDCR replication",
  "required": [
    "fromBucket",
    "toCluster",
    "toBucket",
    "replicationType"
  ],
  "properties": {
    "fromBucket": {
      "type": "string",
      "description": "Name of the source bucket"
    },
    "toCluster": {
      "type": "string",
      "description": "Name of the remote cluster reference"
    },
    "toBucket": {
      "type": "string",
      "description": "Name of the target bucket on the remote cluster"
    },
    "replicationType": {
      "type": "string",
      "description": "Type of replication",
      "enum": [
        "continuous"
      ]
    },
    "filterExpression": {
      "type": "string",
      "description": "Regular expression filter for document IDs"
    },
    "compressionType": {
      "type": "string",
      "description": "Compression type for replication data",
      "enum": [
        "None",
        "Auto",
        "Snappy"
      ]
    },
    "priority": {
      "type": "string",
      "description": "Replication priority",
      "enum": [
        "High",
        "Medium",
        "Low"
      ]
    }
  }
}