Database.CouchDB.Conduit

CouchDB

To work with concrete objects, use the following modules:

• Database.CouchDB.Conduit.DB Database
• Database.CouchDB.Conduit.View Views
• Database.CouchDB.Conduit.LowLevel Low-level methods

For complete documentation about The Couch DB HTTP API see http://wiki.apache.org/couchdb/Complete_HTTP_API_Reference

Document paths and revisions

type Path = ByteString

Represents a path or path fragment.

As a rule, full path to document in CouchDB is just URL path. But there is one subtlety. For example, document ids can contain slashes. But, to work with such objects, path fragments must be escaped.

 database/doc%2Fname

But, fo non-document items such as views, attachments e.t.c., slashes between path fragments must not be escaped. While slashes in path fragments must be escaped.

 database/_design/my%2Fdesign/_view/my%2Fview

Except low-level functions, couchdb-conduit escapes all segments in paths.

type Revision = ByteString

Represents a revision of a CouchDB Document.

CouchDB Connection

data CouchConnection

Represents a single connection to CouchDB server. The constructor for this data type is not exposed. Instead, you should use either the def method to retrieve a default instance.

Instances

Default CouchConnection

ResourceIO m => MonadCouch (ReaderT CouchConnection m)

def :: Default a => a

The default value for this type.

couchHost :: CouchConnection -> ByteString

Hostname. Default value is "localhost"

couchPort :: CouchConnection -> Int

Port. 5984 by default.

couchManager :: CouchConnection -> Maybe Manager

Connection Manager. Nothing by default. If you need to use your Manager (for connection pooling for example), set it to Just Manager.

couchLogin :: CouchConnection -> ByteString

CouchDB login. By default is empty.

couchPass :: CouchConnection -> ByteString

CouchDB password. By default is empty.

Runtime enviroment and errors

class ResourceIO m => MonadCouch m where

A monad which allows access to the connection.

All functions to access CouchDB require a MonadCouch instance to access the connection information. ReaderT is an instance of MonadCouch, and runCouch runs a sequence of database actions using ReaderT and ResourceT.

If your db code is part of a larger monad, it makes sense to just make the larger monad an instance of MonadCouch and skip the intermediate ReaderT, since then performance is improved by eliminating one monad from the final transformer stack.

Methods

couchConnection :: m CouchConnection

Instances

ResourceIO m => MonadCouch (ReaderT CouchConnection m)

data CouchError

A CouchDB Error.

Constructors

CouchHttpError Int ByteString

Error comes from http.

CouchInternalError ByteString

Non-http errors include things like errors parsing the response.

NotModified

Is not an error actually. It is thrown when CouchDB returns 304 - Not Modified response to the request. See http://wiki.apache.org/couchdb/HTTP_Document_API

Instances

Show CouchError

Typeable CouchError

Exception CouchError

runCouch

Arguments

:: ResourceIO m

=> CouchConnection

Couch connection

-> ResourceT (ReaderT CouchConnection m) a

CouchDB actions

-> m a

Run a sequence of CouchDB actions. This function is a combination of withCouchConnection, runReaderT and runResourceT.

If you create your own instance of MonadCouch, use withCouchConnection.

withCouchConnection

Arguments

:: ResourceIO m

=> CouchConnection

Couch connection

-> (CouchConnection -> m a)

Function to run

-> m a

Connect to a CouchDB server, call the supplied function, and then close the connection.

 withCouchConnection def {couchDB = "db"} . runReaderT . runResourceT $ do
    ... -- actions

Documents

couchRev

Arguments

:: MonadCouch m

=> Path

Database.

-> Path

Document path.

-> ResourceT m Revision

Get Revision of a document.

couchRev'

Arguments

:: MonadCouch m

=> Path

Database.

-> Path

Document path.

-> ResourceT m Revision

Brain-free version of couchRev. If document absent, just return empty.

couchDelete

Arguments

:: MonadCouch m

=> Path

Database.

-> Path

Document path.

-> Revision

Revision

-> ResourceT m ()

Delete the given revision of the object.

Utility

quoteQueryParam :: ByteString -> ByteString

Simple query param quotation.