Tableau Connector SDK

  • 版本 :2022.1 及更高版本

Tableau 具有出色的连接性,可让您从几乎任何位置可视化数据。Tableau 已经包含数十个连接器,并且还为您提供了使用 Tableau 连接器 SDK 构建新连接器的工具。


使用此 SDK,可以创建一个连接器,该连接器可用于通过 ODBC 或 JDBC 驱动程序可视化任何数据库中的数据。您可以自定义连接器行为,微调 SQL 生成,在开发过程中使用连接测试工具验证连接器行为,然后将连接器打包并分发给用户。

什么是 Tableau 连接器?


连接器是一组文件,用于描述:

  • 收集用户输入以创建数据源连接所需的 UI 元素

  • 连接所需的任何方言或自定义

  • 如何使用 ODBC 或 JDBC 驱动程序进行连接

连接器可以具有任何内置 Tableau 连接器支持的大多数相同功能,包括发布到服务器(如果服务器具有连接器)、创建数据提取、数据源、可视化等。

使用此 SDK 开发的连接器适用于连接到使用 SQL 接口的 ODBC 或 JDBC 驱动程序。底层技术与关系数据库配合得很好。

请参阅连接器文件(蓝色)与 Tableau 连接窗格和连接对话框之间的关系:


为什么要构建连接器?


您可以使用“其他数据库 (ODBC)”和“其他数据库 (JDBC)”连接器连接到数据库。Tableau 连接器 SDK 与此类似,但具有以下优点:

  • 更好的实时查询支持。您可以自定义用于生成 SQL 查询的方言,以便它们与您的数据库兼容并针对您的数据库进行优化。其他数据库连接器依赖于可能并不总是合适的更高级别标准 SQL。

  • 更简单的连接体验。SDK 连接器可以提供自己的自定义方言,您无需依赖使用 DSN。用户无需输入晦涩难懂的 JDBC URL 字符串或创建 DSN 或配置 odbc.ini文件。连接器可以提供简单的自定义连接对话框。

  • 在 Tableau Desktop 和 Tableau Server 中运行。安装连接器后,无需进行任何配置。

如果您的数据源不适合关系 ODBC/JDBC 模型,则可能值得研究 Web 数据连接器。

什么是 TACO 文件?


TACO 文件 (.taco) 是打包的 Tableau 连接器文件,可以放置在“我的 Tableau 存储库/连接器”文件夹中。从那里,Tableau 会自动加载它找到的所有连接器。

有关将连接器打包到 TACO 中的详细信息,请参阅打包连接器并对其进行签名以进行分发

流程概述

这些是创建功能齐全的连接器时要遵循的一般步骤。

  1. 查看位于postgres_odbc或postgres_jdbc文件夹中的示例连接器之一。如果将连接器文件复制到工作区,则这些连接器可以作为一个很好的起点。

  2. 根据需要自定义连接器文件,以命名连接器并允许其连接到数据库。有关详细信息,请参阅示例。

  3. 确保连接器具有所有必需的文件:

    • 清单文件。这定义了连接器。

    • 连接解析程序(仅限基于 ODBC 的连接器)。ODBC 连接器应包括驱动程序冲突解决程序元素。JDBC 连接器当前不支持驱动程序解析器。

    • 连接生成器 JavaScript 文件。JDBC 连接器可以使用属性生成器 JavaScript 文件。

    • 方言定义文件

    • “连接”对话框

  4. 连接器能够连接后,开始运行测试工具 TDVT 以验证连接器是否与 Tableau 兼容。例如,将测试数据加载到数据库中。

  5. 当 TDVT 测试通过时,即可对连接器进行打包和签名。

发展的先决条件

若要开发连接器,请确保计算机上安装了以下组件:

  • 视窗或 Mac 操作系统

  • Tableau Desktop 或 Tableau Server 2019.2 或更高版本

  • 注意:运行 TACO 文件需要 Tableau 2019.4

  • Python 3.7 或更高版本

  • 满足此处列出的要求的 ODBC 或 JDBC 数据源和驱动程序

  • 在数据源中加载的提供的测试数据

  • JDK 8 或更高版本

安装开发工具包工具

安装以下设备:

  • 腾讯网.这是我们的测试工具。有关详细信息,请参阅使用 TDVT 测试连接器的“安装”部分。

  • 打包工具。有关详细信息,请参阅打包连接器并签名以进行分发的“设置用于打包和签名的虚拟环境”部分。

生成的连接器将在 Windows、Linux 和 Mac 上的 Tableau Desktop 和 Tableau Server 上运行。

使用连接器

封装连接器 (TACO)

将打包的 TACO 文件放在“我的 Tableau 存储库/连接器”文件夹中,然后启动 Tableau。有关详细信息,请参阅运行打包的连接器 (.taco)。

注意:Tableau 的 2019.4 版本中添加了对加载 TACO 文件的支持。

开发人员路径

您可以指示 Tableau 使用特殊的命令行参数加载未打包的连接器,该参数告诉 Tableau 在哪里可以找到您的连接器。有关详细信息,请参阅运行“正在开发”连接器。