-
Copyright 2010-2017, Couchbase Inc.
Generated on for Couchbase C Client by
1.14.0
|
Couchbase C Client
3.3.17
Asynchronous C Client for Couchbase
|
cbc COMMAND [OPTIONS]
cbc help
cbc version
cbc cat KEYS ... [OPTIONS]
cbc create KEY -V VALUE [OPTIONS]
cbc create KEY [OPTIONS]
cbc cp FILES ... [OPTIONS]
cbc incr KEY [OPTIONS]
cbc decr KEY [OPTIONS]
cbc touch KEY [OPTIONS]
cbc rm KEY [OPTIONS]
cbc hash KEY [OPTIONS]
cbc stats KEYS ... [OPTIONS]
cbc observe KEYS ... [OPTIONS]
cbc view VIEWPATH [OPTIONS]
cbc lock KEY [OPTIONS]
cbc unlock KEY CAS [OPTIONS]
cbc admin -P PASSWORD RESTAPI [OPTIONS]
cbc bucket-list -P PASSWORD [OPTIONS]
cbc bucket-create -P PASSWORD NAME [OPTIONS]
cbc bucket-delete -P PASSWORD NAME [OPTIONS]
cbc bucket-flush NAME [OPTIONS]
cbc role-list [OPTIONS]
cbc user-list [OPTIONS]
cbc user-upsert NAME [OPTIONS]
cbc user-delete NAME [OPTIONS]
cbc connstr SPEC
cbc query QUERY ... [OPTIONS]
cbc write-config [OPTIONS ...]
cbc strerror HEX-OR-DECIMAL-CODE
cbc ping [OPTIONS ...]
cbc watch [KEYS ...] [OPTIONS ...]
cbc keygen [KEYS ...] [OPTIONS ...]
cbc is a utility for communicating with a Couchbase cluster.
cbc should be invoked with the command name first and then a series of command options appropriate for the specific command. cbc help will always show the full list of available commands.
Options may be read either from the command line, or from a configuration file (see cbcrc(4)):
The following common options may be applied to most of the commands
-U, --spec=_SPEC_: A string describing the cluster to connect to. The string is in a URI-like syntax, and may also contain other options. See the EXAMPLES section for information. Typically such a URI will look like couchbase://host1,host2,host3/bucket.
The default for this option is couchbase://localhost/default
-P -, --password=-: Specify the password for the bucket. As for servers before 5.x this was only needed if the bucket is protected with a password. For cluster version after 5.x, the password is mandatory, and should match the selected account (read more at "Security/Authorization" section of the server manual).
Specifying the - as the password indicates that the program should prompt for the password. You may also specify the password on the commandline, directly, but is insecure as command line arguments are visible via commands such as ps.
The following options may be included in the connection string (via the -U option) as URI-style query params (e.g. couchbase://host/bucket?option1=value1&option2=value2) or as individual key=value pairs passed to the -D switch (e.g. -Doption1=value1 -Doption2=value). The -D will internally build the connection string, and is provided as a convenience for options to be easily passed on the command-line
The following commands are supported by cbc. Unless otherwise specified, each command supports all of the options above.
Write the value of keys to standard output.
This command requires that at least one key may be passed to it, but may accept multiple keys. The keys should be specified as positional arguments after the command.
In addition to the options in the OPTIONS section, the following options are supported:
Create a new item in the cluster, or update the value of an existing item. By default this command will read the value from standard input unless the --value option is specified.
The cp command functions the same, except it operates on a list of files. Each file is stored in the cluster under the name specified on the command line.
In addition to the options in the OPTIONS section, the following options are supported:
Retrieve persistence and replication information for items.
This command will print the status of each key to standard error.
See the OPTIONS for accepted options
These commands increment or decrement a counter item in the cluster. A counter is a value stored as an ASCII string which is readable as a number, thus for example 42.
These commands will by default refuse to operate on an item which does not exist in the cluster.
The incr and decr command differ with how they treat the --delta argument. The incr command will treat the value as a positive offset and increment the current value by the amount specified, whereas the decr command will treat the value as a negative offset and decrement the value by the amount specified.
In addition to OPTIONS, the following options are supported:
Display mapping information for a key.
This command diplays mapping information about a key. The mapping information indicates which vBucket the key is mapped to, and which server is currently the master node for the given vBucket.
See the OPTIONS for accepted options
Lock an item in the cluster.
This will retrieve and lock an item in the cluster, making it inaccessible for modification until it is unlocked (see unlock).
In addition to the common options (OPTIONS), this command accepts the following options:
Unlock a previously locked item.
This command accepts two mandatory positional arguments which are the key and CAS value. The CAS value should be specified as printed from the [lock][] command (i.e. with the leading 0x hexadecimal prefix).
See the OPTIONS for accepted options
Remove an item from the cluster.
This command will remove an item from the cluster. If the item does not exist, the operation will fail.
See the OPTIONS for accepted options
Retrieve a list of cluster statistics. If positional arguments are passed to this command, only the statistics classified under those keys will be retrieved. See the server documentation for a full list of possible statistics categories.
This command will contact each server in the cluster and retrieve that node's own set of statistics.
The statistics are printed to standard output in the form of SERVER STATISTIC VALUE where SERVER is the host:port representation of the node from which has provided this statistic, STATISTIC is the name of the current statistical key, and VALUE is the value for this statistic.
See the OPTIONS for accepted options
Retrieve a list of cluster statistics, select specified sub-keys and aggregate values across the cluster. Then continuously poll the stats and display the difference with the previous values. If the list of stat sub-keys not specified, the command will use cmd_total_ops, cmd_total_gets, cmd_total_sets.
In addition to the options in the OPTIONS section, the following options are supported:
Output list of keys that equally distribute amongst every vbucket.
In addition to the options in the OPTIONS section, the following options are supported:
Write the configuration file based on arguments passed.
Decode library error code
Display information about the underlying version of libcouchbase to which the cbc binary is linked.
Set the memcached logging versbosity on the cluster. This affects how the memcached processes write their logs. This command accepts a single positional argument which is a string describing the verbosity level to be set. The options are detail, debug info, and warning.
Sends NOOP-like request to every service on each cluster node, and report time it took to response.
Execute an HTTP request against the server's view (CAPI) interface.
The request may be one to create a design document, view a design document, or query a view.
To create a design document, the definition of the document (in JSON) should be piped to the command on standard input.
This command accepts one positional argument which is the path (relative to the bucket) to execute. Thus to query the brewery_beers view in the beer design document within the beer-sample bucket one would do: cbc view -U couchbase://localhost/beer-sample _design/beer/_view/brewery_beers
In addition to the OPTIONS specified above, the following options are recognized:
Execute a N1QL Query. The cluster must have at least one query node enabled.
The query itself is passed as a positional argument on the commandline. The query may contain named placeholders (in the format of $param), whose values may be supplied later on using the ‘--qarg=’$param=value'` syntax.
It is recommended to place the statement in single quotes to avoid shell expansion.
In addition to the OPTIONS specified above, the following options are recognized:
Execute an administrative request against the management REST API. Note that in order to perform an administrative API you will need to provide administrative credentials to cbc admin. This means the username and password used to log into the administration console.
This command accepts a single positional argument which is the REST API endpoint (i.e. HTTP path) to execute.
If the request requires a body, it should be supplied via standard input
In addition to the OPTIONS specified above, the following options are recognized:
List the buckets in the cluster
In addition to the OPTIONS specified above, the following options are recognized:
Create a bucket in the cluster.
This command will create a bucket with the name specified as the lone positional argument on the command line.
As this is an administrative command, the --username and --password options should be supplied administrative credentials.
In addition to the OPTIONS specified above, the following options are recognized:
This command will flush the bucket with the name specified as the lone positional argument on the command line.
This command does not require administrative level credentials, however it does require that flush be enabled for the bucket.
See the OPTIONS for accepted options
List accessible RBAC user roles in the cluster.
In addition to the OPTIONS specified above, the following options are recognized:
List users in the cluster.
In addition to the OPTIONS specified above, the following options are recognized:
Create or update a user in the cluster. Takes user ID as an argument.
In addition to the OPTIONS specified above, the following options are recognized:
Delete a user in the cluster. Takes user ID as an argument.
In addition to the OPTIONS specified above, the following options are recognized:
This command will parse a connection string into its constituent parts and display them on the screen. The command takes a single positional argument which is the string to parse.
The following shows how to connect to various types of buckets. These examples all show how to retrieve the key key. See OPERATION EXAMPLES for more information on specific sub-commands.
Connect to a bucket (a_bucket) on a cluster on a remote host (for servers version 5.x+). It uses account 'myname' and asks password interactively:
cbc cat key -U couchbase://192.168.33.101/a_bucket -u myname -P-
Run against a password-less bucket (a_bucket) on a cluster on a remote host (for servers older than 5.x):
cbc cat key -U couchbase://192.168.33.101/a_bucket
Connect to an SSL cluster at secure.net. The certificate for the cluster is stored locally at /home/couchbase/couchbase_cert.pem:
cbc cat key -U couchbases://secure.net/topsecret_bucket?certpath=/home/couchbase/couchbase_cert.pem
Connect to an SSL cluster at secure.net, ignoring certificate verification. This is insecure but handy for testing:
cbc cat key -U couchbases://secure.net/topsecret_bucket?ssl=no_verify
Connect to a password protected bucket (protected) on a remote host (for servers older than 5.x):
cbc cat key -U couchbase://remote.host.net/protected -P- Bucket password:
Connect to a password protected bucket (for servers older than 5.x), specifying the password on the command line (INSECURE, but useful for testing dummy environments)
cbc cat key -U couchbase://remote.host.net/protected -P t0ps3cr3t
Connect to a bucket running on a cluster with a custom REST API port
cbc cat key -U http://localhost:9000/default
Connec to bucket running on a cluster with a custom memcached port
cbc cat key -U couchbase://localhost:12000/default
Connect to a memcached (http://memcached.org) cluster using the binary protocol. A vanilla memcached cluster is not the same as a memcached bucket residing within a couchbase cluster (use the normal couchbase:// scheme for that):
cbc cat key -U memcached://host1,host2,host3,host4
Connect to a cluster using the HTTP protocol for bootstrap, and set the operation timeout to 5 seconds
cbc cat key -U couchbase://host/bucket -Dbootstrap_on=http -Doperation_timeout=5
Store a file to the cluster:
$ cbc cp mystuff.txt mystuff.txt Stored. CAS=0xe15dbe22efc1e00
Retrieve persistence/replication information about an item (note that Status is a set of bits):
$ cbc observe mystuff.txt mystuff [Master] Status=0x80, CAS=0x0
Display mapping information about keys:
$cbc hash foo bar baz foo: [vBucket=115, Index=3] Server: cbnode3:11210, CouchAPI: http://cbnode3:8092/default bar: [vBucket=767, Index=0] Server: cbnode1:11210, CouchAPI: http://cbnode1:8092/default baz: [vBucket=36, Index=2] Server: cbnode2:11210, CouchAPI: http://cbnode2:8092/default
Create a bucket:
$ cbc bucket-create --bucket-type=memcached --ram-quota=100 --password=letmein -u Administrator -P 123456 mybucket Requesting /pools/default/buckets 202 Cache-Control: no-cache Content-Length: 0 Date: Sun, 22 Jun 2014 22:43:56 GMT Location: /pools/default/buckets/mybucket Pragma: no-cache Server: Couchbase Server
Flush a bucket:
$ cbc bucket-flush default Requesting /pools/default/buckets/default/controller/doFlush 200 Cache-Control: no-cache Content-Length: 0 Date: Sun, 22 Jun 2014 22:53:44 GMT Pragma: no-cache Server: Couchbase Server
Delete a bucket:
$ cbc bucket-delete mybucket -P123456 Requesting /pools/default/buckets/mybucket 200 Cache-Control: no-cache Content-Length: 0 Date: Sun, 22 Jun 2014 22:55:58 GMT Pragma: no-cache Server: Couchbase Server
Use cbc stats to determine the minimum and maximum timeouts for a lock operation:
$ cbc stats | grep ep_getl localhost:11210 ep_getl_default_timeout 15 localhost:11210 ep_getl_max_timeout 30
Create a design document:
$ echo '{"views":{"all":{"map":"function(doc,meta){emit(meta.id,null)}"}}}' | cbc view -X PUT _design/blog
201
Cache-Control: must-revalidate
Content-Length: 32
Content-Type: application/json
Date: Sun, 22 Jun 2014 23:03:40 GMT
Location: http://localhost:8092/default/_design/blog
Server: MochiWeb/1.0 (Any of you quaids got a smint?)
{"ok":true,"id":"_design/blog"}
Query a view:
$ cbc view _design/blog/_view/all?limit=5
200
Cache-Control: must-revalidate
Content-Type: application/json
Date: Sun, 22 Jun 2014 23:06:09 GMT
Server: MochiWeb/1.0 (Any of you quaids got a smint?)
Transfer-Encoding: chunked
{"total_rows":20,"rows":[
{"id":"bin","key":"bin","value":null},
{"id":"check-all-libev-unit-tests.log","key":"check-all-libev-unit-tests.log","value":null},
{"id":"check-all-libevent-unit-tests.log","key":"check-all-libevent-unit-tests.log","value":null},
{"id":"check-all-select-unit-tests.log","key":"check-all-select-unit-tests.log","value":null},
{"id":"cmake_install.cmake","key":"cmake_install.cmake","value":null}
]
}
Issue a N1QL query:
$ cbc query 'SELECT * FROM `travel-sample` WHERE type="airport" AND city=$city' -Qscan_consistency=request_plus -A'$city=\"Reno\"'
Ping cluster services:
$ cbc ping --details -Ucouchbase://192.168.1.101
{
"version" : 1,
"config_rev" : 54,
"id" : "0x1d67af0",
"sdk" : "libcouchbase/2.8.4",
"services" : {
"fts" : [
{
"id" : "0x1d75e90",
"latency_us" : 1500,
"local" : "192.168.1.12:35232",
"remote" : "192.168.1.101:8094",
"status" : "ok"
},
{
"id" : "0x1da6800",
"latency_us" : 2301,
"local" : "192.168.1.12:40344",
"remote" : "192.168.1.103:8094",
"status" : "ok"
},
{
"id" : "0x1da3270",
"latency_us" : 2820,
"local" : "192.168.1.12:42730",
"remote" : "192.168.1.102:8094",
"status" : "ok"
},
{
"details" : "LCB_ENETUNREACH (0x31): The remote host was unreachable - is your network OK?",
"latency_us" : 3071733,
"remote" : "192.168.1.104:8094",
"status" : "error"
}
],
"kv" : [
{
"id" : "0x1d6bde0",
"latency_us" : 3700,
"local" : "192.168.1.12:42006",
"remote" : "192.168.1.101:11210",
"scope" : "default",
"status" : "ok"
},
{
"id" : "0x1dadcf0",
"latency_us" : 5509,
"local" : "192.168.1.12:39936",
"remote" : "192.168.1.103:11210",
"scope" : "default",
"status" : "ok"
},
{
"id" : "0x1dac500",
"latency_us" : 5594,
"local" : "192.168.1.12:33868",
"remote" : "192.168.1.102:11210",
"scope" : "default",
"status" : "ok"
},
{
"latency_us" : 2501688,
"remote" : "192.168.1.104:11210",
"scope" : "default",
"status" : "timeout"
}
],
"n1ql" : [
{
"id" : "0x1d7f280",
"latency_us" : 3235,
"local" : "192.168.1.12:54210",
"remote" : "192.168.1.101:8093",
"status" : "ok"
},
{
"id" : "0x1d76f20",
"latency_us" : 4625,
"local" : "192.168.1.12:58454",
"remote" : "192.168.1.102:8093",
"status" : "ok"
},
{
"id" : "0x1da44b0",
"latency_us" : 4477,
"local" : "192.168.1.12:36678",
"remote" : "192.168.1.103:8093",
"status" : "ok"
},
{
"details" : "LCB_ENETUNREACH (0x31): The remote host was unreachable - is your network OK?",
"latency_us" : 3071843,
"remote" : "192.168.1.104:8093",
"status" : "error"
}
],
"views" : [
{
"id" : "0x1da55c0",
"latency_us" : 1762,
"local" : "192.168.1.12:52166",
"remote" : "192.168.1.103:8092",
"status" : "ok"
},
{
"id" : "0x1da20d0",
"latency_us" : 2016,
"local" : "192.168.1.12:59420",
"remote" : "192.168.1.102:8092",
"status" : "ok"
},
{
"id" : "0x1d6a740",
"latency_us" : 2567,
"local" : "192.168.1.12:38614",
"remote" : "192.168.1.101:8092",
"status" : "ok"
},
{
"details" : "LCB_ENETUNREACH (0x31): The remote host was unreachable - is your network OK?",
"latency_us" : 3071798,
"remote" : "192.168.1.104:8092",
"status" : "error"
}
]
}
}
cbc(1) and cbc-pillowfight(1) may also read options from cbcrc(4). The default path for cbcrc is $HOME/.cbcrc, but may be overridden by setting the CBC_CONFIG evironment variable to an alternate path.
The options in this utility and their behavior are subject to change. This script should be used for experiemntation only and not inside production scripts.
cbc-pillowfight(1), cbcrc(4)
The cbc command first appeared in version 0.3.0 of the library. It was significantly rewritten in version 2.4.0
1.14.0