Skip to content

Commit b5999c4

Browse files
committed
docs(source): Document mode config option
1 parent 289f15b commit b5999c4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/guide/src/docs/asciidoc/source-keys.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,18 @@ connector.class = com.redis.kafka.connect.RedisKeysSourceConnector
4949
redis.keys.pattern = <glob> <1>
5050
redis.keys.timeout = <millis> <2>
5151
topic = <name> <3>
52+
mode = <LIVE|LIVEONLY> <4>
5253
----
5354
<1> Key pattern to subscribe to.
5455
This is the key portion of the pattern that will be used to listen to keyspace events.
56+
+
5557
For example `foo:*` translates to pubsub channel `$$__$$keyspace@0$$__$$:foo:*` and will capture changes to keys `foo:1`, `foo:2`, etc.
5658
See {link_redis_keys} for pattern details.
5759
<2> Idle timeout in millis.
5860
Duration after which the connector will stop if no activity is encountered.
5961
<3> Name of the destination topic.
62+
<4> Reading mode:
63+
+
64+
`LIVE` (default):: initial snapshot + updates
65+
`LIVEONLY`:: just updates
6066

0 commit comments

Comments
 (0)