Skip to content

Commit 93ef937

Browse files
committed
CCBC-1584: update documentation on how to use collections with pillowfight
Change-Id: I3c06dcb247bc116b43916848d7398c2d000adb44 Reviewed-on: https://review.couchbase.org/c/libcouchbase/+/195328 Reviewed-by: Charles Dixon <chvckd@gmail.com> Tested-by: Build Bot <build@couchbase.com> Tested-by: Sergey Avseyev <sergey.avseyev@gmail.com>
1 parent ad04729 commit 93ef937

3 files changed

Lines changed: 44 additions & 2 deletions

File tree

doc/cbc-pillowfight.markdown

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ The following options control workload generation:
6969
Set the prefix to prepend to all keys in the cluster. Useful if you do not wish the items
7070
to conflict with existing data.
7171

72+
* `--collection`=_scopeName.collectionName_:
73+
Access data based on full collection name path. Multiple `--collection` filters can
74+
specify the different scopes with different collection names. Note that default
75+
collection will not be used if the collection was specified, to enable default collection
76+
along with the named ones, it should be specified explicitly `--collection=_default._default`.
77+
7278
* `-t`, `--num-threads`=_NTHREADS_:
7379
Set the number of threads (and thus the number of client instances) to run
7480
concurrently. Each thread is assigned its own client object.
@@ -260,6 +266,11 @@ Run against a bucket (`a_bucket`) on a cluster on a remote host:
260266

261267
cbc-pillowfight -U couchbase://192.168.33.101/a_bucket
262268

269+
Run against a bucket (`a_bucket`) and use collections `app.users` and `backup.stage`:
270+
271+
cbc-pillowfight --spec couchbase://127.0.0.1/a_bucket --username Administrator --password password \
272+
--collection app.users --collection backup.stage
273+
263274
### BENCHMARK EXAMPLES
264275

265276
The following examples show how to configure different types of workloads with

doc/man/cbc-pillowfight.1

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "CBC\-PILLOWFIGHT" "1" "April 2019" "" ""
4+
.TH "CBC\-PILLOWFIGHT" "1" "August 2023" "" ""
55
.
66
.SH "NAME"
77
\fBcbc\-pillowfight\fR \- Stress Test for Couchbase Client and Cluster
@@ -65,6 +65,10 @@ Set the \fItotal\fR number of items the workload will access within the cluster\
6565
Set the prefix to prepend to all keys in the cluster\. Useful if you do not wish the items to conflict with existing data\.
6666
.
6767
.TP
68+
\fB\-\-collection\fR=\fIscopeName\.collectionName\fR
69+
Access data based on full collection name path\. Multiple \fB\-\-collection\fR filters can specify the different scopes with different collection names\. Note that default collection will not be used if the collection was specified, to enable default collection along with the named ones, it should be specified explicitly \fB\-\-collection=_default\._default\fR\.
70+
.
71+
.TP
6872
\fB\-t\fR, \fB\-\-num\-threads\fR=\fINTHREADS\fR
6973
Set the number of threads (and thus the number of client instances) to run concurrently\. Each thread is assigned its own client object\.
7074
.
@@ -438,6 +442,20 @@ cbc\-pillowfight \-U couchbase://192\.168\.33\.101/a_bucket
438442
.
439443
.IP "" 0
440444
.
445+
.P
446+
Run against a bucket (\fBa_bucket\fR) and use collections \fBapp\.users\fR and \fBbackup\.stage\fR:
447+
.
448+
.IP "" 4
449+
.
450+
.nf
451+
452+
cbc\-pillowfight \-\-spec couchbase://127\.0\.0\.1/a_bucket \-\-username Administrator \-\-password password \e
453+
\-\-collection app\.users \-\-collection backup\.stage
454+
.
455+
.fi
456+
.
457+
.IP "" 0
458+
.
441459
.SS "BENCHMARK EXAMPLES"
442460
The following examples show how to configure different types of workloads with pillowfight\.
443461
.

doc/man/cbc.1

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "CBC" "1" "December 2020" "" ""
4+
.TH "CBC" "1" "August 2023" "" ""
55
.
66
.SH "NAME"
77
\fBcbc\fR \- Couchbase Client Commandline Utility
@@ -61,6 +61,9 @@
6161
\fBcbc admin\fR \fI\-P PASSWORD\fR \fIRESTAPI\fR [\fIOPTIONS\fR]
6262
.
6363
.br
64+
\fBcbc bucket\-list\fR \fI\-P PASSWORD\fR [\fIOPTIONS\fR]
65+
.
66+
.br
6467
\fBcbc bucket\-create\fR \fI\-P PASSWORD\fR \fINAME\fR [\fIOPTIONS\fR]
6568
.
6669
.br
@@ -488,6 +491,16 @@ In addition to the \fIOPTIONS\fR specified above, the following options are reco
488491
\fB\-X\fR, \fB\-\-method\fR=\fIGET|PUT|POST|DELETE\fR
489492
Specify the HTTP method to use for the specific request\. The default method is \fBGET\fR\.
490493
.
494+
.SS "bucket\-list"
495+
List the buckets in the cluster
496+
.
497+
.P
498+
In addition to the \fIOPTIONS\fR specified above, the following options are recognized:
499+
.
500+
.TP
501+
\fB\-r\fR, \fB\-\-raw\fR
502+
Print unformatted server response in JSON form\.
503+
.
491504
.SS "bucket\-create"
492505
Create a bucket in the cluster\.
493506
.

0 commit comments

Comments
 (0)