Debezium

= Debezium Extensions for Quarkus

image:https://img.shields.io/github/license/openshift/origin.svg?maxAge=2592000["Licensed under Apache License version 2.0", link="https://www.apache.org/licenses/LICENSE-2.0"] image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg["Chat on Zulip", link="https://debezium.zulipchat.com"]

==== CI Branch Status [width="50%"] |=== |main | image:https://github.com/debezium/debezium-quarkus/actions/workflows/ci-build.yml/badge.svg?branch=main["Main Branch Build", link="https://github.com/debezium/debezium-quarkus/actions?query=workflow%3A%22%22Debezium+Quarkus+CI%22%22"] |===

This repository hosts Debezium extensions for Quarkus, enabling Quarkus applications to work with Debezium for change data capture (CDC) and related patterns.

== What’s included

• Debezium Outbox for Quarkus — a Quarkus extension implementing the Outbox pattern. The Extension provides highly configurable component that facilitates the use of the Outbox pattern paired with Debezium’s CDC connector pipeline.
• Debezium Runtime Extensions for Quarkus — integrates the Debezium runtime into a Quarkus application so you can consume CDC events within the service. It exposes Quarkus-native configuration, lifecycle hooks, listeners, deserializers, heartbeat and notification events, custom converters and post-processors.

== When to use these extensions

• Use the Outbox extension to implement reliable, asynchronous inter-service communication without dual-writes; combine your app’s transactional outbox table with Debezium connectors and your chosen sink (Kafka, etc.).
• Use the Debezium Quarkus Engine extension when you want lightweight, Kafka-free (optional) CDC inside your application with fast startup and small memory footprint (particularly with Quarkus Native/GraalVM). Best for POCs, dev environments, or simple streaming in microservices.

== Quick start

=== Add the Runtime Extension to your Quarkus application

Using Quarkus CLI:

quarkus ext add io.debezium.quarkus:debezium-quarkus-postgres

Using Maven:

<dependency>
  <groupId>io.debezium.quarkus</groupId>
  <artifactId>debezium-quarkus-postgres</artifactId>
  <version>${version.debezium}</version>
</dependency>

Using Gradle:

implementation("io.debezium.quarkus:debezium-quarkus-postgres:${version.debezium}")

The Engine extension brings Quarkus-native configuration and listener APIs for consuming CDC events in-process. See the https://debezium.io/documentation/reference/stable/integrations/quarkus-debezium-engine-extension.html[documentation] for features and setup details.

=== Add the Outbox extension to your Quarkus application

Using Quarkus CLI:

quarkus ext add io.debezium.quarkus:debezium-quarkus-outbox

Using Maven:

<dependency>
  <groupId>io.debezium.quarkus</groupId>
  <artifactId>debezium-quarkus-outbox</artifactId>
  <version>${version.debezium}</version>
</dependency>

Using Gradle:

implementation("io.debezium.quarkus:debezium-quarkus-outbox:${version.debezium}")

Define an event class implementing io.debezium.outbox.quarkus.ExportedEvent interface and emit it via CDI (Jakarta Event), and configure the extension/Debezium will capture the outbox table changes and route them downstream. See the https://debezium.io/documentation/reference/stable/integrations/outbox.html[documentation] for features and setup details.

== Example projects

• Debezium https://github.com/debezium/debezium-examples[examples repository] includes Outbox and other Quarkus-based demos for CDC patterns and native builds.

== Requirements

Depending on the extension and target (JVM vs native), typical prerequisites include:

• JDK 21+
• Apache Maven 3.9+
• Quarkus 3.25+ (or platform-aligned)
• Docker/Podman for local services
• Optional: Mandrel or GraalVM for native builds

Consult the extension docs for exact versions and details.

== License

This software is licensed under the terms you may find in the file named LICENSE.txt in this directory.