We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →How to integrate Kafka with Apache Airflow
Access and process Kafka data in Apache Airflow using the CData JDBC Driver.
Apache Airflow supports the creation, scheduling, and monitoring of data engineering workflows. When paired with the CData JDBC Driver for Apache Kafka, Airflow can work with live Kafka data. This article describes how to connect to and query Kafka data from an Apache Airflow instance and store the results in a CSV file.
With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Kafka data. When you issue complex SQL queries to Kafka, the driver pushes supported SQL operations, like filters and aggregations, directly to Kafka 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 Kafka data using native data types.
Configuring the Connection to Kafka
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Kafka JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.apachekafka.jar
Fill in the connection properties and copy the connection string to the clipboard.
Set BootstrapServers and the Topic properties to specify the address of your Apache Kafka server, as well as the topic you would like to interact with.
Authorization Mechanisms
- SASL Plain: The User and Password properties should be specified. AuthScheme should be set to 'Plain'.
- SASL SSL: The User and Password properties should be specified. AuthScheme should be set to 'Scram'. UseSSL should be set to true.
- SSL: The SSLCert and SSLCertPassword properties should be specified. UseSSL should be set to true.
- Kerberos: The User and Password properties should be specified. AuthScheme should be set to 'Kerberos'.
You may be required to trust the server certificate. In such cases, specify the TrustStorePath and the TrustStorePassword if necessary.
To host the JDBC driver in clustered environments or in the cloud, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.
The following are essential properties needed for our JDBC connection.
Property | Value |
---|---|
Database Connection URL | jdbc:apachekafka:RTK=5246...;User=admin;Password=pass;BootStrapServers=https://localhost:9091;Topic=MyTopic; |
Database Driver Class Name | cdata.jdbc.apachekafka.ApacheKafkaDriver |
Establishing a JDBC Connection within Airflow
- Log into your Apache Airflow instance.
- On the navbar of your Airflow instance, hover over Admin and then click Connections.
- Next, click the + sign on the following screen to create a new connection.
- In the Add Connection form, fill out the required connection properties:
- Connection Id: Name the connection, i.e.: apachekafka_jdbc
- Connection Type: JDBC Connection
- Connection URL: The JDBC connection URL from above, i.e.: jdbc:apachekafka:RTK=5246...;User=admin;Password=pass;BootStrapServers=https://localhost:9091;Topic=MyTopic;)
- Driver Class: cdata.jdbc.apachekafka.ApacheKafkaDriver
- Driver Path: PATH/TO/cdata.jdbc.apachekafka.jar
- Test your new connection by clicking the Test button at the bottom of the form.
- After saving the new connection, on a new screen, you should see a green banner saying that a new row was added to the list of connections:
Creating a DAG
A DAG in Airflow is an entity that stores the processes for a workflow and can be triggered to run this workflow. Our workflow is to simply run a SQL query against Kafka data and store the results in a CSV file.
- To get started, in the Home directory, there should be an "airflow" folder. Within there, we can create a new directory and title it "dags". In here, we store Python files that convert into Airflow DAGs shown on the UI.
- Next, create a new Python file and title it kafka_hook.py. Insert the following code inside of this new file:
import time from datetime import datetime from airflow.decorators import dag, task from airflow.providers.jdbc.hooks.jdbc import JdbcHook import pandas as pd # Declare Dag @dag(dag_id="kafka_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv']) # Define Dag Function def extract_and_load(): # Define tasks @task() def jdbc_extract(): try: hook = JdbcHook(jdbc_conn_id="jdbc") sql = """ select * from Account """ df = hook.get_pandas_df(sql) df.to_csv("/{some_file_path}/{name_of_csv}.csv",header=False, index=False, quoting=1) # print(df.head()) print(df) tbl_dict = df.to_dict('dict') return tbl_dict except Exception as e: print("Data extract error: " + str(e)) jdbc_extract() sf_extract_and_load = extract_and_load()
- Save this file and refresh your Airflow instance. Within the list of DAGs, you should see a new DAG titled "kafka_hook".
- Click on this DAG and, on the new screen, click on the unpause switch to make it turn blue, and then click the trigger (i.e. play) button to run the DAG. This executes the SQL query in our kafka_hook.py file and export the results as a CSV to whichever file path we designated in our code.
- After triggering our new DAG, we check the Downloads folder (or wherever you chose within your Python script), and see that the CSV file has been created - in this case, account.csv.
- Open the CSV file to see that your Kafka data is now available for use in CSV format thanks to Apache Airflow.