Manage CircleCI Data in DBArtisan as a JDBC Source

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

Integrate CircleCI Data into DBArtisan Projects

Follow the steps below to register CircleCI 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

   CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your CircleCI personal API token.

   Example connection string:

   Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the CircleCI 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\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

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

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