Ready to get started?

Learn more about the CData ODBC Driver for Salesforce or download a free trial:

Download Now

Using the CData ODBC Driver for Salesforce in PyCharm

Connect to Salesforce as an ODBC data source in PyCharm using the CData ODBC Driver for Salesforce.

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 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 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

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.

There are several authentication methods available for connecting to Salesforce: Login, OAuth, and SSO. The Login method requires you to have the username, password, and security token of the user.

If you do not have access to the username and password or do not wish to require them, you can use OAuth authentication.

SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and TokenUrl connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the help documentation for more information.

Below is the syntax for a DSN:

[CData Salesforce Source] Driver = CData ODBC Driver for Salesforce Description = My Description User = username Password = password SecurityToken = Your_Security_Token

Execute SQL to Salesforce

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 Salesforce};User = username;Password = password;SecurityToken = Your_Security_Token;') cursor = cnxn.cursor() cursor.execute("SELECT Industry, AnnualRevenue FROM Account WHERE Name = 'GenePoint'") rows = cursor.fetchall() for row in rows: print(row.Industry, row.AnnualRevenue)

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