Couchbase .NET Client Library

Official information may be found at the [.NET Client Library|http://www.couchbase.com/develop/net/current] page.

h2. [#Using Multiple Buckets with the CouchbaseClient]

It is not possible to configure (in app|web.config) a single instance of a CouchbaseClient to work with multiple buckets. Though it is possible to programmatically reconstruct a client to work with multiple buckets, it is not recommended. The process of creating a client is expensive (relative to other Couchbase operations) and should ideally be done once per app domain.

It is possible however to set multiple config sections in app|web.config to allow for multiple client instances to be created, while still maintaining bucket affinity.

{code:xml}
<?xml version="1.0"?>
<configuration>
<configSections>
<sectionGroup name="couchbase">
<section name="bucket-a" type="Couchbase.Configuration.CouchbaseClientSection, Couchbase"/>
<section name="bucket-b" type="Couchbase.Configuration.CouchbaseClientSection, Couchbase"/>
</sectionGroup>
</configSections>

<couchbase>
<bucket-a>
<servers bucket="default">
<add uri="http://127.0.0.1:8091/pools" />
</servers>
</bucket-a>
<bucket-b>
<servers bucket="beernique" bucketPassword="b33rs">
<add uri="http://127.0.0.1:8091/pools" />
</servers>
</bucket-b>
</couchbase>

<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
</startup>
</configuration>
{code}

After defining the config sections, bucket specific clients are created by reading the appropriate config sections and passing the config section reference to the constructor of the CouchbaseClient. Again, constructing the client should not be done per operation, but rather per app domain.

{code:java}
var bucketASection = (CouchbaseClientSection)ConfigurationManager.GetSection("couchbase/bucket-a");
var bucketBSection = (CouchbaseClientSection)ConfigurationManager.GetSection("couchbase/bucket-b");

var clientA = new CouchbaseClient(bucketASection);
var clientB = new CouchbaseClient(bucketBSection);

clientA.ExecuteStore(StoreMode.Set, "fooA", "barA");
var itemA = clientA.Get<string>("fooA");
Console.WriteLine(itemA);

clientB.ExecuteStore(StoreMode.Set, "fooB", "barB");
var itemB = clientB.Get<string>("fooB");
Console.WriteLine(itemB);
{code}

h2. [#Handling Failures with the Operation Results API]

The standard public API (i.e., Get, Store, etc.) exposed by the .NET Client Library is based largely on the .NET Memcached client library Enyim.Caching. These methods were created to support the use case of working with a distributed cache - not a persistent store. As a result, these methods return simple values and swallow exceptions.

For example, if an I/O exception occurred during the following call, then the value of getResult would be null.

{code:java}
var getResult = client.Get("SomeKey");
{code}

Similarly, if the key already existed when the following snippet executes, the value of storeResult would simply be false.

{code:java}
var storeResult = client.Store(StoreMode.Add, "ExistingKey", "SomeValue");
{code}

In summary, for the standard API, retrieve operations will return null for cache misses, I/O exceptions and all other error conditions. Store operations will return false for key errors and I/O exceptions. No exceptions should bubble up to the caller when using the standard API.

In an effort to expose more about an operation's success or failure, additions to the API were introduced starting in client version 1.1. These new methods mirror the existing (while maintaining backwards compatibility), but are prefixed with "Execute." The return value of each of these methods is an instance of an IOperationResult implementation.

With the new API, a caller may use ExecuteGet to learn more about the state of an operation.

{code:java}
var getResult = client.ExecuteGet("foo");

//some examples of how properties are set on the results follow
//sample is not meant to imply flow control for your application

//check the success of the operation
if (getResult.Success) {
Console.WriteLine("Get result successful and the value was {0}", getResult.Value);
}

//exceptions will typically be I/O related and are not always present for a failure
if (getResult.Exception != null) {
Console.WriteLine("Exception occurred: {0}", getResult.Exception.Message);
}

//Check if the nullable status code has a value,
//on a cache miss, for example, this value will be 1
if (getResult.StatusCode != null && getResult.HasValue) {
Console.WriteLine("Server sent StatusCode {0}", getResult.StatusCode.Value);
}

//Check the message (note - the constants will be released in v1.1.7)
//success would also be false, but no exception
//StatusCode would also be equal to (int)StatusCodeEnums.NotFound
if (getResult.Message == StatusCodeMessages.NOT_FOUND) {
Console.WriteLine("Key not found");
}
{code}

In summary:

||Property||Description||
| Success | false when key is not found or exception is thrown |
| Exception | not null when a handled I/O exception is swallowed, null on operation failures |
| StatusCode | not null when server returns valid status code, null on I/O exceptions |
| Message | null when server returns valid results, not null on I/O exceptions or operation failures |

Similarly, Store operations return StoreOperationResult instances.

{code:java}
var storeResult = client.ExecuteStore(StoreMode.Add, "foo", "bar");

//some examples of how properties are set on the results follow
//again, sample is not meant to imply flow control for your application

//check the success of the operation
if (storeResult.Success) {
Console.WriteLine("Store result successful and the cas value was {0}", storeResult.Cas);
}

//exceptions will typically be I/O related and are not always present for a failure
if (storeResult.Exception != null) {
Console.WriteLine("Exception occurred: {0}", storeResult.Exception.Message);
}

//Check if the nullable status code has a value,
//when trying to replace an non-existing key, for example, this value will be 1
if (storeResult.StatusCode != null && getResult.HasValue) {
Console.WriteLine("Server sent StatusCode {0}", getResult.StatusCode.Value);
}

//Check the message (note - the constants will be released in v1.1.7)
//success would also be false, but no exception
//StatusCode would also be equal to (int)StatusCodeEnums.NotFound
if (storeResult.Message == StatusCodeMessages.NOT_FOUND) {
Console.WriteLine("Key not found");
}