bucket-edit

bucket-edit

Edit a Couchbase data bucket

SYNTAX

couchbase-cli bucket-edit [--cluster <url>] [--username <user>] [--password <password>] [--bucket <name>] [--bucket-ramsize <size>] [--bucket-replica <num>] [--bucket-priority <priority>] [--bucket-eviction-policy <policy>] [--enable-flush <num>]

DESCRIPTION

Modifies the settings of the bucket specified. Note that some settings can be applied immediately while other settings may require a rebalance or the bucket to be restarted resulting in potential application downtime. See information about the settings that can be changed below to understand more about their impact on your application.

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.

--bucket <name>

The name of the bucket to edit.

--bucket-ramsize <size>

The amount of memory to allocate to the cache for this bucket in Megabytes. The memory quota of this bucket must fit into the overall cluster memory quota. The minimum cache size is 100MB.

--bucket-replica <num>

The amount of servers to replicate data to. Replicas provide protection against data loss by keeping copies of the data in this bucket on multiple servers. By default the number of replicas is one even if there is only a single server in the cluster. The minimum amount of replicas is zero and the maximum number is three. This option is only valid for couchbase buckets.

--bucket-priority <priority>

The disk I/O priority for this bucket. The value of this flag may be set to high or low. By default the priority is set to low. This option is only valid for couchbase buckets. This setting only has an affect on the disk IO if there are other buckets in the cluster.

--bucket-eviction-policy <policy>

The memory cache eviction policy for this bucket. Couchbase buckets support either "valueOnly" eviction or "fullEviction". Specifying the "valueEviction" policy means that each key stored in this bucket must be kept in memory. This is the default policy and using this policy will improve performance of key-value operations, but limits the maximum size of the bucket. Using the "fullEviction" policy means that performance will be impacted for key-value operations, but the maximum size of the bucket is unbounded.

Ephemeral buckets do not allow changing the eviction policy after the bucket
is created. In order to do this you need to delete and re-create the bucket.
--enable-flush <num>

Specifies whether or not the flush operation is allowed for this bucket. To enable flush set this option to "1". To disable flush set this option to "0". By default flush is disabled.

--enable-index-replica <num>

Enables replica view indexes for this bucket. There may be at most 1 view replica index. To enable replica indexes set the value of this option to "1". To disable replica indexes set the value of this option to "0". By default replica indexes are disabled.

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 memory quota of the travel-data bucket we would run the command below.

$ couchbase-cli bucket-edit -c 192.168.1.5:8091 --username Administrator \
 --password password --bucket travel-data --bucket-ramsize 1024

If we want to change the amount of replicas from 1 to 2 on the cb-data bucket then we would run the following commands below. Note that we need to rebalance with the couchbase-cli-rebalance1 in order to ensure that the replicas are created.

$ couchbase-cli bucket-edit -c 192.168.1.5:8091 --username Administrator \
 --password password --bucket travel-data --bucket-ramsize 1024 \
 --bucket-replicas 2
$ couchbase-cli bucket-edit -c 192.168.1.5:8091 --username Administrator \
 --password password

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.