Crate sofa[][src]

Sofa - CouchDB for Rust





sofa = "0.6"


This crate is an interface to CouchDB HTTP REST API. Works with stable Rust.

Does not support #![no_std]

After trying most crates for CouchDB in Rust (chill, couchdb in particular), none of them fit our needs hence the need to create our own.

No async I/O (yet), uses a mix of Reqwest and Serde under the hood, with a few nice abstractions out there.

NOT 1.0 YET, so expect changes

Supports CouchDB 2.0 and up.

Be sure to check CouchDB's Documentation in detail to see what's possible.

Running tests

Make sure that you have an instance of CouchDB 2.0+ running, either via the supplied docker-compose.yml file or by yourself. It must be listening on the default port.

And then cargo test -- --test-threads=1

Single-threading the tests is very important because we need to make sure that the basic features are working before actually testing features on dbs/documents.

Why the name "Sofa"

CouchDB has a nice name, and I wanted to reflect that.


Licensed under either of these:

Yellow Innovation

Yellow Innovation is the innovation laboratory of the French postal service: La Poste.

We create innovative user experiences and journeys through services with a focus on IoT lately.

Yellow Innovation's website and works





Client handles the URI manipulation logic and the HTTP calls to the CouchDB REST API. It is also responsible for the creation/access/destruction of databases.


Database holds the logic of making operations on a CouchDB Database (sometimes called Collection in other NoSQL flavors such as MongoDB).


Document abstracts the handling of JSON values and provides direct access and casting to the fields of your documents You can get access to the fields via the implementation of the Index and IndexMut traits


Memory-optimized, iterable document collection, mostly returned in calls that involve multiple documents results Can target a specific index through implementation of Index and IndexMut


Used inside a DocumentCollection, to wrap the document itself and facilitate lookups by Document ID.




Trait that provides methods that can be used to switch between abstract Document and concrete Model implementors (such as your custom data models)