airflow.operators.trigger_dagrun

模块内容

类

TriggerDagRunLink

用于 TriggerDagRunOperator 的操作符链接。

TriggerDagRunOperator

为指定的 DAG ID 触发 DAG 运行。

属性

XCOM_LOGICAL_DATE_ISO

XCOM_RUN_ID

airflow.operators.trigger_dagrun.XCOM_LOGICAL_DATE_ISO = 'trigger_logical_date_iso'[源代码]
airflow.operators.trigger_dagrun.XCOM_RUN_ID = 'trigger_run_id'[源代码]

基类: airflow.models.baseoperatorlink.BaseOperatorLink

用于 TriggerDagRunOperator 的操作符链接。

它允许用户访问使用 TriggerDagRunOperator 触发的任务的 DAG。

name = 'Triggered DAG'[源代码]

链接到外部系统。

注意：此函数的旧签名是 (self, operator, dttm: datetime)。运行时仍然支持该签名，但已弃用。

参数
返回

链接到外部系统

返回类型

str

class airflow.operators.trigger_dagrun.TriggerDagRunOperator(*, trigger_dag_id, trigger_run_id=None, conf=None, logical_date=None, 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), execution_date=None, **kwargs)[源代码]

基类: airflow.models.baseoperator.BaseOperator

为指定的 DAG ID 触发 DAG 运行。

请注意，如果启用了数据库隔离模式，则并非所有功能都受支持。

参数

  • trigger_dag_id (str) – 要触发的 DAG 的 dag_id （已模板化）。

  • trigger_run_id (str | None) – 用于触发的 DAG 运行的运行 ID （已模板化）。如果未提供，将自动生成运行 ID。

  • conf (dict | None) – DAG 运行的配置（已模板化）。

  • logical_date (str | datetime.datetime | None) – 触发的 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 允许的 DAG 运行状态的可选列表。当将 wait_for_completion 设置为 True 时，这非常有用。必须是有效的 DagRunState。默认值为 [DagRunState.SUCCESS]。

  • failed_states (list[str | airflow.utils.state.DagRunState] | None) – 触发的 DAG 的失败或不允许的 DAG 运行状态的可选列表。当将 wait_for_completion 设置为 True 时，这非常有用。必须是有效的 DagRunState。默认值为 [DagRunState.FAILED]。

  • skip_when_already_exists (bool) – 如果同一逻辑日期的触发 DAG 的 DAG 运行已存在，则设置为 true 以将任务标记为 SKIPPED。

  • deferrable (bool) – 如果等待完成，是否将任务推迟到完成，默认值为 False。

  • execution_date (str | datetime.datetime | None) – 已弃用的参数；与 logical_date 相同。

template_fields: Sequence[str] = ('trigger_dag_id', 'trigger_run_id', 'logical_date', 'conf', 'wait_for_completion',...[源代码]
template_fields_renderers[源代码]
ui_color = '#ffefeb'[source]
execute(context)[source]

在创建操作符时派生。

上下文是与渲染Jinja模板时使用的相同字典。

有关更多上下文，请参考 get_template_context。

execute_complete(context, session, event)[source]

此条目是否有所帮助？