Redis client plugin

This plugin is a wrapper around redis-plus-plus.

Installation

Follow the instructions in our manual to add our package repository and then run the below command.

Ubuntu

apt-get install halon-extras-redis

RHEL

yum install halon-extras-redis

Configuration

For the configuration schema, see redis.schema.json.

Standalone

smtpd.yaml

plugins:
  - id: redis
    config:
      default_profile: standalone-1
      profiles:
        - id: standalone-1
          type: standalone
          host: redis-node-1
          port: 6379
          user: user
          password: password
          pool_size: 32
          connect_timeout: 5000
          socket_timeout: 5000
          wait_timeout: 5000
          connection_lifetime: 600000
          connection_idle_time: 5000
          keep_alive: true
          db: 0

Cluster

smtpd.yaml

plugins:
  - id: redis
    config:
      default_profile: cluster-1
      profiles:
        - id: cluster-1
          type: cluster
          hosts:
            - host: redis-cluster-node-1
              port: 6379
            - host: redis-cluster-node-2
              port: 6379
            - host: redis-cluster-node-3
              port: 6379
          user: user
          password: password
          pool_size: 32
          connect_timeout: 5000
          socket_timeout: 5000
          wait_timeout: 5000
          connection_lifetime: 600000
          connection_idle_time: 5000
          keep_alive: true
          db: 0

Sentinel

smtpd.yaml

plugins:
  - id: redis
    config:
      default_profile: sentinel-1
      profiles:
        - id: sentinel-1
          type: sentinel
          master_name: redis-sentinel
          hosts:
            - host: redis-sentinel-sentinel-1
              port: 26379
            - host: redis-sentinel-sentinel-2
              port: 26379
            - host: redis-sentinel-sentinel-3
              port: 26379
          user: user
          password: password
          pool_size: 32
          connect_timeout: 5000
          socket_timeout: 5000
          wait_timeout: 5000
          connection_lifetime: 600000
          connection_idle_time: 5000
          keep_alive: true
          db: 0

Exported classes

These classes needs to be imported from the extras://redis module path.

Redis([profile])

The Redis class is a redis-plus-plus wrapper class.

Params

• profile string - The config profile

Returns: class object

import { Redis } from "extras://redis";

$redis = Redis();
echo $redis->command("SET", "key", "value"); // OK
echo $redis->command("GET", "key"); // value

command(...)

Send a generic command.

Returns:

Values are converted to HSL types, types defined in RESP2 and partly the RESP3 format is supported.

echo $redis->command("SET", "key", "value"); // OK