JDBC Driver for Neo4j

Build 23.0.8839

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Neo4j consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.neo4j.Neo4jDriver
  • Provide the JDBC URL. For example:
    jdbc:neo4j:server=localhost;port=7474;user=neo4j;password=password;
    
    or
    
    jdbc:cdata:neo4j:server=localhost;port=7474;user=neo4j;password=password;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:neo4j:" or "jdbc:cdata:neo4j:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Neo4j

CData JDBC Driver for Neo4j supports connections to self-managed Neo4j instances via the HTTP API. To connect, set the following connection properties:

  • 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".
Note that the CData JDBC Driver for Neo4j does not support connections to cloud Neo4j instances like those of AuraDB and AuraDS.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839