How to Connect to Talkdesk Data in Using Python: 6 Steps

The rich ecosystem of Python modules lets you get to work quicker and integrate your systems more effectively. With the CData Linux/UNIX ODBC Driver for Talkdesk and the pyodbc module, you can easily build Talkdesk-connected Python applications. This article shows how to use the pyodbc built-in functions to connect to Talkdesk data, execute queries, and output the results.

How to Use the CData ODBC Drivers on UNIX/Linux

The CData ODBC Drivers are supported in various Red Hat-based and Debian-based systems, including Ubuntu, Debian, RHEL, CentOS, and Fedora. There are also several libraries and packages that are required, many of which may be installed by default, depending on your system. For more information on the supported versions of Linux operating systems and the required libraries, please refer to the "Getting Started" section in the help documentation (installed and found online).

1. Install the Driver Manager

Before installing the driver, check that your system has a driver manager. For this article, you will use unixODBC, a free and open source ODBC driver manager that is widely supported.

For Debian-based systems like Ubuntu, you can install unixODBC with the APT package manager:

$ sudo apt-get install unixodbc unixodbc-dev

For systems based on Red Hat Linux, you can install unixODBC with yum or dnf:

$ sudo yum install unixODBC unixODBC-devel

The unixODBC driver manager reads information about drivers from an odbcinst.ini file and about data sources from an odbc.ini file. You can determine the location of the configuration files on your system by entering the following command into a terminal:

$ odbcinst -j

The output of the command will display the locations of the configuration files for ODBC data sources and registered ODBC drivers. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users. Below is an example of the output of this command:

DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......: 8
SQLLEN Size........: 8
SQLSETPOSIROW Size.: 8

2. Install the Driver

You can download the driver in standard package formats: the Debian .deb package format or the .rpm file format. Once you have downloaded the file, you can install the driver from the terminal.

The driver installer registers the driver with unixODBC and creates a system DSN, which can be used later in any tools or applications that support ODBC connectivity.

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

$ dpkg -i /path/to/package.deb

For Red Hat systems and other systems that support .rpms, run the following command with sudo or as root:

$ rpm -i /path/to/package.rpm

Once the driver is installed, you can list the registered drivers and defined data sources using the unixODBC driver manager:

List the Registered Driver(s)

$ odbcinst -q -d
CData ODBC Driver for Talkdesk
...

List the Defined Data Source(s)

$ odbcinst -q -s
CData Talkdesk Source
...

To use the CData ODBC Driver for Talkdesk with unixODBC, ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.talkdesk.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-talkdesk), as follows:

cdata.odbc.talkdesk.ini

...

[Driver]
DriverManagerEncoding = UTF-16

3. Modify the DSN

The driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties. Additionally, you can create user-specific DSNs that will not require root access to modify in $HOME/.odbc.ini.

Talkdesk uses the OAuth 2.0 Client Credentials grant. There is no browser-based authorization step and no callback URL.

Set the following connection properties:

• AccountName: The name of your Talkdesk account.
• Region: The region where your Talkdesk instance is deployed. Supported values are US (default), EU, CA, AU, UK, and FedRamp.
• OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The Client Secret assigned to your custom OAuth application.

Creating a Custom OAuth Application

1. Log in to your Talkdesk account and select OAuth Clients from the navigation menu.
2. Click Create OAuth Client and give the client a descriptive name.
3. Set Grant Type to Client Credentials.
4. Click Add scopes and select the scopes for the data you want to access.
5. Click Create and copy the Client Id and Client Secret.

When you connect, the driver automatically requests an access token from Talkdesk, caches it, and refreshes it when it expires. Make sure the scopes selected for the application match the views you plan to query, or the token request can fail.

/etc/odbc.ini or $HOME/.odbc.ini

[CData Talkdesk Source]
Driver = CData ODBC Driver for Talkdesk
Description = My Description
AccountName = myAccount
Region = US
OAuthClientId = myClientId
OAuthClientSecret = myClientSecret

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

You can follow the procedure below to install pyodbc and start accessing Talkdesk through Python objects.

4. Install pyodbc

You can use the pip utility to install the module:

pip install pyodbc

Be sure to import with the module with the following:

import pyodbc

5. Connect to Talkdesk Data

You can now connect with an ODBC connection string or a DSN. Below is the syntax for a connection string:

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for Talkdesk};AccountName=myAccount;Region=US;OAuthClientId=myClientId;OAuthClientSecret=myClientSecret;')

Below is the syntax for a DSN:

cnxn = pyodbc.connect('DSN=CData Talkdesk Sys;')

6. Execute SQL on Talkdesk

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

cursor = cnxn.cursor()

Select

You can use fetchall, fetchone, and fetchmany to retrieve Rows returned from SELECT statements:

import pyodbc

cursor = cnxn.cursor()
cnxn = pyodbc.connect('DSN=CData Talkdesk Source;User=MyUser;Password=MyPassword')
cursor.execute("SELECT Id, Name FROM Users WHERE Active = 'true'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.Name)

You can provide parameterized queries in a sequence or in the argument list:

cursor.execute(
  "SELECT Id, Name
  FROM Users
  WHERE Active = ?", 'true',1)

Metadata Discovery

You can use the getinfo method to retrieve data such as information about the data source and the capabilities of the driver. The getinfo method passes through input to the ODBC SQLGetInfo method.

cnxn.getinfo(pyodbc.SQL_DATA_SOURCE_NAME)

You are now ready to build Python apps in Linux/UNIX environments with connectivity to Talkdesk data, using the CData ODBC Driver for Talkdesk.