Referência da linha de comando do Tableau Prep
Você pode interagir com o Tableau Prep usando a linha de comando por meio do aplicativo principal (Tableau Prep.exe) ou da interface de linha de comando (tableau-prep-cli.bat).
Tableau Prep.exe: usado para configurar como o aplicativo se inicializa. Por exemplo; instalar, ativar, licenciar, configurar diretórios de dados do usuário ou solucionar problemas do Electron shell.
Tableau-prep-cli.bat: usado para executar fluxos. Por exemplo, passar credenciais, parâmetros e atualizar saídas de dados sem abrir a interface visual.
Este documento descreve todas as opções de sintaxe de linha de comando suportadas pelo Tableau Prep e disponíveis para os clientes, separadas pelo utilitário onde estão disponíveis.
A sintaxe de linha de comando adicional com suporte usada por desenvolvedores e o suporte do Tableau não está incluída neste documento.
Aplicativo do Tableau Prep
As seguintes ações podem ser executadas na linha de comando do aplicativo Tableau Prep.exe.
Instale
Instale o Tableau Prep executando o arquivo .exe do instalador a partir da linha de comando do computador como administrador. Para obter mais informações, ccconsulte Instalar a partir da linha de comando(O link abre em nova janela).
Nota: esta opção está disponível apenas para o Windows.
| Sintaxe | Descrição |
|---|---|
tableau_<product_installer_name>.exe /option1 /option2 PROPERTY1 PROPERTY2 | Execute o comando como administrador a partir do diretório onde o arquivo .exe está localizado ou especifique o caminho completo para a localização do arquivo .exe no computador. Não execute a partir de um diretório compartilhado. Para obter uma lista das opções do instalador suportadas, consulte Opções do instalador(O link abre em nova janela). Para obter uma lista das propriedades do instalador suportadas, consulte Propriedades do instalador(O link abre em nova janela).
Exemplo:
Este comando instala o Tableau versão 2026.2 no modo silencioso (não exibe prompts, IU ou a caixa de diálogo de licença). Ele conclui a instalação sem uma reinicialização, aceita o contrato de licença do usuário final (EULA) e define os relatórios de erros e relatórios de uso como desativados. |
Ativação, licença e registro
Use esses comandos para verificar sua licença, ativar o produto durante ou após a instalação e registrar o produto. Para obter mais informações, consulte Ativar o Tableau Desktop e o Tableau Prep Builder(O link abre em nova janela).
| Sintaxe | Descrição |
|---|---|
--activate <key> | Ative o produto usando a chave do produto fornecida. Sai com o código 0 em caso de sucesso. Caso contrário, sai com um código de erro. Também aceita single-dash (-activate). Para ativar o produto durante a instalação adicione uma única linha de comando que inclua a opção do instalador ACTIVATE_KEY “<key>” e insira a chave do produto entre aspas. |
--register | Registre o produto. Também aceita single-dash (-register). Para registrar o Tableau usando a linha de comando, é necessário preencher previamente os valores de registro (Windows) ou .plist (Mac) em cada computador que executará o Tableau Prep Builder. No Windows, você pode registrar o produto durante a instalação adicionando uma única linha de comando que inclui a opção REGISTER=“1” do instalador. Para obter mais informações, consulte Registre o Tableau Desktop e o Tableau Prep Builder(O link abre em nova janela). |
--check-license | Exibe a interface de usuário de ativação, se não licenciado. |
--refresh | Atualiza as licenças com a data de validade do período de manutenção vigente e interrompe as mensagens de expiração. Sai com o código 0 em caso de sucesso. Também aceita single-dash (-refresh). Windows: execute o arquivo tableau.exe com a opção MacOS: Execute a opção |
--return <key> | Desative a chave do produto fornecida para que possa ser reutilizada. Também aceita single-dash (-return). Windows: execute o arquivo tableau.exe com a opção MacOS: Execute a opção |
Configuração e armazenamento
Use esses comandos para definir as configurações de arquivos e locais de repositório.
| Sintaxe | Descrição |
|---|---|
--settings-file <file location> | Carregue as definições de configuração do aplicativo a partir do arquivo fornecido. Pode ser especificado várias vezes para dar suporte a configurações em camadas, como quando você tem uma configuração global do servidor proxy usada por todos e uma configuração de banco de dados específica usada para um fluxo. Exemplo de arquivo. json: {
"connection-sources":[
{
"endpoint":"prod-db-server.company.com",
"username":"service_account_admin",
"password":"secure_password_123"
}
]
}Comando de exemplo: Windows: MacOS |
--repository-location <file path> | Defina o diretório do repositório. Por padrão, durante a instalação, o Tableau Prep cria uma pasta na pasta Documentos chamada Meu repositório do Tableau Prep. Essa pasta inclui pastas para fluxos, fontes de dados, conexões, bem como arquivos de registro e um cache temporário. Em ambientes de servidor ou automação, você pode usar este comando para especificar um local de repositório alternativo e apontar o fluxo executado para ele. Exemplo: Windows: " MacOS: |
--user-data-directory <location> | Diretório usado para armazenar dados do aplicativo Electron. Enquanto Como administrador, use este sinalizador se estiver executando o Tableau Prep Builder em um ambiente de alta simultaneidade, onde vários processos precisam de estados de aplicativo isolados, ou ao solucionar erros persistentes de bloqueio de sessão em um servidor sem cabeça. Observação: quando você executa o comando, ele cria automaticamente a pasta especificada em Exemplo: Windows: MacOS: |
Abrir arquivos
Use esses comandos para abrir arquivos .tfl e .tflx de fluxo do Tableau Prep.
| Sintaxe | Descrição |
|---|---|
--tfl<file> | Abra o arquivo de fluxo de .tfl especificado. Use aspas duplas se o caminho do arquivo incluir espaços. Exemplo: Windows: "C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" -tfl "C:\Users\jsmith\Documents\My Flows\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> | Abra o arquivo de fluxo .tflx empacotado especificado. Exemplo: Windows: MacOS: |
Aplicativo de linha de comando do Tableau Prep
Os comandos a seguir podem ser executados usando a interface de linha de comandos (tableau-prep-cli.bat) do Tableau Prep.
Atualizar saída de fluxo
Use essas opções para executar o fluxo via linha de comando para atualizar a saída de fluxo. Esse método permite executar apenas um fluxo de cada vez. Para obter mais informações e limitações, consulte Atualizar arquivos de saída de fluxo a partir da linha de comando(O link abre em nova janela).
| Sintaxe | Descrição |
|---|---|
-c, --connections <path> | O caminho para o arquivo de .json que contém as credenciais para suas fontes de dados e servidores. O Tableau Prep Builder usa informações do arquivo de fluxo e do arquivo .json de credenciais para executar o fluxo quando você tiver conexões remotas. Para obter mais informações, consulte Requisitos do arquivo Credentials.json(O link abre em nova janela). Se você se conectar a um banco de dados snowflake, certifique-se de incluir quaisquer parâmetros específicos, como Role, Warehouse e, às vezes, tokens OAuth ou autenticação de navegador externo. Exemplo de arquivo de configurações .json - Snowflake: {
"connection-sources":[
{
"endpoint":"company_account.snowflakecomputing.com",
"username":"SVC_TABLEAU_PREP",
"password":"EncryptedPassword123",
"attributes":{
"warehouse": "DATA_LOAD_WH",
"role": "TRANSFORM_ROLE"
}
}
]
} Exemplo: Windows: MacOS: |
- p, - - parameters | O caminho para um arquivo .json que substitui os valores de parâmetro padrão em seu fluxo. Este é um arquivo separado do arquivo credentials.json e inclui os nomes e valores dos seus parâmetros. Para obter mais informações, consulte “Executar fluxos que incluem valores de parâmetros” em Requisitos do arquivo Credentials.json(O link abre em nova janela). Exemplo: Windows: MacOS: |
-t,--tflFile <file path> | O caminho para o arquivo de fluxo do Tableau Prep. |
-inc, --incrementalRefresh | Se você não tiver o Tableau Prep Conductor habilitado em seu servidor para agendar execuções de fluxo, poderá usar este comando para executar seu fluxo usando atualização incremental. Para obter mais informações, consulte Executar o fluxo com a atualização incremental ativada. Exemplo: Windows: MacOS: |
Comandos diversos
Use esses comandos para imprimir a versão do Tableau Prep, ative o modo de depuração para depurar um processo de fluxo, desabilite a validação de SSL e muito mais.
| Sintaxe | Descrição |
|---|---|
--version | Produz a versão atual da CLI do Tableau Prep Builder e encerra imediatamente o processo. |
-d, --debug | Ativa o modo de depuração. Gera logs detalhados na pasta do repositório para solução de problemas. Os arquivos de registro estão armazenados em: My Tableau Prep Builder Repository\Command Line Repository\Logs Exemplo: Windows: MacOS: |
-dsv, --disableSslValidation | Desabilita a validação de certificado SSL (útil para determinados ambientes de servidor interno). Ao executar esta opção no MacOS, uma caixa de diálogo pode ser exibida solicitando o usuário e a senha do keychain. A partir da versão 2019.3.2 do Tableau Prep Builder, você pode passar esse parâmetro adicional para desabilitar essa caixa de diálogo de chaves. Exemplo: MacOS: |
-h, --help) | Exibe o menu de ajuda para as opções da linha de comando. |
