As of Couchbase Server 2.0, the following publicly available tools have been renamed, consolidated or removed. This is to provide better usability, and reduce the number of commands required to manage Couchbase Server:
Table 7.1. Administration — Command-line Tools and Availability
| Tool | Server Versions | Description/Status |
|---|---|---|
| couchbase-cli | 2.0 | The main tool for communicating and managing your Couchbase Server. |
| cbstats | 2.0 | A tool for checking a Couchbase Server node for its statistics. |
| cbepctl | 2.0 | A tool for controlling the vBucket states on a Couchbase Server node. Also responsible for controlling the configuration, memory and disk persistence behavior. Formerly provided as the separate tools, cbvbucketctl and cbflushctl in Couchbase 1.8. |
| cbcollect_info | 2.0 | A support tool for gathering statistics from a Couchbase Server node and used by Couchbase Technical Support. |
| cbbackup | 2.0 | Creates a copy of all the data for a cluster, bucket, node, or combination and stores it in a file on disk. |
| cbrestore | 2.0 | Reads in data from a backup file and reload data for a cluster, bucket, node, or combination into RAM. |
| cbtransfer | 2.0 | This tool is the underlying, generic data transfer tool that cbbackup and cbrestore are built upon. |
| cbdocloader | 2.0 | Used for loading sample data sets. Can be used to load a directory of JSON files into Couchbase Server. |
| cbworkloadgen | 2.0 | Generates test workload for cluster. |
| cbanalyze-core | 2.0 | Helper script to parse and analyze core dump from a Couchbase node. |
| vbuckettool | 2.0 | Returns vBucket and node where a key should be for a Couchbase bucket. These two values based on Couchbase Server internal hashing algorithm. Moved as of 1.8 to /bin/tools directory. |
| cbflushctl | 1.8 | Replaced by cbepctl in 2.0. |
| cbvbucketctl | 1.8 | Replaced by cbepctl in 2.0. |
By default, the command-line tools are installed into the following locations on each platform:
| Linux | /opt/couchbase/bin,
/opt/couchbase/bin/install,
/opt/couchbase/bin/tools,
/opt/couchbase/bin/tools/unsupported |
| Windows | C:\Program Files\couchbase\server\bin,
C:\Program Files\couchbase\server\bin\install,
and
C:\Program Files\couchbase\server\bin\tools. |
| Mac OS X | /Applications/Couchbase Server.app/Contents/Resources/couchbase-core/bin |