This is an automated email from the ASF dual-hosted git repository.
jason810496 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 2184b1da543 Document that Dag run conf is meant for small metadata
(#76437)
2184b1da543 is described below
commit 2184b1da5435d0b1645724c7f612e3b26045d162
Author: Chao-Hung Wan <[email protected]>
AuthorDate: Thu Nov 19 21:33:50 2026 +0800
Document that Dag run conf is meant for small metadata (#76437)
* add conf note
Signed-off-by: Xch1 <[email protected]>
* Address review: use the Oxford comma and clarify the conf note wording
---------
Signed-off-by: Xch1 <[email protected]>
---
airflow-core/docs/core-concepts/dag-run.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/airflow-core/docs/core-concepts/dag-run.rst
b/airflow-core/docs/core-concepts/dag-run.rst
index 5531625709d..82c0f881751 100644
--- a/airflow-core/docs/core-concepts/dag-run.rst
+++ b/airflow-core/docs/core-concepts/dag-run.rst
@@ -346,6 +346,12 @@ Example of a parameterized Dag:
**Note**: The parameters from ``dag_run.conf`` can only be used in a template
field of an operator.
+.. note::
+
+ ``dag_run.conf`` is meant for small metadata, such as a path, a table name,
or an identifier. The entire value is stored in
+ the metadata database and sent to every task worker process on startup.
Avoid putting large payloads in it. Use a
+ reference instead, and have the task read the actual data from external
storage.
+
Wait for a Dag Run
------------------