Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

bucket-compact

      +

      Compact a bucket

      SYNOPSIS

      couchbase-cli bucket-compact [--cluster <url>] [--username <user>]
    [--password <password>] [--bucket <name>]

      DESCRIPTION

      Starts compaction of view index and data files for a specified bucket. To compact view index files only, specify the --view-only option. To compact data files only, specify the --data-only option. Only Couchbase buckets can be compacted: Ephemeral and Memcached buckets cannot be compacted.

      OPTIONS

      -c
      --cluster

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

      -u
      --username <username>

      Specifies the username of the user executing the command. If you do not have a user account with permission 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 permission 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.

      --bucket

      The name of the bucket on which to perform compaction.

      --data-only

      Indicates that only data files should be compacted, and that compaction for view index files should therefore be skipped. This option cannot be specified at the same time as the --view-only option.

      --view-only

      Indicates that only view index files should be compacted, and that compaction for data files should therefore be skipped. This option cannot be specified at the same time as the --data-only option.

      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

      To start compaction of both data and view index files for a bucket named "travel-data", run the following command.

      $ couchbase-cli bucket-compact -c 192.168.1.5:8091 --username Administrator \
 --password password --bucket travel-data

      If view index files only should be compacted for a specific bucket, and data files thereby skipped, run the following command.

      $ couchbase-cli bucket-compact -c 192.168.1.5:8091 --username Administrator \
 --password password --bucket travel-data --view-only

      If data files only should be compacted for a specific bucket, and view index files thereby skipped, run the following command.

      $ couchbase-cli bucket-compact -c 192.168.1.5:8091 --username Administrator \
 --password password --bucket travel-data --data-only

      ENVIRONMENT AND CONFIGURATION VARIABLES

      CB_REST_USERNAME

      Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

      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.

      SEE ALSO

      bucket-compact, bucket-create, bucket-delete, bucket-edit, bucket-flush

      COUCHBASE-CLI

      Part of the couchbase-cli suite