airflow.providers.common.sql.sensors.sql

Module Contents

Classes

SqlSensor

Run a sql statement repeatedly until a criteria is met.
class airflow.providers.common.sql.sensors.sql.SqlSensor(*, conn_id, sql, parameters=None, success=None, failure=None, fail_on_empty=False, hook_params=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Run a sql statement repeatedly until a criteria is met.

This will keep trying until success or failure criteria are met, or if the first cell is not either 0, '0', '', or None. 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.

Parameters

  • conn_id – The connection to run the sensor against

  • sql – The sql to run. To pass, it needs to return at least one cell that contains a non-zero / empty string value.

  • parameters – The parameters to render the SQL query with (optional).

  • success – Success criteria for the sensor is a Callable that takes first_cell as the only argument, and returns a boolean (optional).

  • failure – Failure criteria for the sensor is a Callable that takes first_cell as the only argument and return a boolean (optional).

  • fail_on_empty – Explicitly fail on no rows returned.

  • hook_params – Extra config params to be passed to the underlying hook. Should match the desired hook constructor params.

template_fields: Sequence[str] = ('sql', 'hook_params')[source]
template_ext: Sequence[str] = ('.hql', '.sql')[source]
ui_color = '#7c7287'[source]
poke(context)[source]

Override when deriving this class.

Was this entry helpful?