How to use xcom_pull to get a variable from another DAG
In this article, I will show you how to get an XCOM variable from another Airflow DAG.
Please remember that it is not the recommended way of writing Airflow DAGs because DAGs should be independent of each other.
Airflow, however, does not stop us from using XCOM to communicate between DAGs. Here is a description of how we can do that:
- First, we need a reference to the task instance. We can get that, for example, in the PythonOperator when we set the
provide_context
parameter toTrue
:
1
2
3
4
5
6
some_task = PythonOperator(
task_id='the_task_id',
python_callable=function_name,
provide_context=True,
dag=dag
)
When we do that, the function gets the DAG context as the parameter, and we can extract the task instance from the context:
1
2
def function_name(**kwargs):
task_instance = kwargs['task_instance']
- Now, we can use the
xcom_pull
function to get the variable. Note that I have to specify both the name of the task that published the variable and the DAG identifier:
1
task_instance.xcom_pull(dag_id='dag_id', task_ids='task_id', key="variable_name")
There is one caveat that makes this approach almost useless. Both DAGs must have the same execution date. It is caused by the implementation of xcom_pull
in the TaskInstance class. The code in the Airflow repository looks like this:
1
2
3
4
5
6
7
8
query = XCom.get_many(
execution_date=self.execution_date,
key=key,
dag_ids=dag_id,
task_ids=task_ids,
include_prior_dates=include_prior_dates,
session=session,
).with_entities(XCom.value)
Would you like to help fight youth unemployment while getting mentoring experience?
Develhope is looking for tutors (part-time, freelancers) for their upcoming Data Engineer Courses.
The role of a tutor is to be the point of contact for students, guiding them throughout the 6-month learning program. The mentor supports learners through 1:1 meetings, giving feedback on assignments, and responding to messages in Discord channels—no live teaching sessions.
Expected availability: 15h/week. You can schedule the 1:1 sessions whenever you want, but the sessions must happen between 9 - 18 (9 am - 6 pm) CEST Monday-Friday.
Check out their job description.
(free advertisement, no affiliate links)
You may also like