源配置设置

连接器设置

名称 描述

connector.class 必填

org.neo4j.connectors.kafka.source.Neo4jConnector

key.converter 必填

一个兼容的 Kafka Connect 转换器。

可以是以下之一:

  • io.confluent.connect.avro.AvroConverter

  • io.confluent.connect.json.JsonSchemaConverter

  • io.confluent.connect.protobuf.ProtobufConverter

key.converter.schema.registry.url

消息键的 Schema Registry URL。当配置的 key.converter 需要 Schema Registry 时为必填项。

key.converter.optional.for.nullables

key.converterio.confluent.connect.protobuf.ProtobufConverter 时,应设置为 true

value.converter 必填

一个兼容的 Kafka Connect 转换器。

可以是以下之一:

  • io.confluent.connect.avro.AvroConverter

  • io.confluent.connect.json.JsonSchemaConverter

  • io.confluent.connect.protobuf.ProtobufConverter

value.converter.schema.registry.url

消息值的 Schema Registry URL。当配置的 value.converter 需要 Schema Registry 时为必填项。

value.converter.optional.for.nullables

key.converterio.confluent.connect.protobuf.ProtobufConverter 时,应设置为 true

Neo4j 连接设置

名称 描述

neo4j.uri 必填

要连接的 Neo4j URI。可以指定多个 URI,用 , 分隔。

neo4j.database

要连接的 Neo4j 数据库名称。建议明确指定。

neo4j.authentication.type 必填

要使用的认证类型。可以是 NONEBASICKERBEROSBEARERCUSTOM 之一

默认值: BASIC

neo4j.authentication.basic.username

用于认证的用户名。当 neo4j.authentication.typeBASIC 时为必填项。

neo4j.authentication.basic.password

用于认证的密码。当 neo4j.authentication.typeBASIC 时为必填项。

neo4j.authentication.basic.realm

用于认证的认证域,留空表示使用默认值。

neo4j.authentication.kerberos.ticket

用于建立连接的 Kerberos 票据。当 neo4j.authentication.typeKERBEROS 时为必填项。

neo4j.authentication.bearer.token

用于建立连接的 Bearer 令牌。当 neo4j.authentication.typeBEARER 时为必填项。

neo4j.authentication.custom.scheme

用于建立连接的自定义认证方案。当 neo4j.authentication.typeCUSTOM 时为必填项。

neo4j.authentication.custom.principal

用于建立连接的自定义主体。当 neo4j.authentication.typeCUSTOM 时为必填项。

neo4j.authentication.custom.credentials

用于建立连接的自定义凭据。当 neo4j.authentication.typeCUSTOM 时为必填项。

neo4j.authentication.custom.realm

用于认证的自定义认证域,根据您的自定义认证提供商的要求进行设置。

neo4j.connection-timeout

TCP 连接超时(有效单位为:mssmhd;默认单位为 s)。

默认值: 30s (驱动程序默认)

neo4j.pool.max-connection-pool-size

连接池中保持的最大连接数。

默认值: 100 (驱动程序默认)

neo4j.pool.connection-acquisition-timeout

从连接池获取连接的最大等待时间(有效单位为:mssmhd;默认单位为 s)。

默认值: 60s (驱动程序默认)

neo4j.pool.idle-time-before-connection-test

空闲连接在多久后进行存活测试(有效单位为:mssmhd;默认单位为 s)。

默认值: 不测试 (驱动程序默认)

neo4j.pool.max-connection-lifetime

连接从连接池中丢弃的时间长度(有效单位为:mssmhd;默认单位为 s)。

默认值: 1h (驱动程序默认)

neo4j.max-retry-time

重试事务的最大持续时间。

默认值: 30s

neo4j.security.encrypted

是否启用加密。仅当 neo4j.uri 中使用 boltneo4j 方案时适用。可以是 truefalse 之一

默认值: false

neo4j.security.trust-strategy

TLS 连接要使用的信任策略。可以是 TRUST_ALL_CERTIFICATESTRUST_SYSTEM_CA_SIGNED_CERTIFICATESTRUST_CUSTOM_CA_SIGNED_CERTIFICATES 之一。当 neo4j.security.encryptedtrue 时为必填项。

默认值: TRUST_SYSTEM_CA_SIGNED_CERTIFICATES

neo4j.security.cert-files

包含要信任的 CA 的 X509 证书的文件列表。当 neo4j.security.trust-strategyTRUST_CUSTOM_CA_SIGNED_CERTIFICATES 时为必填项。

neo4j.security.hostname-verification-enabled

在 TLS 握手期间是否启用主机名验证。可以是 truefalse 之一。

默认值: true

通用源设置

名称 描述

neo4j.source-strategy 必填

此连接器的源策略。可以是 CDCQUERY 之一。

neo4j.start-from 必填

开始流式传输的时间锚点。可以是 EARLIESTNOWUSER_PROVIDED 之一。仅在连接器实例首次运行时使用,当 Kafka Connect 中已存在存储偏移量时则忽略。

