neo4j-kafka-skill

Configure Neo4j Kafka sink and source connectors and the native CDC API.

Updated Aug 25, 2026
One-click install
npx skills add https://github.com/cardox6/steuer-graph --skill neo4j-kafka-skill-cardox6
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: neo4j-kafka-skill
Source: https://github.com/cardox6/steuer-graph/tree/main/.agents/skills/neo4j-kafka-skill
Command: npx skills add https://github.com/cardox6/steuer-graph --skill neo4j-kafka-skill-cardox6

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Streaming data between Apache Kafka and Neo4j requires choosing the right connector strategy, writing correct configuration, and handling delivery guarantees and errors — a process with many version-specific pitfalls. This Skill provides decision tables, complete configuration examples, and troubleshooting guidance for the Neo4j Connector for Kafka and the native Neo4j CDC API. ## Core Features & Use Cases - Sink connector strategies: Configure Cypher, Pattern, CDC, and CUD sink strategies with idempotent MERGE patterns, exactly-once semantics, and dead-letter queue error handling. - Source connector strategies: Stream Neo4j changes to Kafka via CDC-based source (Neo4j 5.13+) or query-based source for any edition. - Native CDC API: Query change events directly with db.cdc.query using selector filters and cursor-loop patterns in Python and Java, without Kafka. - Use Case: Mirror Kafka events into a Neo4j graph in production by generating a complete sink connector config with EOS offset tracking, DLQ routing, and schema registry converters. ## Quick Start Ask the assistant to generate a Neo4j Kafka sink connector configuration that consumes a Kafka topic and merges Person nodes with exactly-once semantics and a dead-letter queue.

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 Kafka events into Neo4j?▼

Use the Neo4j Kafka sink connector with a strategy matching your data: Cypher for custom transformations, Pattern for no-code field mapping, CDC to mirror another Neo4j, or CUD for pre-formatted messages. Write idempotent MERGE queries since default delivery is at-least-once.

How do I stream Neo4j changes to a Kafka topic?▼

Use the source connector with the CDC strategy on Neo4j 5.13+ Enterprise or Aura Business Critical, defining topic patterns and operations like CREATE or UPDATE. For other editions, use the query-based source with a streaming property and $lastCheck parameter.

Does Neo4j CDC work on Community Edition or Aura Free?▼

No. The native CDC API and CDC-based connectors require Neo4j 5.13+ Enterprise Edition, AuraDB Business Critical, or AuraDB VDC. Self-managed instances also need db.cdc.enabled=true in neo4j.conf.

How do I get exactly-once delivery with the Neo4j Kafka sink?▼

Set neo4j.eos-offset-label and first create a NODE KEY constraint on the offset label covering strategy, topic, and partition. EOS requires connector 5.3.0+ (5.3.1+ for CUD) and Kafka broker EOS support.

Why does my CDC cursor become invalid after a database restore?▼

Restoring Neo4j from a backup invalidates all CDC cursors, causing invalid cursor errors. Reconfigure the source connector's neo4j.start-from to NOW or EARLIEST, or re-bootstrap the cursor with db.cdc.current().

When should I use the native CDC API instead of the Kafka connector?▼

Use db.cdc.query when you want to consume change events in-process without running Kafka infrastructure, such as lightweight polling loops in Python or Java. Use the Kafka connector when you need durable, distributed event streaming to multiple consumers.