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:
| OS | Min. Version |
| Ubuntu | 11.04 |
| Debian | 7 |
| RHEL | 6.9 |
| CentOS | 6.9 |
| Fedora | 13 |
| SUSE | 12.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 Package | RHEL/CentOS/Fedora Package | File |
| libc6 | glibc | linux-vdso.1 |
| libc6 | glibc | libm.so.6 |
| libc6 | glibc | librt.so.1 |
| libc6 | glibc | libdl.so.2 |
| libc6 | glibc | libpthread.so.0 |
| libc6 | glibc | libc.so.6 |
| libc6 | glibc | ld-linux-x86-64.so.2 |
| libstdc++6 | libstdc++ | libstdc++.so.6 |
| zlib1g | zlib | libz.so.1 |
| libgcc1 | libgcc | libgcc_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/ODataODBCDriverforUnix.deb
On systems that support the RPM package format, run the following command with root or sudo:
rpm -ivh /path/to/driver/ODataODBCDriverforUnix.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-odata/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 OData
To connect, you need to set the Url to a valid OData service root URI in addition to the authentication values.
Also, you can specify a CacheLocation to store the metadata of your OData organization. This keeps the CData ODBC Driver for OData from having to send requests for metadata on each connection.
Authenticating to OData
The driver supports following authentication schemes.
HTTP Auth Schemes
The following general HTTP Auth schemes are supported:
- None: If no authentication is required, set the AuthScheme to None.
- Basic: If Basic Auth is supported, set the AuthScheme to Basic. In addition, set the User and Password.
- NTLM: A type of Windows authentication often used across a LAN using your Windows user credentials. Set the AuthScheme to NTLM to support this method of authentication. In addition, set the User and Password if you are not connecting from a Windows machine, or your currently logged in user account should not be used for the connection.
- Digest: If Digest Auth is supported, set the AuthScheme to Digest. In addition, set the User and Password.
Kerberos
Please see Using Kerberos for a description of how to support Kerberos authentication.OAuth
Set the AuthScheme to OAuth. See Using OAuth Authentication for an authentication guide.
Authenticating with AzureAD
AzureAD is a form of OAuth that goes through Azure. Set the AuthScheme to AzureAD. The CData ODBC Driver for OData will internally automatically take care of known Azure URLs. Specifically, the following are unnecessary to specify with the AzureAD AuthScheme:
- OAuthAccessTokenURL
- OAuthAuthorizationURL
- OAuthRefreshTokenURL
- OAuthRequestTokenURL
Other connection properties may be required for this connection method including:
- Scope: Must be specified if InitiateOAuth is set to GETANDREFRESH as the Scope is submitted to Microsoft during retrieval of credentails. This will vary depending on the service, but is generally a combination of the resource (hostname in the URL) and permission name. For example: https://host/user_impersonation.
- AzureADTenant: The specific Azure Tenant to authenticate against during Microsoft login. If none is specified, your user account's default tenant via the common login endpoint will be used. This may not be correct depending on the specific resource you are connecting to. For example, if the resource is stored on a seperate tenant for cases where you have access to multiple tenants.
Otherwise, the steps are identical to the Using OAuth Authentication guide.
SharePoint Online
SharePoint Online connections may be established by retrieving a SharePoint Online cookie. Specify the following connection properties to authenticate:
- AuthScheme: Set this to SharePointOnline.
- User: Set this to your SharePoint Online user account.
- Password: Set this to your SharePoint Online password.
Kerberos
Please see Using Kerberos for details on how to authenticate with Kerberos.
Securing OData Connections
By default, the driver attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.
Refreshing OAuth Values
The driver can refresh the temporary OAuth access tokens obtained during the browser-based OAuth authentication exchange. By default, the driver saves the encrypted tokens in the odbc.ini file corresponding to the DSN. Access to this odbc.ini file can be restricted in the case of System DSNs.
To enable the automatic token exchange, you can give the driver write access to the system odbc.ini.
Installing Dependencies for OAuth Authentication
The OAuth authentication standard requires the authenticating user to interact with OData, using a web-browser. If the first OAuth interaction is to be done on the same machine the driver is installed on, for example, a desktop application, the driver needs access to the xdg-open program, which opens the default browser.
To satisfy this dependency, install the corresponding package with your package manager:
| Debian/Ubuntu Package | RHEL/CentOS/Fedora Package | File |
| xdg-utils | xdg-utils | xdg-open |
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-odata/lib/cdata.odbc.odata.ini':
[Driver]
AnsiCodePage = 932