Connect to Buildkite Data in DBArtisan
The CData ODBC 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 an data source for Buildkite in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate Buildkite Data into DBArtisan Projects
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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).
You can then follow the steps below to register Buildkite data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- 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.
