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

couchbase-server

  • reference
    +

    The couchbase-server command is used to start, stop, and retrieve status on a non-root-installed server, on any supported Linux platform.

    Syntax

    couchbase-server [
          [ --start ]
          [ --status | -s ]
          [ --stop | -k ]
          [ --help | -h ]
          [ --version | -v ]
         ]

    Description

    The couchbase-server command is used to control aspects of a Couchbase Server that has been installed, on a supported Linux platform, by means of the non-root procedure; as described in Non-Root Install and Upgrade. This command cannot be used to control a Couchbase Server installed by the standard, package-based install procedure.

    The --start flag causes the non-root Couchbase Server to start. This is the default option, and is invoked if no flag is specified.

    The --status flag returns status on the non-root Couchbase Server, indicating whether it has been started, or has been stopped.

    The --stop flag causes a running non-root Couchbase Server to stop.

    The --help flag prints help text to the console.

    The --version flag prints to the console the version number of the non-root Couchbase Server.

    Examples

    The following examples show how the couchbase-server command and its parameters can be used. The examples assumes that the current working directory is <install-location/opt/couchbase/bin.

    Start

    To start a non-root Couchbase Server, enter the following command:

    ./couchbase-server --start

    This starts a non-root Couchbase Server. No output is displayed.

    Get Status

    To get status on whether a non-root Couchbase Server is running, enter the following command.

    ./couchbase-server --status

    If a non-root Couchbase Server is running, the following is displayed:

    Couchbase Server is running

    If a non-root-installed Couchbase Server is not running, the following is displayed:

    Couchbase Server is not running

    Stop

    To stop a non-root Couchbase Server, enter the following command:

    ./couchbase-server --stop

    This stops a running, non-root Couchbase Server. The output might appear as follows:

    2020-06-30 09:33:03 cb_dist: terminating with reason: shutdown

    If no non-root Couchbase Server was running, no output is displayed.

    Get Version Number

    To get the version number of the non-root Couchbase Server, enter the following:

    ./couchbase-server --version

    If successful, the command prints the version number and edition of the non-root Couchbase Server, as follows:

    Couchbase Server 6.6.0-7853 (EE)

    See Also

    Links to standard, package-based install procedures are provided in Install Couchbase Server on Linux. A full account of the non-root install procedure for Couchbase Server, and of the preparations this requires, is provided in Non-Root Install and Upgrade.