couchbase-model-views's Introduction

couchbase-model-views

Sample project demonstrating how to generate basic Couchbase Views with the CouchbaseClient and custom attributes on data objects

NOTE: Not supported under Couchbase Enterprise Support Subscriptions!

Usage (Models)

Reference Couchbase.ModelViews.Framework in your models project. Decorate the class with the name of the design doc.
Decorate properties with the name of the views to which they should be keys. Optionally, include the order in which the properties should be emitted.

[CouchbaseDesignDoc("beers")]
[CouchbaseAllView]
public class Beer
  {
	public string Id { get; set; }

	[CouchbaseViewKey("by_abv_and_name", "name", 1)]
	[CouchbaseViewKey("by_name", "name")]
	public string Name { get; set; }

	public string Description { get; set; }

	[CouchbaseViewKey("by_abv_and_name", "abv", 0)]
	public float ABV { get; set; }

	[CouchbaseViewKey("by_brewery", "breweryId")]
	public string Brewery { get; set; }
  }

[CouchbaseDesignDoc("beers")]
[CouchbaseAllView]
public class Brewery
  {
	[CouchbaseCollatedViewKey("all_with_beers", "beer", "name", "brewery_id")]
	public string Id { get; set; }

	[CouchbaseViewKey("by_name", "name")]
	public string Name { get; set; }

	public string Description { get; set; }
	
	[CouchbaseViewKeyCount("by_state", "state", 1)]
	public string State { get; set; }

	[CouchbaseSpatialView("by_location", "geo.lng", 0)]
	public float Longitude { get; set; }
	
	[CouchbaseSpatialView("by_location", "geo.lat", 1)]
	public float Latitude { get; set; }  		
  }

Usage (Console App)

In app.config, list the assemblies from which to build views (along with the CouchbaseCluster configuration).

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>    
    <sectionGroup name="modelViews">
      <section name="assemblies" type="System.Configuration.DictionarySectionHandler"/>      
    </sectionGroup>
    <section name="couchbase" type="Couchbase.Configuration.CouchbaseClientSection, Couchbase"/>
  </configSections>

  <modelViews>
    <assemblies>
      <add key="DemoModels" value="CouchbaseModelViews.DemoModels" />
    </assemblies>
  </modelViews>

  <couchbase>
    <servers bucket="beer-sample" bucketPassword="">
      <add uri="http://localhost:8091/pools"/>      
    </servers>
  </couchbase>
</configuration>

Run the console application. The sample Beer class above will produce the following views:

{
  "views": {
    "all": {
      "map": "function(doc, meta) { \r\n\t if (doc.type == \"beer\") { \r\n\t\t emit(null, null); \r\n\t } \r\n }"        
    },
    "by_name_and_abv": {
      "map": "function(doc, meta) { \r\n\t if (doc.type == \"beer\" && doc.name && doc.abv) { \r\n\t\t emit([doc.name, doc.abv], null); \r\n\t } \r\n }"
    },
    "by_name": {
      "map": "function(doc, meta) { \r\n\t if (doc.type == \"beer\" && doc.name) { \r\n\t\t emit(doc.name, null); \r\n\t } \r\n }"
    },
    "by_brewery": {
      "map": "function(doc, meta) { \r\n\t if (doc.type == \"beer\" && doc.breweryId) { \r\n\t\t emit(doc.breweryId, null); \r\n\t } \r\n }"
    }
  }
}

couchbase-model-views's People

Contributors

Stargazers

Watchers