Source code for airflow.contrib.sensors.redis_key_sensor

# -*- coding: utf-8 -*-
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from airflow.contrib.hooks.redis_hook import RedisHook
from airflow.sensors.base_sensor_operator import BaseSensorOperator
from airflow.utils.decorators import apply_defaults

[docs]class RedisKeySensor(BaseSensorOperator): """ Checks for the existence of a key in a Redis database """ template_fields = ('key',) ui_color = '#f0eee4' @apply_defaults def __init__(self, key, redis_conn_id, *args, **kwargs): """ Create a new RedisKeySensor :param key: The key to be monitored :type key: string :param redis_conn_id: The connection ID to use when connecting to Redis DB. :type redis_conn_id: string """ super(RedisKeySensor, self).__init__(*args, **kwargs) self.redis_conn_id = redis_conn_id self.key = key
[docs] def poke(self, context):'Sensor check existence of key: %s', self.key) return RedisHook(self.redis_conn_id).key_exists(self.key)