A set of Node-RED nodes to work with documents in a Cloudant database that is integrated with IBM Cloud or an on-premises CouchDB. This version is a superset of the functionality in the original Cloudant node and replicates the functionality of the node-red-contrib-cloudantplus node and will eventually replace it.
Ideally, install from the package manager inside Node-RED.
Alternatively, install from npm
npm install node-red-node-cf-cloudant
An additional node allows to retrieve information about server and databases
To insert a new document into the database you have the option to store
msg object or just the
msg.payload. If the input value is not
in JSON format, it will be transformed before being stored. If
msg.payload is an array,
all elements will be processed using the bulk operations API.
For update and delete, you must pass the
_id and the
of the input
msg.payload object. Bulk operations are also supported when putting documents as
an array in the input
To search for a document you have five options:
- get a document directly by its
- use query
- use an existing search index from the database
- use an existing view
- retrieve all documents
- When getting documents by id, the
payloadwill be the desired
payloadwill be the set to an object with a declarative JSON query syntax.
search indexes, the query should follow the format
payloadshould be set be set to an object containing key/value pairs as defined in the Query string section in the Cloudant documentation
- cfenv - Package to retrieve configuration settings if availble
- @ibm-cloud/cloudant - IBM Cloudant SDK
Based on the node written and enhanced by: