RedisGears Glossary ¶
Redis is an ...
... open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries and streams. Redis has built-in replication, Lua scripting, LRU eviction, transactions and different levels of on-disk persistence, and provides high availability via Redis Sentinel and automatic partitioning with Redis Cluster.
Redis is also...
An acronym for RE mote DI ctionary S erver that's pronounced "red" like the color, then "iss".
A Redis module is a shared library that can be loaded by the Redis server during runtime. Useful for extending Redis with new data types and commands.
You can learn more about Redis modules at:
A Redis client is a piece of software that can write and read the Redis Protocol .
For a wide choice of clients refer to:
An instruction sent to the Redis server by a client. Commands are either provided by the core Redis engine or modules.
Refer to these pages for more information about:
Zeros and ones that make up for everything. Usually stored in Redis, but can also be obtained from other sources.
Data Flow ¶
A logical operation that processes input data in some form and may consist of several steps.
Data Type ¶
Redis stores data in structures that implement different types and the API to manipulate their contents. Types can be added by modules, and the core Redis server provides support for Strings, Hashes, Lists, Sets, Sorted Sets and Streams.
Refer to these pages for more information about Redis' core types:
An event is a signal that the RedisGears engine can intercept and react to by triggering the execution of an event-driven processing function.
A RedisGears component that is in charge of the execution of functions. The engine executes locally on each of the cluster's shards.
A RedisGears component that handles cluster communication and data shuffling.
A cluster is a deployment option for Redis, in which the database is partitioned across multiple shards in a shared-nothing fashion. Partitioning is done by hashing key names to slots.
More about the Redis cluster:
A node is a physical (or virtualized) server in a cluster. Each node can be used for hosting one or more shards.
A shard is Redis server process that is a part of a cluster. A shard runs on one of the cluster's nodes and manages an exclusive subset of slots of the Redis keyspace. Every slot is managed by a single master shard. Master shards accepts writes and can optionally be configured with replicas for scaling read throughput and availability purposes.
RedisGears functions can be programmed via applicative interfaces. The APIs are available for the Python and C programming languages
A RedisGears function is a formal description of the processing steps in the data flow.
A function always:
- Starts with a reader
- Operates on zero or more records
- Consists of zero or more operations (steps)
- Ends with an action
- Returns zero or more results
Refer to the Functions page for a complete reference about functions.
A RedisGears reader is the mandatory first step of any function, and every function has exactly one reader. A reader reads data and generates input records from it. The input records are consumed by the function.
Refer to the Readers page for a complete reference about the different readers' types and their operation.
A RedisGears record is the basic abstraction that represents data in the function's flow. Input data records are passed from one step to the next and are finally returned as the result.
An operation is the building block of RedisGears functions. Different operation types can be used to achieve a variety of results to meet various data processing needs.
Refer to the Operations page for a complete reference about the different operation types and their purpose.
A RedisGears function flow step is a term that's almost always interchangeable with "operation".
An action is special type of operation that is always the function's final step. There are two types of actions:
- Run : runs the function immediately in batch
- Register : registers the function's execution to be triggered by an event
Actions are described at the Functions page .
The result of a function is the output records its execution.
Results are described at the Functions page .
Every time that a RedisGears function is executed it generates data that is referred to as its execution . Every execution is uniquely identified by an ID, and consists of the results, errors and more information from the function's execution.
Executions are described at the Functions page .
A RedisGears registration represents a function that was sent to the engine and will be triggered by events.
Registrations are described at the Functions page .
In the context of a clustered environment the initiator is the shard's engine in which a function is originally executed.
In the context of a clustered environment a worker is any shard that isn't the initiator.
Batch Processing ¶
A RedisGears function is executed as a batch when it is run immediately on existing data.
Batch execution is always asynchronous. By default, the client executing the function is blocked until execution is finished. Once finished, the client is unblocked and is returned with any results or errors from the function.
Event Processing ¶
A RedisGears function is executed as an event when it is registered to be triggered by events.
A framework for performing distributed data processing.
A RedisGears recipe is a collection of functions any dependencies they may have, which implements a high-level functional purpose. It can be mentally substituted with "project".