eladkal commented on code in PR #24663: URL: https://github.com/apache/airflow/pull/24663#discussion_r906800914
########## airflow/providers/slack/transfers/sql_to_slack.py: ########## @@ -0,0 +1,166 @@ +# 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. + +from typing import TYPE_CHECKING, Iterable, Mapping, Optional, Sequence, Union + +from pandas import DataFrame +from tabulate import tabulate + +from airflow.exceptions import AirflowException +from airflow.hooks.base import BaseHook +from airflow.hooks.dbapi import DbApiHook +from airflow.models import BaseOperator +from airflow.providers.slack.hooks.slack_webhook import SlackWebhookHook + +if TYPE_CHECKING: + from airflow.utils.context import Context + + +class SqlToSlackOperator(BaseOperator): + """ + Executes an SQL statement in a given SQL connection and sends the results to Slack. The results of the + query are rendered into the 'slack_message' parameter as a Pandas dataframe using a JINJA variable called + '{{ results_df }}'. The 'results_df' variable name can be changed by specifying a different + 'results_df_name' parameter. The Tabulate library is added to the JINJA environment as a filter to + allow the dataframe to be rendered nicely. For example, set 'slack_message' to {{ results_df | + tabulate(tablefmt="pretty", headers="keys") }} to send the results to Slack as an ascii rendered table. + + .. seealso:: + For more information on how to use this operator, take a look at the guide: + :ref:`howto/operator:SqlToSlackOperator` + + :param sql: The SQL statement to execute on Snowflake (templated) + :param slack_message: The templated Slack message to send with the data returned from Snowflake. + You can use the default JINJA variable {{ results_df }} to access the pandas dataframe containing the + SQL results + :param sql_conn_id: Reference to + :ref:`Snowflake connection id<howto/connection:snowflake>` + :param slack_conn_id: The connection id for Slack. Mutually exclusive with 'slack_webhook_token' + :param slack_webhook_token: The token to use to authenticate to Slack. If this is not provided, the + 'slack_conn_id' attribute needs to be specified in the 'Extra' JSON field. + Mutually exclusive with 'slack_conn_id'. + :param slack_channel: The channel to send message. Override default from Slack connection. + :param results_df_name: The name of the JINJA template's dataframe variable, default is 'results_df' + :param parameters: The parameters to pass to the SQL query + """ + + template_fields: Sequence[str] = ('sql', 'slack_message') + template_ext: Sequence[str] = ('.sql', '.jinja', '.j2') + template_fields_renderers = {"sql": "sql", "slack_message": "jinja"} + times_rendered = 0 + + def __init__( + self, + *, + sql: str, + sql_conn_id: str, + slack_conn_id: Optional[str] = None, + slack_webhook_token: Optional[str] = None, + slack_channel: Optional[str] = None, + slack_message: str, + results_df_name: str = 'results_df', + parameters: Optional[Union[Iterable, Mapping]] = None, + **kwargs, Review Comment: If I'm reading this right you are mixing between kwargs for BaseOperator and also kwargs for the underlying hook (SowflakeHook, PrestoHook, etc..) I don't think this is right. We should have a dedicated dict to pass the hook params similar to what we have in `SqlSensor` https://github.com/apache/airflow/blob/37ab8fc76b4d977914ed54fc392b14cdb478d9d1/airflow/sensors/sql.py#L67-L68 To give specific example: ``` SqlToSlackOperator( ..., retries=3, hook_params= {"warehouse": "my_warehouse"} ) ``` Did I miss something? -- 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
