You are viewing documentation for an outdated version of Debezium.
If you want to view the latest stable version of this page, please go here.

Vitess Remove Field

The RemoveField SMT removes a specified field from the event record. When the connector is configured to provide transaction metadata, use this SMT to remove the transaction.id field to avoid storing a duplicate entry of the VGTID. This transformation is designed for use only with the Debezium connector for Vitess.

The SMT uses the field_names configuration option to specify a comma-separated list of paths that identify the fields to remove. The SMT removes each field that you specify from the event record and the event schema. The following example shows how to add the SMT to the connector configuration so that it removes specific fields from the change event records that the connector emits.

Example: Configuring the RemoveField SMT

"connector.class": "io.debezium.connector.vitess.VitessConnector",
...
"transforms": "removeField",
"transforms.removeField.type": "io.debezium.connector.vitess.transforms.RemoveField",
"transforms.removeField.field_names": "transaction.id",
...

The following example shows the value of a change event record before and after the transformation is applied.

Example 1. Effect of applying the RemoveField SMT
Value before the SMT processes the record
{
    "before": {...}
    "after": {...}
    "source": {...}
    "transaction": {
        "id": "[{\"keyspace\":\"test_unsharded_keyspace\",\"shard\":\"0\",\"gtid\":\"MySQL56/e03ece6c-4c04-11ec-8e20-0242ac110004:1-68\"}]",
        "total_order": 1,
        "data_collection_order": 1
      }
}
Value after the SMT processes the record
{
    "before": {...}
    "after": {...}
    "source": {...}
    "transaction": {
        "total_order": 1,
        "data_collection_order": 1
      }
}

Configuration options for the RemoveField SMT

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

Table 1. RemoveField SMT configuration options

Property

Description

Type

Default

Valid Values

Importance

fields_names

A comma-separated list that specifies the paths of the fields to remove from the event record for example, transaction.id).

List

No default value

Non-empty list

High