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

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.

Using API Key Authentication

Miro uses API Key authentication with an access token. To generate an access token:

1. Log in to your Miro account
2. Navigate to Settings > Your apps
3. Click "Create new app" or select an existing app
4. Configure the required permissions (e.g., boards:read, teams:read)
5. Install the app and generate an access token
6. Copy the generated access token (it will only be shown once)

After obtaining your access token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your access token.

Connecting to Miro

Once the authentication is configured, you can connect to Miro and query data from any of the available tables such as Boards, Items, Teams, Organizations, and more.

Below is the syntax for a DSN:

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

Execute SQL to Miro

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\Miro.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_access_token';')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Boards WHERE BoardId = '3074457361234567890'")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

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