Pagination with Couchbase

October 1, 2013 · 8 min read

If you have to deal with a large number of documents when doing queries against a Couchbase cluster it is important to use pagination to get rows by page. You can find some information in the documentation in the chapter "Pagination", but I want to go in more details and sample code in this article.

For this example I will start by creating a simple view based on the beer-sample dataset, the view is used to find brewery by country:

function (doc, meta) {
  if (doc.type == "brewery" &amp;&amp; doc.country){
    emit(doc.country);
  }
}

This view list all the breweries by country, the index looks like:

Doc id	Key	Value
bersaglier	Argentina	null
cervecera_jerome	Argentina	null
brouwerij_nacional_balashi	Aruba	null
australian_brewing_corporation	Australia	null
carlton_and_united_breweries	Australia	null
coopers_brewery	Australia	null
foster_s_australia_ltd	Australia	null
gold_coast_brewery	Australia	null
lion_nathan_australia_hunter_street	Australia	null
little_creatures_brewery	Australia	null
malt_shovel_brewery	Australia	null
matilda_bay_brewing	Australia	null
...	...	...
...	...	...
...	...	...
yellowstone_valley_brewing	United States	null
yuengling_son_brewing	United States	null
zea_rotisserie_and_brewery	United States	null
fosters_tien_gang	Viet Nam	null
hue_brewery	Viet Nam	null

So now you want to navigate in this index with a page size of 5 rows.

Using skip / limit Parameters

The most simplistic approach is to use limit and skip parameters for example:

Page 1 : ?limit=5&skip0
Page 2 : ?limit=5&skip=5 ... Page x : ?limit=5&skip(limit*(page-1))

You can obviously use any other parameters you need to do range or key queries (startkey/endkey, key, keys) and sort option (descending).

This is simple but not the most efficient way, since the query engine has to read all the rows that match the query, until the skip value is reached.

Some code sample in python that paginate using this view :

This application loops on all the pages until the end of the index.

As I said before this is not the best approach since the system must read all the values until the skip is reached. The following example shows a better way to deal with this.

Using startkey / startkey_docid parameters

To make this pagination more efficient it is possible to take another approach. This approach uses the startkey and startkey_docid to select the proper documents.

