Feed Apache Airflow Data into FineReport

The CData JDBC Driver for Apache Airflow fully implements the JDBC standard and can provide Apache Airflow data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Apache Airflow data as JDBC data source in FineReport and view Apache Airflow data as a table in the Report Designer.

Set Up a JDBC Data Source of Apache Airflow Data

Follow the instruction below to set Apache Airflow data as a FineReport database connection.

1. Copy the cdata.jdbc.api.jar file from the lib folder in the CData JDBC Driver for Apache Airflow installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.api.lic file as well.
2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

1. Database: Others
2. JDBC Driver: cdata.jdbc.api.APIDriver
3. URL: A standard JDBC connection string using semicolon-separated connection properties.

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

   ApacheAirflow API Profile Settings

   Apache Airflow 3 uses JWT Bearer tokens for API authentication. You can generate a token from the Airflow web UI under Settings or via the Airflow CLI using airflow users create and the /api/v2/auth/token endpoint. Note that this profile targets Apache Airflow 3.x using the /api/v2 REST API. The legacy /api/v1 endpoint used by Airflow 2.x is not supported.

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Apache Airflow JWT Bearer token.
   • Server: Set this to the base URL of your Airflow instance (e.g. http://localhost:8080).

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Apache Airflow 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.

   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical JDBC URL is below:

   
       jdbc:api:Profile=C:\profiles\ApacheAirflow.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_jwt_token;Server=http://localhost:8080';
     


4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to Apache Airflow set up, you can use it as FineReport data source.

Select Apache Airflow Data in the Report Designer.

1. Click to add a new template data set and select DB query to open the database query window.

2. Choose the JDBC connection that you created from the dropdown list.
3. The Apache Airflow entities will appear as tables on the left pane.
4. Write a SELECT statement for the Apache Airflow data tables and columns that you want to load.

5. Click preview and data is shown as table.

With these simple steps, Apache Airflow can be used as a JDBC data source in FineReport.