MapReduce Views Using the .NET SDK with Couchbase Server

how-to

You can use MapReduce views to create queryable indexes in Couchbase Data Platform.

Although still maintained and supported for legacy use, Views date from the earliest days of Couchbase Server development, and as such are rarely the best choice over, say, our Query service if you are starting a fresh application. See our discussion document on the best service for you to use.

The normal CRUD methods allow you to look up a document by its ID. A MapReduce (view query) allows you to lookup one or more documents based on various criteria. MapReduce views are comprised of a map function that is executed once per document (this is done incrementally, so this is not run each time you query the view) and an optional reduce function that performs aggregation on the results of the map function. The map and reduce functions are stored on the server and written in JavaScript.

MapReduce queries can be further customized during query time to allow only a subset (or range) of the data to be returned.

See the Incremental MapReduce Views and Querying Data with Views sections of the general documentation to learn more about views and their architecture.

By Name Views

The following example is the definition of a by_name view in a "beer" design document. This view checks whether a document is a beer and has a name. If it does, it emits the beer’s name into the index. This view allows beers to be queried for by name. For example, it’s now possible to ask the question "What beers start with A?"

var result = await bucket.ViewQueryAsync("beers", "by_name", options => {
    options.WithStartKey("A");
    options.WithLimit(10);
});

The following example is the definition of a by_name view in a "landmarks" design document in the "travel-sample" sample dataset. This view checks whether a document is a landmark and has a name. If it does, it emits the landmark’s name into the index. This view allows landmarks to be queried for by its "name" field.

var result = await bucket.ViewQueryAsync("landmarks", "by_name", options => {
    options.WithKey("<landmark-name>");
});

Querying Views through the .NET SDK

Once you have a view defined, it can be queried from the .NET SDK by using the ViewQuery method on a Bucket instance.

Here is an example:

var result = await bucket.ViewQueryAsync<Type>("design-doc", "view-name", options =>
{
	options.WithLimit(10);
});

foreach (var row in result.Rows)
{
	var id = row.Id;
	var key = row.Key<string[]>();
	var value = row.Value<Type>();
}