couchdb_connector v0.5.0 API Reference
Modules
Your primary interface for writing to and reading from CouchDB. The exchange format here are Maps. If you want to go more low level and deal with JSON strings instead, please consider using Couchdb.Connector.Reader or Couchdb.Connector.Writer
The Admin module provides functions to create and update users in the CouchDB server given by the database properties
Provides commonly required http headers
The Reader module provides functions to retrieve documents or uuids from CouchDB
The Storage module provides functions to create and destroy databases
The main supervisor of the couchdb_connector application
The types module contains only type definitions that other modules can make use of by simply using this modules: ‘use Couchdb.Connector.Types’
Provides URL helper functions that compose URLs based on given database properties and additional parameters, such as document IDs, usernames, etc
The View module provides functions for basic CouchDB view handling
The Writer module provides functions to create and update documents in the CouchDB database given by the database properties
Protocols
This protocol provides an ‘as_json’ transformation that takes a document as input (a Map representation is expected here) and transforms that into the format expected by the lower level Couchdb Writer module (BitString)
This protocol provides ‘as_map’ transformations that take either tuples of status code and content (BitString is expected here) as they would be returned by the lower level Couchdb Connector modules (Couchdb.Connector.Reader and Couchdb.Connector.Writer). In case there is a sensible payload (other than errors), the protocol will return the payload converted into a Map