Import Real-Time Apache Airflow Data via JDBC in ColdFusion to Build Applications

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST.

When ColdFusion is paired with the CData API Driver for JDBC, you can link your ColdFusion web and mobile applications to operational Apache Airflow data. This allows for your applications to be more robust and complete. This article details how to use the JDBC driver to create a table populated with Apache Airflow data from within a ColdFusion markup file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Apache Airflow data. When you issue complex SQL queries to Apache Airflow, the driver pushes supported SQL operations, like filters and aggregations, directly to Apache Airflow and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Apache Airflow data using native data types.

Configuring the Connection to Apache Airflow

You will need a JDBC connection string to establish a connection between Coldfusion and Apache Airflow.

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

Adding a Data Source and Creating a Table

After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with Apache Airflow data and display it in a table written in the ColdFusion Markup Language, or CFML:

1. Copy the JDBC Driver for Apache Airflow and lic file from "C:\Program Files\CData\CData API Driver for JDBC\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".

   
               cdata.jdbc.api.jar
               cdata.jdbc.api.lic
           

   Note: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.

2. From the ColdFusion administrator interface, choose Data & Services.
3. Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button.
4. Next, populate the driver properties.
   • JDBC URL will need to be in the format: jdbc:api:|connectionString|.
   • A typical connection string looks like this:

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

   • The Driver Class is: cdata.jdbc.api.APIDriver
   • The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
   
5. Now, test the connection by clicking the check mark to the left of the CDataApache AirflowJDBC data source you just created. When the data source reports an "OK" status, it is ready for use.
6. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

   The following code queries the data source:

               
           <cfquery name="Apache AirflowQuery" dataSource="CDataApache AirflowJDBC"> 
             SELECT * FROM DagRuns 
           </cfquery> 
       

   And a CFTable can be used to quickly output the table in HTML:

               
             <cftable  
             query = "Apache AirflowQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
   
             <cfcol header="<b>DagRunId</b>" align="Left" width=2 text="DagRunId"/> 
   
             <cfcol header="<b>State</b>" align="Left" width=15 text="State"/> 
   
             ...
   
           </cftable> 
       

   Full code, including the HTML portion is available below:

               
           <html> 
           <head><title>CData Software | Apache Airflow DagRuns Table Demo </title></head> 
           <body> 
           <cfoutput>#ucase("Apache Airflow DagRuns Table Demo")#</cfoutput> 
           <cfquery name="Apache AirflowQuery" dataSource="CDataApache AirflowJDBC"> 
   
             SELECT * FROM DagRuns 
   
           </cfquery> 
           <cftable  
             query = "Apache AirflowQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
             <cfcol header="<b>DagRunId</b>" align="Left" width=2 text="DagRunId"/> 
   
             <cfcol header="<b>State</b>" align="Left" width=15 text="State"/> 
   
             ...
   
           </cftable> 
           </body> 
   
           </html>  
       

7. Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Apache Airflow data!

As a note, the CData JDBC Drivers also support parameterized queries using the cfqueryparam element. For example:

SELECT * FROM Account WHERE name =  

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Apache Airflow and start building Apache Airflow-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.