Pagination and Querying in Cassandra
1. What if we want to fetch rows batch wise instead of columns?
2. If there are updates during the paged retrieval there is a chance that some items will be missed out. For example let’s say the last access is at column with column key with “Florence”. So the next retrieval would fetch a batch starting from “Florence” on wards. What if a column with key “Cologne” has been newly added? It would not get included in any of the future retrieval.
3. Also there may be a use case where it is required paginate the results obtained by filtering with a range query rather than fetching all the rows page wise in the column family. (Actually this was our use case)
So let’s have a look at how we took a stab at the beast, Cassandra pagination. Before that let me explain our use case fully so that it’s easier to grasp what we did and why we did it. Our use main case was to paginate the access to results returned from a range query which can cleanly expressed in SQL lingo as follows.
SELECT * FROM <column_family> WHERE <column_name_1> BETWEEN [from_1] AND [to_1] AND <column_name_2> BETWEEN [from_2] AND [to_2] .... AND <column_name_n> BETWEEN <from_n> AND <to_n>
Here each column_name is an index. (Actually a sub index of a
composite index. For a description on our indexing scheme refer to my
earlier blog Cassandra: Lessons Learnt)
. So our use case is bit complicated in that it’s required to paginate
the access of the result set obtained from a range query. Also our
requirement was to fetch all the rows satisfying this criteria without
missing any row provided that there would be new additions while we are
retrieving rows in batches. In fact there may be a considerable
time-lapse between two fetches since the retrieved data are processed
using a scheduled task with configurable interval in our use case.
Additionally we had to leave the room for non batched access of the range query result as well. And of course we were not using the OrderedPartitioner. (Evils of OrderedPartitioner is well documented elsewhere. Sub optimal loadbalancing, creating hot spots etc.. ). Had we used OrderedPartitioner our life would have been bit easier since we would have been able to do a range query on the rows. But since we were using RandomPartitioner no ordering of rows using row keys can be assumed as well.
Ok that’s enough for the predicament that we were in couple of months back while faced with the task of ‘Cassandrafication’ our data layer. Hope you got the idea.. Now let’s see what we did to improve the situation.
First we had to deal with our inability to do range query on rows.
Cassandra has this nice caveat, that columns of a particular row is
always sorted using the column keys. So we utilized this nicety to
impose an ordering on rows. We always maintain a meta row in which all
the row keys are stored as columns. (Actually a row key is a column key
and column value is empty).
Let’s say this row is ‘RowIndex’. (See figure 1). Now when doing a query on column family we first query this row using a range query and get the rows matching the criteria and then do the real row fetching one by one using the row keys fetched. You might be wondering how the range query is constructed to match the where clauses in the given SQL above. In our scheme the row key is constituted from concatenating the value for each index. (Index is in fact a column in a particular row and we use the column value as the index value. This will become clearer by having a look at the first step of illustration given in figure 2). So this is the scheme we used for non batched retrieval of rows satisfying a particular query.
Figure 1 : Column family with meta row ‘RowIndex’
But for paginated use case this proved to be insufficient due to the second shortcoming outlined earlier. We realized that there needs to be an ordering from the timestamp to catch a newly added row even if its row key put it in a location in sorted order which is before the last accessed row key. So we introduced another meta row storing the timestamp of insertion of each row. Let’s say this row key of this meta row is ‘TimeStampIndex’. Each column of this row will hold the insertion timestamp as the column key and the corresponding row key of the row inserted at that particular timestamp as the column value. So now we need to do four things we add a row to the column family.
Figure 2 : Row insertion algorithm
1. Create the row key using the defined indexes. Here we use ‘server’ and ‘time’ as the indexes.
2. Insert row key in to the ‘RowIndex’ as a column.
3. Insert the row insertion timestamp along with row key as a column to the ‘TimeStampIndex’
4. Add the row itself to the column family.
‘RowIndex’ is to be used for non batched access of the range query result while ‘TimeStampIndex’ is to be used for batched access of the range query result.
Now when we want to fetch the rows in batches satisfying the range query criteria, first we get a batch size chunk of timestamps from ‘TimeStampIndex’. Then for each and every row associated with the timestamp we check whether if the row matches the filter criteria. This is a simple string comparison to check whether the row key falls between the range first and range last values.
Say for example the filter criteria for above illustration is following where clause.
WHERE 'server' BETWEEN 'esb' and 'esb' and 'hour' BETWEEN '08:00' and '09:00'
Now the range first value of the query would be ‘esb—08:00′ and the range last value would be ‘esb—09:00′. This will select events for server ‘esb’ during the hours from ’08:00′ to ’09:00′. So if the row key is ‘esb—08:23′ it will get picked and if it is ‘esb—09:23′ it won’t.
So as can be seen for this scenario we didn’t use ‘RowIndex’ meta row. It’s for non batched use only. And in this way using ‘TimeStampIndex’ we can catch newly added rows without missing out on any row.
However it’s not without its own drawbacks.
1. The batch size is not consistent. Even though the batch size chunk is picked from the query some of these rows will be discarded since they do not match the filtering criteria. Solution would be to get multiple batches until the batch size number of rows fulfilling the filter criteria is found. But for now we are ok with inconsistent batch sizes.
2. What if an existing row is updated? It will get fetched a second time since the algorithm will not miss any newly added or updated row. This may or may not be desirable according to the use case. For us this is in fact the needed behavior since we need any new updates to an already fetched row. So we are ok with that too.
So that concludes our escapade with Cassandra pagination. The (love) story continues.. (Hope you saw the sarcasm sign unlike Sheldon.. )