DBZ-4588 Insert converters property in configuration tables

This commit is contained in:
Bob Roldan 2022-05-10 19:39:37 -04:00 committed by Jiri Pechanec
parent 3d3800eb30
commit 9b897f1120
7 changed files with 155 additions and 0 deletions

View File

@ -962,6 +962,29 @@ Cassandra connector has built-in support for JMX metrics. The Cassandra driver a
|false
|Determines whether or not the CommitLogProcessor should re-process error commit logs.
|[[cassandra-property-converters]]<<cassandra-property-converters, `converters`>>
|No default
|Enumerates a comma-separated list of the symbolic names of the {link-prefix}:{link-custom-converters}#custom-converters[custom converter] instances that the connector can use. +
For example, `isbn`. +
This property is required to enable the connector to use a custom converter.
For each converter that you configure for a connector, you must also add a property to specify the fully-qualifed name of the class that implements the converter interface.
This second property uses the following format: +
`_<converterSymbolicName>_.type` +
For example, +
isbn.type: io.debezium.test.IsbnConverter
If a configured converter requires further information to customize the way that it converts specific data types, you can add configuration properties to pass these instructions.
To associate such configuration properties with the converter, prefix their names with the converter's symbolic name. +
+
For example, +
isbn.schema.name: io.debezium.cassandra.type.Isbn
|[[cassandra-property-offset-backing-store-dir]]<<cassandra-property-offset-backing-store-dir, `offset.backing.store.dir`>>
|
|The directory to store offset tracking files.

View File

@ -2159,6 +2159,28 @@ The following _advanced_ configuration properties have defaults that work in mos
|===
|Property |Default |Description
|[[db2-property-converters]]<<db2-property-converters, `converters`>>
|No default
|Enumerates a comma-separated list of the symbolic names of the {link-prefix}:{link-custom-converters}#custom-converters[custom converter] instances that the connector can use. +
For example, `isbn`. +
This property is required to enable the connector to use a custom converter.
For each converter that you configure for a connector, you must also add a property to specify the fully-qualifed name of the class that implements the converter interface.
This second property uses the following format: +
`_<converterSymbolicName>_.type` +
For example, +
isbn.type: io.debezium.test.IsbnConverter
If a configured converter requires further information to customize the way that it converts specific data types, you can add configuration properties to pass these instructions.
To associate such configuration properties with the converter, prefix their names with the converter's symbolic name. +
+
For example, +
isbn.schema.name: io.debezium.db2.type.Isbn
|[[db2-property-snapshot-mode]]<<db2-property-snapshot-mode, `+snapshot.mode+`>>
|`initial`
|Specifies the criteria for performing a snapshot when the connector starts: +

View File

@ -2631,6 +2631,28 @@ The following table describes xref:{link-mysql-connector}#mysql-advanced-connect
|`true`
|A Boolean value that specifies whether a separate thread should be used to ensure that the connection to the MySQL server/cluster is kept alive.
|[[mysql-property-converters]]<<mysql-property-converters, `converters`>>
|No default
|Enumerates a comma-separated list of the symbolic names of the {link-prefix}:{link-custom-converters}#custom-converters[custom converter] instances that the connector can use. +
For example, `isbn`. +
This property is required to enable the connector to use a custom converter.
For each converter that you configure for a connector, you must also add a property to specify the fully-qualifed name of the class that implements the converter interface.
This second property uses the following format: +
`_<converterSymbolicName>_.type` +
For example, +
isbn.type: io.debezium.test.IsbnConverter
If a configured converter requires further information to customize the way that it converts specific data types, you can add configuration properties to pass these instructions.
To associate such configuration properties with the converter, prefix their names with the converter's symbolic name. +
+
For example, +
isbn.schema.name: io.debezium.mysql.type.Isbn
|[[mysql-property-table-ignore-builtin]]<<mysql-property-table-ignore-builtin, `+table.ignore.builtin+`>>
|`true`
|A Boolean value that specifies whether built-in system tables should be ignored. This applies regardless of the table include and exclude lists. By default, system tables are excluded from having their changes captured, and no events are generated when changes are made to any system tables.

View File

