airflow.providers.slack.transfers.sql_to_slack

Module Contents

Classes

SqlToSlackOperator

Executes an SQL statement in a given SQL connection and sends the results to Slack. The results of the
class airflow.providers.slack.transfers.sql_to_slack.SqlToSlackOperator(*, sql, sql_conn_id, sql_hook_params=None, slack_conn_id=None, slack_webhook_token=None, slack_channel=None, slack_message, results_df_name='results_df', parameters=None, **kwargs)[source]

Bases: airflow.models.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.

See also

For more information on how to use this operator, take a look at the guide: SqlToSlackOperator

Parameters

  • sql (str) – The SQL query to be executed (templated)

  • slack_message (str) – The templated Slack message to send with the data returned from the SQL connection. You can use the default JINJA variable {{ results_df }} to access the pandas dataframe containing the SQL results

  • sql_conn_id (str) – reference to a specific database.

  • sql_hook_params (Optional[dict]) – Extra config params to be passed to the underlying hook. Should match the desired hook constructor params.

  • slack_conn_id (Optional[str]) – The connection id for Slack.

  • slack_webhook_token (Optional[str]) – The token to use to authenticate to Slack. If this is not provided, the ‘slack_conn_id’ attribute needs to be specified in the ‘password’ field.

  • slack_channel (Optional[str]) – The channel to send message. Override default from Slack connection.

  • results_df_name (str) – The name of the JINJA template’s dataframe variable, default is ‘results_df’

  • parameters (Optional[Union[Iterable, Mapping]]) – The parameters to pass to the SQL query

template_fields :Sequence[str] = ['sql', 'slack_message'][source]
template_ext :Sequence[str] = ['.sql', '.jinja', '.j2'][source]
template_fields_renderers[source]
times_rendered = 0[source]
render_template_fields(context, jinja_env=None)[source]

Template all attributes listed in template_fields.

This mutates the attributes in-place and is irreversible.

Parameters

  • context – Dict with values to apply on content

  • jinja_env – Jinja environment

execute(context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?