cbc-subdoc man page

cbc-subdoc — Interactively Inspect Document Using Subdocument API

Synopsis

cbc-subdoc [Options]

Description

cbc-subdoc runs an interactive shell with commands from subdocument API.

Options

Options may be read either from the command line, or from a configuration file (see cbcrc(4)):

The following options control workload generation:

-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

-u, --username=USERNAME

Specify the username for the connection.

-P, --password=SASLPASS:
-P -, --password=-

Specify the SASL password for the bucket. This is only needed if the bucket is protected with a password. Note that this is not the administrative password used to log into the web interface.

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.

-T, --timings

Dump command timings at the end of execution. This will display a histogram showing the latencies for the commands executed.

--certpath=PATH

The path to the server´s SSL certificate. This is typically required for SSL connectivity unless the certificate has already been added to the openssl installation on the system (only applicable with couchbases:// scheme)

-v, --verbose

Specify more information to standard error about what the client is doing. You may specify this option multiple times for increased output detail.

--dump

Dump verbose internal state after operations are done.

-D, --cparam=OPTION=VALUE

Provide additional client options. Acceptable options can also be placed in the connection string, however this option is provided as a convenience. This option may be specified multiple times, each time specifying a key=value pair (for example, -Doperation_timeout=10 -Dconfig_cache=/foo/bar/baz). See Additional Options for more information

Additional Options

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

operation_timeout=SECONDS

Specify the operation timeout in seconds. This is the time the client will wait for an operation to complete before timing it out. The default is 2.5

config_cache=PATH

Enables the client to make use of a file based configuration cache rather than connecting for the bootstrap operation. If the file does not exist, the client will first connect to the cluster and then cache the bootstrap information in the file.

ssl=no_verify

Temporarily disable certificate verification for SSL (only applicable with couchbases:// scheme). This should only be used for quickly debugging SSL functionality.

sasl_mech_force=MECHANISM

Force a specific SASL mechanism to be used when performing the initial connection. This should only need to be modified for debugging purposes. The currently supported mechanisms are PLAIN and CRAM-MD5

bootstrap_on=<both,http,cccp>

Specify the bootstrap protocol the client should use when attempting to connect to the cluster. Options are: cccp: Bootstrap using the Memcached protocol (supported on clusters 2.5 and greater); http: Bootstrap using the HTTP REST protocol (supported on any cluster version); and both: First attempt bootstrap over the Memcached protocol, and use the HTTP protocol if Memcached bootstrap fails. The default is both

Commands

help

Show list of accessible commands with short help.

Lookup Commands

The following options are supported for lookup commands:

get

get [Options...] KEY...

Retrieve path from the item on the server.

This command requires that at least one key passed to it. If no paths are specified, it will fetch full document.

exists

exists [Options...] KEY...

Check if path exists in the item on the server.

This command requires that at least one key and one path are passed to it. Command has alias exist.

size

size [Options...] KEY...

Count the number of elements in an array or dictionary. The command has alias get-count.

This command requires that at least one key and one path passed to it.

Mutation Commands

The mutation commands below support the following options:

-x, --xattr PATH=VALUE

Store XATTR path (exentnded attributes).

-p, --path PATH=VALUE

JSON path in the document. Read more about paths in the documentation https://developer.couchbase.com/documentation/server/current/n1ql/n1ql-intro/queriesandresults.html#story-h2-2.

-e, --expiry TIME

Expiration time in seconds. Relative (up to 30 days) or absolute (as Unix timestamp).

-i, --intermediates

Create intermediate paths [Default=FALSE].

-u, --upsert

Create document if it does not exist [Default=FALSE].

replace

replace [Options...] KEY...

Replace the value at the specified path.

dict-add

dict-add [Options...] KEY...

Add the value at the given path, if the given path does not exist.

dict-upsert

dict-upsert [Options...] KEY...

Unconditionally set the value at the path.

array-add-first

array-add-first [Options...] KEY...

Prepend the value(s) to the array. All array operations may accept multiple objects. See examples below.

array-add-last

array-add-last [Options...] KEY...

Append the value(s) to the array.

array-add-unique

array-add-unique [Options...] KEY...

Add the value to the array indicated by the path, if the value is not already in the array.

array-insert

array-insert [Options...] KEY...

Add the value at the given array index. Path must include index, e.g. my.list[4]

counter

Increment or decrement an existing numeric path. The value must be 64-bit integer.

set

set [Options...] KEY VALUE

Store document on the server.

This command requires exactly two argument, key and value. Command has alias upsert. If no XATTR specified, the command will add its version to the path _cbc.version.

-x, --xattr PATH=VALUE

Store XATTR path (exentnded attributes)

-e, --expiry TIME

Expiration time in seconds. Relative (up to 30 days) or absolute (as Unix timestamp)

remove

remove [Options...] KEY...

Remove path in the item on the server.

This command requires at least one key. If no paths specified, it will remove whole document.

-p, --path PATH

JSON path in the document. Read more about paths in the documentation https://developer.couchbase.com/documentation/server/current/n1ql/n1ql-intro/queriesandresults.html#story-h2-2.

-x, --xattr PATH

JSON path in the extended attributes.

Examples

Connect to the server and wait for commands:

cbc subdoc -u Administrator -P password -U couchbase://192.168.33.101/a_bucket
subdoc>

Create new document foo with empty JSON document:

subdoc> upsert foo {}
foo                  CAS=0x14d766f19a720000

Fetch document with virtual XATTR, containing its metadata:

subdoc> get -x $document foo
foo                  CAS=0x14d766f19a720000
0. Size=194, RC=0x00 Success (Not an error)
{"CAS":"0x14d766f19a720000","vbucket_uuid":"0x0000ef56295d9206",
"seqno":"0x0000000000000021","exptime":0,"value_bytes":2,
"datatype":["json","xattr"],"deleted":false,"last_modified":"1501782188"}
1. Size=2, RC=0x00 Success (Not an error)
{}

Increment counter with path site.hits twice and set document expiration to 5 seconds. Note that it sends -i option to create site JSON object automatically:

subdoc> counter -e 5 -i -p site.hits=1 foo
foo                  CAS=0x14d76764f3b60000
0. Size=1, RC=0x00 Success (Not an error)
1
subdoc> counter -e 5 -p site.hits=1 foo
foo                  CAS=0x14d76765ea2b0000
0. Size=1, RC=0x00 Success (Not an error)
2
subdoc> get foo
foo                  CAS=0x14d76765ea2b0000
0. Size=19, RC=0x00 Success (Not an error)
{"site":{"hits":2}}

... wait for 5 seconds ...

subdoc> get foo
foo                  The key does not exist on the server (0xd)

Add into array at path ratings value 5. Note, that switch -u will ask server to create the document if it does not exist:

subdoc> array-add-first -u -p ratings=5 foo
foo                  CAS=0x14d76814fbb00000
0. Size=0, RC=0x00 Success (Not an error)
subdoc> get foo
foo                  CAS=0x14d76814fbb00000
0. Size=15, RC=0x00 Success (Not an error)
{"ratings":[5]}

Add several objects at once into ratings array:

subdoc> array-add-last -p ratings=4,6,7 foo
foo                  CAS=0x14d7687097c50000
0. Size=0, RC=0x00 Success (Not an error)
subdoc> get foo
foo                  CAS=0x14d7687097c50000
0. Size=21, RC=0x00 Success (Not an error)
{"ratings":[5,4,6,7]}

Remove rating with index 2 in array (third number):

subdoc> remove -p ratings[2] foo
foo                  CAS=0x14d76885efd90000
0. Size=0, RC=0x00 Success (Not an error)
subdoc> get foo
foo                  CAS=0x14d76885efd90000
0. Size=19, RC=0x00 Success (Not an error)
{"ratings":[5,4,7]}

Insert new rating instead of removed one:

subdoc> array-insert -p ratings[2]=10 foo
foo                  CAS=0x14d768a6daee0000
0. Size=0, RC=0x00 Success (Not an error)
subdoc> get foo
foo                  CAS=0x14d768a6daee0000
0. Size=22, RC=0x00 Success (Not an error)
{"ratings":[5,4,10,7]}

Fetch number of the items in the ratings array:

subdoc> size -p ratings foo
foo                  CAS=0x14d768a6daee0000
0. Size=1, RC=0x00 Success (Not an error)
4

Create document with spaces (surround the value with single quotes, and escape inner single quotes with backslash \):

subdoc> upsert bar ´{"text": "hello world"}´
bar                  CAS=0x14d768bc25270000
subdoc> get bar
bar                  CAS=0x14d768bc25270000
0. Size=23, RC=0x00 Success (Not an error)
{"text": "hello world"}

Todo

Port tool to Windows platform. Currently linenoise only supports UNIX-like systems, but there are unofficial patches for Windows.

Interface Stability

This command´s options should be considered uncommitted and are subject to change.

See Also

cbc(1), cbcrc(4), https://developer.couchbase.com/documentation/server/current/developer-guide/sub-doc-api.html

History

The cbc-subdoc tool was first introduced in libcouchbase 2.7.7.

Info

September 2017