@ -2316,6 +2316,28 @@ The following configuration properties are _required_ unless a default value is
|No default
|The name of the Java class for the connector. Always use a value of `io.debezium.connector.oracle.OracleConnector` for the Oracle connector.
|[[oracle-property-converters]]<<oracle-property-converters, `converters`>>
|No default
|Enumerates a comma-separated list of the symbolic names of the {link-prefix}:{link-custom-converters}#custom-converters[custom converter] instances that the connector can use. +
For example, `isbn`. +
This property is required to enable the connector to use a custom converter.
For each converter that you configure for a connector, you must also add a property to specify the fully-qualifed name of the class that implements the converter interface.
This second property uses the following format: +
`_<converterSymbolicName>_.type` +
For example, +
isbn.type: io.debezium.test.IsbnConverter
If a configured converter requires further information to customize the way that it converts specific data types, you can add configuration properties to pass these instructions.
To associate such configuration properties with the converter, prefix their names with the converter's symbolic name. +
+
For example, +
isbn.schema.name: io.debezium.oracle.type.Isbn
|[[oracle-property-tasks-max]]<<oracle-property-tasks-max, `+tasks.max+`>>
|`1`
|The maximum number of tasks that should be created for this connector. The Oracle connector always uses a single task and therefore does not use this value, so the default is always acceptable.

View File

@ -2913,6 +2913,28 @@ The following _advanced_ configuration properties have defaults that work in mos
|Default
|Description
|[[postgresql-property-converters]]<<postgresql-property-converters, `converters`>>
|No default
|Enumerates a comma-separated list of the symbolic names of the {link-prefix}:{link-custom-converters}#custom-converters[custom converter] instances that the connector can use. +
For example, `isbn`. +
This property is required to enable the connector to use a custom converter.
For each converter that you configure for a connector, you must also add a property to specify the fully-qualifed name of the class that implements the converter interface.
This second property uses the following format: +
`_<converterSymbolicName>_.type` +
For example, +
isbn.type: io.debezium.test.IsbnConverter
If a configured converter requires further information to customize the way that it converts specific data types, you can add configuration properties to pass these instructions.
To associate such configuration properties with the converter, prefix their names with the converter's symbolic name. +
+
For example, +
isbn.schema.name: io.debezium.postgresql.type.Isbn
|[[postgresql-property-snapshot-mode]]<<postgresql-property-snapshot-mode, `+snapshot.mode+`>>
|`initial`
|Specifies the criteria for performing a snapshot when the connector starts: +

View File

@ -2251,6 +2251,28 @@ The following _advanced_ configuration properties have good defaults that will w
|Default
|Description
|[[sqlserver-property-converters]]<<sqlserver-property-converters, `converters`>>
|No default
|Enumerates a comma-separated list of the symbolic names of the {link-prefix}:{link-custom-converters}#custom-converters[custom converter] instances that the connector can use. +
For example, `isbn`. +
This property is required to enable the connector to use a custom converter.
For each converter that you configure for a connector, you must also add a property to specify the fully-qualifed name of the class that implements the converter interface.
This second property uses the following format: +
`_<converterSymbolicName>_.type` +
For example, +
isbn.type: io.debezium.test.IsbnConverter
If a configured converter requires further information to customize the way that it converts specific data types, you can add configuration properties to pass these instructions.
To associate such configuration properties with the converter, prefix their names with the converter's symbolic name. +
+
For example, +
isbn.schema.name: io.debezium.sqlserver.type.Isbn
|[[sqlserver-property-snapshot-mode]]<<sqlserver-property-snapshot-mode, `+snapshot.mode+`>>
|_initial_
|A mode for taking an initial snapshot of the structure and optionally data of captured tables.

View File

@ -1231,6 +1231,28 @@ The following _advanced_ configuration properties have defaults that work in mos
|Default
|Description
|[[vitess-property-converters]]<<vitess-property-converters, `converters`>>
|No default
|Enumerates a comma-separated list of the symbolic names of the {link-prefix}:{link-custom-converters}#custom-converters[custom converter] instances that the connector can use. +
For example, `isbn`. +
This property is required to enable the connector to use a custom converter.
For each converter that you configure for a connector, you must also add a property to specify the fully-qualifed name of the class that implements the converter interface.
This second property uses the following format: +
`_<converterSymbolicName>_.type` +
For example, +
isbn.type: io.debezium.test.IsbnConverter
If a configured converter requires further information to customize the way that it converts specific data types, you can add configuration properties to pass these instructions.
To associate such configuration properties with the converter, prefix their names with the converter's symbolic name. +
+
For example, +
isbn.schema.name: io.debezium.vitess.type.Isbn
|[[vitess-property-event-processing-failure-handling-mode]]<<vitess-property-event-processing-failure-handling-mode, `+event.processing.failure.handling.mode+`>>
|`fail`
| Specifies how the connector should react to exceptions during processing of events: +