airflow.providers.redis.sensors.redis_pub_sub

RedisPubSubSensor

用于从发布/订阅通道读取消息的 Redis 传感器。

模块内容

class airflow.providers.redis.sensors.redis_pub_sub.RedisPubSubSensor(*, channels, redis_conn_id, **kwargs)[source]

基类: airflow.sensors.base.BaseSensorOperator

用于从发布/订阅通道读取消息的 Redis 传感器。

参数:
  • channels (list[str] | str) – 要订阅的通道(可模板化)

  • redis_conn_id (str) – redis 连接 ID

template_fields: collections.abc.Sequence[str] = ('channels',)[source]
ui_color = '#f0eee4'[source]
channels[source]
redis_conn_id[source]
property pubsub[source]
poke(context)[source]

检查已订阅通道上的消息,并将类型为“message”的消息及其键 message 写入 xcom。

一个消息示例: {'type': 'message', 'pattern': None, 'channel': b'test', 'data': b'hello'}

参数:

context (airflow.sdk.definitions.context.Context) – 上下文对象

返回:

如果消息(类型为“message”)可用则返回 True,否则返回 False

返回类型:

bool

此条目是否有帮助?