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

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 Buildkite Profile on disk (e.g. C:\profiles\Buildkite.apip). Next, set the ProfileSettings connection property to the connection string for Buildkite (see below).

Buildkite API Profile Settings

Buildkite uses HTTP API key authentication. Your Buildkite API access token is used to authenticate requests as a Bearer token. You can generate or view your tokens at https://buildkite.com/user/api-access-tokens.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Buildkite API access token.
• Organization: Set this to your Buildkite organization slug (e.g. acme-inc).

Below is the syntax for a DSN:

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

Execute SQL to Buildkite

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\Buildkite.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_api_key;Organization = your_organization_slug';')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, BuildNumber FROM Builds WHERE State = 'passed'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.BuildNumber)

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