Using the CData ODBC Driver for Parallel in PyCharm

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

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 Parallel API uses API Key authentication via the x-api-key request header.

Using API Key Authentication

Your Parallel API key is required to create a connection. To obtain your API key:

1. Log into your Parallel account at app.parallel.ai.
2. Navigate to Settings or API Keys in your account dashboard.
3. Generate or copy your API key.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Parallel API key.

Example connection string:

Profile=C:\profiles\Parallel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Parallel
Description = My Description
Profile = C:\profiles\Parallel.apip
AuthScheme = APIKey
ProfileSettings = 'APIKey = your_api_key'

Execute SQL to Parallel

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 API};Profile = C:\profiles\Parallel.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM MonitorEvents WHERE MonitorId = 'mon_abc123'")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

After connecting to Parallel in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Parallel data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].