Sink Configuration Settings

org.neo4j.connectors.kafka.sink.Neo4jConnector

A compatible Kafka Connect converter.

Could be one of;

Schema Registry URL for message keys. Required when a schema registry is required by the configured key.converter.

Should be set to true when key.converter is io.confluent.connect.protobuf.ProtobufConverter.

A compatible Kafka Connect converter.

Could be one of;

Schema Registry URL for message values. Required when a schema registry is required by the configured value.converter.

Should be set to true when key.converter is io.confluent.connect.protobuf.ProtobufConverter.

Neo4j URI to connect to. Multiple URIs can be specified separated by ,.

Neo4j database name to connect to. Recommended to be specified explicitly.

Authentication type to use. One of NONE, BASIC, KERBEROS, BEARER, CUSTOM

Default: BASIC

Username to authenticate with. Required when neo4j.authentication.type is BASIC.

Password to authenticate with. Required when neo4j.authentication.type is BASIC.

Authentication realm to authenticate with, leave empty for default.

Kerberos ticket to establish connection with. Required when neo4j.authentication.type is KERBEROS.

Bearer token to establish connection with. Required when neo4j.authentication.type is BEARER.

Custom authentication scheme to establish connection with. Required when neo4j.authentication.type is CUSTOM.

Custom principal to establish connection with. Required when neo4j.authentication.type is CUSTOM.

Custom credential to establish connection with. Required when neo4j.authentication.type is CUSTOM.

Custom authentication realm to authenticate with, set as required by your custom authentication provider.

TCP connection timeout (valid units are: ms, s, m, h and d; default unit is s).

Default: 30s (Driver default)

Maximum number of connections to keep in the connection pool.

Default: 100 (Driver default)

Maximum duration to wait for acquiring a connection from the connection pool (valid units are: ms, s, m, h and d; default unit is s).

Default: 60s (Driver default)

Duration after which idle connections are tested for liveness (valid units are: ms, s, m, h and d; default unit is s).

Default: no test (Driver default)

Duration after which a connection is dropped from the connection pool (valid units are: `ms, s, m, h and d; default unit is s).

Default: 1h (Driver default)

Maximum duration to retry a transaction.

Default: 30s

Whether encryption is enabled. Only applicable when bolt or neo4j schemes are used inside neo4j.uri. One of true, false

Default: false.

Trust strategy to use for TLS connections. One of TRUST_ALL_CERTIFICATES, TRUST_SYSTEM_CA_SIGNED_CERTIFICATES, TRUST_CUSTOM_CA_SIGNED_CERTIFICATES Required when neo4j.security.encrypted is true.

Default: TRUST_SYSTEM_CA_SIGNED_CERTIFICATES

List of files that contain X509 certificates of CAs to trust. Required when neo4j.security.trust-strategy is TRUST_CUSTOM_CA_SIGNED_CERTIFICATES.

Whether hostname verification is enabled during TLS handshake. One of true, false.

Default: true

Maximum number of messages processed per transaction per topic.

Default: 1000

Maximum amount of time a batch is allowed to be processed (valid units are: ms, s, m, h and d; default unit is s).

Default: 0s

Cypher statement to run for the specified topic. Example: "neo4j.cypher.topic.my-topic": "MERGE (n:Person {name: __value.name})"

Under what name message timestamp will be bound in user provided Cypher statements. Set to empty string to disable binding of message timestamp.

Default: __timestamp

Under what name message header will be bound in user provided Cypher statements. Message headers will be bound as a map of header names to corresponding values. Set to empty string to disable binding of message headers.

Default: __header

Under what name message key will be bound in user provided Cypher statements. Set to empty string to disable binding of message key.

Default: __key

Under what name message value will be bound in user provided Cypher statements. Set to empty string to disable binding of message value.

Default: __value

Whether message value will be bound as 'event' in user provided Cypher statements for backward compatibility.

Default: true

Node or relationship pattern to apply on the messages received from the specified topic. Example: "neo4j.pattern.topic.user": "(:User\{!userId})" Example: "neo4j.pattern.topic.user": "(:User\{!userId})-[:KNOWS]→(:User\{!otherUserId})"

Whether to merge incoming properties with existing properties of nodes.

Default: false

Whether to merge incoming properties with existing properties of relationships.

Default: false

Under what name message timestamp will be bound in patterns. Set to empty string to disable binding of message timestamp.

Default: __timestamp

Under what name message header will be bound in patterns. Message headers will be bound as a map of header names to corresponding values. Set to empty string to disable binding of message headers.

Default: __header

Under what name message key will be bound in patterns. Set to empty string to disable binding of message key.

Default: __key

Under what name message value will be bound in patterns. Set to empty string to disable binding of message value.

Default: __value

The topic(s) that contain CDC events generated by a Source instance of this connector using CDC source strategy.

The topic(s) that contain CDC events generated by a Source instance of this connector using CDC source strategy.

The label name attached to the nodes managed by the CDC Source Id strategy.

Default: SourceEvent

The id property name attached to the nodes managed by the CDC Source Id strategy.

Default: sourceId

The topic(s) that contain CUD events.