seun104 / mycouch

MyCouch is the asynchronous CouchDb & Cloudant client for .Net

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. It is plug-gable. If you don't like some piece, then hook in your implementation instead.

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

Documentation, Roadmap, Milestones & Issues

The documentation is contained in the project wiki.

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

More MyCouch projects

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

NuGet

MyCouch is distributed via NuGet.

• CouchDb package
• Cloudant package

But basically, in a .Net4.0, .Net4.5 or Windows Store 8 or 8.1 or WP8.1 app project, open up the Package manager console, and invoke:

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"))
{
    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 the latest version of NuGet (v2.7.1+) you should be able to just build and the packages will be restored. If this does not work, you could install the missing NuGet packages using a simple PowerShell script as covered here

Test environments

The project MyCouch.TestServer is a small self-hosted Nancy server that is used to serve e.g. test environment configurations to the integration tests configured in \testenvironments.local.json. You can use \testenvironments.samples.json 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: [email protected]; 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.

License

The MIT License (MIT)

Copyright (c) 2014, 2015 Daniel Wertheim

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.