Ready to get started?

Learn more about the CData ODBC Driver for IBM Cloud SQL Query or download a free trial:

Download Now

Using the CData ODBC Driver for IBM Cloud SQL Query in PyCharm

Connect to IBM Cloud SQL Query as an ODBC data source in PyCharm using the CData ODBC Driver for IBM Cloud SQL Query.

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 IBM Cloud SQL Query 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 IBM Cloud SQL Query 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 IBM Cloud SQL Query

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.

IBM Cloud SQL uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Below is the syntax for a DSN:

[CData IBMCloudSQLQuery Source] Driver = CData ODBC Driver for IBM Cloud SQL Query Description = My Description Api Key = MyAPIKey Instance CRN = myInstanceCRN Region = myRegion Schema = mySchema OAuth Client Id = myOAuthClientId OAuth Client Secret = myOAuthClientSecret

Execute SQL to IBM Cloud SQL Query

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 IBMCloudSQLQuery};Api Key = MyAPIKey;Instance CRN = myInstanceCRN;Region = myRegion;Schema = mySchema;OAuth Client Id = myOAuthClientId;OAuth Client Secret = myOAuthClientSecret;') cursor = cnxn.cursor() cursor.execute("SELECT Id, Status FROM Jobs WHERE UserId = 'user@domain.com'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Status)

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