Manage Buildkite Data in DBArtisan as a JDBC Source

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

Integrate Buildkite Data into DBArtisan Projects

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

   Start by setting the Profile connection property to the location of the Buildkite Profile on disk (e.g. C:\profiles\Buildkite.apip). Next, set the ProfileSettings connection property to the connection string for Buildkite (see below).

   Buildkite API Profile Settings

   Buildkite uses HTTP API key authentication. Your Buildkite API access token is used to authenticate requests as a Bearer token. You can generate or view your tokens at https://buildkite.com/user/api-access-tokens.

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Buildkite API access token.
   • Organization: Set this to your Buildkite organization slug (e.g. acme-inc).

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Buildkite 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=C:\profiles\Buildkite.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Organization=your_organization_slug';

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

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