Back to plugin list
neo4j
Official

Neo4j

This plugin is in preview.

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

Publisher

cloudquery

Repositorygithub.com
Latest version

v5.1.3

Type

Destination

Platforms
Date Published

Mar 12, 2024

Price

Free

Overview

Neo4j Destination Plugin

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):
  • 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"
  path: "cloudquery/neo4j"
  registry: "cloudquery"
  version: "v5.1.3"
  spec:
    connection_string: "${NEO4J_CONNECTION_STRING}"
    username: "${NEO4J_USERNAME}"
    password: "${NEO4J_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.
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.
    • "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.


Types

Neo4j Types

The Neo4j destination (v3.0.0 and later) supports most Apache Arrow types. The following table shows the supported types and how they are mapped to Neo4j data types.
Arrow Column TypeSupported?Neo4j Type
Binary✅ YesBytes
Boolean✅ YesBoolean
Date32✅ YesString
Date64✅ YesString
Decimal✅ YesString
Dense Union✅ YesString
Dictionary✅ YesString
Duration[ms]✅ YesString
Duration[ns]✅ YesString
Duration[s]✅ YesString
Duration[us]✅ YesString
Fixed Size List✅ YesString
Float16✅ YesString
Float32✅ YesFloat
Float64✅ YesFloat
Inet✅ YesString
Int8✅ YesBigInt
Int16✅ YesBigInt
Int32✅ YesBigInt
Int64✅ YesBigInt
Interval[DayTime]✅ YesString
Interval[MonthDayNano]✅ YesString
Interval[Month]✅ YesString
JSON✅ YesString
Large Binary✅ YesBytes
Large List✅ YesList
Large String✅ YesString
List✅ YesList
MAC✅ YesString
Map✅ YesString
String✅ YesString
Struct✅ YesString
Timestamp[ms]✅ YesDateTime
Timestamp[ns]✅ YesDateTime
Timestamp[s]✅ YesDateTime
Timestamp[us]✅ YesDateTime
UUID✅ YesString
Uint8✅ YesBigInt
Uint16✅ YesBigInt
Uint32✅ YesBigInt
Uint64✅ YesBigInt
Union✅ YesString
String-persisted data types are encoded according to the Arrow String Representation specification.


Subscribe to product updates

Be the first to know about new features.