blob: a5a81e223e5558d41d81d77aa4a9ecdfbc7f67fb [file] [log] [blame]
:mod:`airflow.sensors.sql_sensor`
=================================
.. py:module:: airflow.sensors.sql_sensor
Module Contents
---------------
.. py:class:: SqlSensor(conn_id, sql, parameters=None, *args, **kwargs)
Bases::class:`airflow.sensors.base_sensor_operator.BaseSensorOperator`
Runs a sql statement until a criteria is met. It will keep trying while
sql returns no row, or if the first cell in (0, '0', '').
: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
.. attribute:: template_fields
:annotation: = ['sql']
.. attribute:: template_ext
:annotation: = ['.hql', '.sql']
.. attribute:: ui_color
:annotation: = #7c7287
.. method:: poke(self, context)