Ready to get started?

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

Download Now

Using the CData ODBC Driver for HPCC Systems in PyCharm

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

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

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.

To connect, set the following connection properties: Set URL to the machine name or IP address of the server and the port the server is running on, for example, https://server:port. The User and Password are required to authenticate to the HPCC Systems cluster specified in the URL. Note that LDAP authentication is not currently supported by our ODBC driver.

Set Version to the WsSQL Web server version. Note that if you have not already done so, you will need to install the WsSQL service on the HPCC Systems server. The WsSQL Web service is used to interact with the underlying HPCC Systems platform.

Set Cluster to the target cluster.

Below is the syntax for a DSN:

[CData HPCC Source] Driver = CData ODBC Driver for HPCC Systems Description = My Description URL = http://127.0.0.1:8510 User = test password = xA123456 Version = 1 Cluster = hthor

Execute SQL to HPCC Systems

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 HPCC};URL = http://127.0.0.1:8510;User = test;password = xA123456;Version = 1;Cluster = hthor;') cursor = cnxn.cursor() cursor.execute("SELECT CustomerName, Price FROM hpcc::test::orders WHERE ShipCity = 'New York'") rows = cursor.fetchall() for row in rows: print(row.CustomerName, row.Price)

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