Using the CData ODBC Driver for Salesforce CRM Analytics in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Salesforce CRM Analytics from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Salesforce CRM Analytics as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to Salesforce CRM Analytics

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

Salesforce CRM Analytics uses the OAuth 2 authentication standard. Obtain the OAuthClientId and OAuthClientSecret by registering an app with Salesforce CRM Analytics.

See the Getting Started section of the Help documentation for an authentication guide.

Multi-Factor Authentication (MFA)

If the connected Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies alongside the standard OAuth flow.

Below is the syntax for a DSN:

[CData SalesforceCRMAnalytics Source]
Driver = CData ODBC Driver for Salesforce CRM Analytics
Description = My Description
OAuthClientId = MyConsumerKey
OAuthClientSecret = MyConsumerSecret
CallbackURL = http://localhost:portNumber
InitiateOAuth = GETANDREFRESH
MFACode = YourMFACode

Execute SQL to Salesforce CRM Analytics

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

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for SalesforceCRMAnalytics};OAuthClientId = MyConsumerKey;OAuthClientSecret = MyConsumerSecret;CallbackURL = http://localhost:portNumber;InitiateOAuth = GETANDREFRESH;MFACode = YourMFACode')
cursor = cnxn.cursor()
cursor.execute("SELECT Name, CloseDate FROM Dataset_Opportunity WHERE StageName = 'Closed Won'")
rows = cursor.fetchall()
for row in rows:
  print(row.Name, row.CloseDate)

After connecting to Salesforce CRM Analytics in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Salesforce CRM Analytics data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].