Expose xrepl_origin_id on DML change events by kgalieva · Pull Request #400 · yugabyte/debezium-connector-yugabytedb

kgalieva · 2026-03-10T14:17:54Z

Expose `xrepl_origin_id` on CDC change events

Summary

Surface the xrepl_origin_id field from YugabyteDB CDC RowMessage proto onto every DML (INSERT/UPDATE/DELETE) and COMMIT Debezium change event
The field appears as xrepl_origin_id (optional int32) in the source block of the Kafka message envelope, only when non-zero
Companion change to PR which attaches xrepl_origin_id to every DML CDC event on the server side

Motivation

Previously, xrepl_origin_id was only set on COMMIT records in the CDC stream and the Debezium connector did not surface it at all. The upstream YugabyteDB change now attaches it to every DML record as well. This connector change threads that value through to the Debezium output on both DML and COMMIT events so consumers can use the replication origin to filter or route events (e.g. for loop-prevention in bidirectional replication).

Changes

File	Change
`pom.xml`	Bump yb-client from 0.8.108 to 0.8.111-20260312.173733-1 (includes `xrepl_origin_id` in proto)
`ReplicationMessage.java`	Added default `getXreplOriginId()` method returning 0
`YbProtoReplicationMessage.java`	Override to return `rawMessage.getXreplOriginId()`
`SourceInfo.java`	Added `xreplOriginId` field, constant, accessor, and parameter to `update()`
`YugabyteDBOffsetContext.java`	Added overloaded `updateRecordPosition()` accepting `xreplOriginId`
`YugabyteDBStreamingChangeEventSource.java`	DML and COMMIT paths pass `message.getXreplOriginId()`
`YugabyteDBConsistentStreamingSource.java`	DML and COMMIT paths pass `message.getXreplOriginId()`
`YugabyteDBSourceInfoStructMaker.java`	Added `xrepl_origin_id` (optional int32) to schema and struct
`SourceInfoTest.java`	Updated to match new `update()` signature and schema

Surface the replication origin ID from YugabyteDB CDC RowMessage proto onto every DML (INSERT/UPDATE/DELETE) Debezium change event. The field appears as `xrepl_origin_id` in the `source` block of the Kafka message envelope, only when non-zero.

shishir2001-yb · 2026-03-18T12:08:33Z

src/main/java/io/debezium/connector/yugabytedb/SourceInfo.java

    public static final String TABLE_ID = "table_id";
    public static final String TABLET_ID = "tablet_id";
    public static final String PARTITION_ID_KEY = "partition_id";
+    public static final String XREPL_ORIGIN_ID = "xrepl_origin_id";


Change this to below to match the upstream Debezium behaviour:
public static final String XREPL_ORIGIN_ID = "origin";
https://github.com/debezium/debezium/pull/7009/files

src/test/java/io/debezium/connector/yugabytedb/SourceInfoTest.java

src/main/java/io/debezium/connector/yugabytedb/SourceInfo.java

shishir2001-yb · 2026-03-18T12:26:33Z

src/main/java/io/debezium/connector/yugabytedb/SourceInfo.java

    private String tabletId;
    private Long commitTime;
    private Long recordTime;
+    private int xreplOriginId;


Wondering if we should keep it as String instead of int so that we are similar to Upstream Debezium. Thoughts?

Good question. In upstream Postgres Debezium, origin is a string because Postgres's CDC stream provides the replication origin name. In YugabyteDB, the CDC proto only surfaces xrepl_origin_id as a uint32 — the origin name lives in the PG catalog (pg_replication_origin) and isn't accessible from the CDC/DocDB layer.

We could stringify the int to match the upstream schema type, but then consumers would get "42" instead of a meaningful name like "my_origin" - which feels misleading. I'd prefer to keep it as int since that's what YB actually provides, and rename the field to "origin" for partial alignment with upstream.

Hmm true, then I believe we should not use the below as it may cause confusion if a cluster is consuming data from both Logical and gRPC

public static final String XREPL_ORIGIN_ID = "origin";

Maybe we can change it to below?

