Description

The backup process writes a copy of data onto disk. To create a backup using cbbackup, the node or cluster needs to be functioning in order.

The cbbackup, cbrestore, and cbtransfer tools do not communicate with external IP addresses for server nodes outside of a cluster. Backup, restore, or transfer operations are performed on data from a node within a Couchbase cluster. They only communicate with nodes from a node list obtained within a cluster. This also means that if Couchbase Server is installed with a default IP address, an external hostname cannot be used to access it.

This tool has several different options which you can use to:

• Backup all buckets in an entire cluster
• Backup one named bucket in a cluster
• Backup all buckets on a node in a cluster
• Backup one named buckets on a specified node

This tool is the following directories:

CLI commands and parameters

The format of the cbbackup command is:

cbbackup [options] [source] [backup-dir]

Where:

• [options]

  Same options available for cbtransfer tool.

• [source]

  Source for the backup. This can be either a URL of a node when backing up a single node or the cluster, or a URL specifying a directory where the data for a single bucket is located.

• [backup-dir]

  The directory for the backup files to be stored. Either the directory must exist, and be empty, or the directory will be created. The parent directory must exist.

CLI command and parameters

The following are the command options:

The following are extra, specialized command options with the cbbackup -x parameter.

Syntax

The following is the basic syntax:

cbrestore [options] [backup-dir] [destination]

The following syntax examples include a full backup and two incremental backups for a cluster.:

cbbackup http://HOST:8091 /backup-42
cbbackup http://HOST:8091 /backup-42
cbbackup http://HOST:8091 /backup-42
			

The following syntax examples include a full backup, two differential backups, and one accumulative backup for a single node.

cbbackup couchbase://HOST:8091 /backup-43 [-m full] --single-node
cbbackup couchbase://HOST:8091 /backup-43 [-m diff] --single-node
cbbackup couchbase://HOST:8091 /backup-43 [-m diff] --single-node
cbbackup couchbase://HOST:8091 /backup-43 -m accu --single-node
         

Example: Backing up clusters

An entire cluster can be backed up. This includes all of the data buckets and data at all nodes and all design documents. To backup an entire cluster and all buckets for that cluster:

cbbackup http://HOST:8091 ~/backups \
          -u Administrator -p password

Where ~/backups is the directory where you want to store the data. When this operation is performed, be aware that cbbackup creates the following directory structure and files in the ~/backups directory assuming there two buckets in the cluster named my_name and sasl and two nodes N1 and N2 :

~/backups
        bucket-my_name
            N1
            N2
        bucket-sasl
            N1
            N2

Where bucket-my_name and bucket-sasl are directories containing data files and where N1 and N2 are two sets of data files for each node in the cluster.

Example: Backing up a single bucket

To backup a single bucket in a cluster:

cbbackup http://HOST:8091 /backups/backup-20120501 \
  -u Administrator -p password \
  -b default

In this case, the default bucket in the cluster is specified and the data from the default bucket is backed up.

Example: Backing up multiple buckets

To backup all data from multiple buckets on a single node:

> cbbackup http://HOST:8091 /backups/ \
  -u Administrator -p password \
  --single-node

To backup data from a single bucket on a single node:

cbbackup http://HOST:8091 /backups \
  -u Administrator -p password \
  --single-node \
  -b bucket_name

Example: Backing up keys

To specify the keys that are backed up using the - k option. For example, to backup all keys from a bucket with the prefix ‘object’:

> cbbackup http://HOST:8091 /backups/backup-20120501 \
  -u Administrator -p password \
  -b bucket_name \
  -k '^object.*'