Ready to get started?

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

Download Now

Using the CData ODBC Driver for SuiteCRM in PyCharm

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

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

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 must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

Below is the syntax for a DSN:

[CData SuiteCRM Source] Driver = CData ODBC Driver for SuiteCRM Description = My Description URL = http://mySuiteCRM.com User = myUser Password = myPassword

Execute SQL to SuiteCRM

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 SuiteCRM};URL = http://mySuiteCRM.com;User = myUser;Password = myPassword;') cursor = cnxn.cursor() cursor.execute("SELECT Name, Industry FROM Accounts WHERE Industry = 'Manufacturing'") rows = cursor.fetchall() for row in rows: print(row.Name, row.Industry)

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