Neo4j Destination Plugin

Latest: v4.0.11

This destination plugin lets you sync data from a CloudQuery source to a Neo4j database.

Supported database (tested) versions (We use the official Neo4j Go driver (opens in a new tab)):

Neo4j >= 4.4

As a side note graph databases can be quite useful for various networking use-cases, visualization, for read-teams, blue-teams and more.

Configuration

Example

This example configures a Neo4j destination, located at bolt://localhost:7687. The username and password are stored in environment variables.

kind: destination
spec:
  name: "neo4j"
  registry: "github"
  path: "cloudquery/neo4j"
  version: "v4.0.11"
  spec:
    connection_string: "bolt://localhost:7687"
    username: "${USERNAME}"
    password: "${PASSWORD}"
    # Optional parameters:
    # batch_size: 1000 # 1K entries
    # batch_size_bytes: 4194304 # 4 MiB

The (top level) spec section is described in the Destination Spec Reference.

Make sure you use environment variable expansion in production instead of committing the credentials to the configuration file directly.

The Neo4j destination utilizes batching, and supports batch_size and batch_size_bytes.

Plugin Spec

This is the (nested) spec used by the Neo4j destination Plugin.

connection_string (string) (required)

Connection string to connect to the database. This can be a URL or a DSN, as per official neo4j docs (opens in a new tab).
- "bolt://localhost:7687"
- "neo4j://localhost:7687"
username (string) (required)

Username to connect to the database.
password (string) (required)

Password to connect to the database.
batch_size (integer) (optional) (default: 1000)

Number of records to batch together before sending to the database.
batch_size_bytes (integer) (optional) (default: 4194304 (= 4 MiB))

Number of bytes (as Arrow buffer size) to batch together before sending to the database.

Example Types