Manage Rootly Data in DBArtisan as a JDBC Source

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

Integrate Rootly Data into DBArtisan Projects

Follow the steps below to register Rootly 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.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   Using API Key Authentication

   To authenticate using an API key, you will need to obtain your API key from your Rootly account settings.

   To get your API key:

   1. Log in to your Rootly account
   2. Navigate to Settings > API & Integrations
   3. Click on "API Tokens"
   4. Copy the generated token

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Rootly API token.

   Example Connection String

   Profile=Rootly.apip;Authscheme=APIKey;ProfileSettings="APIKey=your_apikey";
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Rootly 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.

   

   Below is a typical connection string:

   jdbc:api:Profile=Rootly.apip;Authscheme=APIKey;ProfileSettings="APIKey=your_apikey";

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

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