Neo4j

Neo4j source connector

Description

Read data from Neo4j.

neo4j-java-driver version 4.4.9

Key features

• batch
• stream
• exactly-once
• column projection
• parallelism
• support user-defined split

Options

name	type	required	default value
uri	String	Yes	-
username	String	No	-
password	String	No	-
bearer_token	String	No	-
kerberos_ticket	String	No	-
database	String	Yes	-
query	String	Yes	-
schema	Object	Yes	-
max_transaction_retry_time	Long	No	30
max_connection_timeout	Long	No	30

uri [string]

The URI of the Neo4j database. Refer to a case: neo4j://localhost:7687

username [string]

username of the Neo4j

password [string]

password of the Neo4j. required if username is provided

bearer_token [string]

base64 encoded bearer token of the Neo4j. for Auth.

kerberos_ticket [string]

base64 encoded kerberos ticket of the Neo4j. for Auth.

database [string]

database name.

query [string]

Query statement.

schema.fields [string]

returned fields of query

see column projection

max_transaction_retry_time [long]

maximum transaction retry time(seconds). transaction fail if exceeded

max_connection_timeout [long]

The maximum amount of time to wait for a TCP connection to be established (seconds)

Example

source {
    Neo4j {
        uri = "neo4j://localhost:7687"
        username = "neo4j"
        password = "1234"
        database = "neo4j"
    
        max_transaction_retry_time = 1
        max_connection_timeout = 1
    
        query = "MATCH (a:Person) RETURN a.name, a.age"
    
        schema {
            fields {
                a.age=INT
                a.name=STRING
            }
        }
    }
}

Changelog

Change Log

Change	Commit	Version
[Improve] restruct connector common options (#8634)	https://github.com/apache/seatunnel/commit/f3499a6ee	2.3.10
[Feature][Restapi] Allow metrics information to be associated to logical plan nodes (#7786)	https://github.com/apache/seatunnel/commit/6b7c53d03	2.3.9
[Feature][Doris] Add Doris type converter (#6354)	https://github.com/apache/seatunnel/commit/518999184	2.3.6
[Feature][Core] Upgrade flink source translation (#5100)	https://github.com/apache/seatunnel/commit/5aabb14a9	2.3.4
[Improve][Common] Introduce new error define rule (#5793)	https://github.com/apache/seatunnel/commit/9d1b2582b	2.3.4
[Improve] Remove use SeaTunnelSink::getConsumedType method and mark it as deprecated (#5755)	https://github.com/apache/seatunnel/commit/8de740810	2.3.4
Support config column/primaryKey/constraintKey in schema (#5564)	https://github.com/apache/seatunnel/commit/eac76b4e5	2.3.4
[Improve] Documentation and partial word optimization. (#4936)	https://github.com/apache/seatunnel/commit/6e8de0e2a	2.3.3
[Improve][connector-V2-Neo4j]Supports neo4j sink batch write and update docs (#4841)	https://github.com/apache/seatunnel/commit/580276a8b	2.3.3
Merge branch 'dev' into merge/cdc	https://github.com/apache/seatunnel/commit/4324ee191	2.3.1
[Improve][Project] Code format with spotless plugin.	https://github.com/apache/seatunnel/commit/423b58303	2.3.1
[improve][api] Refactoring schema parse (#4157)	https://github.com/apache/seatunnel/commit/b2f573a13	2.3.1
[Improve][build] Give the maven module a human readable name (#4114)	https://github.com/apache/seatunnel/commit/d7cd60105	2.3.1
[Improve][Project] Code format with spotless plugin. (#4101)	https://github.com/apache/seatunnel/commit/a2ab16656	2.3.1
[Feature][Connector] add get source method to all source connector (#3846)	https://github.com/apache/seatunnel/commit/417178fb8	2.3.1
[Feature][API & Connector & Doc] add parallelism and column projection interface (#3829)	https://github.com/apache/seatunnel/commit/b9164b8ba	2.3.1
[Hotfix][OptionRule] Fix option rule about all connectors (#3592)	https://github.com/apache/seatunnel/commit/226dc6a11	2.3.0
[Improve][Connector-V2][Neo4j] Unified exception for Neo4j source & sink connector (#3565)	https://github.com/apache/seatunnel/commit/58584eefb	2.3.0
[Feature][Connector][Neo4j] expose configurable options in Neo4j (#3342)	https://github.com/apache/seatunnel/commit/efa04b38f	2.3.0
[Connector-V2][ElasticSearch] Add ElasticSearch Source/Sink Factory (#3325)	https://github.com/apache/seatunnel/commit/38254e3f2	2.3.0
[Feature][Connector-v2] Neo4j source connector (#2777)	https://github.com/apache/seatunnel/commit/38b0daf8b	2.3.0
[#2606]Dependency management split (#2630)	https://github.com/apache/seatunnel/commit/fc047be69	2.2.0-beta
[Feature][Connector-v2] Neo4j sink connector (#2434)	https://github.com/apache/seatunnel/commit/950b27d13	2.2.0-beta