Python Tableau workbooks.publish用法及代码示例

Tableau Server Client (TSC)中workbooks.publish的用法。

用法

workbooks.publish(workbook_item, file_path, publish_mode, connections, skip_connection_check, as_job, hidden_views)

将工作簿发布到指定站点。

注意：REST API 不能自动包含工作簿使用的数据提取或其他资源。因此，无法发布使用本地计算机上 Excel 或 csv 文件中的数据的 .twb 文件，除非您将数据和工作簿打包在 .twbx 文件中，或者单独发布数据源。

对于大于 64 MB 的工作簿，发布方法会自动将文件分块以供上传。使用此方法比直接调用发布 REST API 方便得多。

REST API：Publish Workbook、Initiate File Upload、Append to File Upload

参数

名字	说明
`workbook_item`	`workbook_item` 指定您要发布的工作簿。添加工作簿时，您需要首先创建一个 `workbook_item` 的新实例，其中包括现有项目的 `project_id`。工作簿的名称将是文件的名称，除非您在创建实例时还指定了新工作簿的名称。见WorkbookItem。
`file_path`	要发布的工作簿的路径和名称。
`mode`	指定您是发布新工作簿 (`CreateNew`) 还是覆盖现有工作簿 (`Overwrite`)。您不能附加工作簿。您还可以使用发布模式属性，例如：`TSC.Server.PublishMode.Overwrite`。
`connections`	在工作簿中创建的连接的`ConnectionCredentials` 对象列表。
`connection_credentials`	(可选)连接到工作簿数据源的凭据(如果需要)。这`ConnectionCredentials`对象包含数据源的身份验证信息(用户名和密码，以及是嵌入凭据还是使用 OAuth)。自 API 服务器版本 2.3 起已弃用。
`skip_connection_check`	(可选)设置为`True` 以在上传时跳过连接检查。发布将成功，但未经检查的连接问题可能会导致工作簿无法正常工作。默认为 `False` 。
`as_job`	(可选)设置为 `True` 以将上传作为作业运行(异步上传)。如果设置为`True`，则作业将开始执行发布过程并返回`Job` 对象。默认为 `False` 。
`hidden_views`	(可选)发布工作簿时需要隐藏的视图的字符串名称列表。

异常

错误	说明
`File path does not lead to an existing file.`	引发文件路径不正确或文件丢失的错误。
`Invalid mode defined.`	如果发布模式不是定义的选项之一，则会引发错误。
`Workbooks cannot be appended.`	`mode` 必须设置为 `Overwrite` 或 `CreateNew` 。
`Only .twb or twbx files can be published as workbooks.`	如果指定的文件类型不受支持，则引发错误。

有关其他错误代码，请参阅 REST API Publish Workbook。

已发布工作簿的 WorkbookItem。

示例


import tableauserverclient as TSC
tableau_auth = TSC.TableauAuth('username', 'password', site_id='site')
server = TSC.Server('https://servername')

with server.auth.sign_in(tableau_auth):
   # create a workbook item
   wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e')
   # call the publish method with the workbook item
   wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite')

相关用法

注：本文由纯净天空筛选整理自tableau.github.io大神的英文原创作品 workbooks.publish。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。