airflow.providers.standard.operators.trigger_dagrun¶
属性¶
类¶
TriggerDagRunOperator 的 Operator 链接。 |
|
为指定的 DAG ID 触发一个 DAG 运行。 |
模块内容¶
- airflow.providers.standard.operators.trigger_dagrun.XCOM_LOGICAL_DATE_ISO = 'trigger_logical_date_iso'[源代码]¶
- class airflow.providers.standard.operators.trigger_dagrun.TriggerDagRunLink[源代码]¶
基类:
airflow.sdk.BaseOperatorLink
TriggerDagRunOperator 的 Operator 链接。
它允许用户访问由 TriggerDagRunOperator 触发的 DAG。
- get_link(operator, *, ti_key)[源代码]¶
外部系统的链接。
- 参数::
operator (airflow.models.BaseOperator) – 此链接关联的 Airflow operator 对象。
ti_key (airflow.models.taskinstancekey.TaskInstanceKey) – 要返回链接的 TaskInstance ID。
- 返回::
外部系统的链接
- 返回类型::
- class airflow.providers.standard.operators.trigger_dagrun.TriggerDagRunOperator(*, trigger_dag_id, trigger_run_id=None, conf=None, logical_date=NOTSET, reset_dag_run=False, wait_for_completion=False, poke_interval=60, allowed_states=None, failed_states=None, skip_when_already_exists=False, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[源代码]¶
基类:
airflow.models.BaseOperator
为指定的 DAG ID 触发一个 DAG 运行。
请注意,如果启用了数据库隔离模式,则并非所有功能都受支持。
- 参数::
trigger_dag_id (str) – 要触发的 DAG 的
dag_id
(模板化)。trigger_run_id (str | None) – 用于触发的 DAG 运行的 run ID(模板化)。如果未提供,将自动生成 run ID。
conf (dict | None) – DAG 运行的配置(模板化)。
logical_date (str | datetime.datetime | None | airflow.utils.types.ArgNotSet) – 触发的 DAG 的逻辑日期(模板化)。
reset_dag_run (bool) – 是否清除已存在的 DAG 运行。这在回填或重新运行现有 DAG 运行时很有用。这只会重置(而不是重新创建)DAG 运行。DAG 运行 conf 是不可变的,在重新运行现有 DAG 运行时不会重置。当 reset_dag_run=False 且 DAG 运行存在时,将引发 DagRunAlreadyExists 异常。当 reset_dag_run=True 且 DAG 运行存在时,将清除现有 DAG 运行以重新运行。
wait_for_completion (bool) – 是否等待 DAG 运行完成。(默认值:False)
poke_interval (int) – 当 wait_for_completion=True 时检查 DAG 运行状态的轮询间隔。(默认值:60)
allowed_states (list[str | airflow.utils.state.DagRunState] | None) – 触发的 DAG 运行允许的状态列表(可选)。这在设置
wait_for_completion
为 True 时很有用。必须是有效的 DagRunState。默认值是[DagRunState.SUCCESS]
。failed_states (list[str | airflow.utils.state.DagRunState] | None) – 触发的 DAG 运行失败或不允许的状态列表(可选)。这在设置
wait_for_completion
为 True 时很有用。必须是有效的 DagRunState。默认值是[DagRunState.FAILED]
。skip_when_already_exists (bool) – 如果触发的 DAG 在相同的逻辑日期已经存在一个 DAG 运行,则设置为 true 会将任务标记为 SKIPPED。
deferrable (bool) – 如果等待完成,是否延迟任务直到完成,默认值是
False
。
- template_fields: collections.abc.Sequence[str] = ('trigger_dag_id', 'trigger_run_id', 'logical_date', 'conf', 'wait_for_completion',...[源代码]¶