Ready to get started?

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

Download Now

Using the CData ODBC Driver for Sugar CRM in PyCharm

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

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

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.

The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

Below is the syntax for a DSN:

[CData SugarCRM Source] Driver = CData ODBC Driver for Sugar CRM Description = My Description User = MyUser Password = MyPassword URL = MySugarCRMAccountURL CacheMetadata = True

Execute SQL to Sugar CRM

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 SugarCRM};User = MyUser;Password = MyPassword;URL = MySugarCRMAccountURL;CacheMetadata = True;') cursor = cnxn.cursor() cursor.execute("SELECT Name, AnnualRevenue FROM Accounts WHERE Name = 'Bob'") rows = cursor.fetchall() for row in rows: print(row.Name, row.AnnualRevenue)

After connecting to Sugar CRM in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Sugar CRM 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.