setting-xdcr

setting-xdcr

Modifies cross datacenter replication (XDCR) settings

SYNTAX

couchbase-cli setting-xdcr [--cluster <url>] [--username <user>] [--password <password>] [--checkpoint-interval <seconds>] [--worker-batch-size <num>] [--doc-batch-size <kilobytes>] [--failure-restart-interval <seconds>] [--source-nozzle-per-node <num>] [--target-nozzle-per-node <num>] [--bandwidth-usage-limit <num>] [--stats-interval <milliseconds>] [--optimistic-replication-threshold <bytes>] [--log-level <level>]

DESCRIPTION

This command sets gloabl default settings for all XDCR replications. If you only want to change the settings for a single XDCR replication see the couchbase-cli-xdcr-replicate1 command.

OPTIONS

-c
--cluster

Specfies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

-u
--user <username>

Specifies the username of the user executing the command. If you do not have a user account with permision to execute the command then it will fail with an unauthorized error.

-p
--password <password>

Specifies the password of the user executing the command. If you do not have a user account with permision to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

--checkpoint-interval <seconds>

The interval between checkpoints in seconds. The value of this option must be between 60 and 14,400.

--worker-batch-size <num>

The worker batch size. The value of this option must be between 500 and 10,000.

--doc-batch-size <kilobytes>

The document batch size in Kilobytes. The value of this option must be between 10 and 100,000.

--failure-restart-interval <seconds>

Interval for restarting failed XDCR connections in seconds. The value of this option must be between 1 and 300.

--optimistic-replication-threshold <bytes>

Document body size threshold in bytes used to trigger optimistic replication.

--source-nozzle-per-node <num>

The number of source nozzles to each node in the target cluster. The value of this option must be between 1 and 10.

--target-nozzle-per-node <num>

The number of outgoing nozzles to each node in the target cluster. The value of this option must be between 1 and 10.

--bandwidth-usage-limit <num>

The default bandwidth limit for XDCR replications in Megabytes per second.

--log-level <level>

The XDCR log level.

--stats-interval <milliseconds>

The interval for statistics updates in milliseconds.

HOST FORMATS

When specifying a host for the couchbase-cli command the following formats are expected:

  • couchbase://<addr>

  • <addr>:<port>

  • http://<addr>:<port>

It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

EXAMPLES

If we want to change the checkpoint interval to 500 seconds, the worker batch to 1000 documents, the document batch size to 10240KB, the failure restart interval to 60 seconds. the optimistic replication threshold to 102400 bytes, the source nozzels to 8, the target nozzles to 8, the log level to info, and the stats interval to 100 milliseconds run the following command.

$ couchbase-cli xdcr-setup -c 192.168.1.5 -u Administrator \
 -p password --checkpoint-interval 500 --worker-batch-size 1000 \
 --doc-batch-size 10240 --failure-restart-interval 60 \
 --optimistic-replication-threshold 102400 --source-nozzle-per-node 8 \
 --target-nozzle-per-node 8 --log-level info --stats-interval 100

ENVIRONMENT AND CONFIGURATION VARIABLES

CB_REST_PASSWORD Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

CB_REST_PASSWORD Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line.