Skip to content

Commit

Permalink
[docs] add brief storage kind docs (#22328)
Browse files Browse the repository at this point in the history
## Summary

Adds a brief docs section about storage kind tags. I notice we don't
have a similar section for compute kind - maybe we should wait until
after these can be asset tags (#22188)

## Test Plan

vercel

---------

Co-authored-by: Erin Cochran <[email protected]>
  • Loading branch information
benpankow and erinkcochran87 authored Jun 7, 2024
1 parent 6fc07c3 commit deee4e3
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 0 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.
18 changes: 18 additions & 0 deletions docs/content/concepts/metadata-tags/tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,24 @@ def leads(): ...

Other APIs that define assets can also accept tag arguments, such as <PyObject object="AssetSpec" />, <PyObject object="AssetOut" />, <PyObject object="AssetOut" />, and <PyObject object="graph_asset" decorator />.

#### Storage kind tags

You can attach the `dagster/storage_kind` tag to an asset to specify the storage technology used to store the asset. For example, `s3` or `snowflake`.

```python file=/concepts/metadata-tags/tags.py startafter=start_asset_storage_kind_tag endbefore=end_asset_storage_kind_tag
@asset(tags={"dagster/storage_kind": "snowflake"})
def users(): ...
```

These tags will appear in the asset graph and can be used to filter assets in the Dagster UI:

<Image
alt="An asset with a storage kind tag in the Dagster UI"
src="/images/concepts/metadata-tags/storage-kind-tag.png"
width={758}
height={303}
/>

### Jobs

Adding tags to a job will attach them to every run executed by the job.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/next/public/objects.inv
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ def leads(): ...

# end_asset_tags


# start_asset_storage_kind_tag


@asset(tags={"dagster/storage_kind": "snowflake"})
def users(): ...


# end_asset_storage_kind_tag

# start_asset_job_tags

asset_job = define_asset_job(
Expand Down

1 comment on commit deee4e3

@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-h58wh0trg-elementl.vercel.app
https://master.dagster.dagster-docs.io

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

Please sign in to comment.