harishkrao commented on code in PR #28950: URL: https://github.com/apache/airflow/pull/28950#discussion_r1102114019
########## airflow/providers/databricks/sensors/databricks_table_changes.py: ########## @@ -0,0 +1,164 @@ +# +# 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 datetime import datetime, timedelta +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.providers.databricks.sensors.databricks_sql import DatabricksSqlSensor +from airflow.utils.context import Context + + +class DatabricksTableChangesSensor(DatabricksSqlSensor): + """Sensor to detect changes in a Delta table. + + + :param databricks_conn_id: Reference to :ref:`Databricks + connection id<howto/connection:databricks>` (templated), 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, defaults to None + :param session_configuration: An optional dictionary of Spark session parameters. If not specified, + it could be specified in the Databricks connection's extra parameters., defaults to None + :param http_headers: An optional list of (k, v) pairs + that will be set as HTTP headers on every request. (templated). + :param catalog: An optional initial catalog to use. + Requires DBR version 9.0+ (templated), defaults to "" + :param schema: An optional initial schema to use. + Requires DBR version 9.0+ (templated), defaults to "default" + :param table_name: Table name to generate the SQL query, defaults to "" + :param handler: Handler for DbApiHook.run() to return results, defaults to fetch_all_handler + :param caller: String passed to name a hook to Databricks, defaults to "DatabricksPartitionSensor" + :param client_parameters: Additional parameters internal to Databricks SQL Connector parameters. + :param timestamp: Timestamp to check event history for a Delta table, + defaults to datetime.now()-timedelta(days=7) + """ + + template_fields: Sequence[str] = ("databricks_conn_id", "catalog", "schema", "table_name", "timestamp") + + 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 = "", + schema: str = "default", + table_name: str = "", + handler: Callable[[Any], Any] = fetch_all_handler, + timestamp: datetime = datetime.now() - timedelta(days=7), + caller: str = "DatabricksTableChangesSensor", + client_parameters: dict[str, Any] | None = None, + **kwargs, + ) -> 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.table_name = table_name + self.timestamp = timestamp + self.caller = caller + 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 + + @staticmethod + def get_previous_version(context: Context, lookup_key): + return context["ti"].xcom_pull(key=lookup_key, include_prior_dates=True) + + @staticmethod + def set_version(context: Context, lookup_key, version): + context["ti"].xcom_push(key=lookup_key, value=version) + + def get_current_table_version(self, table_name, time_range): + change_sql = ( + f"SELECT COUNT(version) as versions from " Review Comment: Agree, will change it. ########## airflow/providers/databricks/sensors/databricks_table_changes.py: ########## @@ -0,0 +1,164 @@ +# +# 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 datetime import datetime, timedelta +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.providers.databricks.sensors.databricks_sql import DatabricksSqlSensor +from airflow.utils.context import Context + + +class DatabricksTableChangesSensor(DatabricksSqlSensor): + """Sensor to detect changes in a Delta table. + + + :param databricks_conn_id: Reference to :ref:`Databricks + connection id<howto/connection:databricks>` (templated), 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, defaults to None + :param session_configuration: An optional dictionary of Spark session parameters. If not specified, + it could be specified in the Databricks connection's extra parameters., defaults to None + :param http_headers: An optional list of (k, v) pairs + that will be set as HTTP headers on every request. (templated). + :param catalog: An optional initial catalog to use. + Requires DBR version 9.0+ (templated), defaults to "" + :param schema: An optional initial schema to use. + Requires DBR version 9.0+ (templated), defaults to "default" + :param table_name: Table name to generate the SQL query, defaults to "" + :param handler: Handler for DbApiHook.run() to return results, defaults to fetch_all_handler + :param caller: String passed to name a hook to Databricks, defaults to "DatabricksPartitionSensor" + :param client_parameters: Additional parameters internal to Databricks SQL Connector parameters. + :param timestamp: Timestamp to check event history for a Delta table, + defaults to datetime.now()-timedelta(days=7) + """ + + template_fields: Sequence[str] = ("databricks_conn_id", "catalog", "schema", "table_name", "timestamp") + + 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 = "", + schema: str = "default", + table_name: str = "", + handler: Callable[[Any], Any] = fetch_all_handler, + timestamp: datetime = datetime.now() - timedelta(days=7), + caller: str = "DatabricksTableChangesSensor", + client_parameters: dict[str, Any] | None = None, + **kwargs, + ) -> 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.table_name = table_name + self.timestamp = timestamp + self.caller = caller + 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 + + @staticmethod + def get_previous_version(context: Context, lookup_key): + return context["ti"].xcom_pull(key=lookup_key, include_prior_dates=True) + + @staticmethod + def set_version(context: Context, lookup_key, version): + context["ti"].xcom_push(key=lookup_key, value=version) + + def get_current_table_version(self, table_name, time_range): + change_sql = ( + f"SELECT COUNT(version) as versions from " + f"(DESCRIBE HISTORY {table_name}) " + f"WHERE timestamp >= '{time_range}'" Review Comment: I am working on this, will push the changes soon. -- 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
