This little repo is here to help you write Redis modules a bit more easily.
What it includes:
The only file you really need to start writing Redis modules. Either put this path into your module's include path, or copy it.
Notice: This is an up-to-date copy of it from the Redis repo.
A small library of utility functions and macros for module developers, including:
- Easier argument parsing for your commands.
- Testing utilities that allow you to wrap your module's tests as a redis command.
RedisModuleStringutility functions (formatting, comparison, etc)
- The entire
sdsstring library, lifted from Redis itself.
- A generic scalable Vector library. Not redis specific but we found it useful.
- A few other helpful macros and functions.
alloc.h, an include file that allows modules implementing data types to implicitly replace the
malloc()function family with the Redis special allocation wrappers.
It can be found under the
rmutil folder, and compiles into a static library you link your module against.
3. An example Module
A minimal module implementing a few commands and demonstarting both the Redis Module API, and use of rmutils.
You can treat it as a template for your module, and extned its code and makefile.
It includes 3 commands:
EXAMPLE.PARSE- demonstrating rmutil's argument helpers.
EXAMPLE.HGETSET- an atomic HGET/HSET command, demonstrating the higher level Redis module API.
EXAMPLE.TEST- a unit test of the above commands, demonstrating use of the testing utilities of rmutils.
4. Documentation Files:
API.md - The official manual for writing Redis modules, copied from the Redis repo. Read this before starting, as it's more than an API reference.
FUNCTIONS.md - Generated API reference documentation for both the Redis module API, and LibRMUtil.
TYPES.md - Describes the API for creating new data structures inside Redis modules, copied from the Redis repo.
BLOCK.md - Describes the API for blocking a client while performing asynchronous tasks on a separate thread.
Quick Start Guide
Here's what you need to do to build your first module:
- Build Redis in a build supporting modules.
- Build librmutil and the module by running
make. (you can also build them seperatly by running
makein their respective dirs)
- Run redis loading the module:
/path/to/redis-server --loadmodule ./module.so
redis-cli and try the commands:
127.0.0.1:9979> EXAMPLE.HGETSET foo bar baz (nil) 127.0.0.1:9979> EXAMPLE.HGETSET foo bar vaz "baz" 127.0.0.1:9979> EXAMPLE.PARSE SUM 5 2 (integer) 7 127.0.0.1:9979> EXAMPLE.PARSE PROD 5 2 (integer) 10 127.0.0.1:9979> EXAMPLE.TEST PASS