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

dbt test supports --resource-type / --exclude-resource-type CLI flags and related environment variables #6126

Closed
wants to merge 14 commits into from
Closed

dbt test supports --resource-type / --exclude-resource-type CLI flags and related environment variables #6126

Changes from 5 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ce39d1f
dbt test now enables passing values
nataliefiann Sep 24, 2024
12e1587
Update website/docs/reference/global-configs/resource-type.md
nataliefiann Sep 24, 2024
cc335cc
Update website/docs/reference/global-configs/resource-type.md
nataliefiann Sep 24, 2024
7f9bebf
Update website/docs/reference/global-configs/resource-type.md
nataliefiann Sep 24, 2024
bbc091e
Merge branch 'current' into nfiann-resourcetype-dbttest
nataliefiann Sep 30, 2024
5b1a6b6
Added to the `dbt test` subcommand starting in v1.9
dbeatty10 Oct 1, 2024
2d29514
Examples of `--resource-type` / `--exclude-resource-type` with `dbt t…
dbeatty10 Oct 1, 2024
c3591be
Remove in favor of the new examples added below
dbeatty10 Oct 1, 2024
42efcf8
List of applicable resources remains the same between v1.8 and v1.9
dbeatty10 Oct 1, 2024
18d67ca
Remove the version-specific call-out (which had the wrong version any…
dbeatty10 Oct 1, 2024
8935561
Merge branch 'current' into nfiann-resourcetype-dbttest
dbeatty10 Oct 1, 2024
a578f4e
Merge branch 'current' into nfiann-resourcetype-dbttest
mirnawong1 Oct 1, 2024
76b0405
Merge branch 'current' into nfiann-resourcetype-dbttest
mirnawong1 Oct 1, 2024
2fa9413
Merge branch 'current' into nfiann-resourcetype-dbttest
mirnawong1 Oct 1, 2024
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
43 changes: 42 additions & 1 deletion website/docs/reference/global-configs/resource-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The available resource types are:

</VersionBlock>

<VersionBlock firstVersion="1.8">
<VersionBlock firstVersion="1.8" lastVersion="1.8">
dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved

- [`analysis`](/docs/build/analyses)
- [`exposure`](/docs/build/exposures)
Expand All @@ -58,6 +58,47 @@ The available resource types are:

</VersionBlock>

<VersionBlock firstVersion="1.9">

- [`analysis`](/docs/build/analyses)
- [`exposure`](/docs/build/exposures)
- [`metric`](/docs/build/build-metrics-intro)
- [`model`](/docs/build/models)
- [`saved_query`](/docs/build/saved-queries)
- [`seed`](/docs/build/seeds)
- [`semantic_model`](/docs/build/semantic-models)
- [`snapshot`](/docs/build/snapshots)
- [`source`](/docs/build/sources)
- [`test`](/docs/build/data-tests)
- [`unit_test`](/docs/build/unit-tests)
dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved

dbt `test` now enables passing values such as `unit_tests`, `tests`, and more in the `--resource-type` and `--exclude-resource-type` for CLI flags (or in the environment variables `DBT_RESOURCE_TYPES` and `DBT_EXCLUDE_RESOURCE_TYPES)`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think we need callouts like "now" - we should:

  • have a callout that this is available in versionless and starting in dbt Core v1.9
  • then document the feature


The following are some examples of how dbt `test` enables passing values:
dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved

<Expandable alt_header="CLI flag">

```
dbt `test` --resource-type unit_test
dbt `test` --exclude-resource-type unit_test

```

</Expandable>

<Expandable alt_header="Environment variables">

```

`DBT_RESOURCE_TYPES`=`unit_test` dbt `test`
`DBT_EXCLUDE_RESOURCE_TYPES`=`unit_test` dbt `test`

```

</Expandable>

</VersionBlock>

dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved
## Example

Instead of targeting specific resources, use the `--resource-flag` or `--exclude-resource-type` flags to target all resources of a certain type: `dbt build --resource-type RESOURCE_TYPE` replacing `RESOURCE_TYPE` with the resource type you want to include.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Instead of targeting specific resources, use the `--resource-flag` or `--exclude-resource-type` flags to target all resources of a certain type: `dbt build --resource-type RESOURCE_TYPE` replacing `RESOURCE_TYPE` with the resource type you want to include.
Instead of targeting specific resources, use the `--resource-flag` or `--exclude-resource-type` flags with the `build` or `test` command to target all resources of a certain type: `dbt build --resource-type RESOURCE_TYPE` replacing `RESOURCE_TYPE` with the resource type you want to include.

I think this is all we need?

Copy link
Contributor

Choose a reason for hiding this comment

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

See https://github.com/dbt-labs/docs.getdbt.com/pull/6126/files#r1782100963 which I believe accomplishes this same thing.

Expand Down
Loading