neo4j-kafka-skill

Configure Neo4j Kafka Connect sink and source pipelines with CDC query API options.

101|35|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/neo4j-contrib/neo4j-skills --skill neo4j-kafka-skill
Or copy as Structured Prompt for Agentā–¼
Please help me install this Agent Skill.
Skill: neo4j-kafka-skill
Source: https://github.com/neo4j-contrib/neo4j-skills/tree/main/neo4j-kafka-skill
Command: npx skills add https://github.com/neo4j-contrib/neo4j-skills --skill neo4j-kafka-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

šŸ’” This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you configure and operate Neo4j’s Kafka integrations so graph data can be ingested from Kafka topics and graph changes can be streamed out with correct semantics and resilient error handling.

Core Features & Use Cases

  • Kafka sink strategies for Neo4j writes: supports Cypher, Pattern, CDC (schema/source-id), and CUD message formats to transform or apply streaming events to a Neo4j graph.
  • Reliable streaming with EOS and DLQ: enables exactly-once semantics using offset tracking constraints and configures dead-letter queues for production-grade failure handling.
  • Kafka source strategies and native change queries: streams Neo4j changes to Kafka via CDC-based (Neo4j 5.13+) or query-based approaches, and also supports consuming change events without Kafka through the native db.cdc.query API.

Quick Start

Install and configure the Neo4j Kafka Connect connector for your target Kafka topics, then choose a sink strategy (Cypher/Pattern/CDC/CUD) or a source strategy (CDC/Query) based on whether you are writing to Neo4j or streaming Neo4j changes out.

Frequently Asked Questions about neo4j-kafka-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I stream Neo4j database changes to Kafka reliably?ā–¼

To stream Neo4j changes to Kafka reliably, configure the Kafka source connector using the Neo4j native CDC query API, which captures graph modifications and publishes them to Kafka topics with exactly-once semantics and dead-letter queue error handling.

What Kafka message formats can I use to write streaming data into Neo4j?ā–¼

You can write streaming data into Neo4j using Cypher, Pattern, CDC (schema/source-id), and CUD message formats. These sink strategies map Kafka messages into graph writes by transforming or applying streaming events directly to the graph database.

Can I consume Neo4j change data capture events without using Kafka?ā–¼

Yes, you can consume Neo4j change data capture events without Kafka by using the native db.cdc.query API. This in-process CDC consumption approach allows you to query change events directly within Neo4j without requiring a Kafka Connect pipeline.

How do exactly-once semantics work with the Neo4j Kafka Connector?ā–¼

Exactly-once semantics with the Neo4j Kafka Connector work by using EOS offset tracking constraints. This ensures that streaming events between Kafka and Neo4j are processed exactly once, preventing duplicate graph writes during connector failures or rebalances.

Does the Neo4j Kafka Connector support schema registry converters?ā–¼

Yes, the Neo4j Kafka Connector supports Kafka Connect configuration including schema registry converters. This allows you to integrate schema validation and serialization formats when mapping Kafka messages into graph writes or publishing graph changes.

How do I handle failed messages when streaming data between Kafka and Neo4j?ā–¼

You handle failed messages when streaming data between Kafka and Neo4j by configuring a dead-letter queue (DLQ). This production-grade error handling mechanism captures unprocessable events, allowing the pipeline to continue streaming without blocking valid graph writes.