...
| Name |
Default Value |
Type |
Context |
Description |
| additionalHosts |
"" |
String |
Shared |
Comma separated list of additional hostnames |
| designDocumentName |
"beer" |
String |
Consumer |
The Document Design name, defaults to the beer example distributed with Couchbase |
| viewName |
"brewery_beers" |
String |
Consumer |
The Document view name, defaults, to the beer example distributed with Couchbase |
| limit |
-1 |
int |
Consumer |
Limit the number of results that should be returned, default is unlimited |
| descending |
false |
boolean |
Consumer |
Revert the sorting order of the result set. |
| skip |
0 |
int |
Consumer |
Number of results to skip |
| rangeStartKey |
"" |
String |
Consumer |
Start Key to return records in the given key range. |
| rangeEndKey |
"" |
String |
Consumer |
End Key to return records in the given key range. |
| consumerProcessedStrategy |
none |
String |
Consumer |
The strategy applied with consumed documents none = consumed documents are untouched, you should beware of duplicates (f.e. use an idempotent receiver) delete = consumed documents are deleted |
| operation |
PUT |
String |
Producer |
The operation to perform, currently supports the following values: PUT, DELETE, GET |
| autoStartIdForInserts |
false |
boolean |
Producer |
If set to true, document id will be automatically generated |
| startingIdForInsertsFrom |
0 |
int |
Producer |
Starting value for the document id (if autoStartIdForInserts == true) |
| producerRetryAttempts |
2 |
int |
Producer |
Number of retries |
| producerRetryPause |
5000 |
int |
Producer |
Pause between retries (in ms) |
| persistTo |
0 |
int |
Producer |
0: Don't wait for persistence on any nodes. 1: Persist to Master. 2: Persist to at least two nodes including Master. 3: Persist to at least three nodes including Master. 4: Persist to at least four nodes including Master. |
| replicateTo |
0 |
int |
Producer |
0: Don't replicate. 1: Replicate to at least one node. 2: Replicate to at least two nodes. 3: Replicate to at least three nodes. |
| username |
"" |
String |
Shared |
Username |
| password |
"" |
String |
Shared |
Password |
...
| Name |
Default Value |
Type |
Context |
Description |
| CCB_KEY |
null |
String |
Shared |
Key of the consumed row |
| CCB_ID |
null |
String |
Consumer |
Id of the consumed row |
| CCB_DDN |
null |
String |
Consumer |
Document Design name |
| CCB_VN |
null |
String |
Consumer |
View Name |
| CCB_TTL |
0 |
int |
Producer |
TTL of the document |
Example
Consume 10 documents from "beer-sample" bucket using Design Document "beer" and View "brewery_beers":
...