A newer version of this documentation is available.

View Latest

Create a Replication

      An XDCR replication allows data to be replicated continuously from a specified bucket on the source cluster to a specified bucket on the target.

      Understanding Replications

      An XDCR replication is created on the cluster that is to be the source of the data-replication. Each replication uses a single reference, which has already been created. (See Create a Reference.) To create the replication, you specify:

      • The local, source bucket from which data is to be replicated; and, potentially, the scopes and collections within that bucket.

      • The remote cluster to which data is to be replicated. This cluster must already be registered on the local cluster as a reference.

      • The bucket on the remote cluster to which data is to be replicated; and, potentially, the scopes and collections within that bucket.

      • Whether filtering should be used in replication, and if so, according to what regular expression.

      • Other Advanced Replication Settings, which can be used to optimize replication-performance.

      Note that multiple replications (each using a different source-target bucket combination) can be created using a single reference (which refers to a target cluster, but not to any specific bucket on it).

      Examples on This Page

      The examples in the subsections below show how to create the same replication; using the UI, the CLI, and the REST API respectively. As their starting-point, the examples assume the scenario that concluded the page Create a Reference, this being:

      • Two clusters already exist; each containing a single node. These are named after their IP addresses: and

      • Each cluster contains a single bucket, which is the travel-sample bucket.

      • Each cluster has the Full Administrator username of Administrator, and password of password.

      • Cluster now has a reference that specifies its own travel-sample bucket as a source, and the travel-sample bucket on as a target.

      Create an XDCR Replication with the UI

      Proceed as follows:

      1. Access Couchbase Web Console. Left-click on the XDCR tab, in the left-hand navigation menu.

        left click on xdcr tab

        This displays the XDCR Replications screen, the lower part of the main panel of which is entitled Outgoing Replications:

        xdcr outgoing replications initial

        The list, which is designed to show the name and IP address or hostname of each existing replication, is currently empty, and so bears the notification There are currently no replications defined. Use ADD REPLICATION to set one up.

      2. To start creating a replication, left-click on the ADD REPLICATION button:

        left click on add replication button

        The XDCR Add Replication screen is now displayed:

        xdcr add replication screen

        The fields in the upper area of the screen — Replicate From Bucket, Remote Bucket, and Remote Cluster — allow a replication to be defined that specifies source and target bucket only. The remaining fields allow scopes and collections — within source and/or target buckets — to be additionally specified; and allow Advanced Settings to be used.

        The example on this page will not configure Advanced Settings; and will specify source and target bucket only — each bucket being specified as the sample bucket travel-sample.

        Note that since the data within travel-sample is contained within multiple scopes and collections, the path to each collection — known as a keyspace, and always being of the form scope-name.collection-name — is necessarily identical on each cluster. XDCR’s default behavior is always to replicate data between corresponding keyspaces: for example, data in inventory.airline on the source is replicated to inventory.airline on the target. When a keyspace on the source does not have a corresponding keyspace on the target, XDCR’s default behavior is not to replicate data from that source keyspace. This is known as replication by implicit mapping.

        Detailed examples of explicitly specifying scopes and collections (and so, potentially, establishing mappings between dissimilar keyspaces) are provided later, in Replicate Using Scopes and Collections.

        Note that when a replication is defined only as bucket to bucket (as in the current example), and thereby makes no reference to a scope or collection, the documents to be replicated are understood by XDCR to reside in the _default collection, which resides within the _default scope, of the source bucket. The documents will duly be replicated to the _default collection, in the _default scope, of the target bucket. For more information , see Default Scope and Collection.

        An account of Advanced Settings is provided in Advanced Replication Settings with the UI, below.

        The practical steps required for establishing filters are explained in Filter a Replication.

      3. Enter appropriate information into the upper fields of the Add Replication screen. Specify as the target cluster, and travel-sample as both source and target bucket. The fields in the upper area of the screen now appear as follows.

        xdcr add replication screen upper fields complete
      4. Left-click on the Save Replication button, at the bottom of the screen:


        The XDCR Replications screen is now redisplayed, with the appearance of the Outgoing Replications panel as follows:

        xdcr outgoing replications with replication2

        This indicates that a replication is now in progress: from travel-sample on this cluster, to travel-sample on cluster

      This concludes creation of the replication. Note that by left-clicking on the row for the replication, additional controls can be displayed:

      xdcr outgoing replications with replication opened

      Use of the Pause control is described in Pause a Replication; use of the Delete control in Delete a Replication; and use of the Edit control in Editing Filters.

      Monitor Current Replications

      All current replications can be monitored, by left-clicking on the XDCR Stats tab, at the left of the XDCR Replications screen. The panel appears as follows.

      xdcr statistics

      For information on how to read the interactive charts now displayed, see Manage Statistics.

      Advanced Replication Settings with the UI

      Left-click on the Advanced Replication Settings control, in the Add Replication dialog. The UI expands vertically, to reveal the following:

      xdcr advanced settings

      The values displayed in the fields are defaults, which can be modified interactively, and saved: this may help in achieving optimal replication-performance. For details on the significance of each field, see the XDCR Reference.

      Error Notifications

      If, while a replication is in progress, errors occur, a notification appears adjacent to the status displayed on the row for the replication:

      xdcr error notification

      Left-click on the orange icon, to display a full account of problems:

      xdcr error notification full

      Create an XDCR Replication with the CLI

      Staring from the scenario defined above, in Examples on This Page, use the CLI xdcr-replicate command to create an XDCR replication, as follows:

      couchbase-cli xdcr-replicate -c \
      -u Administrator \
      -p password \
      --create \
      --xdcr-cluster-name \
      --xdcr-from-bucket travel-sample \
      --xdcr-to-bucket travel-sample \
      --xdcr-replication-mode xmem

      If successful, this provides the following response:

      SUCCESS: XDCR replication created

      For more information, see the complete reference for the xdcr-replicate command. Note that this includes descriptions of all flags that support the Advanced Settings, described above.

      Create an XDCR Replication with the REST API

      Starting from the scenario defined above, in Examples on This Page, using the REST API’s POST /controller/createReplication HTTP method and URI, create an XDCR reference as follows:

      curl -v -X POST -u Administrator:password \ \
      -d fromBucket=travel-sample \
      -d toCluster= \
      -d toBucket=travel-sample \
      -d replicationType=continuous \
      -d enableCompression=1

      If successful, this provides the following response:


      For more information, see Creating XDCR Replications. For information on REST-driven configuration of the Advanced Settings described above, see Managing Advanced XDCR Settings.

      Next Steps

      Once a replication has been defined and is therefore running, you can opt to pause it, in order to perform system maintenance. See Pause a Replication.