SchemaChangeEventFilter

Table of Contents

Schema change event filter configuration
Effect of applying the SchemaChangeEventFilter SMT
Configuration options

Use the SchemaChangeEventFilter single message transformation (SMT) to filter schema change events that the connector captures from a table and sends to Kafka. After you enable the SMT, the connector synchronizes only the unfiltered DDL events to Kafka, giving you control over which DDL operations are exposed to consuming applications.

Schema change event filter configuration

To use the transformation, add the SchemaChangeEventFilter to the connector configuration, and specify the types of events that you want to remove. The following excerpt from a connector configuration shows how you would add the transformation to the connector and set it to remove DROP and TRUNCATE events from the DDL messages that the connector captures.

Schema change event filter configuration to remove DROP and TRUNCATE events

transforms=filterTableDropAndTruncateEvent
transforms.filterTableDropAndTruncateEvent.type=io.debezium.transforms.SchemaChangeEventFilter
transforms.filterTableDropAndTruncateEvent.schema.change.event.exclude.list=DROP,TRUNCATE

For more information about configuring the transformation, see the schema change event filter configuration options.

Effect of applying the `SchemaChangeEventFilter` SMT

After you configure the SMT for a connector, whenever the connector captures schema change events that match the configured types, it resets the values for those events to null. The connector does not send events with the resulting null values to Kafka.

The following examples shows a schema change event record before it is processed by the SMT, followed by the output after the SMT filters the event.

Example 1. Schema change event record before it is processed by the SchemaChangeEventFilter transformation

{
    "schema":{
        "type":"struct",
        "fields":[
            {
                "type":"int64",
                "optional":false,
                "field":"ts_ms"
            },
            {
                "type":"string",
                "optional":true,
                "field":"databaseName"
            },
            {
                "type":"string",
                "optional":true,
                "field":"schemaName"
            },
            {
                "type":"string",
                "optional":true,
                "field":"ddl"
            },
            {
                "type":"array",
                "items":{
                    "type":"struct",
                    "fields":[
                        {
                            "type":"string",
                            "optional":false,
                            "field":"type"
                        },
                        {
                            "type":"string",
                            "optional":false,
                            "field":"id"
                        }
                    ],
                    "optional":false,
                    "name":"io.debezium.connector.schema.Change"
                },
                "optional":false,
                "field":"tableChanges"
            }
        ],
        "optional":false,
        "name":"filter.SchemaChangeValue"
    },
    "payload":{
        "ts_ms":1691035505397,
        "databaseName":"test",
        "schemaName":"test_schema",
        "ddl":"",
        "tableChanges":[
            {
                "type":"DROP",
                "id":"test.table"
            }
        ]
    }
}

Based on the earlier configuration example, after the SMT processes the original schema change event, it resets the values for the DROP event to null, as shown in the following example:

Example 2. Schema change event record after processing by the SMT

null

Configuration options

The following table lists the configuration options that you can use with the SchemaChangeEventFilter SMT.

Table 1. SchemaChangeEventFilter SMT configuration options
Property	Description	Type	Default	Valid values
`schema.change.event.exclude.list`	A comma-separated list of schema change events to filter. Specify one or more of the following options: `CREATE` `ALTER` `DROP` `TRUNCATE` `DATABASE`	String	No default value	Non-empty string

SchemaChangeEventFilter

Schema change event filter configuration

Effect of applying the SchemaChangeEventFilter SMT

Configuration options

Effect of applying the `SchemaChangeEventFilter` SMT