Rapidly Develop Apache Airflow-Driven Apps with Active Query Builder

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Leverage the Active Query Builder SQL interface and .NET data access to create data-driven WinForms and ASP.NET apps backed by Apache Airflow.

Write standard .NET to expose Apache Airflow data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Apache Airflow enables standards-based access to Apache Airflow. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to Apache Airflow as an ODBC Data Source

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

Use SQL to Interact with Apache Airflow

Follow the steps below to create a WinForms visual query builder.

  1. Open Active Query Builder for .NET WinForms. Opening Active Query Builder.
  2. In the new Windows Forms project go to the "File" menu and click "Connect..."
  3. Under Database Connections, click "Add..." Adding a new Connection.
  4. Set your desired Connection Name (e.g. CData Apache Airflow), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown. Selecting a previously configured DSN (Amazon Athena is shown).
  5. Click "OK" to save the new connection.
  6. Back in the Database Connection wizard, select the newly created connection and click "OK." A newly added Connection (Amazon Athena is shown).
  7. Click "File" > "New Query" to create a QueryBuilder

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.

Building queries interactively with Active Query Builder.

Ready to get started?

Connect to live data from Apache Airflow with the API Driver

Connect to Apache Airflow