Skip to content

Commit

Permalink
[pulsar-io] [doc] Add docs for Redis sink (apache#4046)
Browse files Browse the repository at this point in the history
### Motivation

Add docs for Redis sink.

### Modifications

Add `io-redis.md`.
  • Loading branch information
murong00 authored and sijie committed Apr 25, 2019
1 parent 824a654 commit c642e5d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions site2/docs/io-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ Pulsar Functions cluster.
- [File Source Connector](io-file.md#source)
- [Hdfs Sink Connector](io-hdfs.md#sink)
- [MongoDB Sink Connector](io-mongo.md#sink)
- [Redis Sink Connector](io-redis.md#sink)
- [Solr Sink Connector](io-solr.md#sink)
- [InfluxDB Sink Connector](io-influxdb.md#sink)
27 changes: 27 additions & 0 deletions site2/docs/io-redis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
id: io-redis
title: redis Connector
sidebar_label: redis Connector
---

## Sink

The redis Sink Connector is used to pull messages from Pulsar topics and persist the messages
to a redis database.

## Sink Configuration Options

| Name | Default | Required | Description |
|------|---------|----------|-------------|
| `redisHosts` | `null` | `true` | A comma separated list of Redis hosts to connect to. |
| `redisPassword` | `null` | `false` | The password used to connect to Redis. |
| `redisDatabase` | `0` | `true` | The Redis database to connect to. |
| `clientMode` | `Standalone` | `false` | The client mode to use when interacting with the Redis cluster. Possible values [Standalone, Cluster]. |
| `autoReconnect` | `true` | `false` | Flag to determine if the Redis client should automatically reconnect. |
| `requestQueue` | `2147483647` | `false` | The maximum number of queued requests to Redis. |
| `tcpNoDelay` | `false` | `false` | Flag to enable TCP no delay should be used. |
| `keepAlive` | `false` | `false` | Flag to enable a keepalive to Redis. |
| `connectTimeout` | `10000` | `false` | The amount of time in milliseconds to wait before timing out when connecting. |
| `operationTimeout` | `10000` | `false` | The amount of time in milliseconds before an operation is marked as timed out. |
| `batchTimeMs` | `1000` | `false` | The Redis operation time in milliseconds. |
| `batchSize` | `1000` | `false` | The batch size of write to Redis database. |

0 comments on commit c642e5d

Please sign in to comment.