Skip to content

Commit e66193e

Browse files
committed
update help text for in node
1 parent 73d6934 commit e66193e

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

77-cloudant-cf.html

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -301,11 +301,22 @@
301301

302302
<script type="text/x-red" data-help-name="cloudant in">
303303
<p>
304-
A node for searching a Cloudant database using a Search Index.
304+
A node for searching documents in a Cloudant database.
305305
</p>
306306
<p>
307-
Query is performed on existing <b>Search Indexes</b> stored on the desired
308-
database. The query argument should be passed on the <code>msg.payload</code>
309-
following the <code>indexName:value</code> pattern.
307+
Searching for a document can be done in two modes: directly by using the
308+
document <b>_id</b> or by using an existing <a
309+
href="https://cloudant.com/for-developers/search/" target="_blank">Search
310+
Index</a>.
311+
</p>
312+
<p>
313+
When querying using the <b>_id</b> option, the <code>_id</code> should be
314+
passed in the <code>msg.payload</code> as a string.
315+
</p>
316+
<p>
317+
To use an existing <b>Search Index</b> stored on the desired database, the
318+
query argument should be passed on the <code>msg.payload</code> following
319+
the <code>indexName:value</code> pattern. The index must be created beforehand
320+
on the database.
310321
</p>
311322
</script>

0 commit comments

Comments
 (0)