CouchDB

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

Important information:

  • This documentation is currently available only in English but will soon be translated into Portuguese.

  • The content is under revision and may change. We appreciate your understanding as we work to improve the documentation.

Consume 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).

Required Tab

ParameterDescriptionDefault valueData type

Dynamic Account

When activated, the connector will use the account dynamically. When deactivated, it’ll use the account statically.

false

boolean

Account Name (DB)

The name of the account that is generated dynamically via the Store Account connector.

string

Account

Sets the account to be used by the connector.

N/A

account

Protocol

The protocol to use for communicating with the database.

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 true will stop pipeline with an error, if false will let the pipeline continue but the output will show a property success with value false

false

boolean

Optional Tab

ParameterDescriptionDefault valueData type

Port

Port number for the running couchdb instance

5984

number

Create Database

Creates the database if it does not already exist

false

boolean

Headers Tab

ParameterDescriptionDefault valueData type

CouchDbId (DB)

The couchdb document id

N/A

string

CouchDbRev (DB)

The couchdb document revision

N/A

string

CouchDbMethod (DB)

The method (delete / update)

N/A

string

Successful executions should output at least a property "success": true

Last updated