Ready to get started?

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

Download Now

Using the CData ODBC Driver for SAP ByDesign in PyCharm

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

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

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 SAP ByDesign.

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.
  • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
    If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

Below is the syntax for a DSN:

[CData SAPByDesign Source] Driver = CData ODBC Driver for SAP ByDesign Description = My Description URL = https://my999999.sapbydesign.com User = username Password = password CustomService = servicename

Execute SQL to SAP ByDesign

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 SAPByDesign};URL = https://my999999.sapbydesign.com;User = username;Password = password;CustomService = servicename;') cursor = cnxn.cursor() cursor.execute("SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE ProductCategoryID = '1234567'") rows = cursor.fetchall() for row in rows: print(row.ID, row.ProductCategoryID)

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