(Quick Reference)

1 Introduction

Redis is an advanced key-value store. It is similar to memcached except the dataset is not volatile. Like memcached, Redis can store string values, but it can also store lists, sets, and ordered sets. All these data types can be manipulated with atomic operations that push, pop, add and remove elements, perform server side union, intersection, difference between sets, and more. Redis also supports different kinds of sorting.

This project aims to provide an object-mapping layer on top of Redis to ease common activities such as:

• Marshalling from Redis strings to Groovy/Java types and back again
• Creating and caching indices for querying
• Working with transactions
• Validating domain instances backed by the Redis datastore

1.1 Compatibility with GORM for Hibernate

This implementation tries to be as compatible as possible with GORM for Hibernate. In general you can refer to the GORM documentation and the "Domain Classes" section of the reference guide (see the left nav) for usage information.

The following key features are supported by GORM for Redis:

• Simple persistence methods
• Dynamic finders
• Criteria queries
• Named queries
• Inheritance

However, some features are not supported:

• HQL queries
• Dirty checking methods
• Composite primary keys
• Many-to-many associations (these can be modelled with a mapping class)
• Any direct interaction with the Hibernate API
• Sorting on strings
• Custom Hibernate user types

There may be other limitations not mentioned here so in general it shouldn't be expected that an application based on GORM for Hibernate will "just work" without some tweaking involved. Having said that, the large majority of common GORM functionality is supported.