Use CouchDB with .NET


C# Problem Overview

Can .NET (managed code) read and write to CouchDB?

I would like to build a part of my project that does document management using CouchDB

C# Solutions

Solution 1 - C#

Its a late answer, but do check out Hammock. It's active and going into production use on several projects soon and is receiving regular updates and fixes. Besides basic object persistence, Hammock gives you:

  • True POCO. You don't even need an 'id' property; Hammock tracks that internally.
  • Robust support for views, including an easy to use fluent API that both generates AND executes views, and support for creating custom map/reduce views.
  • Attachments support.
  • A generic Repository<> class that helps bring your queries/views (i.e. _Design doc) together with your c# application code. Repositories are responsible for maintaining _design docs, and this helps keep CouchDB views from feeling like stored procs.
  • A full unit test suite. This is not prototype software.

Solution 2 - C#

Take a look at the SharpCouch utility class.

It is a simple wrapper class for the CouchDB HTTP API.

Solution 3 - C#

Little late to the game but there's an open source project for a new driver written in C# over the async HTTP Client and by default Newtonsoft's JSON.Net for serialization (switchable). MyCouch - Simple async CouchDb client for .Net.

A Getting started post exists here:

Solution 4 - C#

Given that you generally communicate with CouchDB over REST and JSON, I'd imagine it wouldn't be too hard to use JSON.NET and the normal WebClient/HttpWebRequest classes to do it. I haven't tried it myself, mind you...

Solution 5 - C#


See here for instructions on installing CouchDB on windows.

Here is a link to the getting started with C# wiki article. There is a link to a .Net wrapper in that article. It would be pretty easy to roll your own as well.

Solution 6 - C#

Keep an eye on Ottoman an open-source project written in C#. It is still in heavy development, but I wanted to point it out as an option for projects in the planning stages. I will update this post as it gets closer to completion. You can view the source on github. Read the README to see examples and what is possible with the current version.

  • Unlike SharpCouch, which uses strings heavily, Ottoman uses generics for automatic serialization and desrialization for mapping an object from a JSON string and vice versa. All this without your objects needing to inherit off an interface or base class.
  • It uses Json.Net underneath to handle the JSON serialization and deserialization.
  • Maps the RESTFul error codes that CouchDB returns into Exceptions.
  • Planned Feature: Id generators for generating Id's for the objects being persisted
  • Planned Feature: Implicit Offline Optimistic Lock via Document Revisions, Ottoman will use an Identity Map to keep track for you and will throw an exception when a conflict occurs.
  • Planned Feature: It will be Mono compatible.
  • Planned Feature: This is down the road, but I do plan on having LINQ expressions for Map/Reduce functions which you express to CouchDB using JavaScript.

It is a fairly new project, but very active. Of course, I'm a bit biased also. ;-)

Solution 7 - C#

also take a look at divan - a light-weight wrapper for the cdb api

Solution 8 - C#

I have used JSON.NET in conjunction with the MS REST starter kit's http client class to integrate to CouchDB and it works really well.

Solution 9 - C#

CouchDB's wiki has a list of API for C# (with their features) if you want the latest status :

Solution 10 - C#

Very easy to use .NET API for CouchDB included into WDK10 that you can grab from it is very flexible and allows you to deal with your data on objects and pure json level.

Solution 11 - C#

The options (ordered by latest update):

Solution 12 - C#

One more - CouchDBClient:

Disclaimer: I'm the author.

I tried to make CouchDBClient more friendly to work with custom objects - that's what usually applications store in the database.

Back when I started writing this framework, all others that I found and tried were making an impression of non-standardized method signatures (named using various conventions and harder to guess what they did), not unified interfaces (some operations around string docs, while others around json docs), not very flexible (some worked only with strings, others only with objects), or not very abstract (had to know CouchDB REST API first to use them correctly). I'm assuming and hoping they have matured since then, but at least this one is designed up to my taste.

I'm hoping that CouchDBClient can create a feeling of comfortable abstraction without worrying about underlying API too much, and just focusing on your application, and how it stores and retrieves objects it needs.

Solution 13 - C#

I know I am VERY late, but maybe it's helpful for the future. In the last few years, I worked on a library for CouchDB.

The biggest feature is converting LINQ (EF Core like) to mango queries, but also DB Changes Feed, Views, and Table Splitting.

var skywalkers = await context.Rebels
    .Where(r => 
        r.Surname == "Skywalker" && 
            r.Battles.All(b => b.Planet == "Naboo") ||
            r.Battles.Any(b => b.Planet == "Death Star")
    .OrderByDescending(r => r.Name)
    .ThenByDescending(r => r.Age)
        r => r.Name,
        r => r.Age

Solution 14 - C#

Check out Relax Relax is a ".Net API abstraction of CouchDB's (excellent) RESTful API. It includes a repository-based interface for document interaction and a server controller for administrative type tasks."

Solution 15 - C#

I recommend the CouchDb.Repository.Helper package. It is comprehensive and allows you to create your queries in XML files with parse of dynamic parameters according to values ​​of variables or properties of objects.

I had the same need and after evaluating the options available, to meet the requirements of my application, I created these components that helped me a lot and maybe they can help you and also others. I make it clear that I have no intention of promoting myself here, just sharing something that may be useful.

The detailed explanation of how to configure and use it is on github.

Link: Nuget Package | Github

Example of use for retrieving documents with mango-querie:

IList<User> users;
var sts = new List<String> { "ACTIVE", "LOCKED" };
using (UserRepository db = new UserRepository())
	var query = db.FindOf("list-status", new { id = "OwnerIdloop.user.7", statuses = sts });
	users = db.List<User>(query);
Array.ForEach(users.ToArray(), Console.WriteLine);

Example of adding documents:

User user = createUser("[email protected]");
using (UserRepository db = new UserRepository())
	var result = db.Insert<User>(user); // add document and return instance changed with operation revision id

Example of changing documents:

using (UserRepository db = new UserRepository())
	// Load document data by ID
	var user = db.Get<User>("[email protected]");
	user.Name = user.Name + "::CHANGED";

	var result = db.Update<User>(user); // update document and return instance changed with operation revision id

Example of deleting documents:

using (UserRepository db = new UserRepository())
	// Load document data by ID
	var user = db.Get<User>("[email protected]");

	var result = db.Delete<User>(user); // delete document from database. Return true case sucess or false case not deleted
	Console.WriteLine($"Sucesso: {result}");

Hope this helps!


All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionDeveloperView Question on Stackoverflow
Solution 1 - C#nicknystromView Answer on Stackoverflow
Solution 2 - C#BengtBeView Answer on Stackoverflow
Solution 3 - C#DanielView Answer on Stackoverflow
Solution 4 - C#Jon SkeetView Answer on Stackoverflow
Solution 5 - C#ScottSView Answer on Stackoverflow
Solution 6 - C#Dale RaganView Answer on Stackoverflow
Solution 7 - C#kolosyView Answer on Stackoverflow
Solution 8 - C#DokieView Answer on Stackoverflow
Solution 9 - C#PeterView Answer on Stackoverflow
Solution 10 - C#Evgenios SkitsanosView Answer on Stackoverflow
Solution 11 - C#JP HellemonsView Answer on Stackoverflow
Solution 12 - C#TengizView Answer on Stackoverflow
Solution 13 - C#Matteo BortolazzoView Answer on Stackoverflow
Solution 14 - C#Daniel MohlView Answer on Stackoverflow
Solution 15 - C#Wedson Quintanilha da SilvaView Answer on Stackoverflow