Airflow Summit 2025 is coming October 07-09. Register now to secure your spot!

airflow.providers.databricks.sensors.databricks

Attributes

XCOM_STATEMENT_ID_KEY

Classes

DatabricksSQLStatementsSensor

DatabricksSQLStatementsSensor.

Module Contents

airflow.providers.databricks.sensors.databricks.XCOM_STATEMENT_ID_KEY = 'statement_id'[source]
class airflow.providers.databricks.sensors.databricks.DatabricksSQLStatementsSensor(warehouse_id, *, statement=None, statement_id=None, catalog=None, schema=None, parameters=None, databricks_conn_id='databricks_default', polling_period_seconds=30, databricks_retry_limit=3, databricks_retry_delay=1, databricks_retry_args=None, do_xcom_push=True, wait_for_termination=True, timeout=3600, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]

Bases: airflow.providers.databricks.utils.mixins.DatabricksSQLStatementsMixin, airflow.sdk.bases.sensor.BaseSensorOperator

DatabricksSQLStatementsSensor.

template_fields: collections.abc.Sequence[str] = ('databricks_conn_id', 'statement', 'statement_id')[source]
template_ext: collections.abc.Sequence[str] = ('.json-tpl',)[source]
ui_color = '#1CB1C2'[source]
ui_fgcolor = '#fff'[source]
statement = None[source]
statement_id = None[source]
warehouse_id[source]
catalog = None[source]
schema = None[source]
parameters = None[source]
databricks_conn_id = 'databricks_default'[source]
polling_period_seconds = 30[source]
databricks_retry_limit = 3[source]
databricks_retry_delay = 1[source]
databricks_retry_args = None[source]
wait_for_termination = True[source]
deferrable = True[source]
timeout = 3600[source]
do_xcom_push = True[source]
execute(context)[source]

Derive when creating an operator.

The main method to execute the task. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

poke(context)[source]

Handle non-deferrable Sensor execution.

Parameters:

context (airflow.utils.context.Context) – (Context)

Returns:

(bool)

Was this entry helpful?