DOC-4744 updated SQL Server preparation guide #1073
Closed
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 21, 2025
| To prepare your SQL Server database for Debezium, you must first run a query to | ||
| enable CDC globally and then separately enable CDC for each table you want to | ||
| To prepare your SQL Server database for Debezium, you must first create a dedicated Debezium user, | ||
| run a script to enable CDC globally and then separately enable CDC for each table you want to |
There was a problem hiding this comment.
Suggested change
| run a script to enable CDC globally and then separately enable CDC for each table you want to | |
| run a script to enable CDC globally, and then separately enable CDC for each table you want to |
| |--|--|--|--| | ||
| | `host` | `string` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer|The address of the database instance.| | ||
| | `port` | `integer` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer | The port of the database instance.| | ||
| | `database` | `string` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer|The name of the database from which to stream the changes. For `SQL Server` you can define the database as comma-separated list of the SQL Server database names from which to stream the changes.| |
There was a problem hiding this comment.
Suggested change
| | `database` | `string` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer|The name of the database from which to stream the changes. For `SQL Server` you can define the database as comma-separated list of the SQL Server database names from which to stream the changes.| | |
| | `database` | `string` | MariaDB, MySQL, Oracle, PostgreSQL, SQLServer|The name of the database from which to stream the changes. For `SQL Server` you can define the database as a comma-separated list of the SQL Server database names from which to stream the changes.| |
| | `database.pdb.name` | `string` | Oracle|The name of the [Oracle Pluggable Database](https://docs.oracle.com/en/database/oracle/oracle-database/19/riwin/about-pluggable-databases-in-oracle-rac.html) that the connector captures changes from. For non-CDB installation, do not specify this property.<br/> Default: "ORCLPDB1"| | ||
| | `database.encrypt` | `string` | MySQL|If SSL is enabled for a SQL Server database, enable SSL by setting the value of this property to true.<br/> Default: false | | ||
| | `database.server.id` | `integer` | MySQL|A 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 provide flexibility in defining that database connection. Valid values include raw TNS names and RAC connection strings.| |
There was a problem hiding this comment.
Suggested change
| | `database.url` | `string` | Oracle|Specifies the raw database JDBC URL. Use this property to provide flexibility in defining that database connection. Valid values include raw TNS names and RAC connection strings.| | |
| | `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.| |
Comment on lines
56
to
57
| | `redis.null.key` | `string` | Redis does not support the notion of data without key, so this string will be used as key for records without primary key.<br/> Default: "default" | | ||
| | `redis.null.value` | `string` | Redis does not support the notion of null payloads, as is the case with tombstone events. This string will be used as value for records without a payload.<br/> Default: "default" | |
There was a problem hiding this comment.
Suggested change
| | `redis.null.key` | `string` | Redis does not support the notion of data without key, so this string will be used as key for records without primary key.<br/> Default: "default" | | |
| | `redis.null.value` | `string` | Redis does not support the notion of null payloads, as is the case with tombstone events. This string will be used as value for records without a payload.<br/> Default: "default" | | |
| | `redis.null.key` | `string` | Redis does not support the notion of data without key, so this string will be used as the key for records without primary key.<br/> Default: "default" | | |
| | `redis.null.value` | `string` | Redis does not support the notion of null payloads, as is the case with tombstone events. This string will be used as the value for records without a payload.<br/> Default: "default" | |
|
|
||
| ### Fully-qualified table name | ||
|
|
||
| In this document we refer to the fully-qualified table name as `<databaseName>.<tableName>`. This format is for MySQL database. For Oracle, SQLServer and Postgresql databases use `<schemaName>`.`<tableName>` instead. |
There was a problem hiding this comment.
Suggested change
| In this document we refer to the fully-qualified table name as `<databaseName>.<tableName>`. This format is for MySQL database. For Oracle, SQLServer and Postgresql databases use `<schemaName>`.`<tableName>` instead. | |
| In this document the fully-qualified table name is referred to as `<databaseName>.<tableName>`. This format is for MySQL database. For Oracle, SQLServer and Postgresql databases use `<schemaName>`.`<tableName>` instead. |
|
@dwdougherty Sorry - just realised I have been pushing the config.yaml reference stuff to this branch by mistake (it should have been just the SQL Server prep stuff). I'll close this and do it again :-( |
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-4744
Basically just George's updates from the RDI doc repo with a couple of minor changes for our doc markup.