How to Query Apache Airflow Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Apache Airflow to query Apache Airflow data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Apache Airflow data in MySQL Workbench.

Connect to Apache Airflow Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Apache Airflow data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Apache Airflow from MySQL Workbench

The steps below outline connecting to the virtual Apache Airflow database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Apache Airflow data.

Connect to Apache Airflow through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Apache Airflow).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Apache Airflow Data

1. Open the connection you just created (CData SQL Gateway for Apache Airflow).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Apache Airflow data, like SELECT * FROM `CData API Sys`.DagRuns;

With access to live Apache Airflow data from MySQL Workbench, you can easily work with Apache Airflow, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.