Connect to CircleCI Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for CircleCI enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with CircleCI as sources. In this article, you will use the JDBC Driver for CircleCI to set up a simple transfer into a flat file. The CData JDBC Driver for CircleCI enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with CircleCI as sources. In this article, you will use the JDBC Driver for CircleCI to set up a simple transfer into a flat file.

Connect to CircleCI as a JDBC Data Source

1. Create the connection to CircleCI data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
3. Enter 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.

   

   A typical JDBC URL is below:

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

Query CircleCI Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the CircleCI JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT ,  FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Artifacts table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.