airflow.providers.tableau.hooks.tableau¶

异常¶

TableauJobFailedException

表示作业未能完成的异常。

类¶

`TableauJobFinishCode`	完成代码表示作业的状态。
`TableauHook`	连接到 Tableau Server 实例并允许与其通信。

函数¶

parse_boolean(val)

尝试将字符串解析为布尔值。

模块内容¶

airflow.providers.tableau.hooks.tableau.parse_boolean(val)[source]¶

尝试将字符串解析为布尔值。

如果字符串看起来不像布尔值，则原样返回。

exception airflow.providers.tableau.hooks.tableau.TableauJobFailedException[source]¶

基类: airflow.exceptions.AirflowException

表示作业未能完成的异常。

class airflow.providers.tableau.hooks.tableau.TableauJobFinishCode[source]¶

基类: enum.Enum

完成代码表示作业的状态。

另请参见

https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job

PENDING = -1[source]¶

SUCCESS = 0[source]¶

ERROR = 1[source]¶

CANCELED = 2[source]¶

class airflow.providers.tableau.hooks.tableau.TableauHook(site_id=None, tableau_conn_id=default_conn_name)[source]¶

基类: airflow.hooks.base.BaseHook

连接到 Tableau Server 实例并允许与其通信。

可以用作上下文管理器：打开时自动认证连接，关闭时注销。

另请参见

https://tableau.github.io/server-client-python/docs/

参数:

site_id (str | None) – 工作簿所属站点的 ID。如果您未提供 ID，它将连接到默认站点。
tableau_conn_id (str) – 包含用于认证到 Tableau Server 的凭据的 Tableau 连接 ID。

conn_name_attr = 'tableau_conn_id'[source]¶

default_conn_name = 'tableau_default'[source]¶

conn_type = 'tableau'[source]¶

hook_name = 'Tableau'[source]¶

tableau_conn_id = 'tableau_default'[source]¶

conn[source]¶

site_id[source]¶

server[source]¶

tableau_conn = None[source]¶

__enter__()[source]¶

__exit__(exc_type, exc_val, exc_tb)[source]¶

get_conn()[source]¶

登录到 Tableau Server。

返回:: 一个已授权的 Tableau Server 上下文管理器对象。
返回类型:: tableauserverclient.server.Auth.contextmgr

get_all(resource_name)[source]¶

获取给定资源的所有项目。

参数:: resource_name (str) – 要分页的资源名称。例如：jobs 或 workbooks。
返回:: 通过返回 Pager 来获取所有项目。
返回类型:: tableauserverclient.Pager

get_job_status(job_id)[source]¶

获取已定义 Tableau 作业的当前状态。

参数:: job_id (str) – 要检查的作业 ID。
返回:: 描述 Tableau 作业返回代码的枚举。
返回类型:: TableauJobFinishCode

wait_for_state(job_id, target_state, check_interval)[source]¶

等待直到已定义 Tableau 作业的当前状态是 target_state 或与 PENDING 不同。

参数:

job_id (str) – 要检查的作业 ID。
target_state (TableauJobFinishCode) – 描述 Tableau 作业目标状态的枚举
check_interval (float) – 作业在每次实例状态检查之间应等待的时间（秒），直到操作完成

返回:

如果作业等于 target_status，则返回 True，否则返回 False。

返回类型:

bool