(Quick Reference)

7 The Low-level API - Reference Documentation

Authors: Graeme Rocher

Version: 5.0.0.BUILD-SNAPSHOT

7 The Low-level API

There is a lower-level API that provides access to the majority of commands from the Redis Command Reference. The API is available via a Spring bean called redis that you can inject into your own artifacts.

For example in a controller:

class MyController {
    def redis

def foo = { redis.select(2) redis.flushdb() redis["message"] = "World"

render "Hello ${redis["message"]}!" } }

See the org.grails.redis.util.RedisTemplate interface for the full list of available methods.

The low-level API gives you an easy way to work with Redis lists, sets and hashes via the list, set and hash methods. For example, the list method returns a normal Java java.util.List that is backed onto a Redis list:

def list = redis.list("my.list")
list << 1 << 2 << 3
assert 3 == list.size()
assert 1 == list[0] as Integer
assert 2 == list[1] as Integer
assert 3 == list[2] as Integer

whilst the set method returns a Java java.util.Set:

def set = redis.set("my.set")
set << 1 << 2 << 3 << 1 << 2
assert 3 == set.size()
assert set.contains(1)

And finally the hash method returns a Java java.util.Map:

def hash = redis.hash("my.hash")

hash["foo"] = "bar"

assert "bar" == hash["foo"]

There is also an entities helper method for obtaining domain classes from a Redis set or list. This is useful when you want to build your own indices:

def theSimpsons = Person.findAllByLastName("Simpson")

def list = redis.list("the.simpsons") theSimpsons.each { list << it.id }

and later query them:

def theSimpsons = redis.entities(Person, "the.simpsons")
theSimpsons.each {
    println it.firstName
}