Skip to content
MyCouch is the asynchronous CouchDb & Cloudant client for .Net
C# JavaScript
Latest commit 80fdbbe Apr 15, 2016 @danielwertheim Update README.md
Rem broken shields

README.md

MyCouch

The asynchronous CouchDb and Cloudant client for .Net - builds on top of the asynchronous HTTP client and uses JSON.Net to provide flexible serialization behaviour. It tries to keep the domain language of CouchDb instead of bringing in generic repositories and other confusing stuff. MyCouch lets you work with raw JSON and/or entities/POCOS without requiring any implementation of interfaces, baseclasses etc. MyCouch provides you with some model conventions like injection of $doctype to the document.

Supports: Net4.5+, Windows store 8 & 8.1, DNXCore5.0

MyCouch

Nuget

MyCouch.Cloudant

Nuget

Documentation, Release Notes & Issues

The documentation is contained in the project wiki.

The Release Notes is well worth a read for news and breaking changes info.

The "Issues list" here on GitHub is used for tracking issues.

More MyCouch projects

MyCouch.AspNet.Identity - an ASP.Net identity provider for CouchDb and Cloudant

NuGet

MyCouch is distributed via NuGet.

So...

pm:> install-package mycouch

or if you also want some Cloudant specific features like Lucene searches:

pm:> install-package mycouch.cloudant

Quick sample - using Requests and Responses

using(var client = new MyCouchClient("http://localhost:5984/", "mydb"))
{
    //POST with server generated id
    await client.Documents.PostAsync("{\"name\":\"Daniel\"}");

    //POST with client generated id - possible but wrong
    await client.Documents.PostAsync("{\"_id":\"someId", \"name\":\"Daniel\"}");

    //PUT for client generated id
    await client.Documents.PutAsync("someId", "{\"name\":\"Daniel\"}");

    //PUT for updates
    await client.Documents.PutAsync("someId", "docRevision", "{\"name\":\"Daniel Wertheim\"}");

    //PUT for updates with _rev in JSON
    await client.Documents.PutAsync("someId", "{\"_rev\": \"docRevision\", \"name\":\"Daniel Wertheim\"}");

    //Using entities
    var me = new Person {Id = "SomeId", Name = "Daniel"};
    await client.Entities.PutAsync(me);

    //Using anonymous entities
    await client.Entities.PostAsync(new { Name = "Daniel" });
}
using(var client = new MyCouchServerClient("http://localhost:5984"))
{
    var r = await client.Replicator.ReplicateAsync(id, source, target);
}

Quick sample - using MyCouchStore

using(var store = new MyCouchStore("http://localhost:5984", "mydb"))
{
    var mySomething = await store.StoreAsync(new Something("foo", "bar", 42));

    var retrieved = await store.GetByIdAsync(mySomething.Id);

    var deleted = await store.DeleteAsync(mySomething.Id, mySomething.Rev);

    //... ... and so on... ...
}

Get up and running with the source

Please note. No NuGet packages are checked in. If you are using an awesome version of NuGet you should be able to just build and the packages will be restored.

Test environments

Test environment configurations to the integration tests should be configured in a file: \testenvironments.local.json placed next to \testenvironments.samples.json, which you can use as a template.

How-to Contribute

This is described in the wiki, under: "How-to Contribute".

Issues, questions, etc

So you have issues or questions... Great! That means someone is using it. Use the issues function here at the project page or contact me via mail: firstname@lastname.se; or Twitter: @danielwertheim

NOTE!

It's your data. Ensure to test against isolated test-environments and test-accounts first e.g. a separate Cloudant account, specific CouchDB instances etc.

Something went wrong with that request. Please try again.