Skip to main content

dagster-sigma library

Dagster allows you to represent the workbooks and datasets in your Sigma project as assets alongside other technologies including dbt and Sling. This allows you to visualize relationships between your Sigma assets and their dependencies.

Related documentation pages: Using Dagster with Sigma.

Component​

class dagster_sigma.SigmaComponent [source]
beta

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

Pulls in the contents of a Sigma organization into Dagster assets.

Example:

# defs.yaml

type: dagster_sigma.SigmaComponent
attributes:
  organization:
    base_url: https://aws-api.sigmacomputing.com
    client_id: "{{ env.SIGMA_CLIENT_ID }}"
    client_secret: "{{ env.SIGMA_CLIENT_SECRET }}"
  sigma_filter:
    workbook_folders:
      - ["My Documents", "Analytics"]
    include_unused_datasets: false
get_asset_spec [source]

Generates an AssetSpec for a given Sigma content item.

This method can be overridden in a subclass to customize how Sigma content (workbooks, datasets) are converted to Dagster asset specs. By default, it delegates to the configured DagsterSigmaTranslator.

Parameters: data – The SigmaTranslatorData containing information about the Sigma content item and organizationReturns: An AssetSpec that represents the Sigma content as a Dagster asset

Example:

Override this method to add custom tags based on content properties:

from dagster_sigma import SigmaComponent
from dagster import AssetSpec

class CustomSigmaComponent(SigmaComponent):
    def get_asset_spec(self, data):
        base_spec = super().get_asset_spec(data)
        return base_spec.replace_attributes(
            tags={
                **base_spec.tags,
                "sigma_type": data.properties.get("type"),
                "owner": data.properties.get("ownerId")
            }
        )

To use the Sigma component, see the Sigma component integration guide.

YAML configuration​

When you scaffold a Sigma component definition, the following defs.yaml configuration file will be created:

type: dagster_sigma.SigmaComponent

attributes:
  organization:
    base_url: "{{ env.SIGMA_BASE_URL }}"
    client_id: "{{ env.SIGMA_CLIENT_ID }}"
    client_secret: "{{ env.SIGMA_CLIENT_SECRET }}"

Sigma API​

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

Assets (Sigma API)​

class dagster_sigma.SigmaOrganization [source]

Represents a workspace in Sigma and provides utilities to interact with the Sigma API.

class dagster_sigma.SigmaBaseUrl [source]

Enumeration of Sigma API base URLs for different cloud providers.

https://help.sigmacomputing.com/reference/get-started-sigma-api#identify-your-api-request-url

class dagster_sigma.DagsterSigmaTranslator [source]

Translator class which converts raw response data from the Sigma API into AssetSpecs. Subclass this class to provide custom translation logic.

class dagster_sigma.SigmaDataset [source]

Represents a Sigma dataset, a centralized data definition which can contain aggregations or other manipulations.

https://help.sigmacomputing.com/docs/datasets

class dagster_sigma.SigmaWorkbook [source]

Represents a Sigma workbook, a collection of visualizations and queries for data exploration and analysis.

https://help.sigmacomputing.com/docs/workbooks

class dagster_sigma.SigmaFilter [source]

Filters the set of Sigma objects to fetch.

Parameters:

  • workbook_folders (Optional[Sequence[Sequence[str]]]) – A list of folder paths to fetch workbooks from. Each folder path is a list of folder names, starting from the root folder. All workbooks contained in the specified folders will be fetched. If not provided, all workbooks will be fetched.
  • workbooks (Optional[Sequence[Sequence[str]]]) – A list of fully qualified workbook paths to fetch. Each workbook path is a list of folder names, starting from the root folder, and ending with the workbook name. If not provided, all workbooks will be fetched.
  • include_unused_datasets (bool) – Whether to include datasets that are not used in any workbooks. Defaults to True.
dagster_sigma.load_sigma_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 Sigma content in the organization.

Parameters:

  • organization (SigmaOrganization) – The Sigma organization to fetch assets from.
  • dagster_sigma_translator (Optional[DagsterSigmaTranslator]) – The translator to use to convert Sigma content into dagster.AssetSpec. Defaults to DagsterSigmaTranslator.
  • sigma_filter (Optional[SigmaFilter]) – Filters the set of Sigma objects to fetch.
  • fetch_column_data (bool) – Whether to fetch column data for datasets, which can be slow.
  • fetch_lineage_data (bool) – Whether to fetch any lineage data for workbooks and datasets.
  • snapshot_path (Optional[Union[str, Path]]) – Path to a snapshot file to load Sigma data from, rather than fetching it from the Sigma API.

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