airflow.providers.slack.transfers.sql_to_slack¶
類¶
在給定的 SQL 連線中執行 SQL 語句並將結果作為檔案傳送到 Slack API。 |
模組內容¶
- class airflow.providers.slack.transfers.sql_to_slack.SqlToSlackApiFileOperator(*, sql, sql_conn_id, sql_hook_params=None, parameters=None, slack_conn_id=SlackHook.default_conn_name, slack_filename, slack_channels=None, slack_initial_comment=None, slack_title=None, slack_base_url=None, slack_method_version='v2', df_kwargs=None, action_on_empty_df='send', **kwargs)[source]¶
基類:
airflow.providers.slack.transfers.base_sql_to_slack.BaseSqlToSlackOperator在給定的 SQL 連線中執行 SQL 語句並將結果作為檔案傳送到 Slack API。
另請參閱
有關如何使用此 operator 的更多資訊，請參閱指南：SqlToSlackApiFileOperator
- 引數:
sql (str) – 要執行的 SQL 查詢
sql_conn_id (str) – 對特定 DB-API 連線的引用。
slack_conn_id (str) – Slack API 連線。
slack_filename (str) – 在 slack 中顯示的檔名。應包含
SUPPORTED_FILE_FORMATS中引用的受支援的副檔名。也可以在副檔名中設定壓縮：filename.csv.gzip、filename.json.zip等。sql_hook_params (dict | None) – 要傳遞給底層 hook 的額外配置引數。應匹配所需的 hook 建構函式引數。
parameters (list | tuple | collections.abc.Mapping[str, Any] | None) – 要傳遞給 SQL 查詢的引數。
slack_channels (str | collections.abc.Sequence[str] | None) – 檔案將要共享的頻道名稱或 ID 的逗號分隔列表。如果省略此引數，檔案將傳送到工作區。
slack_initial_comment (str | None) – 在指定的
slack_channels中介紹檔案的訊息文字。slack_title (str | None) – 檔案標題。
slack_base_url (str | None) – 表示 Slack API 基礎 URL 的字串。可選
slack_method_version (typing_extensions.Literal[v1, v2]) – 要使用的 Slack SDK Client 方法的版本，可以是“v1”或“v2”。
df_kwargs (dict | None) – 轉發到
pandas.DataFrame.to_{format}()方法的關鍵字引數。action_on_empty_df (typing_extensions.Literal[send, skip, error]) –
指定如何處理空的 SQL 輸出資料框。可能的值
send: (預設) 傳送帶有空檔案的 slack 訊息。skip: 跳過傳送 slack 訊息。任務狀態設定為“skipped”。error: 引發錯誤以使任務失敗。任務狀態設定為“failed”。
- template_fields: collections.abc.Sequence[str] = ('sql', 'slack_channels', 'slack_filename', 'slack_initial_comment', 'slack_title')[source]¶
- template_ext: collections.abc.Sequence[str] = ('.sql', '.jinja', '.j2')[source]¶
- SUPPORTED_FILE_FORMATS: collections.abc.Sequence[str] = ('csv', 'json', 'html')[source]¶