airflow.providers.snowflake.transfers.snowflake_to_slack

Module Contents

class airflow.providers.snowflake.transfers.snowflake_to_slack.SnowflakeToSlackOperator(*, sql: str, slack_message: str, snowflake_conn_id: str = 'snowflake_default', slack_conn_id: str = 'slack_default', results_df_name: str = 'results_df', parameters: Optional[Union[Iterable, Mapping]] = None, warehouse: Optional[str] = None, database: Optional[str] = None, schema: Optional[str] = None, role: Optional[str] = None, slack_token: Optional[str] = None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Executes an SQL statement in Snowflake 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: SnowflakeToSlackOperator

Parameters

  • sql (str) – The SQL statement to execute on Snowflake (templated)

  • slack_message (str) – 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

  • snowflake_conn_id (str) – The Snowflake connection id

  • slack_conn_id (str) – The connection id for Slack

  • 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

  • warehouse (Optional[str]) – The Snowflake virtual warehouse to use to run the SQL query

  • database (Optional[str]) – The Snowflake database to use for the SQL query

  • schema (Optional[str]) – The schema to run the SQL against in Snowflake

  • role (Optional[str]) – The role to use when connecting to Snowflake

  • slack_token (Optional[str]) – 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

template_fields = ['sql', 'slack_message'][source]
template_ext = ['.sql', '.jinja', '.j2'][source]
template_fields_renderers[source]
times_rendered = 0[source]
_get_query_results(self)[source]
_render_and_send_slack_message(self, context, df)[source]
_get_snowflake_hook(self)[source]
_get_slack_hook(self)[source]
render_template_fields(self, context, jinja_env=None)[source]
execute(self, context)[source]

Was this entry helpful?