Using the CData ODBC Driver for CleverPush 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 CleverPush 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 CleverPush 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 CleverPush

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.

Start by setting the Profile connection property to the location of the Cleverpush Profile on disk (e.g. C:\profiles\Cleverpush.apip). Next, set the ProfileSettings connection property to the connection string for Cleverpush (see below).

Cleverpush API Profile Settings

CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CleverPush private API key.

Optional Connection Properties

• ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for CleverPush
Description = My Description
Profile = C:\profiles\Cleverpush.apip
ProfileSettings = 'APIKey = my_api_key'

Execute SQL to CleverPush

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\Cleverpush.apip;ProfileSettings = 'APIKey = my_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, Name FROM Segments WHERE ChannelId = 'your_channel_id'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.Name)

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