The startkey parameter will be the value of the key where the query should start to read (based on the last key of the "previous page"
Since for a key for example "Germany" you may have one or more ids (documents) it is necessary to say to Couchbase query engine where to start, for this you need to use the startkey_docid parameter, and ignore this id since it is the last one of the previous page.

So if we look at the index, and add a row number to explain the pagination

Row num	Doc id	Key	Value
Query for page 1 `?limit=5`
1		bersaglier	Argentina	null
2		cervecera_jerome	Argentina	null
3		brouwerij_nacional_balashi	Aruba	null
4		australian_brewing_corporation	Australia	null
5		carlton_and_united_breweries	Australia	null
Query for page 2 `?limit=5&startkey="Australia"&startkey_docid=carlton_and_united_breweries&skip=1`
6		coopers_brewery	Australia	null
7		foster_s_australia_ltd	Australia	null
8		gold_coast_brewery	Australia	null
9		lion_nathan_australia_hunter_street	Australia	null
10		little_creatures_brewery	Australia	null
Query for page 3 `?limit=5&startkey="Australia"&startkey_docid=little_creatures_brewery``&skip=1`
11		malt_shovel_brewery	Australia	null
12		matilda_bay_brewing	Australia	null
...	...	...
...	...	...
...	...	...
...		yellowstone_valley_brewing	United States	null
...		yuengling_son_brewing	United States	null
...		zea_rotisserie_and_brewery	United States	null
...		fosters_tien_gang	Viet Nam	null
...		hue_brewery	Viet Nam	null

So as you can see in the examples above, the query uses the startkey, a document id, and just passes it using skip=1.

Let's now look at the application code, once again in Python

from couchbase import Couchbase
cb = Couchbase.connect(bucket='beer-sample')

hasRow = True
rowPerPage = 5
page = 0
currentStartkey=""
startDocId=""

while hasRow :
    hasRow = False
    skip = 0 if page == 0 else 1
    page = page + 1
    print "-- Page %s --" % (page)
    rows = cb.query("test", "by_country", limit=rowPerPage, skip=skip, startkey=currentStartkey, startkey_docid=startDocId)
    for row in rows:
        hasRow = True
        print "Country: \"%s\" \t Id: '%s'" % (row.key, row.docid)
        currentStartkey = row.key
        startDocId = row.docid
    print " -- -- -- -- \n"

This application loops on all the pages until the end of the index

Using this approach, the application start to read the index at a specific key (startkey parameter), and only loop on the necessary entry in the index. This is more efficient than using the simple skip approach.

Views with Reduce function

When your view is using a reduce function, if you want to paginate on the various keys only (with the reduce function) you need to use the skip and limit parameters.

When you are using the paramater startkey_docid with a reduce function it will calculate the reduce only to the subset of document ids that are part of your query.

Couchbase Java SDK Paginator

In the previous examples, I have showed how to do pagination using the various query parameters. The Java SDK provides a Paginator object to help developers to deal with pagination. The following example is using the same view with the Paginator API.

package com.couchbase.devday;

import com.couchbase.client.CouchbaseClient;
import com.couchbase.client.protocol.views.*;
import java.net.URI;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.TimeUnit;
import java.util.logging.ConsoleHandler;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;

public class JavaPaginatorSample {

public static void main(String[] args) {

    configure();
    System.out.println("--------------------------------------------------------------------------");
    System.out.println("\tCouchbase - Paginator");
    System.out.println("--------------------------------------------------------------------------");

    List<URI> uris = new LinkedList<URI>();
    uris.add(URI.create("http://127.0.0.1:8091/pools"));

    CouchbaseClient cb = null;
    try {
        cb = new CouchbaseClient(uris, "beer-sample", "");
        System.out.println("--------------------------------------------------------------------------");
        System.out.println("Breweries (by_name) with docs & JSON parsing");
        View view = cb.getView("test", "by_country");
        Query query = new Query();
        int docsPerPage = 5;

        Paginator paginatedQuery = cb.paginatedQuery(view, query, docsPerPage);
        int pageCount = 0;
        while(paginatedQuery.hasNext()) {
            pageCount++;
            System.out.println(" -- Page "+ pageCount +" -- ");
            ViewResponse response = paginatedQuery.next();
            for (ViewRow row : response) {
                System.out.println(row.getKey() + " : " + row.getId());
            }
            System.out.println(" -- -- -- ");
        }
        
        System.out.println("\n\n");
        cb.shutdown(10, TimeUnit.SECONDS);
    } catch (Exception e) {
        System.err.println("Error connecting to Couchbase: " + e.getMessage());
    }
}



private static void configure() {

    for(Handler h : Logger.getLogger("com.couchbase.client").getParent().getHandlers()) {
        if(h instanceof ConsoleHandler) {
            h.setLevel(Level.OFF);
        }
    }
    Properties systemProperties = System.getProperties();
    systemProperties.put("net.spy.log.LoggerImpl", "net.spy.memcached.compat.log.SunLogger");
    System.setProperties(systemProperties);

    Logger logger = Logger.getLogger("com.couchbase.client");
    logger.setLevel(Level.OFF);
    for(Handler h : logger.getParent().getHandlers()) {
        if(h instanceof ConsoleHandler){
            h.setLevel(Level.OFF);
        }
    }
}

}

So as you can see you can easily paginate on the results of a Query using the Java Paginator.

At the line #37, the Paginator is created from using the view and query objects and a page size is specified
Then you just need to use the hasNext() and next() methods to navigate in the results.

The Java Paginator is aware of the fact that they query is using a reduce or not, so you can use it with all type of queries - Internally it will switch between the skip/limit approach and the doc_id approaches. You can see how it is done in the Paginator class.

Note that if you want to do that in a Web application between HTTP request you must keep the Paginator object in the user session since the current API keeps the current page in its state.

Conclusion

In this blog post you have learned how to deal with pagination in Couchbase views; to summarize

The pagination is based on some specific parameters that you send when executing a query.
Java developers can use the Paginator class that simplifies pagination.

I am inviting you to look at the new Couchbase Query Language N1QL, still under development, that will provide more options to developers including pagination, using LIMIT & OFFSET parameters, for example:

SELECT fname, age
FROM tutorial
WHERE age > 30
LIMIT 2
OFFSET 2

If you want to learn more about N1QL:

Using skip / limit Parameters​

Using startkey / startkey_docid parameters​

Views with Reduce function​

Couchbase Java SDK Paginator​

Conclusion​

Using skip / limit Parameters

Using startkey / startkey_docid parameters

Views with Reduce function

Couchbase Java SDK Paginator

Conclusion