This section describes how to set up ODBC connectivity and configure DSNs on several Linux distributions: Debian-based systems, like Ubuntu, and Red Hat Linux platforms, like Red Hat Enterprise Linux (RHEL) and Fedora.

Minimum Linux Versions

Here are the minimum supported versions for Red Hat-based and Debian-based systems:

OS	Min. Version
Ubuntu	18.04
Debian	10
RHEL	8
Fedora	28
SUSE	15

Installing the Driver Dependencies

Run the following commands as root or with sudo to install the necessary dependencies:

• Debian/Ubuntu:
  

  apt-get install libc6 libstdc++6 zlib1g libgcc1

• RHEL/Fedora:
  

  yum install glibc libstdc++ zlib libgcc

Installing the Driver

You can use standard package management systems to install the driver.

On Debian-based systems, like Ubuntu, run the following command with root or sudo:

dpkg -i /path/to/driver/setup/Neo4jODBCDriverforUnix.deb 

On systems that support the RPM package format, run the following command with root or sudo:

rpm -ivh /path/to/driver/Neo4jODBCDriverforUnix.rpm 

Licensing the Driver

Run the following commands to license the driver. To activate a trial, omit the <key> input.

cd /opt/cdata/cdata-odbc-driver-for-neo4j/bin/
sudo ./install-license.sh <key>

Connecting through the Driver Manager

The driver manager loads the driver and passes function calls from the application to the driver. You need to register the driver with the driver manager and you define DSNs in the driver manager's configuration files.

The driver installation registers the driver with the unixODBC driver manager and creates a system DSN. The unixODBC driver manager can be used from Python and from many other applications. Your application may embed another driver manager.

Creating the DSN

See Using unixODBC to install unixODBC and configure DSNs. See Using the DataDirect Driver Manager to create a DSN to connect to OBIEE, Informatica, and SAS.

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.

Set the Driver Encoding

The ODBC drivers need to specify which encoding to use with the ODBC Driver Manager. By default, the CData ODBC Drivers for Unix are configured to use UTF-16 which is compatible with unixODBC, but other Driver Managers may require alternative encoding.

Alternatively, if you are using the ODBC driver from an application that uses the ANSI ODBC API it may be necessary to set the ANSI code page. For example, to import Japanese characters in an ANSI application, you can specify the code page in the config file '/opt/cdata/cdata-odbc-driver-for-neo4j/lib/cdata.odbc.neo4j.ini':

[Driver]
AnsiCodePage = 932