Usage with a Neo4j cluster

The documentation on the deprecated Neo4j Streams plugin and the previous version of the Kafka Connect Neo4j Connector can be found here.

Overview

Neo4j Clustering is a feature available in Enterprise Edition which allows high availability of the database.

When the Kafka Connect Neo4j Connector is used with a Neo4j cluster, the most important consideration is to use a routing driver. Generally, routing drivers are identified by a URI starting with neo4j:// as the scheme instead of just bolt://.

If your Neo4j cluster is located at graph.mycompany.com:7687, simply configure the Kafka Connect worker with the following:

neo4j.server.uri=neo4j://graph.mycompany.com:7687

The use of the neo4j driver will mean that the Neo4j Driver itself will handle connecting to the correct cluster member, and managing changes to the cluster membership over time.

For further information on routing drivers, see the Neo4j Driver Manual.