Skip to main content

Sigma (dagster-sigma)

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.

Sigma API​

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

Assets (Sigma API)​

class dagster_sigma.SigmaOrganization

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

build_defs
deprecated

This API will be removed in version 1.9.0. Use dagster_sigma.load_sigma_asset_specs instead.

Returns a Definitions object representing the Sigma content in the organization.

Parameters: dagster_sigma_translator (Type[DagsterSigmaTranslator]) – The translator to use to convert Sigma content into AssetSpecs. Defaults to DagsterSigmaTranslator.Returns: The set of assets representing the Sigma content in the organization.Return type: Definitions

class dagster_sigma.SigmaBaseUrl

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

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

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

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

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
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[Union[DagsterSigmaTranslator, Type[DagsterSigmaTranslatorr]]]) – 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]