# RedisGears

**Repository Path**: mirrors/RedisGears

## Basic Information

- **Project Name**: RedisGears
- **Description**: RedisGears 是一个基于 Redis 的动态执行框架，使用方法： 
GearsBuilder().filter(filter_function).map(map_funct
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/redisgears
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2019-06-01
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Triggers and Functions

[![GitHub Builds](https://github.com/RedisGears/RedisGears/actions/workflows/branch_merge.yml/badge.svg)](https://github.com/RedisGears/RedisGears/actions/workflows/branch_merge.yml)
[![CircleCI](https://circleci.com/gh/RedisGears/RedisGears/tree/master.svg?style=svg)](https://circleci.com/gh/RedisGears/RedisGears/tree/master)
[![Documentation](https://img.shields.io/badge/documentation-redis)](https://redis.io/docs/interact/programmability/triggers-and-functions/)

A [Redis module](https://redis.io/docs/modules/) that allows running a JS functions inside the Redis processes. The `JS` code is execute use [V8 `JS` engine](https://v8.dev/).

**Notice, Triggers and Functions is still under active development and not yet GA. The API might (and probably will) change at the final GA version.**

## Run Using Docker

```bash
docker run -p 6379:6379 redislabs/redisgears:edge
```

## How do I Redis?

[Learn for free at Redis University](https://university.redis.com/)

[Build faster with the Redis Launchpad](https://launchpad.redis.com/)

[Try the Redis Cloud](https://redis.com/try-free/)

[Dive in developer tutorials](https://developer.redis.com/)

[Join the Redis community](https://redis.com/community/)

[Work at Redis](https://redis.com/company/careers/jobs/)

## Build

### With Docker

Run the following on the main directory:
```bash
> docker build -t redisgears2 .
```

Then run the built image:
```bash
> docker run -p 6379:6379 redisgears2
```

### From Source

See the [build](docs/build_instructions.md) page for more information.

## Getting started

### Run JS code
The API exposed by the module is very similar to the way [Redis Functions](https://redis.io/docs/manual/programmability/functions-intro/) work. Let's write a simple `hello world` function that returns the string `hello world`:
```js
#!js name=lib api_version=1.0

redis.registerFunction('hello_world', function(){
    return 'hello_world';
});
```
The first line indicates the engine to use (`js`) and the library name (`lib`). The rest is the library code.


Assuming we put the following code in the file `lib.js`, we can register our function in Redis using the `TFUNCTION LOAD` command:

```bash
> redis-cli -x TFUNCTION LOAD < ./lib.js
OK
```

And now we can execute our function using [`TFCALL`](docs/commands/tfcall.md) command, the command gets the library name and the function name `.` separated:

```bash
> redis-cli TFCALL lib.hello_world 0
"hello_world"
```

Notice that the [`TFCALL`](docs/commands/tfcall.md) command arguments are very close to the Redis [`FCALL`](https://redis.io/commands/fcall/) command arguments. The only difference is that, for Triggers and Functions, the command also requires the library name. The `0` represents the number of keys that will follow, which in our case is `0`.

### Calling Redis Commands Inside Triggers and Functions

It is possible to call Redis commands inside Triggers and Functions. The function gets as the first argument a client object that allows interaction with Redis using the `call` function. The following example executes a simple `PING` command and returns the result:

```js
#!js name=lib api_version=1.0

redis.registerFunction('my_ping', function(client){
    return client.call('ping');
});
```

If we will try to send it to our running Redis instance, we will get the following error:
```bash
> redis-cli -x TFUNCTION LOAD < ./lib.js
(error) Library lib already exists
```

We get the error because the library with the same name already exists, we can use the `REPLACE` argument to replace the library with the new code:
```bash
> redis-cli -x TFUNCTION LOAD UPGRADE < ./lib.js
OK
```

And now we can invoke `my_ping` using [`TFCALL`](docs/commands/tfcall.md) :
```bash
> redis-cli TFCALL lib.my_ping 0
"PONG"
```

### What's next?

* [Quick Start](docs/docs/Quick_Start.md)
* [Official documentation](https://redis.io/docs/interact/programmability/triggers-and-functions/)
* [Commands](https://redis.io/commands)
* [Configuration](docs/docs/Configuration.md)
* [Sync and Async Run](docs/docs/concepts/Sync_Async.md)
* [KeySpace Triggers](docs/docs/concepts/triggers/KeySpace_Triggers.md)
* [Stream Triggers](docs/docs/concepts/triggers/Stream_Triggers.md)
* [Cluster support](docs/docs/concepts/Cluster_Support.md)
* [JS API](docs/docs/concepts//JavaScript_API.md)