Introduction to Redict Modules on Redict

Community Redict modules

Mon, 01 Jan 0001 00:00:00 +0000

Community Modules for Redict #

Redict Modules allow you to extend the functionality of Redict with native code. For details on writing new modules, see Introduction to Redict Modules.

Note: Redict is broadly compatible with Redis® Modules* compatible with Redis® versions 7.2.4 and earlier in source and binary form. See Compatibility with Redis® for details.

Redict modules and blocking commands

Mon, 01 Jan 0001 00:00:00 +0000

Redict modules and blocking commands #

Redict has a few blocking commands among the built-in set of commands. One of the most used is BLPOP (or the symmetric BRPOP) which blocks waiting for elements arriving in a list.

The interesting fact about blocking commands is that they do not block the whole server, but just the client calling them. Usually the reason to block is that we expect some external event to happen: this can be some change in the Redict data structures like in the BLPOP case, a long computation happening in a thread, to receive some data from the network, and so forth.

Modules API for native types

Mon, 01 Jan 0001 00:00:00 +0000

Modules API for native types #

Redict modules can access Redict built-in data structures both at high level, by calling Redict commands, and at low level, by manipulating the data structures directly.

By using these capabilities in order to build new abstractions on top of existing Redict data structures, or by using strings DMA in order to encode modules data structures into Redict strings, it is possible to create modules that feel like they are exporting new data types. However, for more complex problems, this is not enough, and the implementation of new data structures inside the module is needed.

API reference

Mon, 01 Jan 0001 00:00:00 +0000

Modules API reference #

Heap allocation raw functions #

Memory allocated with these functions are taken into account by Redict key eviction algorithms and are reported in Redict memory usage information.

`RedictModule_Alloc` #

void *RedictModule_Alloc(size_t bytes);

Available since: Redict 7.3.0

Use like malloc(). Memory allocated with this function is reported in Redict INFO memory, used for keys eviction according to maxmemory settings and in general is taken into account as memory allocated by Redict. You should avoid using malloc(). This function panics if unable to allocate enough memory.

Introduction to Redict Modules on Redict

Community Redict modules

Community Modules for Redict #

Redict modules and blocking commands

Redict modules and blocking commands #

Modules API for native types

Modules API for native types #

API reference

Modules API reference #

Heap allocation raw functions #

RedictModule_Alloc #

`RedictModule_Alloc` #