A newer version of this documentation is available.

View Latest

MapReduce Views Using the Scala with Couchbase Server

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

    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.

    Querying Views

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

    Here is an example:

    val result: Try[ViewResult] = bucket.viewQuery("design-doc", "view-name")
    result match {
      case Success(result) =>
        result.rows.foreach(row => {
          val key = row.keyAs[String]
          val value = row.valueAs[JsonObject]
          println(s"Row: ${key} = ${value}")
      case Failure(err) => println(s"Failure: ${err}")
    var result = bucket.ViewQuery<Type>("design-doc", "view-name", options =>
    val result: Try[ViewResult] = bucket.viewQuery("beers", "by_name",

    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.