ODBC Driver for TigerGraph

Build 23.0.8839

Linux DSN Configuration

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), CentOS, and Fedora.

Minimum Linux Versions

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

OSMin. Version
Ubuntu11.04
Debian7
RHEL6.9
CentOS6.9
Fedora13
SUSE12.1

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/CentOS/Fedora:
    yum install glibc libstdc++ zlib libgcc

Here are the corresponding libraries required by the driver:

Debian/Ubuntu PackageRHEL/CentOS/Fedora PackageFile
libc6glibclinux-vdso.1
libc6glibclibm.so.6
libc6glibclibrt.so.1
libc6glibclibdl.so.2
libc6glibclibpthread.so.0
libc6glibclibc.so.6
libc6glibcld-linux-x86-64.so.2
libstdc++6libstdc++libstdc++.so.6
zlib1gzliblibz.so.1
libgcc1libgcclibgcc_s.so.1

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/TigerGraphODBCDriverforUnix.deb 

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

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

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 TigerGraph

This section documents how to authenticate and connect to your TigerGraph instance.

Authenticate to TigerGraph Server

To authenticate requests to TigerGraph Server, set the following properties:

  • AuthScheme: Set this property to 'Basic'.
  • User: Set this property to your TigerGraph user name.
  • Password: Set this property to your TigerGraph user password.
  • Url: Set this property to the domain name or IP of your TigerGraph instance.
  • Port: Set this property to the port of your TigerGraph server instance (14240 by default).
  • TigerGraphEdition: Set this property to 'TigerGraph Server'.
See this page for notes on configuring a TigerGraph Server account: Managing Credentials

Authenticate to TigerGraph Cloud

To authenticate requests to TigerGraph Cloud, set the following properties:

  • User: Set this property to your TigerGraph database user name.
  • Password: Set this property to your TigerGraph database user password.
  • Url: Set this property to the domain name or IP of your TigerGraph instance.
To configure a TigerGraph Cloud user:
  1. From the Cloud portal, go to Clusters.
  2. Find the cluster you want to create users for, and select Access Management
  3. From the Cluster Access Management page, click Database Access.
  4. Click Add new users and specify the username and password. Note: The password will not be visible again after leaving this page.
  5. Click Role Management, select 'superuser' from the 'Select a role' list, then select the created user and click Save.
See this page for additional notes on configuring a TigerGraph Cloud database user: Managing Database Users

Secret-Based Authentication

To authenticate using a Secret, set the following properties:

  • AuthScheme: Set this property to 'Secret'.
  • Secret: Set this property to your generated secret.
  • Url: Set this property to the domain name or IP of your TigerGraph instance.
  • Schema: Set this property to the graph name your secret has been generated for.
Secrets can be generated for a given graph in the TigerGraph Admin Portal.

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-tigergraph/lib/cdata.odbc.tigergraph.ini':

[Driver]
AnsiCodePage = 932

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