https://github.com/couchbase/kafka-connect-couchbase

Kafka Connect connector for Couchbase Server
https://github.com/couchbase/kafka-connect-couchbase

Last synced: 9 months ago
JSON representation

Kafka Connect connector for Couchbase Server

• Host: GitHub
• URL: https://github.com/couchbase/kafka-connect-couchbase
• Owner: couchbase
• License: apache-2.0
• Created: 2016-07-27T12:57:00.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2025-08-12T16:39:37.000Z (11 months ago)
• Last Synced: 2025-08-12T18:30:52.765Z (11 months ago)
• Language: Java
• Homepage: https://issues.couchbase.com/projects/KAFKAC
• Size: 1.6 MB
• Stars: 75
• Watchers: 41
• Forks: 78
• Open Issues: 3
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.adoc
  • License: LICENSE

Awesome Lists containing this project

• awesome-kafka-connect - couchbase/kafka-connect-couchbase - Official Couchbase Kafka Connector (source and sink) (Databases / Couchbase)

README

          
https://docs.couchbase.com/kafka-connector/current/release-notes.html[*Download*]

| https://docs.couchbase.com/kafka-connector/current/index.html[*Documentation*]

| https://issues.couchbase.com/projects/KAFKAC[*Issues*]

| https://forums.couchbase.com/c/Kafka-Connector[*Discussion*]

= Kafka Connect Couchbase

[abstract]

A plug-in for the https://kafka.apache.org/documentation.html#connect[Kafka Connect framework].

== What does it do?

The plugin includes a "source connector" for publishing document change notifications from Couchbase to a Kafka topic, as well as a "sink connector" that subscribes to one or more Kafka topics and writes the messages to Couchbase.

See the documentation linked above for more details and a quickstart guide.

== Customizing the message format

The example project in `examples/custom-extensions` shows how to extend the source connector and customize the format of messages published to Kafka.

== Building the connector from source

Pre-built distributions are available from the download link above.

The following instructions are intended for developers working on the connector.

JDK 9 or later is required when building the connector.

. Clone this GitHub repository.

. Run `./mvnw package` in the project's root directory to generate the connector archive.

. Look for `couchbase-kafka-connect-couchbase-.zip` under the `target` directory.