CouchDB

Discover more about the CouchDB connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

CouchDB consumes changesets for inserts, updates and deletes in a CouchDB database, as well as get, save, update and delete documents from a CouchDB database.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter
Description
Default value
Data type

Dynamic Account

When active, the connector will use the account dynamically. Otherwise, it will use the account statically.

False

Boolean

Account Name (DB)

The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.

N/A

String

Account

The account used by the connector. It is only available if the Dynamic Account parameter is inactive.

N/A

Account

Protocol

The protocol to be used for communication with the database.

N/A

String

Hostname (DB)

Hostname of the running CouchDB instance.

N/A

String

Database (DB)

Name of the database to use.

N/A

String

Fail On Error

If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.

False

Boolean

Optional tab

Parameter
Description
Default value
Data type

Port

Port number for the running CouchDB instance.

5984

Integer

Create Database

If active, creates the database if it doesn’t yet exist.

False

Boolean

Body

The body, if applicable.

{}

JSON

Headers tab

Parameter
Description
Default value
Data type

CouchDb Id (DB)

The CouchDB document ID.

N/A

String

CouchDb Rev (DB)

The CouchDB document revision.

N/A

String

CouchDb Method (DB)

The method (delete/update).

N/A

String

Documentation tab

Parameter
Description
Default value
Data type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

Last updated