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) 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/CassandraODBCDriverforUnix.deb
On systems that support the RPM package format, run the following command with root or sudo:
rpm -ivh /path/to/driver/CassandraODBCDriverforUnix.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-cassandra/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 Cassandra
You can connect directly to Cassandra instances, as well as Cosmos DB and DataStax Astra DB via their Cassandra APIs.
Cassandra
Set the following to connect to a Cassandra instance:
- Server: Set this to the the host name or IP address of the server hosting the Cassandra database. You can specify the port at the end of this property or in Port.
- Port: Set this to the port on which the Cassandra database is hosted, if you haven't specified the port as part of the Server connection property.
- Database: Set this to the name of the Cassandra keyspace containing your tables.
- ConsistencyLevel: Set this to the number of the replicas that you want to enforce a response from before queries are considered a success.
- User: Set this to the username used to access your Cassandra database.
- Password: Set this to the password used to access your Cassandra database.
Cosmos DB
If you're using Cosmos DB as your Cassandra data store, specify the following values to connect:- Server: Set this to the Host value, the FQDN of the server provisioned for your account. You can specify the port at the end of this property or in Port.
- Port: Set this to the port on which your Cosmos DB instance is hosted, if you haven't specified the port as part of the Server connection property.
- Database: Set this to the database you want to read from and write to.
- ConsistencyLevel: Set this to the number of the replicas that you want to enforce a response from before queries are considered a success.
- User: Set this to your Cosmos DB account name.
- Password: Set this to the account key associated with the Cosmos DB account.
DataStax Astra DB
If you're using Astra DB as your Cassandra data store, specify the following values to connect:
- Server: Set this to the server in your BASE_ADDRESS value. You can also specify the port here or in Port.
- Port: Set this to the port on which your Astra DB instance is hosted, if you haven't specified the port as part of the Server connection property.
- Database: Set this to the database you want to read from and write to.
- ConsistencyLevel: Set this to the number of the replicas that you want to enforce a response from before queries are considered a success.
- User: Set this to your Astra DB username.
- Password: Set this to the password associated with your Astra DB username.
Secure Bundle Connection
You can configure any connection as a secure bundle by setting the following connection properties:- Server: Set this to your server name.
- Port: Set this to 29042.
- User: Set this to the Atra DB user.
- Password: Set this to Astra DB user password.
- SSLClientCert: Set this to the path to the identity.jks file.
- SSLClientCertType: Set this JKSFILE.
- SSLClientCertPassword: Set this to the password for the identity.jks file.
- SSLClientCertSubject: Set this to CERTIFICATE SUBJECT INFORMATION.
- UseSSL: Set this to "true".
See Secure connect bundle contents for a list of files that are included in a secure bundle.
Authenticating to Cassandra
The driver supports Basic authentication with login credentials and the additional authentication features of DataStax Enterprise (DSE). The following sections detail connection properties your authentication method may require.You need to set AuthScheme to the value corresponding to the authenticator configured for your system. You specify the authenticator in the authenticator property in the cassandra.yaml file. This file is typically found in /etc/dse/cassandra or through the DSE Unified Authenticator on DSE Cassandra.
Basic
Set AuthScheme to Basic to authenticate with login credentials alone.
In the cassandra.yaml file, set the authenticator property to "PasswordAuthenticator".
DSE
Set the AuthScheme property to DSE to authenticate with login credentials and the DSE Unified Authenticator.
In the file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".
Kerberos
Set the following to authenticating using Kerberos:
- AuthScheme: Set this to KERBEROS.
- KerberosKDC: Set this to the Kerberos Key Distribution Center (KDC) service used to authenticate the user.
- KerberosRealm: Set this to the Kerberos Realm used to authenticate the user.
- KerberosSPN: Set this to the service principal name (SPN) for the Kerberos Domain Controller.
- In the cassandra.yaml file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".
- Modify the authentication_options section in the dse.yaml file, specifying the default_schema and other_schemas properties as "kerberos".
- Modify the kerberos_options section in the dse.yaml file, specifying the keytab, service_principle, http_principle and qop properties.
Please see Using Kerberos for more details on how to set connection properties in order to connect to Kerberos.
LDAP
Set the following to authenticate:
- AuthScheme: Set this to LDAP to authenticate an LDAP user.
- LDAPServer: Set this to the host name or IP address of the LDAP server.
- LDAPPassword: The password of the default LDAP user.
- In the cassandra.yaml file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".
- Modify the authentication_options section in the dse.yaml file, specifying the default_schema and other_schemas properties as "ldap".
- Modify the ldap_options section in the dse.yaml file, specifying the server_host, server_port, search_dn, search_password, user_search_base, and user_search_filter properties.
Securing Cassandra Connections
You can set UseSSL to negotiate SSL/TLS encryption when you connect. 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.
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-cassandra/lib/cdata.odbc.cassandra.ini':
[Driver]
AnsiCodePage = 932