This is an automated email from the ASF dual-hosted git repository.
zhangshenghang pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new 05978c6f5b [Docs][Connector-V2] Improve Redis source examples (#11240)
05978c6f5b is described below
commit 05978c6f5b1d4ae1238b892a5a71b205c511f096
Author: Daniel Carter <[email protected]>
AuthorDate: Wed Jul 1 13:42:16 2026 +0800
[Docs][Connector-V2] Improve Redis source examples (#11240)
Co-authored-by: DanielCarter-stack
<[email protected]>
---
docs/en/connectors/source/Redis.md | 44 ++++++++++++++++++--
docs/zh/connectors/source/Redis.md | 84 ++++++++++++++++++++++++++++++++++++--
2 files changed, 120 insertions(+), 8 deletions(-)
diff --git a/docs/en/connectors/source/Redis.md
b/docs/en/connectors/source/Redis.md
index f5e8c4dbaa..5277fb7a61 100644
--- a/docs/en/connectors/source/Redis.md
+++ b/docs/en/connectors/source/Redis.md
@@ -39,7 +39,7 @@ When using `tables_configs` to read multiple key patterns,
each table configurat
| name | type | required | default value | description |
|---------------------|--------|----------|---------------|-------------|
| keys | string | yes | - | Redis key pattern
to scan |
-| data_type | string | yes | - | Redis data type:
`key`, `hash`, `list`, `set`, `zset` |
+| data_type | string | yes | - | Redis data type:
`key`, `string`, `hash`, `list`, `set`, `zset` |
| batch_size | int | no | 10 | Batch size for
SCAN operations |
| format | string | no | json | Data format:
`json` or `text` |
| schema | config | no | - | Schema
configuration for this table |
@@ -185,9 +185,9 @@ indicates the number of keys to attempt to return per
iteration,default 10
### data_type [string]
-redis data types, support `key` `hash` `list` `set` `zset`
+redis data types, support `key` `string` `hash` `list` `set` `zset`
-- key
+- key/string
> The value of each key will be sent downstream as a single row of data.
> For example, the value of key is `SeaTunnel test message`, the data received
> downstream is `SeaTunnel test message` and only one message will be received.
@@ -391,6 +391,42 @@ sink {
}
```
+read string type keys together with their Redis keys
+
+```hocon
+source {
+ Redis {
+ host = "redis-e2e"
+ port = 6379
+ auth = "U2VhVHVubmVs"
+ keys = "string_test*"
+ data_type = string
+ batch_size = 33
+ read_key_enabled = true
+ key_field_name = custom_key
+ single_field_name = custom_value
+ format = json
+ schema = {
+ table = "RedisDatabase.RedisTable"
+ columns = [
+ {
+ name = "custom_key"
+ type = "string"
+ },
+ {
+ name = "custom_value"
+ type = "string"
+ }
+ ]
+ }
+ }
+}
+
+sink {
+ Console {}
+}
+```
+
### Multiple Table Mode
**Example 1: Reading multiple key patterns with different data types**
@@ -498,4 +534,4 @@ sink {
```
## Changelog
-<ChangeLog />
\ No newline at end of file
+<ChangeLog />
diff --git a/docs/zh/connectors/source/Redis.md
b/docs/zh/connectors/source/Redis.md
index f7d32d27c9..39416dac71 100644
--- a/docs/zh/connectors/source/Redis.md
+++ b/docs/zh/connectors/source/Redis.md
@@ -39,7 +39,7 @@ import ChangeLog from '../changelog/connector-redis.md';
| 名称 | 类型 | 是否必须 | 默认值 | 描述
|
|---------------------|---------|--------|-------|--------------------------------------------|
| keys | string | 是 | - | 要扫描的 Redis key pattern
|
-| data_type | string | 是 | - | Redis
数据类型：`key`、`hash`、`list`、`set`、`zset` |
+| data_type | string | 是 | - | Redis
数据类型：`key`、`string`、`hash`、`list`、`set`、`zset` |
| batch_size | int | 否 | 10 | SCAN 操作的批量大小
|
| format | string | 否 | json | 数据格式：`json` 或 `text`
|
| schema | config | 否 | - | Schema 配置
|
@@ -131,6 +131,46 @@ hash key 中的每个 kv 将会被视为一行并被发送给上游。
keys 模式
+### read_key_enabled [boolean]
+
+配置为 `true` 时，Redis source 会把 Redis key 和 value 一起读出。
+
+默认值为 `false`，也就是只读取 value。
+
+如果读取的是 `string`、`list`、`set`、`zset` 这类单值类型，并且开启了 `read_key_enabled`，需要同时配置：
+
+- `key_field_name`：Redis key 写入哪一列。
+- `single_field_name`：Redis value 写入哪一列。
+
+示例：
+
+```hocon
+read_key_enabled = true
+key_field_name = key
+single_field_name = value
+schema {
+ fields {
+ key = string
+ value = string
+ }
+}
+```
+
+### key_field_name [string]
+
+指定 Redis key 输出到哪一个字段。
+
+- 当 `read_key_enabled = true` 时，如果不配置，默认字段名是 `key`。
+- 当 `data_type = hash` 且不配置该选项时，默认字段名是 `hash_key`。
+
+当默认字段名和已有字段冲突，或者想使用更明确的字段名时，可以配置该选项。
+
+### single_field_name [string]
+
+读取单值类型并且 `read_key_enabled = true` 时，指定 Redis value 输出到哪一个字段。
+
+该选项主要用于 `string`、`list`、`set`、`zset` 这类不能直接映射成多列对象的数据。
+
### batch_size [int]
表示每次迭代尝试返回的键的数量，默认值为 10。
@@ -139,9 +179,9 @@ keys 模式
### data_type [string]
-redis 数据类型, 支持 `key` `hash` `list` `set` `zset`。
+redis 数据类型, 支持 `key` `string` `hash` `list` `set` `zset`。
-- key
+- key/string
> 将每个 key 的值将作为单行数据发送给下游。
> 例如，key 对应的值为 `SeaTunnel test message`，则下游接收到的数据为 `SeaTunnel test
> message`，并且仅会收到一条信息。
@@ -326,6 +366,42 @@ sink {
}
```
+读取 string 类型时同时读取 Redis key：
+
+```hocon
+source {
+ Redis {
+ host = "redis-e2e"
+ port = 6379
+ auth = "U2VhVHVubmVs"
+ keys = "string_test*"
+ data_type = string
+ batch_size = 33
+ read_key_enabled = true
+ key_field_name = custom_key
+ single_field_name = custom_value
+ format = json
+ schema = {
+ table = "RedisDatabase.RedisTable"
+ columns = [
+ {
+ name = "custom_key"
+ type = "string"
+ },
+ {
+ name = "custom_value"
+ type = "string"
+ }
+ ]
+ }
+ }
+}
+
+sink {
+ Console {}
+}
+```
+
### 多表模式
**示例 1：读取具有不同数据类型的多个 key pattern**
@@ -435,4 +511,4 @@ sink {
## 变更日志
-<ChangeLog />
\ No newline at end of file
+<ChangeLog />
