Tableau Prep 命令行参考
您可以使用命令行通过主应用程序 (Tableau Prep.exe) 或命令行界面 (tableau-prep-cli.bat) 与 Tableau Prep 交互。
Tableau Prep.exe:用于配置应用程序自身初始化的方式。例如,安装、激活、许可、设置用户数据目录或对 Electron 外壳进行故障排除。
Tableau-prep-cli.bat:用于运行流程。例如,在不打开可视界面的情况下传递凭据、参数和刷新数据输出。
本文档介绍 Tableau Prep 支持并可供客户使用的所有命令行语法选项,并按可用实用工具进行分类说明。
本文档中未包括 Tableau 开发人员和支持人员使用的其他受支持的命令行语法。
Tableau Prep 应用程序
对于 Tableau Prep.exe 应用程序,可以通过命令行执行以下操作。
安装
以管理员身份从计算机的命令行中运行安装程序 .exe 文件,安装 Tableau Prep。有关详细信息,请参见通过命令行安装(链接在新窗口中打开)。
注意:此选项仅适用于 Windows。
| 语法 | 描述 |
|---|---|
tableau_<product_installer_name>.exe /option1 /option2 PROPERTY1 PROPERTY2 | 以管理员身份从 .exe 文件所在的目录运行命令,或指定计算机上 .exe 文件位置的完整路径。不要从共享目录运行。有关支持的安装程序选项的列表,请参见安装程序选项(链接在新窗口中打开)。有关支持的安装程序属性的列表,请参见安装程序属性(链接在新窗口中打开)。
示例:
此命令在无提示模式下安装 Tableau 版本 2026.2(不显示提示符、UI 或许可证对话框)。它将在不重新启动的情况下完成安装,接受最终用户许可协议 (EULA),并将错误报告和使用情况报告设置为关闭。 |
激活、许可证和注册
使用这些命令检查许可证、在安装过程中或安装后激活产品,以及注册产品。有关详细信息,请参见“激活 Tableau Desktop 和 Tableau Prep Builder”(链接在新窗口中打开)。
| 语法 | 描述 |
|---|---|
--activate <key> | 使用提供的产品密钥激活产品。成功时退出并显示代码 0。其他情况下退出并显示错误代码。也接受单破折号 (-activate)。 若要在安装期间激活产品,请添加一个包括安装程序选项 ACTIVATE_KEY "<key>" 的命令行,并在引号中输入产品密钥。 |
--register | 注册产品。也接受单破折号 (-register)。若要通过命令行注册 Tableau,您需要在将运行 Tableau Prep Builder 的每台计算机上预先填充注册表 (Windows) 或 .plist (Mac) 值。 对于 Windows,您可以通过添加包括安装程序选项 REGISTER="1" 的单一命令行,在安装过程中注册产品。 有关详细信息,请参见注册 Tableau Desktop 和 Tableau Prep Builder(链接在新窗口中打开)。 |
--check-license | 如果未获得许可,则显示激活 UI。 |
--refresh | 使用许可证的当前维护期的到期日期更新许可证,并停止发送到期消息。成功时退出并显示代码 0。也接受单破折号 (-refresh)。 Windows:使用 MacOS:对 /Applications 路径中的 Tableau 对象运行 |
--return <key> | 停用提供的产品密钥,以便可以重复使用。也接受单破折号 (-return)。 Windows:使用 MacOS:对 /Applications 路径中的 Tableau 对象运行 |
配置和存储
使用这些命令来配置文件设置和存储库位置。
| 语法 | 描述 |
|---|---|
--settings-file <file location> | 从给定文件加载应用程序配置设置。可以多次指定以支持分层配置,例如当您有每个人都使用的全局代理服务器配置,以及用于流程的特定数据库配置时。 .json 文件示例: {
"connection-sources":[
{
"endpoint":"prod-db-server.company.com",
"username":"service_account_admin",
"password":"secure_password_123"
}
]
}示例命令: Windows: MacOS |
--repository-location <file path> | 设置存储库目录。默认情况下,在安装过程中,Tableau Prep 会在您的“文档”文件夹中创建一个名为“我的 Tableau Prep 存储库”的文件夹。此文件夹包括流程、数据源、连接以及日志文件的文件夹,以及临时缓存。在服务器或自动化环境中,可以使用此命令指定备用存储库位置,并将流程运行指向该位置。 示例: Windows:" MacOS: |
--user-data-directory <location> | 用于存储 Electron 应用程序数据的目录。
作为管理员,如果您在多个进程需要隔离应用程序状态的高并发环境中运行 Tableau Prep Builder,或者在无头服务器上排查持久性会话锁定错误时,请使用此标志。 注意:运行该命令时,它会自动创建 示例: Windows: MacOS: |
打开文件
使用这些命令打开 .tfl 和 .tflx Tableau Prep 流程文件。
| 语法 | 描述 |
|---|---|
--tfl<file> | 打开指定的 .tfl 流程文件。如果文件路径包括空格,请使用双引号。 示例: Windows:"C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" -tfl "C:\用户\jsmith\文档\我的流程\Clean_Sales_Data.tfl" MacOS:/Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder -tfl "/Users/jsmith/Documents/My Flows/Clean_Sales_Data.tfl" |
--tflx<file> | 打开指定的 .tflx 打包流程文件。 示例: Windows: MacOS: |
Tableau Prep 命令行应用程序
可以使用 Tableau Prep 命令行界面 (tableau-prep-cli.bat) 运行以下命令。
刷新流程输出
使用这些选项从命令行运行流程以刷新流程输出。此方法一次只允许您运行一个流程。有关详细信息和限制,请参见通过命令行刷新流程输出文件(链接在新窗口中打开)。
| 语法 | 描述 |
|---|---|
-c, --connections <path> | 包含数据源和服务器凭据的 .json 文件的路径。 如果使用远程连接,Tableau Prep Builder 将使用流程文件和凭据 .json 文件中的信息来运行流程。有关详细信息,请参见 凭据 .json 文件要求(链接在新窗口中打开)。 如果连接到 Snowflake 数据库,请确保包括任何特定参数,例如角色、仓库,有时还要包括 OAuth 令牌或外部浏览器身份验证。 .json 设置文件示例 - Snowflake: {
"connection-sources":[
{
"endpoint":"company_account.snowflakecomputing.com",
"username":"SVC_TABLEAU_PREP",
"password":"EncryptedPassword123",
"attributes":{
"warehouse": "DATA_LOAD_WH",
"role": "TRANSFORM_ROLE"
}
}
]
} 示例: Windows: MacOS: |
- p, - - parameters | 覆盖流程中默认参数值的 .json 文件的路径。这是一个独立于您的 credentials.json 文件的文件,包含您的参数名称和值。 有关详细信息,请参见凭据 .json 文件要求(链接在新窗口中打开)中的“运行包含参数值的流程”。 示例: Windows: MacOS: |
-t,--tflFile <file path> | Tableau Prep 流程文件的路径。 |
-inc, --incrementalRefresh | 如果在服务器上未启用 Tableau Prep Conductor 来计划流程运行,则可以通过增量刷新使用此命令来运行流程。有关详细信息,请参见“在启用增量刷新的情况下运行流程”。 示例: Windows: MacOS: |
其他命令
使用这些命令打印输出 Tableau Prep 版本、打开调试模式以调试流程进程、禁用 SSL 验证,等等。
| 语法 | 描述 |
|---|---|
--version | 输出 Tableau Prep Builder CLI 的当前版本,并立即终止进程。 |
-d, --debug | 启用调试模式。在存储库文件夹中生成详细日志以进行故障排除。日志文件存储位置:我的 Tableau Prep Builder 存储库\Command Line Repository\Logs 示例: Windows: MacOS: |
-dsv, --disableSslValidation | 禁用 SSL 证书验证(对于某些内部服务器环境很有用)。在 MacOS 上运行此选项时,可能会显示一个对话框,询问钥匙串用户和密码。 从 Tableau Prep Builder 版本 2019.3.2 开始,您可以传入此附加参数来禁用此钥匙串对话框。 示例: MacOS: |
-h, --help) | 显示命令行选项的帮助菜单。 |
