Connecting to Neo4J

This article explains how to connect Dataedo to Neo4J database and import metadata - nodes, edges, and their attributes.

Importing Metadata in Dataedo Portal

Entry point

To start the Metadata Import flow, make sure you have the Connection Manager role.
Then navigate to:

Connections → Add new connection → Neo4j

This will open the import wizard described in the following steps.

Step 1. Host details

Provide the name of Connection, the required connection details, and an optional description.

info

A Connection in Dataedo represents a saved configuration for accessing a data source.
It can be reused for future imports and scheduling.

Step 2. Credentials

Choose credentials from the list of existing ones available for the selected connector, or add new credentials.

Step 3. Data Sources

• The Portal will display all databases accessible with the provided credentials.
• You can select multiple databases at once and use the search box to narrow down results.
• Each selected database should be given a Title, which will be visible in Dataedo.
• At this step, the Portal also retrieves the number of assets in each source.

Step 4. Objects to import

For each selected database, you can refine which objects to import:

• Select schemas and object types (tables, views, procedures, etc.).

• Use Advanced filters to include or exclude objects with:
  • schema patterns
  • name patterns

Step 5. Schedule

Configure scheduling options for each source individually:

• Define tasks you want to schedule (Metadata Import).
• Run daily, on selected weekdays, or on specific days of the month.
• Choose an exact time of execution.
• Task state:
  • Active – the task will run as scheduled.
  • Draft – the task is saved but not executed until switched to Active.
• Run immediately – when checked, the task will also be executed right after clicking Create connection.

useful tip

Only one source in a metadata import can have Run immediately selected.

caution

You must configure at least one import task in the schedule section.
If you skip this, an empty database will be created and no metadata will be imported.

Importing Metadata in Dataedo Desktop

To connect to Neo4J database, create new documentation by clicking Add and choosing Database connection.

On the Add documentation screen, choose NEO4J.

Connection details

Provide database connection details:

• Connection URL - provide a URL (address) of a server where a database is available. E.g. bolt://server17:7687, bolt://192.168.0.37:7687 or neo4j+s://12345.databases.neo4j.io for cloud Neo4J database.

• User and password - provide your username and password

• Database - database name (applicable for Neo4j versions 4.0.0 and above). Leave empty if you want to connect to the default database. Otherwise, type in the database name or click [...] and choose it from the list.

Here is a comparison with connection details in Neo4j Desktop. Connection URL in Dataedo is the very same value as Connect URL in Neo4J Desktop.

Saving password

You can save the password for later connections by checking the Save password option. Passwords are saved in the repository database.

Importing metadata

When the connection is successful, Dataedo will read objects and show a list of objects found. You can choose which objects to import. You can also use advanced filter to narrow down the list of objects.

Confirm the list of objects to import by clicking Next.

The next screen allows you to change the default name of the documentation under which it will be visible in the Dataedo repository.

Click Import to start the import.

When done, close the import window with the Finish button.

Output

Your database schema has been imported to new documentation in the repository.

Neo4J support

Neo4J support