Upgrade a change tracking instance from the previous version to the new version

Updated at:
Copy as MD

Previous-version change tracking instances have been discontinued in Data Transmission Service (DTS). The new DTS console does not support creating or configuring previous-version instances. Follow the steps in this topic to migrate to a new-version change tracking instance.

Before you begin

  • Previous-version and new-version change tracking instances use different architectures and are implemented differently. Create a new-version instance rather than reconfigure the existing one.

  • Releasing a previous-version instance is irreversible. Confirm that the new-version instance is consuming tracked data before you release the previous-version instance.

Warning

A released instance cannot be restored. Do not release the previous-version instance until the new-version instance has successfully consumed data at the expected checkpoint.

Version comparison

Review the following table before starting the upgrade to understand what changes in your consumption setup.

ItemPrevious versionNew version
Consumption modeAn AccessKey pair is used to consume data.A consumer group consumes data. See Create consumer groups.
Consumption checkpoint managementA single consumption checkpoint per instance. Edit the checkpoint in the DTS console.Each consumer group maintains a separate consumer offset. In SUBSCRIBE mode, the SDK client uses the checkpoint saved on the DTS server at restart and cannot modify it. In ASSIGN mode, the SDK client uses a specified checkpoint at restart. See Save and query the consumption checkpoint.
SDKPrevious-version SDK only.New-version SDK (recommended). See Use the SDK demo to consume tracked data. Alternatively, use a Flink client with flink-dts-connector or a native Kafka client.
Message formatPrevious-version format.New-version SDK: DefaultUserRecord. Flink client: DataStream API, Table API, and SQL. Kafka client: Avro.
TroubleshootingN/ATroubleshoot via SDK error reporting or the DTS toolkit.

Upgrade a change tracking instance

  1. Create a new-version change tracking instance. For details, see Overview of change tracking scenarios.

  2. Configure your client to consume tracked data using the new-version instance. For details, see Consume tracked data.

  3. Verify that the new-version instance is consuming data at the expected checkpoint.

  4. Release the previous-version instance. For details, see Release DTS instances.