Neo4j

CLI based Ingestion

Install the Plugin

The neo4j source works out of the box with acryl-datahub.

Starter Recipe

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
    type: 'neo4j'
    config:
        uri: 'neo4j+ssc://host:7687'
        username: 'neo4j'
        password: 'password'
        node_tag: 'Node'
        relationship_tag: 'Relationship'
        environment: 'PROD'

sink:
  type: "datahub-rest"
  config:
    server: 'http://localhost:8080'

Config Details

Options

Note that a . is used to denote nested fields in the YAML recipe.

Field	Description
environment string	Neo4j env
node_tag string	The tag that will be used to show that the Neo4j object is a Node Default: Node
password string	Neo4j Password
platform string	Neo4j platform Default: neo4j
relationship_tag string	The tag that will be used to show that the Neo4j object is a Relationship Default: Relationship
uri string	The URI for the Neo4j server
username string	Neo4j Username
env string	The environment that all assets produced by this connector belong to Default: PROD

Schema

The JSONSchema for this configuration is inlined below.

{
  "title": "Neo4jConfig",
  "description": "Any source that produces dataset urns in a single environment should inherit this class",
  "type": "object",
  "properties": {
    "env": {
      "title": "Env",
      "description": "The environment that all assets produced by this connector belong to",
      "default": "PROD",
      "type": "string"
    },
    "username": {
      "title": "Username",
      "description": "Neo4j Username",
      "type": "string"
    },
    "password": {
      "title": "Password",
      "description": "Neo4j Password",
      "type": "string"
    },
    "uri": {
      "title": "Uri",
      "description": "The URI for the Neo4j server",
      "type": "string"
    },
    "environment": {
      "title": "Environment",
      "description": "Neo4j env",
      "type": "string"
    },
    "node_tag": {
      "title": "Node Tag",
      "description": "The tag that will be used to show that the Neo4j object is a Node",
      "default": "Node",
      "type": "string"
    },
    "relationship_tag": {
      "title": "Relationship Tag",
      "description": "The tag that will be used to show that the Neo4j object is a Relationship",
      "default": "Relationship",
      "type": "string"
    },
    "platform": {
      "title": "Platform",
      "description": "Neo4j platform",
      "default": "neo4j",
      "type": "string"
    }
  },
  "additionalProperties": false
}

Integration Details

Neo4j metadata will be ingested into DataHub using CALL apoc.meta.schema() YIELD value UNWIND keys(value) AS key RETURN key, value[key] AS value;
The data that is returned will be parsed and will be displayed as Nodes and Relationships in DataHub. Each object will be tagged with describing what kind of DataHub object it is. The defaults are 'Node' and 'Relationship'. These tag values can be overwritten in the recipe.

Metadata Ingestion Quickstart

Prerequisites

In order to ingest metadata from Neo4j, you will need:

• Neo4j instance with APOC installed

Install the Plugin(s)

Run the following commands to install the relevant plugin(s):

Use the following recipe(s) to get started with ingestion.

View All Recipe Configuartion Options

| Field | Required | Default | Description | |--------------------|:--------:|:---------------:|---------------------------------------| | source | | | | | `type` | ✅ | `neo4j` | A required field with a default value | | config | | | | | `uri` | ✅ | `default_value` | The URI for the Neo4j server | | `username` | ✅ | None | Neo4j Username | | `password` | ✅ | None | Neo4j Password | `gms_server` | ✅ | None |Address for the gms server| | `node_tag` | ❌ | `Node` |The tag that will be used to show that the Neo4j object is a Node| | `relationship_tag` | ❌ | `Relationship` |The tag that will be used to show that the Neo4j object is a Relationship| | `environment` | ✅ | None || | sink | | || | `type` | ✅ | None || | conifg | | || | `server` | ✅ | None ||

source:
    type: 'neo4j'
    config:
        uri: 'neo4j+ssc://host:7687'
        username: 'neo4j'
        password: 'password'
        gms_server: &gms_server 'http://localhost:8080'
        node_tag: 'Node'
        relationship_tag: 'Relationship'
        environment: 'PROD'

sink:
  type: "datahub-rest"
  config:
    server: *gms_server

Sample data that is returned from Neo4j. This is the data that is parsed and used to create Nodes, Relationships.

  Example relationship:
    {
    relationship_name: {
        count: 1, 
        properties: {}, 
        type: "relationship"
        }
    }
    
  Example node:
    {
    key: Neo4j_Node, 
    value: {
        count: 10, 
        labels: [], 
        properties: {
            node_id: {
                unique: true, 
                indexed: true, 
                type: "STRING", 
                existence: false
                }, 
            node_name: {
                unique: false, 
                indexed: false, 
                type: "STRING", 
                existence: false
                }
            }, 
        type: "node", 
        relationships: {
            RELATIONSHIP_1: {
                count: 10, 
                direction: "in", 
                labels: ["Node_1", "Node_2", "Node_3"], 
                properties: {
                    relationsip_name: {
                        indexed: false, 
                        type: "STRING", 
                        existence: false, 
                        array: false
                        }, 
                    relationship_id: {
                        indexed: false, 
                        type: "INTEGER", 
                        existence: false, 
                        array: false
                        }
                    }
                }, 
            RELATIONSHIP_2: {
                count: 10, 
                direction: "out", 
                labels: ["Node_4"], 
                properties: {
                    relationship_name: {
                        indexed: false, 
                        type: "STRING", 
                        existence: false, 
                        array: false
                        }, 
                    relationship_id: {
                        indexed: false, 
                        type: "INTEGER", 
                        existence: false, 
                        array: false
                        }
                    }
                }
            }
        }
    }

Code Coordinates

• Class Name: datahub.ingestion.source.neo4j.neo4j_source.Neo4jSource
• Browse on GitHub

Questions

If you've got any questions on configuring ingestion for Neo4j, feel free to ping us on our Slack.