redis

Description

Plugin to send messages on Redis queues.

See https://redis-py.readthedocs.io/en/latest/connections.html#redis.Redis for supported parameters.

Configuration

redis:
    # No configuration required

Actions

• redis.delete

• redis.expire

• redis.mget

• redis.mset

• redis.send_message

Module reference

class platypush.plugins.redis.RedisPlugin(*args, **kwargs)

Bases: Plugin

Plugin to send messages on Redis queues.

See https://redis-py.readthedocs.io/en/latest/connections.html#redis.Redis for supported parameters.

__init__(*args, **kwargs)

delete(*args)

Delete one or multiple keys

Parameters:

args – Keys to delete

expire(key, expiration)

Set an expiration time in seconds for the specified key

Parameters:

• key (str) – Key to set to expire

• expiration (int) – Expiration timeout (in seconds)

mget(keys, *args)

Returns:

The values specified in keys as a key/value dict (wraps MGET)

mset(**kwargs)

Set key/values based on mapping (wraps MSET)

send_message(queue: str, msg, *args, **kwargs)

Send a message to a Redis queue.

Parameters:

• queue – Queue name

• msg (str, bytes, list, dict, platypush.message.Message) – Message to be sent

• args – Args passed to the Redis constructor (see https://redis-py.readthedocs.io/en/latest/connections.html#redis.Redis)

• kwargs – Kwargs passed to the Redis constructor (see https://redis-py.readthedocs.io/en/latest/connections.html#redis.Redis)