As a follow to the previous DP2 in June, we are releasing another developer preview, DP3. This developer preview, adds a plethora of bug fixes, features and most importantly, changes to the public API by way of a) providing methods for working with “documents” and b) changing the way a cluster object is instantiated. We have also moved the repo from CouchbaseLabs to Couchbase proper on Github; I’ll touch on that a bit later.

Documents, Documents Everywhere!

One of the major changes in this developer preview and a departure from the earlier .NET SDK, is the evolution of Couchbase from a Key/Value store to a document database – which in turn is reflected in the public API’s. What this means is that we now have methods that take and return a document object rather than a K/V pair. All of the other Couchbase goodness like CAS and durability constraints and other features are still provided, but we now wrap them in to a single “document” object, from which by settings the various properties, you get the behavior that you desire.

To support the “document” concept, a series of document based methods were add to the IBucket interface that support a new Document class:



The result of a call using one of these new document methods is a DocumentResult object, which is similar to the OperationResult object’s that are returned by the other K/V methods. The difference is that the Document field is a Document reference. If you want to get directly at the value that the Document (the value of T), then you use the Value field.

For example, here is how you would now (using DP3) store a JSON document in Couchbase using the Upsert method:

 using (var bucket = _cluster.OpenBucket())
var document = new Document<dynamic>
Id = “person1”,
Value = new
Name = “Jeff”, Age = 22
};var result = bucket.Upsert(document);

If you’re wondering, Upsert() is a method which either inserts or updates a document depending upon if it exists or not. Other document based methods include:

  • Insert(): insert a document, failing of it exists.
  • Replace(): replace an existing document, failing if it doesn’t exist.
  • Remove(): removes a document if it exists.
  • GetDocument(): returns a document for a given id.

Does this mean that Couchbase is no longer supporting the traditional K/V based Memcached operations? Absolutely not! The API’s will still support these operations, however, the hope is that the new “document” based approach will make it easier for developer’s to use the API’s and Couchbase in general for a wider range of applications. At the least it should make the semantics of working with JSON documents simpler to grasp and more intuitive.

Singleton’s? We Don’t Need No Stink’n Singleton’s!

In DP1 and DP2 to instantiate a CouchbaseCluster object, since it was a lazy-loaded Singleton, you would first create a ClientConfiguration and pass it into the static Initialize() method and then call Get() on the CouchbaseCluster class to get a reference to the cluster object. While the intention was good (ensure that the CouchbaseCluster is a global object), the tradeoffs made it less than a stellar design choice: it meant you could have one and only one CouchbaseCluster object per AppDomain (what if you had two separate Couchbase clusters you were using in a single app?) and it was a bit of a funky way to get started using a bucket – an uncomfortable programming experience.

In DP3 we decided to do away with the explicit requirement for a Singleton and instead split the class into a standard CouchbaseCluster class, with no limits to number that could be instantiated and a ClusterHelper class which is a wrapper singleton around CouchbaseCluster in the case you wanted to be assured that only on instance would be created. The best of both worlds.

Here is an example of creating a CouchbaseCluster object in DP3:

 var configuration = new ClientConfiguration();
var cluster = new CouchbaseCluster(configuration);

Here is an example of using the ClusterHelper class to ensure that only a single CouchbaseCluster object would be created per AppDomain:

var cluster = ClusterHelper.Get();

If you’re wondering why we even include a ClusterHelper object? It’s because the CouchbaseCluster object is a very expensive object to create and works best when it’s created when the application starts and is destroyed when the application ends. I’ll have more about that in a future post!

Try It Out (and Please Provide Feedback)!

Download the binaries below or checkout the source on Github and let us know what you think. Also, don’t forget that this is pre-release and things will definitely change before Beta and GA. Most of the changes will be internally, especially around the IO portions and namespaces. Depending upon community feedback the public interfaces may change as well.

Please, please do not use this in production either, while the base functionality works, the code has yet to make through and exhaustive set of situational tests, so things will like fail during a Failover/Swap/Rebalance scenario.

Source and Binaries

  • Note that the SDK 2.0 development branch is now the master branch on Github and the 1.X development branch is now called release13.
  • If you find a bug, either create a pull request and/or and NCBC.
  • Binaries can be found here.


Posted by Jeff Morris, Senior Software Engineer, Couchbase

Jeff Morris is a Senior Software Engineer at Couchbase. Prior to joining Couchbase, Jeff spent six years at Source Interlink as an Enterprise Web Architect. Jeff is responsible for the development of Couchbase SDKs and how to integrate with N1QL (query language).


  1. Will there be async versions of all API methods that return a Task<documentresult<t>>?

    1. David –

      Yes, that\’s the plan; were currently working on stabilizing the configuration aspects (swap/rebalance/failover) scenarios, once that is done will move over to the TAP methods. There was some experiemtal work that was done early on that still needs to be integrated.


  2. Will there be bulk upsert operations? It is a huge gap that this does not exist in the 1.3 SDK, especially for a system that is supposed to be highly-performant.

    1. BTW this example no longer works with latest in git.

      1. Yeah, there are changes between DP3, Beta and the current development branch. Notable, CouchbaseCluster has been renamed to Cluster, to make it more symmetrically with the other SDK\’s.

    2. Yes, bulk Get/Upsert will be included in the GA, which should be released any day now.

  3. […] new Document API for performing CRUD operations on JSON […]

Leave a reply