> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streamnative.io/llms.txt
> Use this file to discover all available pages before exploring further.

> The Redis sink connector pulls messages from Pulsar topics and persists the messages to a Redis database.

# Redis sink

The Redis sink connector pulls messages from Pulsar topics and persists the messages to a Redis database.

# Configuration

The configuration of the Redis sink connector has the following properties.

## Property

| Name               | Type    | Required | Sensitive | Default            | Description                                                                                                                                 |
| ------------------ | ------- | -------- | --------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `redisHosts`       | String  | true     | false     | " " (empty string) | A comma-separated list of Redis hosts to connect to.                                                                                        |
| `redisPassword`    | String  | false    | true      | " " (empty string) | The password used to connect to Redis.                                                                                                      |
| `redisDatabase`    | int     | true     | false     | 0                  | The Redis database to connect to.                                                                                                           |
| `clientMode`       | String  | false    | false     | Standalone         | The client mode when interacting with Redis cluster. <br /><br />Below are the available options: <br /><li>Standalone</li><li>Cluster</li> |
| `autoReconnect`    | boolean | false    | false     | true               | Whether the Redis client automatically reconnect or not.                                                                                    |
| `requestQueue`     | int     | false    | false     | 2147483647         | The maximum number of queued requests to Redis.                                                                                             |
| `tcpNoDelay`       | boolean | false    | false     | false              | Whether to enable TCP with no delay or not.                                                                                                 |
| `keepAlive`        | boolean | false    | false     | false              | Whether to enable a keepalive to Redis or not.                                                                                              |
| `connectTimeout`   | long    | false    | false     | 10000              | The time to wait before timing out when connecting in milliseconds.                                                                         |
| `operationTimeout` | long    | false    | false     | 10000              | The time before an operation is marked as timed out in milliseconds .                                                                       |
| `batchTimeMs`      | int     | false    | false     | 1000               | The Redis operation time in milliseconds.                                                                                                   |
| `batchSize`        | int     | false    | false     | 200                | The batch size of writing to Redis database.                                                                                                |

## Example

Before using the Redis sink connector, you need to create a configuration file through one of the following methods.

* JSON

  ```json theme={null}
  {
      "redisHosts": "localhost:6379",
      "redisPassword": "fake@123",
      "redisDatabase": "1",
      "clientMode": "Standalone",
      "operationTimeout": "2000",
      "batchSize": "100",
      "batchTimeMs": "1000",
      "connectTimeout": "3000"
  }
  ```

* YAML

  ```yaml theme={null}
  {
      redisHosts: "localhost:6379"
      redisPassword: "fake@123"
      redisDatabase: 1
      clientMode: "Standalone"
      operationTimeout: 2000
      batchSize: 100
      batchTimeMs: 1000
      connectTimeout: 3000
  }
  ```