Skip to content

Commit

Permalink
Fix examples for dbt deps --add-package (#4470)
Browse files Browse the repository at this point in the history
[Preview](https://docs-getdbt-com-git-dbeatty-fix-dbt-deps-add-package-dbt-labs.vercel.app/reference/commands/deps)

## What are you changing in this pull request and why?

Fixing the code examples per
dbt-labs/dbt-core#9076 by using test examples
from dbt-labs/dbt-core#8408

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [x] I've checked that the code examples work
- [x] I've confirmed that the preview renders correctly
  • Loading branch information
dbeatty10 authored Nov 15, 2023
1 parent a96731e commit ac5ad7b
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions website/docs/reference/commands/deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,28 @@ Update your versions in packages.yml, then run dbt deps

<VersionBlock firstVersion="1.7">

dbt generates the `package-lock.yml` file in the _project_root_ where `packages.yml` is recorded, which contains all the resolved packages, the first time you run `dbt deps`. Each subsequent run records the packages installed in this file. If the subsequent `dbt deps` runs contain no updated packages in `depenedencies.yml` or `packages.yml`, dbt-core installs from `package-lock.yml`.
dbt generates the `package-lock.yml` file in the _project_root_ where `packages.yml` is recorded, which contains all the resolved packages, the first time you run `dbt deps`. Each subsequent run records the packages installed in this file. If the subsequent `dbt deps` runs contain no updated packages in `dependencies.yml` or `packages.yml`, dbt-core installs from `package-lock.yml`.

When you update the package spec and run `dbt deps` again, the package-lock and package files update accordingly. You can run `dbt deps --lock` to update the `package-lock.yml` with the most recent dependencies from `packages`.

The `--add` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist.
The `--add-package` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist.

Examples of the `--add` flag:
Examples of the `--add-package` flag:
```shell
# add package from hub (--source arg defaults to "hub")
dbt deps add --package dbt-labs/dbt_utils --version 1.0.0
dbt deps --add-package dbt-labs/dbt_utils@1.0.0

# add package from hub with semantic version
dbt deps add --package dbt-labs/snowplow --version ">=0.7.0,<0.8.0"
# add package from hub with semantic version range
dbt deps --add-package dbt-labs/snowplow@">=0.7.0,<0.8.0"

# add package from git
dbt deps add --package https://github.com/fivetran/dbt_amplitude --version v0.3.0 --source git
dbt deps --add-package https://github.com/fivetran/dbt_amplitude@v0.3.0 --source git

# add package from local (--version not required for local)
dbt deps add --package /opt/dbt/redshift --source local
# add package from local
dbt deps --add-package /opt/dbt/redshift --source local

# add package to packages.yml WITHOUT updating package-lock.yml
dbt deps add --package dbt-labs/dbt_utils --version 1.0.0 --dry-run True
# add package to packages.yml and package-lock.yml WITHOUT actually installing dependencies
dbt deps --add-package dbt-labs/dbt_utils@1.0.0 --dry-run

```
</VersionBlock>
</VersionBlock>

0 comments on commit ac5ad7b

Please sign in to comment.