Skip to main content

Tableau (dagster-tableau)

Dagster allows you to represent your Tableau workspace as assets, alongside other your other technologies like dbt and Sling. This allows you to see how your Tableau assets are connected to your other data assets, and how changes to other data assets might impact your Tableau workspace.

Tableau API​

Here, we provide interfaces to manage Tableau projects using the Tableau API.

Assets (Tableau API)​

class dagster_tableau.TableauCloudWorkspace [source]
beta

This API is currently in beta, and may have breaking changes in minor version releases, with behavior changes in patch releases.

Represents a workspace in Tableau Cloud and provides utilities to interact with Tableau APIs.

class dagster_tableau.TableauServerWorkspace [source]
beta

This API is currently in beta, and may have breaking changes in minor version releases, with behavior changes in patch releases.

Represents a workspace in Tableau Server and provides utilities to interact with Tableau APIs.

class dagster_tableau.DagsterTableauTranslator [source]

Translator class which converts raw response data from the Tableau API into AssetSpecs. Subclass this class to implement custom logic for each type of Tableau content.

@dagster_tableau.tableau_assets [source]
beta

This API is currently in beta, and may have breaking changes in minor version releases, with behavior changes in patch releases.

Create a definition for how to refresh the extracted data sources and views of a given Tableau workspace.

Parameters:

  • workspace (Union[TableauCloudWorkspace, TableauServerWorkspace]) – The Tableau workspace to fetch assets from.
  • name (Optional[str], optional) – The name of the op.
  • group_name (Optional[str], optional) – The name of the asset group.
  • dagster_tableau_translator (Optional[DagsterTableauTranslator], optional) – The translator to use to convert Tableau content into dagster.AssetSpec. Defaults to DagsterTableauTranslator.
  • workbook_selector_fn (Optional[WorkbookSelectorFn]) – beta A function that allows for filtering which Tableau workbook assets are created for, including data sources, sheets and dashboards.

Examples:

Refresh extracted data sources and views in Tableau:

from dagster_tableau import TableauCloudWorkspace, tableau_assets

import dagster as dg

tableau_workspace = TableauCloudWorkspace(
    connected_app_client_id=dg.EnvVar("TABLEAU_CONNECTED_APP_CLIENT_ID"),
    connected_app_secret_id=dg.EnvVar("TABLEAU_CONNECTED_APP_SECRET_ID"),
    connected_app_secret_value=dg.EnvVar("TABLEAU_CONNECTED_APP_SECRET_VALUE"),
    username=dg.EnvVar("TABLEAU_USERNAME"),
    site_name=dg.EnvVar("TABLEAU_SITE_NAME"),
    pod_name=dg.EnvVar("TABLEAU_POD_NAME"),
)

@tableau_assets(
    workspace=tableau_workspace,
    name="tableau_workspace_assets",
    group_name="tableau",
)
def tableau_workspace_assets(context: dg.AssetExecutionContext, tableau: TableauCloudWorkspace):
    yield from tableau.refresh_and_poll(context=context)

defs = dg.Definitions(
    assets=[tableau_workspace_assets],
    resources={"tableau": tableau_workspace},
)

Refresh extracted data sources and views in Tableau with a custom translator:

from dagster_tableau import (
    DagsterTableauTranslator,
    TableauTranslatorData,
    TableauCloudWorkspace,
    tableau_assets
)

import dagster as dg

class CustomDagsterTableauTranslator(DagsterTableauTranslator):
    def get_asset_spec(self, data: TableauTranslatorData) -> dg.AssetSpec:
        default_spec = super().get_asset_spec(data)
        return default_spec.replace_attributes(
            key=default_spec.key.with_prefix("my_prefix"),
        )

tableau_workspace = TableauCloudWorkspace(
    connected_app_client_id=dg.EnvVar("TABLEAU_CONNECTED_APP_CLIENT_ID"),
    connected_app_secret_id=dg.EnvVar("TABLEAU_CONNECTED_APP_SECRET_ID"),
    connected_app_secret_value=dg.EnvVar("TABLEAU_CONNECTED_APP_SECRET_VALUE"),
    username=dg.EnvVar("TABLEAU_USERNAME"),
    site_name=dg.EnvVar("TABLEAU_SITE_NAME"),
    pod_name=dg.EnvVar("TABLEAU_POD_NAME"),
)

@tableau_assets(
    workspace=tableau_workspace,
    name="tableau_workspace_assets",
    group_name="tableau",
    dagster_tableau_translator=CustomDagsterTableauTranslator(),
)
def tableau_workspace_assets(context: dg.AssetExecutionContext, tableau: TableauCloudWorkspace):
    yield from tableau.refresh_and_poll(context=context)

defs = dg.Definitions(
    assets=[tableau_workspace_assets],
    resources={"tableau": tableau_workspace},
)
dagster_tableau.load_tableau_asset_specs [source]
beta

This API is currently in beta, and may have breaking changes in minor version releases, with behavior changes in patch releases.

Returns a list of AssetSpecs representing the Tableau content in the workspace.

Parameters:

Returns: The set of assets representing the Tableau content in the workspace.Return type: List[AssetSpec]

dagster_tableau.build_tableau_materializable_assets_definition [source]
beta

This API is currently in beta, and may have breaking changes in minor version releases, with behavior changes in patch releases.

superseded

This API has been superseded. Use tableau_assets decorator instead..

Returns the AssetsDefinition of the materializable assets in the Tableau workspace.

Parameters:

  • resource_key (str) – The resource key to use for the Tableau resource.

  • specs (Sequence[AssetSpec]) – The asset specs of the executable assets in the Tableau workspace.

  • refreshable_workbook_ids (Optional[Sequence[str]]) –

    deprecated A list of workbook IDs. The provided workbooks must have extracts as data sources and be refreshable in Tableau.

    When materializing your Tableau assets, the workbooks provided are refreshed, refreshing their sheets and dashboards before pulling their data in Dagster.

  • refreshable_data_source_ids (Optional[Sequence[str]]) –

    A list of data source IDs. The provided data sources must have extracts and be refreshable in Tableau.

    When materializing your Tableau assets, the provided data source are refreshed, refreshing upstream sheets and dashboards before pulling their data in Dagster.

Returns: The AssetsDefinition of the executable assets in the Tableau workspace.Return type: AssetsDefinition

dagster_tableau.parse_tableau_external_and_materializable_asset_specs [source]

Parses a list of Tableau AssetSpecs provided as input and return two lists of AssetSpecs, one for the Tableau external assets and another one for the Tableau materializable assets.

In Tableau, data sources are considered external assets, while sheets and dashboards are considered materializable assets.

Parameters:

  • specs (Sequence[AssetSpec]) – The asset specs of the assets in the Tableau workspace.
  • include_data_sources_with_extracts (bool) – Whether to include published data sources with extracts in materializable assets.

Returns: A named tuple representing the parsed Tableau asset specs as external_asset_specs and materializable_asset_specs.

Return type: ParsedTableauAssetSpecs