prefect_redis.tasks

Prebuilt Prefect tasks for reading and writing data to Redis

Functions

redis_set ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/tasks.py#L14" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

redis_set(credentials: 'RedisDatabase', key: str, value: Any, ex: Optional[float] = None, px: Optional[float] = None, nx: bool = False, xx: bool = False) -> None

Set a Redis key to a any value.

Will use cloudpickle to convert value to binary representation.

Args:

• credentials: Redis credential block
• key: Key to be set
• value: Value to be set to key. Does not accept open connections such as database-connections
• ex: If provided, sets an expire flag in seconds on key set
• px: If provided, sets an expire flag in milliseconds on key set
• nx: If set to True, set the value at key to value only if it does not already exist
• xx: If set tot True, set the value at key to value only if it already exists

redis_set_binary ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/tasks.py#L46" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

redis_set_binary(credentials: 'RedisDatabase', key: str, value: bytes, ex: Optional[float] = None, px: Optional[float] = None, nx: bool = False, xx: bool = False) -> None

Set a Redis key to a binary value

Args:

• credentials: Redis credential block
• key: Key to be set
• value: Value to be set to key. Must be bytes
• ex: If provided, sets an expire flag in seconds on key set
• px: If provided, sets an expire flag in milliseconds on key set
• nx: If set to True, set the value at key to value only if it does not already exist
• xx: If set tot True, set the value at key to value only if it already exists

redis_get ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/tasks.py#L74" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

redis_get(credentials: 'RedisDatabase', key: str) -> Any

Get an object stored at a redis key. Will use cloudpickle to reconstruct the object.

Args:

• credentials: Redis credential block
• key: Key to get

Returns:

• Fully reconstructed object, decoded brom bytes in redis

redis_get_binary ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/tasks.py#L94" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

redis_get_binary(credentials: 'RedisDatabase', key: str) -> bytes

Get an bytes stored at a redis key

Args:

• credentials: Redis credential block
• key: Key to get

Returns:

• Bytes from key in Redis

redis_execute ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/tasks.py#L113" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

redis_execute(credentials: 'RedisDatabase', cmd: str) -> Any

Execute Redis command

Args:

• credentials: Redis credential block
• cmd: Command to be executed

Returns:

• Command response