Viewing Buildkite Data in RAD Studio Data Explorer

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Buildkite, you gain access to live Buildkite data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve Buildkite data. This article will walk through connecting to Buildkite using the Data Explorer.

Configure a Connection to Buildkite

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).

Connecting to Buildkite Data Using Data Explorer

You can create a simple application for displaying Buildkite data by utilizing the CData FireDAC Components for Buildkite and a new VCL Forms Application:

1. Open the Data Explorer in RAD Studio and expand FireDAC.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Buildkite.
6. Back in the Data Explorer, expand the views for the connection.

7. Create a new VCL Forms application and drag a view (for example: Builds) onto the form.

   
8. Select the BuildsView object on the form and set the Active property to true.

9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

   

10. Arrange the TStringGrid on the form and run the application to see the Builds data.

    

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to Buildkite Data in C++Builder
• DataBind Controls to Buildkite Data in Delphi
• Build a Simple VCL Application for Buildkite Data