RSCoordinator is an add-on module that enables scalable distributed search over RediSearch.
RSCoordinator runs alongside RediSearch, and distributes search commands across the cluster. It translates its own API, which is similar to RediSearch's API, into a set of RediSearch commands, sends those to the appropriate shards, and merges the responses to a single one.
# Creating an index
> FT.CREATE myIdx SCHEMA foo TEXT
# Adding a document
> FT.ADD myIdx doc1 1.0 FIELDS foo "hello world"
# Searching
> FT.SEARCH myIdx "hello world"
The syntax of all these commands is identical to that of the equivalent RediSearch commands.
RSCoordinator has no dependencies, and only needs gcc/lldb, automake, libtool and libc to build it. It includes libuv internally, and uses the provided internal library.
Building is simply done by running:
$ mkdir build
$ python configure.py
$ cd build
$ make
This creates two files called module-oss.so and module-enterprise.so in /build, and from here on, you can run it inside redis oss cluster.
To load the module just add the loadmodule parameter:
loadmodule /path/to/oss-module.so
The module automatically discovers the Redis cluster topology and distributes the search commands accordingly. Notice that it is possible to give a global password that will be used to connect to other shards using OSS_GLOBAL_PASSWORD module argument, i.e:
loadmodule /path/to/oss-module.so OSS_GLOBAL_PASSWORD <password>