josh-fell commented on code in PR #23979: URL: https://github.com/apache/airflow/pull/23979#discussion_r889237549
########## airflow/providers/presto/transfers/presto_to_slack.py: ########## @@ -0,0 +1,141 @@ +# 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.models import BaseOperator +from airflow.providers.presto.hooks.presto import PrestoHook +from airflow.providers.slack.hooks.slack_webhook import SlackWebhookHook + +if TYPE_CHECKING: + from airflow.utils.context import Context + + +class PrestoToSlackOperator(BaseOperator): + """ + Executes a single SQL statement in Presto 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:PrestoToSlackOperator` + + :param sql: The SQL statement to execute on Presto (templated) + :param slack_message: The templated Slack message to send with the data returned from Presto. + You can use the default JINJA variable {{ results_df }} to access the pandas dataframe containing the + SQL results + :param presto_conn_id: destination presto connection + :param slack_conn_id: The connection id for Slack + :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 + :param slack_token: The token to use to authenticate to Slack. If this is not provided, the + 'webhook_token' attribute needs to be specified in the 'Extra' JSON field against the slack_conn_id + :param slack_channel: The channel to send message. Override default from Slack connection. + """ + + template_fields: Sequence[str] = ('sql', 'slack_message') Review Comment: WDYT about adding `slack_channel` as well? I was thinking maybe users would configure the Slack channel as an Airflow variable which could be accessed via Jinja. ########## docs/apache-airflow-providers-presto/operators/transfer/presto_to_slack.rst: ########## @@ -0,0 +1,37 @@ + .. 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. + +.. _howto/operator:PrestoToSlackOperator: + +PrestoToSlackOperator +======================== + +Use the :class:`~airflow.providers.presto.transfers.presto_to_slack.presto_to_slack` to post messages to predefined Slack +channels. + +Using the Operator +^^^^^^^^^^^^^^^^^^ + +This operator will execute a custom query on a selected Presto table and publish a Slack message that can be formatted +and contain the resulting dataset (e.g. ASCII formatted dataframe). + +An example usage of the PrestoToSlackOperator is as follows: + +.. exampleinclude:: /../../tests/system/providers/presto/example_presto_to_slack.py + :language: python Review Comment: ```suggestion :language: python :indent: 4 ``` ########## docs/apache-airflow-providers-presto/operators/transfer/presto_to_slack.rst: ########## @@ -0,0 +1,37 @@ + .. 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. + +.. _howto/operator:PrestoToSlackOperator: + +PrestoToSlackOperator +======================== + +Use the :class:`~airflow.providers.presto.transfers.presto_to_slack.presto_to_slack` to post messages to predefined Slack +channels. + +Using the Operator +^^^^^^^^^^^^^^^^^^ + +This operator will execute a custom query on a selected Presto table and publish a Slack message that can be formatted Review Comment: ```suggestion This operator will execute a custom query in Presto and publish a Slack message that can be formatted ``` The query can involve more than 1 Presto table right? -- 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
