Neo4j Import Specification Format
Scope
This library provides a uniform configuration facade for tools running imports to Neo4j.
In particular, it offers:
- a user-friendly configuration surface (in JSON or YAML), called import specification, backed by a JSON schema
- the Java equivalent of the import specification, a.k.a.
org.neo4j.importer.v1.ImportSpecification
- a user-friendly Java API built on top, a.k.a.
org.neo4j.importer.v1.pipeline.ImportPipeline
The import specification also offers various extension points, such as:
The library does NOT:
- define any sources, you need to define and register at least one (see examples)
- implement any actual import to Neo4j (although some end-to-end tests just do that)
- expose any configuration to locate a Neo4j instance to import data to
Getting Started
First, implement and register a source provider for BigQuery.
Then, save the following import specification into spec.json:
You can then deserialize it and run your import logic accordingly:
Prerequisites
- Maven
- JDK 21+ (21 is used for examples, 11 and 17 for core)