Skip to content

DOC-3901 add advanced props section to config.yaml docs #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andy-stark-redis merged 1 commit into from
Jun 18, 2024
Merged

DOC-3901 add advanced props section to config.yaml docs #329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions content/integrate/redis-data-integration/ingest/data-pipelines/data-pipelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,18 @@ sources:
- lname
keys:
- empno
# Advanced collector properties (optional):
# advanced:
# Sink collector properties - see the full list at https://debezium.io/documentation/reference/stable/operations/debezium-server.html#_redis_stream
# sink:
# redis.memory.limit.mb: 100
# redis.memory.threshold.percentage: 85
# Source specific properties - see the full list at https://debezium.io/documentation/reference/stable/connectors/
# source:
# snapshot.mode: initial
# Quarkus framework properties - see the full list at https://quarkus.io/guides/all-config
# quarkus:
# banner.enabled: "false"
targets:
my-redis:
connection:
Expand Down Expand Up @@ -101,12 +113,17 @@ configuration contains the following data:
[`PRIMARY KEY`](https://www.w3schools.com/sql/sql_primarykey.asp) or
[`UNIQUE`](https://www.w3schools.com/sql/sql_unique.asp) constraint then you can
supply a unique composite key.

There are also some advanced source configurations that are specific to each
type of source database but you usually won't need these. Some of them are documented
in our
[RDI configuration file]({{< relref "/integrate/redis-data-integration/ingest/reference/config-yaml-reference" >}})
reference.
- `advanced`: These optional properties configure other Debezium-specific features.
The available sub-sections are:
- `sink`: all advanced properties for writing to RDI (TLS, memory threshold, etc).
See the Debezium [Redis stream properties](https://debezium.io/documentation/reference/stable/operations/debezium-server.html#_redis_stream)
page for the full set of available properties.
- `source`: all advanced connector properties (for example, RAC nodes). See the
Debezium [Connectors](https://debezium.io/documentation/reference/stable/connectors/)
page for the full set of available properties.
- `quarkus`: all advanced properties for Debezium server, such as the log level. See the
Quarkus [Configuration options](https://quarkus.io/guides/all-config)
docs for the full set of available properties.

### Targets

Expand Down