/whisk.system/cloudant

Cloudant database service (version: 0.0.121)

Parameters

Name Default Type Required
bluemixServiceName cloudantNoSQLDB
username (Your Cloudant username) true
host (This is usually your username.cloudant.com) true
dbname (The name of your Cloudant database)
apihost openwhisk.ng.bluemix.net
password (Your Cloudant password) password true
overwrite boolean

Actions

Name Parameters (* is required)
create-attachment (Create document attachment in database)
  • dbname*
  • docid*
  • docrev*
  • attachment*
  • attachmentname*
  • contenttype*
  • params
create-database (Create Cloudant database)
  • dbname*
create-document (Create document in database)
  • dbname*
  • doc* (The JSON document to insert)
  • params
create-query-index (Create a Cloudant Query index into database)
  • dbname*
  • index*
delete-attachment (Delete document attachment from database)
  • dbname*
  • docid*
  • docrev*
  • attachmentname*
  • params
delete-database (Delete Cloudant database)
  • dbname*
delete-document (Delete document from database)
  • dbname*
  • docid* (The Cloudant document id to delete)
  • docrev* (The document revision number)
delete-query-index (Delete index from design document)
  • dbname*
  • docid*
  • indexname*
  • params
delete-view (Delete view from design document)
  • dbname*
  • docid*
  • viewname*
  • params
exec-query-find (Execute query against Cloudant Query index)
  • dbname*
  • query*
exec-query-search (Execute query against Cloudant search)
  • dbname*
  • docid*
  • indexname*
  • search*
exec-query-view (Call view in design document from database)
  • dbname*
  • docid*
  • viewname*
  • params
list-all-databases (List all Cloudant databases)
list-design-documents (List design documents from database)
  • dbname*
  • includedocs
list-documents (List all docs from database)
  • dbname*
  • params
list-query-indexes (List Cloudant Query indexes from database)
  • dbname*
manage-bulk-documents (Create, Update, and Delete documents in bulk)
  • dbname*
  • docs*
  • params
read (Read document from database)
  • dbname*
  • id* (The Cloudant document id to fetch)
  • params
read-attachment (Read document attachment from database)
  • dbname*
  • docid*
  • attachmentname*
  • params
read-changes-feed (Read Cloudant database changes feed (non-continuous))
  • dbname*
  • params
read-database (Read Cloudant database)
  • dbname*
read-document (Read document from database)
  • dbname*
  • docid* (The Cloudant document id to fetch)
  • params
read-updates-feed (Read updates feed from Cloudant account (non-continuous))
  • dbname*
  • params
update-attachment (Update document attachment in database)
  • dbname*
  • docid*
  • docrev*
  • attachment*
  • attachmentname*
  • contenttype*
  • params
update-document (Update document in database)
  • dbname*
  • doc*
  • params
write (Write document in database)
  • dbname*
  • doc*

Feeds

Name Parameters (* is required)
changes (Database change feed)

Sample Input:

{
	"dbname": "mydb",
	"filter": "mailbox/by_status",
	"query_params": {
		"status": "new"
	}
}
  • dbname*
  • filter (The name of your Cloudant database filter) (type: string)
  • query_params (JSON Object containing query parameters that are passed to the filter)