Automatic Protobuf schema registration - connect_cdc_sqdata - Latest

Connect CDC (SQData) Apply engine

Product type
Software
Portfolio
Integrate
Product family
Connect
Product
Connect > Connect CDC (SQData)
Version
Latest
ft:locale
en-US
Product name
Connect CDC (SQData)
ft:title
Connect CDC (SQData) Apply engine
Copyright
2026
First publish date
2000
ft:lastEdition
2026-08-24
ft:lastPublication
2026-08-24T13:31:43.482000
L1_Product_Gateway
Integrate
L2_Product_Segment
Data Integration
L3_Product_Brand
Precisely Connect
L4_Investment_Segment
Application Data Integration
L5_Product_Group
ADI - Connect
L6_Product_Name
Connect CDC
Table 1. Changes in this topic
Change type Description
Introduced in version 5.0.6 Describes automatic Protobuf schema generation and registration, parse-and-run behavior, schema compatibility validation, and schema evolution.

Connect CDC (SQData) generates and registers Protobuf schemas automatically. No manual schema authoring is required. Schemas are derived directly from source record definitions — Db2 DDL for Apply Engine scripts, or the source table catalog metadata provided by the Capture agent for the Replicator Engine.

Because a Confluent Schema Registry is always required for Protobuf targets, automatic schema registration is always active. There is no schema-registry-free Protobuf option.

Automatic registration is a two-step process. When the Apply Engine is parsed — either using the two-step parse-and-run method or the combined SQDENG method — the engine first retrieves each schema from the Confluent Registry that matches the descriptions in the engine script. It then compares those schemas to the descriptions using the TOPIC and SUBJECT values specified for each description. If they are compatible, the parse phase completes and the engine is ready for execution. Any retrieved schema that does not match the current description is automatically registered, the parse phase completes, and the engine is ready for execution.

Note: Apply engines that use the REPLICATE function for Db2, IMS, and VSAM source data still require manual updates to the source DESCRIPTION parts when new or altered schemas are introduced. Once updated, the engine need only be re-parsed before execution, because the registration of updated Protobuf schemas is performed automatically. Even engines with customized target DESCRIPTIONS and mapping PROCEDUREs benefit from this, because target DESCRIPTIONS used to create Protobuf schemas are automatically validated and registered when the engine is parsed.

Example — Db2 to Kafka Protobuf

Review the Apply Engine script in Construct the Kafka apply engine script. Only a few elements of the engine script need to be added or changed to switch to Protobuf format with Confluent Schema Registry:
----------------------------------------------------------------------
-- Name: DB2TOKAF:  Z/OS DB2 To Kafka Protobuf on Linux
----------------------------------------------------------------------
-- Change Log:
----------------------------------------------------------------------
-- 2019-02-01 INITIAL RELEASE using JSON
-- <date>     Switch to Protobuf with Confluent Schema Registry
----------------------------------------------------------------------
OPTIONS
   CDCOP('I','U','D')
  ,CONFLUENT REPOSITORY 'http://schema_registry.precisely.com:8081'
;
----------------------------------------------------------------------
BEGIN GROUP DB2_SOURCE;
DESCRIPTION DB2SQL ./DB2DDL/EMP.ddl AS EMPLOYEE
            KEY IS EMP_NO
            TOPIC IVP_HR_EMPLOYEE
            SUBJECT IVP_HR_EMPLOYEE-value;
DESCRIPTION DB2SQL ./DB2DDL/DEPT.ddl AS DEPARTMENT
            KEY IS DEPT_NO
            TOPIC IVP_HR_DEPARTMENT
            SUBJECT IVP_HR_DEPARTMENT-value;
END GROUP;
----------------------------------------------------------------------
DATASTORE kafka:///*/key
  OF PROTOBUF FORMAT CONFLUENT
  AS TARGET
  DESCRIBED BY GROUP DB2_SOURCE
;
REPLICATE (TARGET)

Protobuf field names automatically preserve their original case from the source definition. Unlike AVRO, no naming transformation option is applied.

Schema evolution for the Replicator Engine works identically to AVRO: when a source table structure changes, the engine automatically regenerates the Protobuf schema and updates the Confluent Schema Registry, with no manual intervention required.

Note: Precisely strongly recommends using the --parse option before running the engine for the first time. This lets you review and confirm the generated Protobuf schemas before they are registered in the Confluent Schema Registry.
Note: For the equivalent AVRO behavior, see Automatic AVRO schema registration.