prefect.blocks.redis

Classes

RedisStorageContainer ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L24" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Block used to interact with Redis as a filesystem

Attributes:

• host: The value to store.
• port: The value to store.
• db: The value to store.
• username: The value to store.
• password: The value to store.
• connection_string: The value to store.

Methods:

aread_path ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L77" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

aread_path(self, path: Path | str) -> Optional[bytes]

Read the redis content at path

Args:

• path: Redis key to read from

Returns:

• Contents at key as bytes, or None if key does not exist

awrite_path ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L116" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

awrite_path(self, path: Path | str, content: bytes) -> bool

Write content to the redis at path

Args:

• path: Redis key to write to
• content: Binary object to write

Returns:

• True if the key was set successfully

block_initialization ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L67" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

block_initialization(self) -> None

from_connection_string ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L204" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

from_connection_string(cls, connection_string: str | SecretStr) -> Self

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
• unix:// creates a Unix Domain Socket connection

See [Redis docs](https://redis.readthedocs.io/en/stable/examples /connection_examples.html#Connecting-to-Redis-instances-by-specifying-a-URL -scheme.) for more info.

Args:

• connection_string: Redis connection string

Returns:

• RedisStorageContainer instance

from_host ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L178" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

from_host(cls, host: str, port: int = 6379, db: int = 0, username: None | str | SecretStr = None, password: None | str | SecretStr = None) -> Self

Create block from hostname, username and password

Args:

• host: Redis hostname
• username: Redis username
• password: Redis password
• port: Redis port

Returns:

• RedisStorageContainer instance

read_path ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L90" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_path(self, path: Path | str) -> Optional[bytes]

Read the redis content at path

Args:

• path: Redis key to read from

Returns:

• Contents at key as bytes, or None if key does not exist

read_path ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/filesystems.py#L37" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_path(self, path: str) -> bytes

write_path ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/blocks/redis.py#L131" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

write_path(self, path: Path | str, content: bytes) -> bool

Write content to the redis at path

Args:

• path: Redis key to write to
• content: Binary object to write

Returns:

• True if the key was set successfully

write_path ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/filesystems.py#L41" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

write_path(self, path: str, content: bytes) -> None