Skip to content

Commit

Permalink
[docs][dagster-sigma] Update dagster-sigma filter docs (#26006)
Browse files Browse the repository at this point in the history
## Summary

Updates the dagster-sigma docs to include more information on filtering.
  • Loading branch information
benpankow authored Nov 20, 2024
1 parent 21818b6 commit db070bc
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 10 deletions.
Binary file modified docs/content/api/modules.json.gz
Binary file not shown.
Binary file modified docs/content/api/searchindex.json.gz
Binary file not shown.
Binary file modified docs/content/api/sections.json.gz
Binary file not shown.
12 changes: 8 additions & 4 deletions docs/content/integrations/sigma.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ defs = dg.Definitions(assets=[*sigma_specs], resources={"sigma": sigma_organizat

## Load Sigma assets from filtered workbooks

It is possible to load a subset of your Sigma assets by providing a <PyObject module="dagster_sigma" method="SigmaFilter" /> to the <PyObject module="dagster_sigma" method="load_sigma_asset_specs" /> function. All workbooks contained in the folders provided to your <PyObject module="dagster_sigma" method="SigmaFilter" /> will be fetched.
It is possible to load a subset of your Sigma assets by providing a <PyObject module="dagster_sigma" method="SigmaFilter" /> to the <PyObject module="dagster_sigma" method="load_sigma_asset_specs" /> function. This `SigmaFilter` object allows you to specify the folders from which you want to load Sigma workbooks, and also will allow you to configure which datasets are represented as assets.

Note that the content and size of Sigma organization may affect the performance of your Dagster deployments. Filtering the workbooks selection from which your Sigma assets will be loaded is particularly useful for improving loading times.

Expand All @@ -80,10 +80,14 @@ sigma_organization = SigmaOrganization(
sigma_specs = load_sigma_asset_specs(
organization=sigma_organization,
sigma_filter=SigmaFilter(
# Filter down to only the workbooks in these folders
workbook_folders=[
["my_folder", "my_subfolder"],
["my_folder", "my_other_subfolder"],
]
("my_folder", "my_subfolder"),
("my_folder", "my_other_subfolder"),
],
# Specify whether to include datasets that are not used in any workbooks
# default is True
include_unused_datasets=False,
),
)
defs = dg.Definitions(assets=[*sigma_specs], resources={"sigma": sigma_organization})
Expand Down
Binary file modified docs/next/public/objects.inv
Binary file not shown.
9 changes: 6 additions & 3 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-sigma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@
Sigma (dagster-sigma)
#####################

Dagster allows you to represent your Sigma project as assets, alongside other your other
technologies like dbt and Sling. This allows you to see how your Sigma assets are connected to
your other data assets, and how changes to other data assets might impact your Sigma project.
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 <https://docs.dagster.io/integrations/sigma>`_.

.. currentmodule:: dagster_sigma

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@
sigma_specs = load_sigma_asset_specs(
organization=sigma_organization,
sigma_filter=SigmaFilter(
# Filter down to only the workbooks in these folders
workbook_folders=[
["my_folder", "my_subfolder"],
["my_folder", "my_other_subfolder"],
]
("my_folder", "my_subfolder"),
("my_folder", "my_other_subfolder"),
],
# Specify whether to include datasets that are not used in any workbooks
# default is True
include_unused_datasets=False,
),
)
defs = dg.Definitions(assets=[*sigma_specs], resources={"sigma": sigma_organization})

1 comment on commit db070bc

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for dagster-docs ready!

✅ Preview
https://dagster-docs-6pje4e7bt-elementl.vercel.app
https://master.dagster.dagster-docs.io

Built with commit db070bc.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.