Connect to CircleCI Data in DBArtisan
The CData ODBC 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 an data source for CircleCI in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate CircleCI 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.
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';
You can then follow the steps below to register CircleCI 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 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.
