• 主页
• Airflow 的公共接口
• airflow.models.xcom

airflow.models.xcom

模块内容

类

BaseXCom

XCom 对象的基础类。

函数

resolve_xcom_backend()

解析自定义 XCom 类。

属性

日志
XCom

airflow.models.xcom.log

class airflow.models.xcom.BaseXCom(name, doc)

基类：airflow.models.base.TaskInstanceDependencies, airflow.utils.log.logging_mixin.LoggingMixin

XCom 对象的基础类。

__tablename__ = 'xcom'

dag_run_id

task_id

map_index

key

dag_id

run_id

value

timestamp

__table_args__ = ()

dag_run

execution_date

init_on_load()

在实例从数据库加载或以其他方式重建后执行；由 ORM 调用。

即从数据库加载时自动反序列化 Xcom 值。

__repr__()

返回 repr(self)。

static get_value(*, ti_key, key=None, session=NEW_SESSION)

检索任务实例的 XCom 值。

此方法返回“完整”的 XCom 值（即使用 XCom 后端的 deserialize_value）。如果您想要通过 orm_deserialize_value 获取“缩短的”值，请使用 get_many()。

如果没有结果，则返回None。如果多个 XCom 条目符合条件，则返回任意一个。

参数

• ti_key (airflow.models.taskinstancekey.TaskInstanceKey) – 用于查找 XCom 的 TaskInstanceKey。

• key (str | None) – XCom 的键。如果提供，则仅返回具有匹配键的 XCom。传递None（默认）以删除过滤器。

• session (sqlalchemy.orm.Session) – 数据库会话。如果未给定，将为此函数创建一个新的会话。

classmethod delete(xcoms, session)

删除一个或多个 XCom 条目。

static purge(xcom, session)

从底层存储实现中清除 XCom 条目。

static serialize_value(value, *, key=None, task_id=None, dag_id=None, run_id=None, map_index=None)

将 XCom 值序列化为 str 或 pickle 对象。

静态 deserialize_value(result)

从字符串或pickle对象反序列化XCom值。

orm_deserialize_value()

反序列化方法，用于重建ORM XCom对象。

在创建XCom orm模型时，为了避免不必要的请求或其他资源消耗操作，应在自定义XCom后端中覆盖此方法。例如，这用于在Web服务器中查看XCom列表时。

airflow.models.xcom.resolve_xcom_backend()

解析自定义 XCom 类。

确认自定义XCom类扩展了BaseXCom。比较自定义XCom的serialize_value函数签名与基本XCom的serialize_value函数签名。

airflow.models.xcom.XCom

上一个 下一个

此条目是否有帮助？