Documentation

What

Rom is a package whose purpose is to offer active-record style data modeling
within Redis from Python, similar to the semantics of Django ORM, SQLAlchemy,
Google’s Appengine datastore, and others.

Why

I was building a personal project, wanted to use Redis to store some of my
data, but didn’t want to hack it poorly. I looked at the existing Redis object
mappers available in Python, but didn’t like the features and functionality
offered.

Lua support

From version 0.25.0 and on, rom assumes that you are using Redis version 2.6
or later, which supports server-side Lua scripting. This allows for the
support of multiple unique column constraints without annoying race conditions
and retries. This also allows for the support of prefix, suffix, and pattern
matching on certain column types.

If you are using a version of Redis prior to 2.6, you should upgrade Redis. If
you are unable or unwilling to upgrade Redis, but you still wish to use rom,
you should call rom._disable_lua_writes(), which will prevent you from
using features that require Lua scripting support.