airflow.models.xcom

Module Contents

airflow.models.xcom.log[source]
airflow.models.xcom.MAX_XCOM_SIZE = 49344[source]
airflow.models.xcom.XCOM_RETURN_KEY = return_value[source]
class airflow.models.xcom.BaseXCom[source]

Bases: airflow.models.base.Base, airflow.utils.log.logging_mixin.LoggingMixin

Base class for XCom objects.

__tablename__ = xcom[source]
id[source]
key[source]
value[source]
timestamp[source]
execution_date[source]
task_id[source]
dag_id[source]
__table_args__[source]

TODO: “pickling” has been deprecated and JSON is preferred. “pickling” will be removed in Airflow 2.0.

init_on_load(self)[source]
__repr__(self)[source]
classmethod set(cls, key, value, execution_date, task_id, dag_id, session=None)[source]

Store an XCom value.

Returns

None

classmethod get_one(cls, execution_date, key=None, task_id=None, dag_id=None, include_prior_dates=False, session=None)[source]

Retrieve an XCom value, optionally meeting certain criteria. TODO: “pickling” has been deprecated and JSON is preferred. “pickling” will be removed in Airflow 2.0.

Returns

XCom value

classmethod get_many(cls, execution_date, key=None, task_ids=None, dag_ids=None, include_prior_dates=False, limit=100, session=None)[source]

Retrieve an XCom value, optionally meeting certain criteria TODO: “pickling” has been deprecated and JSON is preferred. “pickling” will be removed in Airflow 2.0.

classmethod delete(cls, xcoms, session=None)[source]
static serialize_value(value)[source]
airflow.models.xcom.resolve_xcom_backend()[source]
Resolves custom XCom class
airflow.models.xcom.XCom[source]