Check that the requested database exists

The return value is an object that should only contain a single key "ok", so it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Bool <- Database.exists ctx >>= asBool

Status: Complete

Get most basic meta-information

The return value is an object whose fields often vary, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.meta ctx

Status: Complete

Create a database

The return value is an object whose fields often vary, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.meta ctx

Status: Complete

Delete a database

The return value is an object that should only contain a single key "ok", so it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Bool <- Database.delete ctx >>= asBool

Status: Complete

Create a new document in a database

The return value is an object that can hold "id" and "rev" keys, but if you don't need those values, it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Bool <- Database.createDoc True someObject ctx >>= asBool

Status: Complete

Get a list of all database documents

The return value is a list of objects whose fields often vary, so it is easily decoded as a List of Value:

>>> value :: Result [Value] <- Database.allDocs dbAllDocs ctx

Status: Complete

Get a list of some database documents

The return value is a list of objects whose fields often vary, so it is easily decoded as a List of Value:

>>> value :: Result [Value] <- Database.someDocs ["a", "b", "c"] ctx

Status: Complete

Create or update a list of documents

The return value is a list of objects whose fields often vary, so it is easily decoded as a List of Value:

>>> value :: Result [Value] <- Database.bulkDocs dbBulkDocs ["a", "b", "c"] ctx

Status: Complete

Get a list of all document modifications

This call does not stream out results; so while it allows you to specify parameters for streaming, it's a dirty, dirty lie.

The return value is an object whose fields often vary, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.changes ctx

Status: Limited

Compact a database

The return value is an object that should only contain a single key "ok", so it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Bool <- Database.compact ctx >>= asBool

Status: Complete

Compact the views attached to a particular design document

The return value is an object that should only contain a single key "ok", so it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Bool <- Database.compactDesignDoc "ddoc" ctx >>= asBool

Status: Complete

Ensure that all changes to the database have made it to disk

The return value is an object that can hold an "instance_start_time" key, but if you don't need those values, it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Bool <- Database.sync ctx >>= asBool

Status: Complete

Cleanup any stray view definitions

The return value is an object that should only contain a single key "ok", so it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Bool <- Database.cleanup ctx >>= asBool

Status: Complete

Get security information for database

The return value is an object that has with a standard set of fields ("admin" and "members" keys, which each contain "users" and "roles"), the system does not prevent you from adding (and even using in validation functions) additional fields, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.getSecurity ctx

Status: Complete

Set security information for database

The input value is an object that has with a standard set of fields ("admin" and "members" keys, which each contain "users" and "roles"), but the system does not prevent you from adding (and even using in validation functions) additional fields, so we don't specify a specific type, and you can roll your own:

The return value is an object that should only contain a single key "ok", so it is easily decoded into a Bool with our asBool combinator:

>>> value :: Result Value <- Database.setSecurity (object [("users", object [("harry")])]) ctx >>= asBool

Status: Complete

Create a temporary view

The return value is an object whose fields often vary, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.tempView "function (doc) { emit (1); }" (Just "_count") Nothing ctx

Status: Complete

Purge document revisions from the database

The return value is an object with two fields "purge_seq" and "purged", which contains an object with no fixed keys, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.purge $ DocRevMap [(DocId "junebug", [DocRev "1-1"])] Nothing ctx

However, the content of "purged" is effectively a DocRevMap, so the output can be parsed into an (Int, DocRevMap) pair using:

>>> (,) <$> (getKey "purge_seq" >>= toOutputType) <*> (getKey "purged" >>= toOutputType)

Status: Complete

Find document revisions not present in the database

The return value is an object with one field "missed_revs", which contains an object with no fixed keys, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.missingRevs $ DocRevMap [(DocId "junebug", [DocRev "1-1"])] ctx

However, the content of "missed_revs" is effectively a DocRevMap, so it can be parsed into a DocRevMap using:

>>> getKey "missed_revs" >>= toOutputType

Status: Complete

Find document revisions not present in the database

The return value is an object whose fields often vary, so it is most easily decoded as a Value:

>>> value :: Result Value <- Database.revsDiff $ DocRevMap [(DocId "junebug", [DocRev "1-1"])] ctx

Status: Complete

Get the revision limit setting

The return value is a JSON numeric value that can easily be decoded to an Int:

>>> value :: Result Integer <- Database.getRevsLimit ctx

Status: Complete

Set the revision limit

Status: Complete

Base bits for all _all_docs requests

Base bits for all our _compact requests

Base bits for our revision examination functions

Base bits for our revisions limit functions

Base bits for our security functions