Skip to main content

​
prefect_redis.blocks

Redis credentials handling

​
Classes

​
RedisDatabase

Block used to manage authentication with a Redis database Attributes:
  • host: The host of the Redis server
  • port: The port the Redis server is running on
  • db: The database to write to and read from
  • username: The username to use when connecting to the Redis server
  • password: The password to use when connecting to the Redis server
  • ssl: Whether to use SSL when connecting to the Redis server
Methods:

​
as_connection_params 

as_connection_params(self) -> Dict[str, Any]
Return a dictionary suitable for unpacking

​
block_initialization 

block_initialization(self) -> None
Validate parameters

​
from_connection_string 

from_connection_string(cls, connection_string: Union[str, SecretStr]) -> 'RedisDatabase'
Create block from a Redis connection string Supports the following URL schemes:
  • redis:// creates a TCP socket connection
  • rediss:// creates a SSL wrapped TCP socket connection
Args:
  • connection_string: Redis connection string
Returns:
  • RedisCredentials instance

​
get_async_client 

get_async_client(self) -> redis.asyncio.Redis
Get Redis Client Returns:
  • An initialized Redis async client

​
get_client 

get_client(self) -> redis.Redis
Get Redis Client Returns:
  • An initialized Redis async client

​
read_path 

read_path(self, path: str) -> bytes
Read a redis key Args:
  • path: Redis key to read from
Returns:
  • Contents at key as bytes

​
write_path 

write_path(self, path: str, content: bytes) -> None
Write to a redis key Args:
  • path: Redis key to write to
  • content: Binary object to write