Ready to get started?

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

Download Now

Using the CData ODBC Driver for Acumatica in PyCharm

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

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

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.

Set the following connection properties to connect to Acumatica:

  • User: Set this to your username.
  • Password: Set this to your password.
  • Company: Set this to your company.
  • Url: Set this to your Acumatica URL, in the format http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/.
    For example: https://acumatica.com/entity/Default/17.200.001/

See the Getting Started guide in the CData driver documentation for more information.

Below is the syntax for a DSN:

[CData Acumatica Source] Driver = CData ODBC Driver for Acumatica Description = My Description Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/ User = user Password = password Company = CompanyName

Execute SQL to Acumatica

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 Acumatica};Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/;User = user;Password = password;Company = CompanyName;') cursor = cnxn.cursor() cursor.execute("SELECT Id, location_displayname FROM Events WHERE Id = '1'") rows = cursor.fetchall() for row in rows: print(row.Id, row.location_displayname)

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