couchbase:create-bucket
Full name:
org.stuartgunter:couchbase-maven-plugin:1.0.0:create-bucket
Description:
Creates a bucket in a running Couchbase Server instance. The mojo
requires the target Couchbase Server instance to be running and
accessible at the configured host and port.
Attributes:
Required Parameters
| Name |
Type |
Since |
Description |
| bucketName |
String |
1.0.0 |
The name of the bucket to create
|
| host |
String |
1.0.0 |
The Couchbase Server host to connect to (e.g.
"http://localhost:8091")
User property is: couchbase.host. |
| password |
String |
1.0.0 |
The password to connect to Couchbase Server
User property is: couchbase.password. |
| proxyPort |
String |
1.0.0 |
The proxy port to assign to this bucket
|
| username |
String |
1.0.0 |
The username to connect to Couchbase Server
User property is: couchbase.username. |
Optional Parameters
| Name |
Type |
Since |
Description |
| authType |
String |
1.0.0 |
The auth type to use
Default value is: none.
|
| bucketType |
String |
1.0.0 |
The type of bucket to create
Default value is: memcached.
|
| failOnError |
boolean |
1.0.0 |
Indicates whether the build should fail in the event of an error
Default value is: true.
|
| ramQuotaMB |
String |
1.0.0 |
The RAM quota to assign to the bucket
Default value is: 100.
|
| replicaNumber |
String |
1.0.0 |
The number of replicas to use for this bucket (only relevant for
couchbase buckets)
Default value is: 1.
|
Parameter Details
authType:
The auth type to use
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- Default: none
bucketName:
The name of the bucket to create
- Type: java.lang.String
- Since: 1.0.0
- Required: Yes
bucketType:
The type of bucket to create
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- Default: memcached
failOnError:
Indicates whether the build should fail in the event of an error
- Type: boolean
- Since: 1.0.0
- Required: No
- Default: true
host:
The Couchbase Server host to connect to (e.g.
"http://localhost:8091")
- Type: java.lang.String
- Since: 1.0.0
- Required: Yes
- User Property: couchbase.host
password:
The password to connect to Couchbase Server
- Type: java.lang.String
- Since: 1.0.0
- Required: Yes
- User Property: couchbase.password
proxyPort:
The proxy port to assign to this bucket
- Type: java.lang.String
- Since: 1.0.0
- Required: Yes
ramQuotaMB:
The RAM quota to assign to the bucket
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- Default: 100
replicaNumber:
The number of replicas to use for this bucket (only relevant for
couchbase buckets)
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- Default: 1
username:
The username to connect to Couchbase Server
- Type: java.lang.String
- Since: 1.0.0
- Required: Yes
- User Property: couchbase.username
