* support search index parameters

* add "all documents" option

Author: lgfa29

77-cloudant-cf.html

@@ -161,6 +161,7 @@
         <select id="node-input-search">
             <option value="_id_">_id</option>
             <option value="_idx_">search index</option>
+            <option value="_all_">all documents</option>
         </select>
     </div>
 
@@ -318,19 +319,34 @@
         A node for searching documents in a Cloudant database.
     </p>
     <p>
-        Searching for a document can be done in two modes: directly by using the
-        document's <b>_id</b> or by using an existing <a
+        Searching for documents can be done in three modes: directly by using the
+        document's <b>_id</b>, by using an existing <a
         href="https://cloudant.com/for-developers/search/" target="_blank">Search
-        Index</a>.
+        Index</a> or retrieving <b>all documents</b> stored in your database.
     </p>
     <p>
-        When querying using the <b>_id</b> option, the value for <code>_id</code>
-        should be passed in the <code>msg.payload</code> as a string.
+        When querying using the <b>_id</b> option, the value for the document's
+        <code>_id</code> should be passed in the <code>msg.payload</code> as a
+        string.
     </p>
     <p>
-        To use an existing <b>Search Index</b> stored on the desired database, the
-        query argument should be passed on the <code>msg.payload</code> following
-        the <code>indexName:value</code> pattern. <i>The index must be created
-        beforehand on the database.</i>
+        To use an existing <b>Search Index</b> stored on the desired database,
+        the query argument should be passed on the <code>msg.payload</code> as a
+        string following the <code>indexName:value</code> pattern. Keep in mind
+        that <i>the index must be created beforehand in the database.</i> and
+        referenced here by its <code>design document/index name</code>.
+    </p>
+    <p>
+        When querying using a <b>Search Index</b> you can pass the search
+        parameters as an object in <code>msg.payload</code>. For example, you
+        can pass an object like this: <code>{ query: "abc*", limit: 100 }</code>
+        to change the value of <code>limit</code>. You can find more information
+        on the accepted parameters in the <a
+        href="https://docs.cloudant.com/api.html?http#queries" target="_blank">
+        official Cloudant documentation</a>.
+    </p>
+    <p>
+        The last method to retrieve documents is to simply get all of them by
+        selecting the option <b>all documents</b>.
     </p>
 </script>

77-cloudant-cf.js

@@ -242,13 +242,21 @@ module.exports = function(RED) {
                         });
                     }
                     else if (node.search === "_idx_") {
-                        options.q = options.q || formatSearchQuery(msg.payload);
+                        options.query = options.query || options.q || formatSearchQuery(msg.payload);
+                        options.include_docs = options.include_docs || true;
                         options.limit = options.limit || 200;
 
                         db.search(node.design, node.index, options, function(err, body) {
                             sendDocumentOnPayload(err, body, msg);
                         });
                     }
+                    else if (node.search === "_all_") {
+                        options.include_docs = options.include_docs || true;
+
+                        db.list(options, function(err, body) {
+                            sendDocumentOnPayload(err, body, msg);
+                        });
+                    }
                 });
             }
         });
@@ -280,9 +288,23 @@ module.exports = function(RED) {
 
         function sendDocumentOnPayload(err, body, msg) {
             if (!err) {
-                msg.payload  = body.rows;
                 msg.cloudant = body;
-            } else {
+
+                if ("rows" in body) {
+                    msg.payload = body.rows.
+                        map(function(el) {
+                            if (el.doc._id.indexOf("_design/") < 0) {
+                                return el.doc;
+                            }
+                        }).
+                        filter(function(el) {
+                            return el !== null && el !== undefined;
+                        });
+                } else {
+                    msg.payload = body;
+                }
+            }
+            else {
                 msg.payload = null;
 
                 if (err.description === "missing") {

package.json

@@ -1,6 +1,6 @@
 {
     "name"         : "node-red-node-cf-cloudant",
-    "version"      : "0.2.8",
+    "version"      : "0.2.9",
     "description"  : "A Node-RED node to access a Cloudant database on Bluemix",
     "dependencies" : {
         "cfenv"   : "1.0.0",