https://github.com/datastax/cdc-apache-cassandra
Datastax CDC for Apache Cassandra
https://github.com/datastax/cdc-apache-cassandra
cassandra cdc change-data-capture datastax pulsar
Last synced: about 1 month ago
JSON representation
Datastax CDC for Apache Cassandra
- Host: GitHub
- URL: https://github.com/datastax/cdc-apache-cassandra
- Owner: datastax
- License: apache-2.0
- Created: 2021-04-21T08:17:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-21T16:49:06.000Z (about 1 year ago)
- Last Synced: 2025-04-05T17:51:12.019Z (12 months ago)
- Topics: cassandra, cdc, change-data-capture, datastax, pulsar
- Language: Java
- Homepage:
- Size: 33.3 MB
- Stars: 38
- Watchers: 14
- Forks: 22
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE-HEADER.txt
Awesome Lists containing this project
README
# DataStax CDC for Apache Cassandra
[](https://github.com/datastax/cdc-apache-cassandra/actions/workflows/ci.yaml)
[](https://github.com/datastax/cdc-apache-cassandra/releases/latest)
The DataStax CDC for Apache Cassandra requires:
* DataStax Change Agent for Apache Cassandra, which is an event producer deployed as a JVM agent on each Cassandra data node.
* DataStax Source Connector for Apache Pulsar, which is source connector deployed in your streaming platform.
Supported streaming platform:
* Apache Pulsar 2.8.1+
* IBM Elite Support for Apache Pulsar (formerly DataStax Luna Streaming) 2.8.0.1.1.40+
Supported Cassandra version:
* Cassandra 3.11+
* Cassandra 4.0+
* [DataStax Enterprise (DSE)](https://www.datastax.com/products/datastax-enterprise) 6.8.16+
Note: Only Cassandra 4.0 and DSE 6.8.16+ support the near realtime CDC allowing to replicate data as soon as they are synced on disk.
## Documentation
To get started, see [QUICKSTART.md](QUICKSTART.md).
For the complete documentation, see the [CDC for Apache Cassandra documentation](https://docs.datastax.com/en/cdc-for-cassandra/docs/latest/index.html).
## Demo
Cassandra data replicated to Elasticsearch:
* Create a Cassandra table with cdc enabled
* Deploy a Cassandra source and an Elasticsearch sink into Apache Pulsar
* Writes into Cassandra are replicated to Elasticsearch.
[](https://asciinema.org/a/kiEYzHQrPWhJR19nZ7tbqrDIX?speed=2&theme=tango)
## Monitoring
You can collect Cassandra/DSE and Pulsar metrics into Prometheus, and build a Grafana dashboard with:
* The CQL read latency from the Cassandra Source Connector
* The replication latency from the Cassandra Source Connector (computed from the Cassandra writetime)
* The CDC disk space used in the cdc_raw directory (for DSE only)
* The mutation sent throughput from a Cassandra node
* The pulsar events and data topic rate in
## Limitations
* Does not replay logged batches
* Does not manage table truncates
* Does not manage TTLs
* Does not support range deletes
* Does not sync data available before starting the CDC agent.
* CQL column names must not match a [Pulsar primitive type](https://pulsar.apache.org/docs/next/schema-understand/#primitive-type) name (ex: INT32)
* Does not support primary key only tables (ex: CREATE TABLE t (k int, c int, PRIMARY KEY (k, c)) WITH cdc=true;)
## Supported data types
Cassandra supported CQL3 data types (with the associated AVRO type or logical-type):
* text (string), ascii (string)
* tinyint (int), smallint (int), int (int), bigint (long), double (double), float (float),
* inet (string)
* decimal (cql_decimal), varint (cql_varint), duration (cql_duration)
* blob(bytes)
* boolean (boolean)
* timestamp (timestamp-millis), time (time-micros), date (date)
* uuid, timeuuid (uuid)
* User Defined Types (record)
* tuple (record)
* Collection types:
* list (array)
* set (array)
* map (map)
## Build from the sources
./gradlew assemble
Note: Artifacts for DSE agent are excluded by default. To build the `agent-dse4` module, specify the `dse4` property:
./gradlew assemble -Pdse4
## Acknowledgments
Apache Cassandra, Apache Pulsar, Cassandra and Pulsar are trademarks of the Apache Software Foundation.
Elasticsearch, is a trademark of Elasticsearch BV, registered in the U.S. and in other countries.