node-red-contrib-cloudantplus

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

Installation

Ideally, install from the package manager inside Node-RED.

Alternatively, install from npm

npm install node-red-contrib-cloudantplus

Usage

Allows basic access to a Cloudant or CouchDB database to insert, update, delete and search for documents. Also bulk operation is supported.

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 the entire 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 or msp.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 _revas part of the input msg.payload object. Bulk operations are also supported when putting documents as an array in the input msg.payload object.

To search for a document you have five options:

• get a document directly by its _id
• use query
• use an existing search index from the database
• use an existing view
• retrive all documents

Take note

• When getting documents by id, the payload will be the desired _id value.
• For query, the payload will be the set to an object with a declarative JSON query syntax.
• For search indexes, the query should follow the format indexName:value.
• For views, payload should be set be set to an object containing key/value pairs as defined in the Query string section in the Cloudant documentation

Dependencies

• cfenv - Package to retrieve configuration settings if availble
• @ibm-cloud/cloudant - IBM Cloudant SDK

Authors

• Adam Hammond - adam_hammond@uk.ibm.com
• Stephan H. Wissel stw@linux.com

Based on the node written and enhanced by:

• Austin Chang - austinhc@tw.ibm.com
• Luiz Gustavo Ferraz Aoqui - laoqui@ca.ibm.com
• Túlio Pascoal