默认值: NOW

neo4j.start-from.value

用作起始偏移量的自定义值。当 neo4j.start-from 设置为 USER_PROVIDED 时为必填项。

neo4j.ignore-stored-offset

是否忽略从上次运行保存的偏移量存储中检索到的任何偏移量值。可以是 truefalse 之一。

默认值: false

neo4j.batch-size

每个轮询周期发布的最大变更事件数。

默认值: 1000

neo4j.payload-mode

定义变更消息的结构。可以是 COMPACTEXTENDED 之一。COMPACT 提供更简单的消息,但如果属性类型更改,则面临模式兼容性问题。EXTENDED 包含类型信息以避免此类问题。

默认值: EXTENDED在 5.1.5 中引入

CDC 策略设置

名称 描述

neo4j.cdc.topic.{NAME}.key-strategy

CDC 主题键的序列化策略。可以是 SKIPELEMENT_IDENTITY_KEYSWHOLE_VALUE 之一。

默认值: WHOLE_WALUE

neo4j.cdc.topic.{NAME}.value-strategy

CDC 主题值的序列化策略。可以是 CHANGE_EVENTENTITY_EVENT 之一。

默认值: CHANGE_EVENT

注意: 如果您使用带有 CDC 策略之一的目标连接器,此设置必须配置为 CHANGE_EVENT

neo4j.cdc.poll-duration

Kafka Connect 轮询请求等待从数据库接收变更的最大时间量(有效单位为:mssmhd;默认单位为 s

默认值: 5s

neo4j.cdc.poll-interval

neo4j.cdc.poll-duration 期间轮询数据库以获取变更的间隔(有效单位为:mssmhd;默认单位为 s)。

默认值: 1s

neo4j.cdc.topic.{NAME}.patterns

逗号分隔的图模式列表,带有可选事件属性过滤器(分别以 +- 作为前缀表示包含或排除)。

示例设置: "neo4j.cdc.topic.my-topic.patterns": "(:Person {+name}),(:Person)-[:WORKS_FOR]→(:Company),(:Company {-id})". Company 节点的变更事件将不包含 id 属性。

neo4j.cdc.topic.{NAME}.patterns.{INDEX}.pattern

索引图模式,带有可选事件属性过滤器(分别以 +- 作为前缀表示包含或排除)。

示例: "neo4j.cdc.topic.my-topic.patterns.0.pattern": "(:Company {+name})". Company 节点的变更事件将始终包含 name 属性(在 CDC FULL 丰富模式下),或者在 name 属性更改时包含该属性(在 CDC DIFF 丰富模式下)。

neo4j.cdc.topic.{NAME}.patterns.{INDEX}.operation

可以是 CREATEUPDATEDELETE 之一。我们希望为相应的索引图模式接收事件的操作。

示例: "neo4j.cdc.topic.my-topic.patterns.0.operation": "DELETE"

neo4j.cdc.topic.{NAME}.patterns.{INDEX}.changesTo

逗号分隔的属性名称列表。

示例: "neo4j.cdc.topic.my-topic.patterns.0.changesTo": "name, age" (参见如何组合选择器)

neo4j.cdc.topic.{NAME}.patterns.{INDEX}.metadata.authenticatedUser

执行变更时已认证的用户。

示例: "neo4j.cdc.topic.my-topic.patterns.0.metadata.authenticatedUser": "userA"

neo4j.cdc.topic.{NAME}.patterns.{INDEX}.metadata.executingUser

执行变更时正在执行事务的用户。通常与 authenticatedUser 相同,但如果使用用户模拟,则可能会改变。

示例: "neo4j.cdc.topic.my-topic.patterns.0.metadata.executingUser": "userB"

neo4j.cdc.topic.{NAME}.patterns.{INDEX}.metadata.txMetadata.{KEY}

键值事务元数据选择器。键值对与实际事务元数据匹配(键已去除上述前缀)。

示例: "neo4j.cdc.topic.my-topic.patterns.0.metadata.txMetadata.app": "neo4j-browser"

QUERY 策略设置

名称 描述

neo4j.query.topic 必填

Kafka 主题,用于发布通过提供的查询收集的变更事件。

neo4j.query 必填

用于收集变更的 Cypher 查询。要求 neo4j.query.streaming-property 存在于结果集中,并且使用 $lastCheck 查询参数来跟踪变更。

neo4j.query.streaming-property

属性名称,它既存在于指定查询的结果集中,又用作从先前值查询变更的过滤器。

默认值: timestamp

neo4j.query.poll-duration

Kafka Connect 轮询请求等待从数据库接收变更的最大时间量(有效单位为:mssmhd;默认单位为 s)。

默认值: 5s

neo4j.query.poll-interval

neo4j.query.poll-duration 期间轮询数据库以获取变更的间隔(有效单位为:mssmhd;默认单位为 s)。

默认值: 1s

neo4j.query.timeout

查询允许运行的最大时间量(有效单位为:mssmhd;默认单位为 s)。

默认值: 0s

© . All rights reserved.