Query Miro Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live Miro data. This article shows how to establish a connection to Miro data in DataGrip.

Create a New Driver Definition for Miro

The steps below describe how to create a new Data Source in DataGrip for Miro.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Miro Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Miro

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Miro Driver" to create a new Miro Data Source.
2. In the new window, configure the connection to Miro with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Miro JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

         java -jar cdata.jdbc.api.jar
       

   Fill in the connection properties and copy the connection string to the clipboard.

   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.

   
3. Set URL to the connection string, e.g.,

   jdbc:api:Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Miro

To browse through the Miro entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT ,  FROM Boards WHERE BoardId = '3074457361234567890'

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Miro data in DataGrip. Reach out to our Support Team if you have any questions.