A Couchbase profile is used to read and write bucket data in a Couchbase database and can be accessed by workflows using Aggregation, Distributed Storage, or PCC. The profile should not be used to operate on data that has been inserted or updated by external third-party software.
...
| Note | ||
|---|---|---|
| ||
Created or updated Couchbase profiles that are used for PCC do not become effective until you restart the EC/ECSAs. | ||
| ||
The documentation on this page, and the user interface in , do not reflect the fact that Couchbase version 7.0.0 is supported. |
Configuration
To create a new Couchbase profile, click on the New Configuration button in the upper left part of the Desktop window, and then select Couchbase Profile from the menu.
...
In a Couchbase profile, there are three tabs: Connectivity, Management, and Advanced.
...
| Excerpt |
|---|
Connectivity TabThe Connectivity tab is displayed by default. |
...
Couchbase profile - Connectivity |
...
tab for Couchbase |
...
Releases 5.x - |
...
The Bucket Configuration settings are different depending on if you select Couchbase Release 5.x - 6.x or 4.x.
Couchbase Release 5.x - 6.x
The following settings are available in the Connectivity tab:
7.x, and 4.x
The following settings are available in the Connectivity tab:
|
...
|
...
Bucket Name
...
Enter the bucket that you want to access in Couchbase in this field.
...
User Password
Enter the password for the user who has access to the bucket.
| Note | ||
|---|---|---|
| ||
If you are using Couchbase Server 5.x, or 6.x the password is mandatory. For further information, see https://developer.couchbase.com/documentation/server/current/security/security-authorization.html. |
...
Operation Timeout (ms)
...
Enter the number of milliseconds after which you want Couchbase "CRUD" operations, i e create, read, update, and delete, to timeout. Setting a lower value than the default 1000 ms may have a positive impact on throughput performance. However, if the value is set too low, indicated by a large number of operation timeouts errors in the EC/ECSA logs, a lower throughput can be expected.
...
Retry Interval Time (ms)
...
Enter the time interval, in milliseconds, that you want to wait before trying to read the cluster configuration again after a failed attempt.
...
Max Number Of Retries
...
Enter the maximum number of retries.
...
Cluster Nodes
...
In this section, add IP addresses/hostnames of at least one of the nodes in the cluster. This address information is used by the Couchbase profile to connect to the cluster at workflow start, and to retrieve the IP addresses of the other nodes in the cluster.
If the first node in the list cannot be accessed, the Couchbase profile will attempt to connect to the next one in order. This is repeated until a successful connection can be established. Hence it is not necessary to add all the nodes, but it is good practice to do so for a small cluster. For example, if there are just three nodes, you should add all of them.
Couchbase Release 4.x
...
|
The following settings are available in the Connectivity tab:
...
|
...
|
...
Management Tab |
...
The Management tab |
...
contains Cluster Management and Monitoring settings. |
...
Couchbase profile - Management tab The following settings are available in the Management tab:
|
...
If the bucket |
...
you |
...
want to access in |
...
Couchbase |
...
does not exist, |
...
the Couchbase profile can be used for creating the bucket in runtime |
...
for you, provided that the Admin User Name and Admin Password for your Couchbase cluster have been |
...
entered in the Management tab. If the bucket you want to access already exists in your cluster, these two fields do not have to be |
...
filled in. Advanced TabIn the Advanced tab you can configure additional properties. These can typically be left unchanged in the standard Couchbase configuration. It is recommended that you change these properties when using the Couchbase profile in Aggregation. For more information about using the Couchbase profile in Aggregation, see Performance Tuning with Couchbase Storage in 9.2.5.3 Aggregation Agent Configuration - Real-Time. |
...
Couchbase profile - Advanced tab
See the text in the Properties field for further information about the properties that you can set. Logging Couchbase StatisticsYou can use the property |
...
if you want to log Couchbase statistics to file. |
...
The default value |
...
is To enable this property, set the value to If you set the property value to If you set the property value to |
...
The Couchbase statistics that you can log include the following:
|