Source code for airflow.sensors.sql_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 builtins import str
from typing import Iterable

from airflow.exceptions import AirflowException
from airflow.hooks.base_hook import BaseHook
from airflow.sensors.base_sensor_operator import BaseSensorOperator
from airflow.utils.decorators import apply_defaults

[docs]class SqlSensor(BaseSensorOperator): """ Runs a sql statement repeatedly until a criteria is met. It will keep trying until success or failure criteria are met, or if the first cell is not in (0, '0', '', None). An allow_null parameter exclude 'None' results from failure criteria. Optional success and failure callables are called with the first cell returned as the argument. If success callable is defined the sensor will keep retrying until the criteria is met. If failure callable is defined and the criteria is met the sensor will raise AirflowException. Failure criteria is evaluated before success criteria. A fail_on_empty boolean can also be passed to the sensor in which case it will fail if no rows have been returned :param conn_id: The connection to run the sensor against :type conn_id: str :param sql: The sql to run. To pass, it needs to return at least one cell that contains a non-zero / empty string value. :type sql: str :param parameters: The parameters to render the SQL query with (optional). :type parameters: mapping or iterable :param success: Success criteria for the sensor is a Callable that takes first_cell as the only argument, and returns a boolean (optional). :type: success: Optional<Callable[[Any], bool]> :param failure: Failure criteria for the sensor is a Callable that takes first_cell as the only argument and return a boolean (optional). :type: failure: Optional<Callable[[Any], bool]> :param fail_on_empty: Explicitly fail on no rows returned. :type: fail_on_empty: bool :param allow_null: Treat NULL in first cell as success. :type: allow_null: bool """
[docs] template_fields = ('sql',) # type: Iterable[str]
[docs] template_ext = ('.hql', '.sql',) # type: Iterable[str]
[docs] ui_color = '#7c7287'
@apply_defaults def __init__(self, conn_id, sql, parameters=None, success=None, failure=None, fail_on_empty=False, allow_null=True, *args, **kwargs): self.conn_id = conn_id self.sql = sql self.parameters = parameters self.success = success self.failure = failure self.fail_on_empty = fail_on_empty self.allow_null = allow_null super(SqlSensor, self).__init__(*args, **kwargs)
[docs] def _get_hook(self): conn = BaseHook.get_connection(self.conn_id) allowed_conn_type = {'google_cloud_platform', 'jdbc', 'mssql', 'mysql', 'oracle', 'postgres', 'presto', 'snowflake', 'sqlite', 'vertica'} if conn.conn_type not in allowed_conn_type: raise AirflowException("The connection type is not supported by SqlSensor. " + "Supported connection types: {}".format(list(allowed_conn_type))) return conn.get_hook()
[docs] def poke(self, context): hook = self._get_hook()'Poking: %s (with parameters %s)', self.sql, self.parameters) records = hook.get_records(self.sql, self.parameters) if not records: if self.fail_on_empty: raise AirflowException("No rows returned, raising as per fail_on_empty flag") else: return False first_cell = records[0][0] if self.failure is not None: if callable(self.failure): if self.failure(first_cell): raise AirflowException( "Failure criteria met. self.failure({}) returned True".format(first_cell)) else: raise AirflowException("self.failure is present, but not callable -> {}".format(self.success)) if self.success is not None: if callable(self.success): return self.success(first_cell) else: raise AirflowException("self.success is present, but not callable -> {}".format(self.success)) if self.allow_null: return first_cell is None or bool(first_cell) return bool(first_cell)

Was this entry helpful?