We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →How to Connect to Salesforce Data Cloud Data in Using Python: 6 Steps
Create Python applications on Linux/UNIX machines with connectivity to Salesforce Data Cloud data. Leverage the pyodbc module for ODBC in Python.
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 Salesforce Data Cloud and the pyodbc module, you can easily build Salesforce Data Cloud-connected Python applications. This article shows how to use the pyodbc built-in functions to connect to Salesforce Data Cloud 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 Salesforce Data Cloud
...
List the Defined Data Source(s)
$ odbcinst -q -s
CData SalesforceDataCloud Source
...
To use the CData ODBC Driver for Salesforce Data Cloud with unixODBC, ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.salesforcedatacloud.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-salesforcedatacloud), as follows:
cdata.odbc.salesforcedatacloud.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.
Salesforce Data Cloud supports authentication via the OAuth standard.
OAuth
Set AuthScheme to OAuth.
Desktop Applications
CData provides an embedded OAuth application that simplifies authentication at the desktop.
You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Salesforce Data Cloud console. For further information, see Creating a Custom OAuth App in the Help documentation.
Before you connect, set these properties:
- InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- OAuthClientId (custom applications only): The Client ID assigned when you registered your custom OAuth application.
- OAuthClientSecret (custom applications only): The Client Secret assigned when you registered your custom OAuth application.
When you connect, the driver opens Salesforce Data Cloud's OAuth endpoint in your default browser. Log in and grant permissions to the application.
The driver then completes the OAuth process as follows:
- Extracts the access token from the callback URL.
- Obtains a new access token when the old one expires.
- Saves OAuth values in OAuthSettingsLocation so that they persist across connections.
For other OAuth methods, including Web Applications and Headless Machines, refer to the Help documentation.
/etc/odbc.ini or $HOME/.odbc.ini
[CData SalesforceDataCloud Source]
Driver = CData ODBC Driver for Salesforce Data Cloud
Description = My Description
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 Salesforce Data Cloud 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 Salesforce Data Cloud 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 Salesforce Data Cloud};')
Below is the syntax for a DSN:
cnxn = pyodbc.connect('DSN=CData SalesforceDataCloud Sys;')
6. Execute SQL on Salesforce Data Cloud
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 SalesforceDataCloud Source;User=MyUser;Password=MyPassword')
cursor.execute("SELECT [Account ID], [Account Name] FROM Account WHERE EmployeeCount = '250'")
rows = cursor.fetchall()
for row in rows:
print(row.[Account ID], row.[Account Name])
You can provide parameterized queries in a sequence or in the argument list:
cursor.execute(
"SELECT [Account ID], [Account Name]
FROM Account
WHERE EmployeeCount = ?", '250',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 Salesforce Data Cloud data, using the CData ODBC Driver for Salesforce Data Cloud.