Create a Data Access Object for Miro Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Miro integrates connectivity to live Miro data in Java applications. By pairing these technologies, you gain simple, programmatic access to Miro data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Miro data.

Create a DAO for the Miro Boards Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyBoardsDAO {
  //request specific data from Miro (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Boards WHERE BoardId = :boardId")
  String findByBoardId(@Bind("boardId") String boardId);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Miro

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Miro.

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.

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.

A connection string for Miro will typically look like the following:

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

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Miro.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_access_token';");
MyBoardsDAO dao = dbi.open(MyBoardsDAO.class);

//do stuff with the DAO

dao.close();

Read Miro Data

With the connection open to Miro, simply call the previously defined method to retrieve data from the Boards entity in Miro.

//disply the result of our 'find' method
String  = dao.findByBoardId("3074457361234567890");
System.out.println();

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Miro by integrating with the CData JDBC Driver for Miro. Download a free trial and work with live Miro data in custom Java applications today.