DOC-4549 improve RDI config reference #1086
Open
+266
−72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dwdougherty
approved these changes
Jan 22, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
galilev
reviewed
Jan 23, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
galilev
reviewed
Jan 23, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
galilev
reviewed
Jan 23, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
galilev
reviewed
Jan 23, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
Co-authored-by: David Dougherty <[email protected]>
content/integrate/redis-data-integration/data-pipelines/data-pipelines.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
yaronp68
requested changes
Jan 27, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
…-reference.md Co-authored-by: Zdravko Donev <[email protected]>
galilev
reviewed
Jan 27, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
galilev
reviewed
Jan 27, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Show resolved
Hide resolved
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
galilev
reviewed
Jan 27, 2025
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/reference/config-yaml-reference.md
Show resolved
Hide resolved
content/integrate/redis-data-integration/data-pipelines/data-pipelines.md
Show resolved
Hide resolved
ZdravkoDonev-redis
approved these changes
Jan 30, 2025
yaronp68
approved these changes
Feb 4, 2025
galilev
reviewed
Feb 5, 2025
| | `database.encrypt` | `string` | SQL Server| If SSL is enabled for your SQL Server database, you should also enable SSL in RDI by setting the value of this property to `true`.<br/> Default: `false` | | ||
| | `database.server.id` | `integer` | MariaDB, MySQL | Numeric ID of this database client, which must be unique across all currently-running database processes in the MySQL cluster.<br/> Default: 1| | ||
| | `database.url` | `string` | Oracle | Specifies the raw database JDBC URL. Use this property to define a custom database connection. Valid values include raw TNS names and RAC connection strings.| | ||
| | `topic.prefix` | `string` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer | A prefix for all topic names that receive events emitted by this connector.<br/> Default: `"rdi"` | |
There was a problem hiding this comment.
@andy-stark-redis it's already defined in the advanced-source section. should be removed
galilev
reviewed
Feb 5, 2025
| | -- | -- | -- | -- | | ||
| | `host` | `string` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer| The IP address of the database instance. | | ||
| | `port` | `integer` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer | The port of the database instance. | | ||
| | `database` | `string` | Oracle, PostgreSQL, SQLServer| The name of the database to capture changes from. For `SQL Server` you can define this as comma-separated list of database names. | |
There was a problem hiding this comment.
There is an extra space between the SQL and Server
galilev
reviewed
Feb 5, 2025
|
|
||
| ### Using custom queries in the initial snapshot {#custom-initial-query} | ||
|
|
||
| {{< note >}}This section is relevant only for MySQL/MariaDB, Oracle, PostgreSQL, and SQLServer. |
There was a problem hiding this comment.
@andy-stark-redis i think that MySQL/Mariadb should be replaced with MariaDB, MySQL.....
galilev
approved these changes
Feb 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DOC-4549 (but mainly refers to RDSC-2814)
I've reworked the content quite a bit to fit in with the docs style and also because the original formatting didn't work very well on the finished HTML page.
Aside from general review, a couple of things to note:
database.encrypthad MySQL in the source database column, but referred to SQL Server in the description. I've assumed it should be SQL Server, but let me know if that is not correct.targets.connectionsection includes some properties for SSL/TLS. Currently, the descriptions just say "Uncomment this line if you are using SSL/TLS". These lines contain the${...}format to refer to the source secrets, so the user shouldn't modify them. However, do we want more description in this reference file, or should we just stick with the "uncomment this line" instruction?