The tableau
utility is used to trigger a refresh of a Tableau data source once the data has been updated. Usually this is run in a pipeline following a transformation (i.e. dbt) step that altered the data that Tableau is connected to.
EDK Based Plugin
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tableau utility to your
project using
:meltano add -
Configure the tableau
settings using
:meltano config
meltano add utility tableaumeltano config tableau set --interactiveNext steps
- For username/password auth you can skip this step but for API token auth you will need to generate an API token on your Tableau server to authenticate any requests: Tableau API Auth Docs
If you run into any issues, learn how to get help.
Capabilities
This plugin currently has no capabilities defined. If you know the capabilities required by this plugin, please contribute!Settings
The
tableau settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tableau list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Tableau API Version (API_VERSION)
-
Environment variable:
TABLEAU_API_VERSION -
Default Value:
3.18
The API version to be used.
Configure this setting directly using the following Meltano command:
meltano config tableau set API_VERSION [value]Tableau Base Url (BASE_URL)
-
Environment variable:
TABLEAU_BASE_URL
Base URL for the Tableau server you are trying to reach.
Configure this setting directly using the following Meltano command:
meltano config tableau set BASE_URL [value]Datasource LUID (DATASOURCE_LUID)
-
Environment variable:
TABLEAU_DATASOURCE_LUID
LUID of the Tableau datasource
Configure this setting directly using the following Meltano command:
meltano config tableau set DATASOURCE_LUID [value]Password (PASSWORD)
-
Environment variable:
TABLEAU_PASSWORD
Tableau account password.
Configure this setting directly using the following Meltano command:
meltano config tableau set PASSWORD [value]Tableau Site ID (SITE_ID)
-
Environment variable:
TABLEAU_SITE_ID
The site ID for the hosted Tableau instance.
Configure this setting directly using the following Meltano command:
meltano config tableau set SITE_ID [value]Token Name (TOKEN_NAME)
-
Environment variable:
TABLEAU_TOKEN_NAME
Personal token name generated on the Tableau site.
Configure this setting directly using the following Meltano command:
meltano config tableau set TOKEN_NAME [value]Token Secret (TOKEN_SECRET)
-
Environment variable:
TABLEAU_TOKEN_SECRET
Personal token secret generated on the Tableau site.
Configure this setting directly using the following Meltano command:
meltano config tableau set TOKEN_SECRET [value]Username (USERNAME)
-
Environment variable:
TABLEAU_USERNAME
Tableau account username.
Configure this setting directly using the following Meltano command:
meltano config tableau set USERNAME [value]Commands
The tableau utility supports the following commands that can be used withmeltano invokerefresh
-
Equivalent to:
refresh
Refresh a Tableau datasource.
meltano invoke tableau:refresh [args...]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-1-c0c0c4){kind=icon}
