How to integrate Cosmos DB with Apache Airflow

Apache Airflow supports the creation, scheduling, and monitoring of data engineering workflows. When paired with the CData JDBC Driver for Cosmos DB, Airflow can work with live Cosmos DB data. This article describes how to connect to and query Cosmos DB 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 Cosmos DB data. When you issue complex SQL queries to Cosmos DB, the driver pushes supported SQL operations, like filters and aggregations, directly to Cosmos DB 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 Cosmos DB data using native data types.

Configuring the Connection to Cosmos DB

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Cosmos DB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.cosmosdb.jar

Fill in the connection properties and copy the connection string to the clipboard.

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

• AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
• AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

👁 Using the built-in connection string designer to generate a JDBC URL (cosmos db is shown.)

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.

Establishing a JDBC Connection within Airflow

1. Log into your Apache Airflow instance.
2. On the navbar of your Airflow instance, hover over Admin and then click Connections. 👁 Clicking connections
   
3. Next, click the + sign on the following screen to create a new connection.
4. In the Add Connection form, fill out the required connection properties:
   • Connection Id: Name the connection, i.e.: cosmosdb_jdbc
   • Connection Type: JDBC Connection
   • Connection URL: The JDBC connection URL from above, i.e.: jdbc:cosmosdb:RTK=5246...;AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;)
   • Driver Class: cdata.jdbc.cosmosdb.CosmosDBDriver
   • Driver Path: PATH/TO/cdata.jdbc.cosmosdb.jar
   👁 Add JDBC connection form
   
5. Test your new connection by clicking the Test button at the bottom of the form.
6. 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: 👁 New connection added
   

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 Cosmos DB data and store the results in a CSV file.

1. 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.
2. Next, create a new Python file and title it cosmos db_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="cosmos db_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()
   

3. Save this file and refresh your Airflow instance. Within the list of DAGs, you should see a new DAG titled "cosmos db_hook". 👁 New DAG added
   
4. 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 cosmos db_hook.py file and export the results as a CSV to whichever file path we designated in our code. 👁 Run the DAG
   
5. 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. 👁 CSV created
   
6. Open the CSV file to see that your Cosmos DB data is now available for use in CSV format thanks to Apache Airflow. 👁 CSV file with Cosmos DB data.
   

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for Cosmos DB and start working with your live Cosmos DB data in Apache Airflow. Reach out to our Support Team if you have any questions.