SSIS Components for Neo4j

Build 25.0.9434

Establishing a Connection

Enabling SSIS in Visual Studio 2022

If you're using Visual Studio 2022, you will need to install the SQL Server Integration Services Projects extension to use SSIS.

  1. Navigate to Extensions > Manage Extensions.
  2. In the Manage Extensions window's search box, search for "SQL Server Integration Services Projects 2022" and select the extension in the list.
  3. Click Download.
  4. Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer. Proceed through the installer with default settings.
  5. Open Visual Studio. There should now be an "Integration Services Project" project template available.

Adding the Neo4j Connection Manager

Create a new connection manager as follows:

  1. Create a Visual Studio project with the "Integration Services Project" template.
  2. In the project, right-click within the Connection Managers window and select New Connection from the menu.
  3. In the Description column, select CData Neo4j Connection Manager and click Add...
  4. Configure the component as described in the next section.

Alternatively, if you have an existing project and CData Neo4j Source or CData Neo4j Destination:

  1. Right-click your CData Neo4j source or destination component in your data flow
  2. Select Edit... to open an editor window.
  3. Click the New... button next to the Connection manager: dropdown selector to create a connection manager.
  4. Configure the component as described in the next section.

Connecting to Neo4j

To connect to Neo4j, you have the following options:

If you are connecting to Neo4j AuraDB, you must use the Query API.

If you are connecting to Self-hosted Neo4j you can choose between the Query API and the HTTP API, depending on your version.

Connecting to Self-hosted Neo4j

Query API

To connect to Neo4j instances via the Query API, set the following connection properties:

  • API: Set this to Query.
  • Server: The server hosting the Neo4j instance. An HTTP or HTTPS protocol prefix may be optionally prepended to the server name or address.
  • Port: The port on which the Neo4j service is running. Self-managed instances have a default port of 7474 for the Query API. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in Server.
  • User: The username of the user using the Neo4j instance.
  • Password: The password of the user using the Neo4j instance.
  • Database: The database to target in the Neo4j instance. Defaults to Neo4j.

HTTP API

To connect to Neo4j instances via the HTTP API, set the following connection properties:

  • API: Set this to HTTP.
  • Server: The server hosting the Neo4j instance. An HTTP or HTTPS protocol prefix may be optionally prepended to the server name or address.
  • Port: The port on which the Neo4j service is running. The provider connects to HTTP 7474 port by default. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in Server.
  • User: The username of the user using the Neo4j instance.
  • Password: The password of the user using the Neo4j instance.
  • Database: The database to target in the Neo4j instance. Defaults to Neo4j.

Connecting to Neo4j AuraDB

Neo4j AuraDB

To connect to Neo4j Aura instances, the required properties will be the same as the Query API configuration above. Notes on finding property values are below.

  • API: Set this to Query.
  • Server: Found in Query API URL in the Inspect menu of the instance in the Neo4j Aura cloud console. Nothing after Neo4j.io should be provided.
  • Port: Set this to 443.
  • User: The username of the user using the Neo4j instance.
  • Password: Provided only once when creating the instance or when a new user is invited.
  • Database: Currently, Neo4j Aura deployments do not allow changing the database name from the default value of Neo4j.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434