harishkrao commented on code in PR #28950: URL: https://github.com/apache/airflow/pull/28950#discussion_r1111577966
########## airflow/providers/databricks/sensors/databricks_sql.py: ########## @@ -0,0 +1,136 @@ +# +# 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 +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +"""This module contains Databricks sensors.""" + +from __future__ import annotations + +from typing import Any, Callable, Sequence + +from airflow.exceptions import AirflowException +from airflow.providers.common.sql.hooks.sql import fetch_all_handler +from airflow.providers.databricks.hooks.databricks_sql import DatabricksSqlHook +from airflow.sensors.base import BaseSensorOperator +from airflow.utils.context import Context + + +class DatabricksSqlSensor(BaseSensorOperator): + """Generic SQL sensor for Databricks + + :param databricks_conn_id: connection id from Airflow to databricks, + defaults to DatabricksSqlHook.default_conn_name + :param http_path: Optional string specifying HTTP path of + Databricks SQL Endpoint or cluster.If not specified, it should be either specified + in the Databricks connection's extra parameters, or ``sql_endpoint_name`` must be specified. + :param sql_endpoint_name: Optional name of Databricks SQL Endpoint. + If not specified, ``http_path`` must be provided as described above. + :param session_configuration: An optional dictionary of Spark session parameters. + Defaults to None. If not specified, it could be specified in the + Databricks connection's extra parameters. + :param http_headers: An optional list of (k, v) pairs that will be set as HTTP headers on every request. + :param client_parameters: Additional parameters internal to Databricks SQL Connector parameters. + :param sql: SQL query to be executed. + :param catalog: Database name/catalog name, defaults to "hive_metastore" + :param schema: Schema name, defaults to "default" + :param handler: The result handler which is called with the result of each statement. + """ + + template_fields: Sequence[str] = ( + "databricks_conn_id", + "sql", + "catalog", + "schema", + "http_headers", + ) + + template_ext: Sequence[str] = (".sql",) + template_fields_renderers = {"sql": "sql"} + + def __init__( + self, + *, + databricks_conn_id: str = DatabricksSqlHook.default_conn_name, + http_path: str | None = None, + sql_endpoint_name: str | None = None, + session_configuration=None, + http_headers: list[tuple[str, str]] | None = None, + catalog: str = "hive_metastore", + schema: str = "default", + sql: str | None = None, + handler: Callable[[Any], Any] = fetch_all_handler, + client_parameters: dict[str, Any] | None = None, + **kwargs, + ) -> None: + """_summary_ + + :param databricks_conn_id: _description_, defaults to DatabricksSqlHook.default_conn_name + :param http_path: _description_, defaults to None + :param sql_endpoint_name: _description_, defaults to None + :param session_configuration: _description_, defaults to None + :param http_headers: _description_, defaults to None + :param catalog: _description_, defaults to "hive_metastore" + :param schema: _description_, defaults to "default" + :param sql: _description_, defaults to None + :param handler: _description_, defaults to fetch_all_handler + :param client_parameters: _description_, defaults to None + """ + super().__init__(**kwargs) + self.databricks_conn_id = databricks_conn_id + self._http_path = http_path + self._sql_endpoint_name = sql_endpoint_name + self.session_config = session_configuration + self.http_headers = http_headers + self.catalog = catalog + self.schema = schema + self.sql = sql + self.caller = "DatabricksSqlSensor" + self.client_parameters = client_parameters or {} + self.hook_params = kwargs.pop("hook_params", {}) + self.handler = handler + + def _get_hook(self) -> DatabricksSqlHook: + return DatabricksSqlHook( + self.databricks_conn_id, + self._http_path, + self._sql_endpoint_name, + self.session_config, + self.http_headers, + self.catalog, + self.schema, + self.caller, + **self.client_parameters, + **self.hook_params, + ) + + def _sql_sensor(self, sql): + hook = self._get_hook() + sql_result = hook.run( + sql, + handler=self.handler if self.do_xcom_push else None, + ) + return sql_result + + def _get_results(self) -> bool: + result = self._sql_sensor(self.sql) + self.log.debug("SQL result: %s", result) + if len(result) < 1: + raise AirflowException("No results for SQL sensor.") Review Comment: I tried to solve this multiple times before submitting the PR to have it return `False`, but it goes into an infinite loop when set to False (saw this in a few other sensors' code as well). So, I added the exception to be raised, making that task instance to fail. I couldn't make it work any other way. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
