Skip to content

Commit

Permalink
Skip download of artifacts with dbt Cloud CLI (#5954)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

For the dbt Cloud CLI, prevent artifact files from being downloaded by
using `--download-artifacts=false`

- Add new FAQ item to the Configure CLI page
https://docs.getdbt.com/docs/cloud/configure-cloud-cli#faqs
- Add new paragraph in this section
https://docs.getdbt.com/reference/artifacts/dbt-artifacts#when-are-artifacts-produced

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] Needs review from PM

---------

Co-authored-by: Matt Shaver <[email protected]>
  • Loading branch information
nghi-ly and matthewshaver authored Aug 23, 2024
1 parent def5d94 commit 55088cc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
7 changes: 7 additions & 0 deletions website/docs/docs/cloud/configure-cloud-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,3 +189,10 @@ move %USERPROFILE%\Downloads\dbt_cloud.yml %USERPROFILE%\.dbt\dbt_cloud.yml
This command moves the `dbt_cloud.yml` from the `Downloads` folder to the `.dbt` folder. If your `dbt_cloud.yml` file is located elsewhere, adjust the path accordingly.
</Expandable>
<Expandable alt_header="How to skip artifacts from being downloaded">
By default, [all artifacts](/reference/artifacts/dbt-artifacts) are downloaded when you execute dbt commands from the dbt Cloud CLI. To skip these files from being downloaded, add `--download-artifacts=false` to the command you want to run. This can help improve run-time performance but might break workflows that depend on assets like the [manifest](/reference/artifacts/manifest-json).
</Expandable>
2 changes: 2 additions & 0 deletions website/docs/reference/artifacts/dbt-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Most dbt commands (and corresponding RPC methods) produce artifacts:
- [catalog](catalog-json): produced by `docs generate`
- [sources](/reference/artifacts/sources-json): produced by `source freshness`

When running commands from the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), all artifacts are downloaded by default. If you want to change this behavior, refer to [How to skip artifacts from being downloaded](/docs/cloud/configure-cloud-cli#how-to-skip-artifacts-from-being-downloaded).

## Where are artifacts produced?

By default, artifacts are written to the `/target` directory of your dbt project. You can configure the location using the [`target-path` flag](/reference/global-configs/json-artifacts).
Expand Down

0 comments on commit 55088cc

Please sign in to comment.