API Reference sofa v#0.7.0

Copy Markdown View Source

Modules

Documentation for Sofa, a test-driven idiomatic Apache CouchDB client.

A document attachment: the metadata CouchDB keeps in a document's _attachments stubs, plus the content once fetched or supplied.

Writes and reads documents in bulk, via _bulk_docs and _bulk_get.

A behaviour for following the CouchDB _changes feed of a database.

Decodes _changes responses into events, using pure functions.

Turns follower options into the request for GET|POST /{db}/_changes.

One _changes request, run in its own process on behalf of a Sofa.Changes follower.

Internal Helpers for Sofa, with a vanity naming convention.

Documentation for Sofa.DB, a test-driven idiomatic Apache CouchDB client.

Design documents: the _design/ documents that hold views, filters and validation functions, built as pipelines and saved like any document.

Documentation for Sofa.Doc, a test-driven idiomatic Apache CouchDB client.

Mango, the CouchDB declarative query API: _find, _explain and the _index endpoints.

Replication: one-off and continuous jobs via _replicate, persistent ones as documents in _replicator, and the scheduler that runs them.

HTTP Response Handler for Sofa, the Elixir-native Apache CouchDB client

A database's security object: who its admins and members are, by user name and by role.

Cookie sessions, via _session: log in once and send a cookie instead of credentials on every request.

Documentation for Sofa.User, a test-driven idiomatic Apache CouchDB client.

Queries views, _all_docs and _design_docs, the CouchDB index reads.

One row of a view result. doc is set with include_docs: true.