> ## Documentation Index
> Fetch the complete documentation index at: https://prefect-bd373955-codex-docket-background-task-ha.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# blocks
# `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
* `key_ttl`: Optional per-key TTL in seconds applied to every written key
(`SET ... EX`); `None` (default) means keys never expire
**Methods:**
#### `aread_path`
```python theme={null}
aread_path(self, path: str) -> bytes
```
Read a redis key
**Args:**
* `path`: Redis key to read from
**Returns:**
* Contents at key as bytes
**Examples:**
Read a key:
```python theme={null}
content = await block.aread_path("my-key")
```
#### `as_connection_params`
```python theme={null}
as_connection_params(self) -> Dict[str, Any]
```
Return a dictionary suitable for unpacking
#### `awrite_path`
```python theme={null}
awrite_path(self, path: str, content: bytes) -> bool
```
Write to a redis key
**Args:**
* `path`: Redis key to write to
* `content`: Binary object to write
**Examples:**
Write a key:
```python theme={null}
await block.awrite_path("my-key", b"contents")
```
#### `block_initialization`
```python theme={null}
block_initialization(self) -> None
```
Validate parameters
#### `from_connection_string`
```python theme={null}
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`
```python theme={null}
get_async_client(self) -> redis.asyncio.Redis
```
Get Redis Client
**Returns:**
* An initialized Redis async client
#### `get_client`
```python theme={null}
get_client(self) -> redis.Redis
```
Get Redis Client
**Returns:**
* An initialized Redis async client
#### `read_path`
```python theme={null}
read_path(self, path: str) -> bytes
```
Read a redis key
**Args:**
* `path`: Redis key to read from
**Returns:**
* Contents at key as bytes
**Examples:**
Read a key:
```python theme={null}
content = block.read_path("my-key")
```
#### `write_path`
```python theme={null}
write_path(self, path: str, content: bytes) -> bool
```
Write to a redis key
**Args:**
* `path`: Redis key to write to
* `content`: Binary object to write
**Examples:**
Write a key:
```python theme={null}
block.write_path("my-key", b"contents")
```