A newer version of this documentation is available.

View Latest

bucket-list

    +

    List all buckets

    SYNOPSIS

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

    DESCRIPTION

    Lists all buckets in the cluster. For each bucket, the following are printed to stdout: bucketType, authType, numReplicas, ramQuota, ramUsed.

    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
    --user <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.

    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 list all buckets in the cluster, run the following command.

    $ couchbase-cli bucket-list -c 192.168.1.5:8091 --username Administrator \
     --password password
    
     travel-data
       bucketType: membase
       authType: sasl
       numReplicas: 1
       ramQuota: 104857600
       ramUsed: 45302840
     airline-data
       bucketType: ephemeral
       authType: sasl
       numReplicas: 1
       ramQuota: 268435456
       ramUsed: 1134432
     flight-data
       bucketType: memcached
       authType: sasl
       numReplicas: 0
       ramQuota: 104857600
       ramUsed: 0

    DISCUSSION

    In the output, RAM figures are in bytes. The "membase" bucketType signifies a Couchbase bucket. The authType can be either "sasl" or "none".

    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.

    COUCHBASE-CLI

    Part of the couchbase-cli suite