Manage Miro Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Miro seamlessly integrates Miro data into database management tools like DBArtisan by enabling you to access Miro data as a database. This article shows how to create a JDBC source for Miro in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Miro Data into DBArtisan Projects

Follow the steps below to register Miro data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Miro data. Miro entities are displayed in the Datasource Explorer.

You can now work with Miro data as you work with any other database. See the driver help documentation for more information on the queries supported by the Miro API.