This repository contains the Debezium connector for PlanetScale. It is based on the Debezium Vitess connector and packages the PlanetScale-specific connector classes, patches, and runtime dependencies for Kafka Connect and Debezium Server.
Requires Java 21.
./gradlew buildThe build produces the following artifacts under debezium-planetscale/build/:
| Modality | Artifact | Shading |
|---|---|---|
| Debezium Server | libs/planetscale-debezium-adapter-<version>.jar |
Partially |
| Debezium Server | libs/planetscale-debezium-adapter-<version>-all.jar |
Fully |
| Kafka Connect | connect/dist/planetscale-debezium-connector-planetscale-<version>.zip |
Partially |
Use the Debezium Server helper in ./server.
cp server/sample-application.properties server/ps.properties
# edit server/ps.properties with your PlanetScale credentials and source settings
./gradlew build
make -C server runhttps://planetscale.com/docs/vitess/integrations/debezium#debezium-connector-for-planetscale