public static final String XREPL_ORIGIN_ID = "origin_id";

shishir2001-yb · 2026-03-18T12:50:12Z

Minor comments but overall looks good

- Rename source info field from "xrepl_origin_id" to "origin" to align with upstream Debezium naming convention - Add xreplOriginId to SourceInfo.toString() when non-zero for debugging - Add YugabyteDBReplicationOriginTest with integration tests covering origin propagation on DML events, omission when zero, and multiple origins in the same session

shishir2001-yb · 2026-03-20T09:29:30Z

@kgalieva, which YB-client version are you using? Compiling your PR changes throws me this error

[INFO] -------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  8.312 s
[INFO] Finished at: 2026-03-20T08:58:50Z
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project debezium-connector-yugabytedb: Compilation failure
[ERROR] /home/ec2-user/code/debezium-connector-yugabytedb/src/main/java/io/debezium/connector/yugabytedb/connection/pgproto/YbProtoReplicationMessage.java:[180,26] cannot find symbol
[ERROR]   symbol:   method getXreplOriginId()
[ERROR]   location: variable rawMessage of type org.yb.cdc.CdcService.RowMessage
[ERROR] 
[ERROR] -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

kgalieva · 2026-03-23T16:57:44Z

@shishir2001-yb I updated the client version, ready to run the tests

shishir2001-yb · 2026-03-23T17:12:15Z

@kgalieva, just one comment needs to be addressed #400 (comment)

shishir2001-yb · 2026-03-24T15:59:22Z

src/main/java/io/debezium/connector/yugabytedb/SourceInfo.java

            sb.append(", table=").append(tableName);
        }
+        if (xreplOriginId != 0) {
+            sb.append(", origin=").append(xreplOriginId);


Change this to origin_id

shishir2001-yb self-requested a review March 17, 2026 17:04

shishir2001-yb reviewed Mar 18, 2026

View reviewed changes

src/test/java/io/debezium/connector/yugabytedb/SourceInfoTest.java Show resolved Hide resolved

shishir2001-yb reviewed Mar 18, 2026

View reviewed changes

src/main/java/io/debezium/connector/yugabytedb/SourceInfo.java Show resolved Hide resolved

shishir2001-yb reviewed Mar 18, 2026

View reviewed changes

Update ybclient version

6263407

Change field name to origin_id

d009e8b

shishir2001-yb reviewed Mar 24, 2026

View reviewed changes

Change field name to origin_id

80499a7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose xrepl_origin_id on DML change events#400

Expose xrepl_origin_id on DML change events#400
kgalieva wants to merge 5 commits intoyugabyte:mainfrom
Shopify:expose-xrepl-origin-id-on-dml

kgalieva commented Mar 10, 2026 •

edited

Loading

Uh oh!

shishir2001-yb Mar 18, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

shishir2001-yb Mar 18, 2026 •

edited

Loading

Uh oh!

kgalieva Mar 18, 2026

Uh oh!

shishir2001-yb Mar 20, 2026

Uh oh!

shishir2001-yb commented Mar 18, 2026

Uh oh!

shishir2001-yb commented Mar 20, 2026

Uh oh!

kgalieva commented Mar 23, 2026

Uh oh!

shishir2001-yb commented Mar 23, 2026

Uh oh!

shishir2001-yb Mar 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

kgalieva commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Expose xrepl_origin_id on CDC change events

Summary

Motivation

Changes

Uh oh!

shishir2001-yb Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

shishir2001-yb Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgalieva Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

shishir2001-yb Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

shishir2001-yb commented Mar 18, 2026

Uh oh!

shishir2001-yb commented Mar 20, 2026

Uh oh!

kgalieva commented Mar 23, 2026

Uh oh!

shishir2001-yb commented Mar 23, 2026

Uh oh!

shishir2001-yb Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kgalieva commented Mar 10, 2026 •

edited

Loading

Expose `xrepl_origin_id` on CDC change events

shishir2001-yb Mar 18, 2026 •

edited

Loading

shishir2001-yb Mar 18, 2026 •

edited

Loading