Tableau 元数据 API 简介

  • 版本 :2022.1 及更高版本

Tableau 元数据 API 可发现 Tableau Online 站点或 Tableau Server 上的所有内容并为其编制索引,包括工作簿、数据源、流和指标。索引用于收集有关 Tableau 内容或元数据、有关内容架构和沿袭的信息。然后,元数据 API 从元数据中识别 Tableau Online 站点或 Tableau Server 上的内容使用的所有数据库、文件和表。

您可以使用元数据 API 执行以下任务:

  • 发现与发布到 Tableau Online 站点或 Tableau Server 的内容相关联的数据。搜索表、数据库和数据源等外部资产。

  • 跟踪沿袭或内容与外部资产(如数据源和工作簿)之间的关系。例如,确定哪些工作簿使用特定的已发布数据源。

  • 进行影响分析。使用上游和下游沿袭信息,您可以评估内容更改的影响。例如,查找依赖于数据库表列的所有工作表,或确定发生数据源更改时应通知的作者。

在这个部分

  • 什么是 Tableau 元数据?

  • 元数据 API 和 GraphQL

  • 何时使用元数据 API?

  • 何时使用 Tableau REST API?

  • 使用 GraphQL 和 REST 的区别

什么是 Tableau 元数据?

元数据 API 发现、跟踪、存储并显示有关 Tableau 内容的信息。

可以按类型(例如,表格或工作簿)对内容进行分类。内容可以是 Tableau 独有的(例如,嵌入式数据源和计算字段),其外部资产也可以是 Tableau 独有的(例如,数据库表和列)。内容和外部资产都可以附有信息(例如,标签和评级)。内容和外部资产也可以与其他内容和外部资产有关系。

内容和外部资产之间的关系以及关于它们的信息是元数据。

元数据 API 和 GraphQL

元数据 API 使用 GraphQL,这是一种 API 查询语言,描述了如何请求并仅返回您感兴趣的数据。

有关 GraphQL 的一般信息以及您可以使用它做什么,请参阅GraphQL.org。

何时使用元数据 API?

元数据 API 快速且灵活。当您要查找有关内容和资产之间的关系或其结构的特定信息时,请使用元数据 API。

何时使用 Tableau REST API?

对于元数据,您可以使用 Tableau REST API 进行与元数据 API 类似的查询。但是,如果您的 Tableau Online 站点或 Tableau Server 获得了 Data Management Add-on 的许可,您可以使用 REST API 执行各种写入操作,例如添加、更新或删除外部资产;并向外部资产添加额外的元数据,例如描述、认证和数据质量警告。有关详细信息,请参阅Tableau REST API 中的元数据方法主题。

注意:您始终可以将 Tableau REST API 用于其他任务,例如发布工作簿或数据源,或者用于管理任务,例如创建组以及添加或删除用户。

使用 GraphQL 和 REST 的区别

如果您熟悉 REST API,那么您就会了解端点(或资源)和 HTTP 请求的概念。例如,如果您使用 Tableau REST API 并且想要在 Tableau Online 站点或 Tableau Server 上查找所有工作簿,则可以发出 GET 请求以返回该信息。如果您想查找其他内容,则需要向不同的端点发出另一个请求。

与 REST API 一样,GraphQL 也通过 HTTP 提供服务。但是,您无需向多个端点发送请求以返回感兴趣的数据,而是可以对一个端点进行一次查询并对其进行过滤以仅返回您所要求的内容。GraphQL 服务器与一个端点相关联。

GraphQL 基于图(查询)的概念以及 GraphQL 模式定义的类型(对象)之间的关系。