Bridge Neo4J Connectivity with Apache NiFi



Access and process Neo4J data in Apache NiFi using the CData JDBC Driver.

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for Neo4J, NiFi can work with live Neo4J data. This article describes how to connect to and query Neo4J data from an Apache NiFi Flow.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Neo4J data. When you issue complex SQL queries to Neo4J, the driver pushes supported SQL operations, like filters and aggregations, directly to Neo4J and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Neo4J data using native data types.

Connecting to Neo4J Data in Apache NiFi

  1. Download the CData JDBC Driver for Neo4J installer, unzip the package, run the .exe file to install the driver.
  2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.neo4j.jar (and cdata.jdbc.neo4j.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

    On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for Neo4J.

  3. Start Apache NiFi by running the run-nifi.bat file in bin subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\bin.

    (OR)

    Use the command prompt to navigate to the particular directory and run the run-nifi.bat file for example:

    cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
    .\run-nifi.bat
    
  4. Navigate to the Apache NiFi UI in your web browser: It should be https://localhost:8443/nifi.

    Note: If users are utilizing an older version of Apache NiFi, they should access it via http://localhost:8080/nifi. In earlier versions, HTTP was the protocol employed. However, in the most recent version, HTTPS is the standard. By default, HTTP operates on port 8080, while HTTPS uses port 8443.

  5. When accessing Apache NiFi via a URL, it prompts you to enter a username and password for login.

    To retrieve login credentials, users should consult the 'App.log' file located within the log directory of their NiFi installation. This file typically contains the necessary details for accessing the NiFi interface.

  6. Click the (Configuration) button from the Operate sidebar under the "NiFi Flow" process group.
  7. In the NiFi Flow Configuration page, navigate to the "Controller Services" tab.
  8. Click the button to create a new controller service.
  9. In the Add Controller Service page, select "DBCPConnectionPool", and then click Add.
  10. In the Configure Controller Service page, navigate to the "Properties" tab.
  11. Click the gear button to configure the new DBCPConnection Pool.
  12. Fill in the properties:

    PropertyValue
    Database Connection URLjdbc:neo4j:Server=localhost;Port=7474;User=my_user;Password=my_password;
    Database Driver Class Namecdata.jdbc.neo4j.Neo4jDriver
    Database Driver Location(s)Path to your Apache NiFi's lib folder where the JAR files are present.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Neo4J JDBC Driver. Either double-click the JAR file or execute the JAR file from the command-line.

    java -jar cdata.jdbc.neo4j.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    To connect to Neo4j, set the following connection properties:

    • Server: The server hosting the Neo4j instance.
    • Port: The port on which the Neo4j service is running. The provider connects to port 7474 by default.
    • User: The username of the user using the Neo4j instance.
    • Password: The password of the user using the Neo4j instance.
  13. To establish a connection and execute a select query, simply drag and drop the processor (indicated by the yellow highlight) into the workspace.
  14. Select the 'ExecuteSQL' processor and click the 'Add' button to make it visible in the workspace.
  15. Click on the added processor (ExecuteSQL)to open the connection page.
  16. Click on the Verify Properties button and verify to test the connection.
  17. Ensure that all the verification results are successful, and then click on APPLY.
  18. Activate the connection by clicking the small button at the right corner of the screen.

Your Neo4J data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor (shown below).

Download a free, 30-day trial of the CData JDBC Driver for Neo4J and start working with your live Neo4J data in Apache NiFi. Reach out to our Support Team if you have any questions.

Ready to get started?

Download a free trial of the Neo4J Driver to get started:

 Download Now

Learn more:

Neo4J Icon Neo4J JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Neo4J.