Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding semantic models to list #4156

Merged
merged 9 commits into from
Oct 12, 2023
Merged

Adding semantic models to list #4156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
687388a
Adding semantic models to list
matthewshaver Sep 28, 2023
d499211
Adding to "methods" page
matthewshaver Sep 28, 2023
e77f21e
Merge branch 'current' into backport-semantic
mirnawong1 Sep 29, 2023
8e097d7
Update website/docs/reference/node-selection/methods.md
matthewshaver Oct 12, 2023
e89dfc8
Update website/docs/reference/commands/list.md
matthewshaver Oct 12, 2023
e7a472b
Update website/docs/reference/node-selection/methods.md
matthewshaver Oct 12, 2023
115a204
Merge branch 'current' into backport-semantic
matthewshaver Oct 12, 2023
f116fe9
Remove comment from code example
dbeatty10 Oct 12, 2023
1fbac66
Merge branch 'current' into backport-semantic
matthewshaver Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions website/docs/guides/migration/versions/01-upgrading-to-v1.6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,5 @@ More consistency and flexibility around packages. Resources defined in a package
- [`dbt debug --connection`](/reference/commands/debug) to test just the data platform connection specified in a profile
- [`dbt docs generate --empty-catalog`](/reference/commands/cmd-docs) to skip catalog population while generating docs
- [`--defer-state`](/reference/node-selection/defer) enables more-granular control
- [`dbt ls`](/reference/commands/list) adds the Semantic model selection method to allow for `dbt ls -s "semantic_model:*"` and the ability to execute `dbt ls --resource-type semantic_model`.

12 changes: 11 additions & 1 deletion website/docs/reference/commands/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `dbt ls` command lists resources in your dbt project. It accepts selector ar
### Usage
```
dbt ls
[--resource-type {model,source,seed,snapshot,metric,test,exposure,analysis,default,all}]
[--resource-type {model,semantic_model,source,seed,snapshot,metric,test,exposure,analysis,default,all}]
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't have a versioning component for the metric and semantic_model types, but maybe that is okay? 🤷

[--select SELECTION_ARG [SELECTION_ARG ...]]
[--models SELECTOR [SELECTOR ...]]
[--exclude SELECTOR [SELECTOR ...]]
Expand Down Expand Up @@ -93,6 +93,16 @@ $ dbt ls --select snowplow.* --output json --output-keys name resource_type desc

</VersionBlock>

<VersionBlock firstVersion="1.6">

**Listing Semantic models**

List all resources upstream of your orders semantic model:
```
dbt ls -s +semantic_model:orders
```

</VersionBlock>

**Listing file paths**
```
Expand Down
15 changes: 15 additions & 0 deletions website/docs/reference/node-selection/methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,3 +352,18 @@ dbt list --select version:none # models that are *not* versioned
```

</VersionBlock>

matthewshaver marked this conversation as resolved.
Show resolved Hide resolved
### The "semantic_model" method
<VersionBlock lastVersion="1.5">
Supported in v1.6 or newer.
</VersionBlock>
<VersionBlock firstVersion="1.6">

The `semantic_model` method selects [semantic models](/docs/build/semantic-models).

```bash
dbt list --select semantic_model:* # list all semantic models
dbt list --select +semantic_model:orders # list your semantic model named "orders" and all upstream resources
```

</VersionBlock>
Loading