Kafka Sink Connect Couchdb
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
src
.checkstyle
.editorconfig
.gitignore
LICENSE
README.md
couchdb.png
pom.xml

README.md

Overview

Kafka Connect CouchDB is a sink only connector to pull messages from Kafka to store in CouchDB as JSON documents.

Prerequisites

Apache ZooKeeper and Apache Kafka installed and running in your machine. Please refer to respective sites to download, install, and start ZooKeeper and Kafka.

What is CouchDB?

Seamless multi-master sync, that scales from Big Data to Mobile, with an Intuitive HTTP/JSON API and designed for Reliability. For more details, refer to official website.

What is Apache Kafka?

Apache Kafka is an open-source stream processing platform developed by the Apache Software Foundation written in Scala and Java. The project aims to provide a unified, high-throughput, low-latency platform for handling real-time data feeds. For more details, please refer to kafka home page.

High Level Architecture Diagram

Kafka Connect CouchDB

Data Mapping

CouchDB is a schemaless document store/NoSQL database. Since we are working with plain JSON data, a schema is not necessary to serialize and deserialize the messages.

For stand-alone mode, please copy kafka_home/config/connect-standalone.properties to create kafka_home/config/couchdb-connect-standalone.properties file. Open kafka_home/config/couchdb-connect-standalone.properties and set the following properties to false.

key.converter.schemas.enable=false
value.converter.schemas.enable=false

For distributed mode, please copy kafka_home/config/connect-distributed.properties to create kafka_home/config/couchdb-connect-distributed.properties file. Open kafka_home/config/couchdb-connect-distributed.properties and set the following properties to false.

key.converter.schemas.enable=false
value.converter.schemas.enable=false

In distributed mode, if you run more than one worker per host, the rest.port settings must have different values for each instance. By default REST interface is available at 8083.

How to deploy the connector in Kafka?

This is maven project. To create an uber jar, execute the following maven goals.

mvn clean compile package shade:shade install

Copy the artifact kafka-connect-couchdb-0.0.1-SNAPSHOT.jar to kakfa_home/lib folder.

Copy the couchdb-sink.properties file into kafka_home/config folder. Update the content of the property file according to your environment.

Alternatively, you may keep the kafka-connect-couchdb-0.0.1-SNAPSHOT.jar in another directory and export that directory into Kafka class path before starting the connector.

How to start connector in stand-alone mode?

Open a shell prompt, move to kafka_home and execute the following.

bin/connect-standalone.sh config/couchdb-connect-standalone.properties config/couchdb-sink.properties

How to start connector in distribute mode?

Open a shell prompt, move to kafka_home and execute the following.

bin/connect-distributed.sh config/couchdb-connect-distributed.properties config/couchdb-sink.properties

Contact

Create an issue in the GitHub or write a line to kafka@sanju.org

License

The project is licensed under the MIT license.