SqlSensor

Apache Airflow Certified

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). 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

View on GitHub

Last Updated: Jun. 3, 2021

Access Instructions

Install the Apache Airflow provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

conn_idRequiredstrThe connection to run the sensor against
sqlRequiredstrThe sql to run. To pass, it needs to return at least one cell that contains a non-zero / empty string value.
parametersdict or iterableThe parameters to render the SQL query with (optional).
successSuccess criteria for the sensor is a Callable that takes first_cell as the only argument, and returns a boolean (optional).
failureFailure criteria for the sensor is a Callable that takes first_cell as the only argument and return a boolean (optional).
fail_on_emptyExplicitly fail on no rows returned.

Documentation

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). 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

Was this page helpful?