Installing packages with packages.yml in dbt - Visual Walkthrough

Concept Flow - Installing packages with packages.yml

Create packages.yml file

↓

Add package details

↓

Run 'dbt deps' command

↓

dbt downloads packages

↓

Packages installed in 'dbt_packages'

↓

Use packages in your project

This flow shows how to add package info to packages.yml, run dbt deps to download, and then use the packages.

Execution Sample

dbt

packages:
  - package: fishtown-analytics/dbt_utils
    version: 0.8.6

This packages.yml file tells dbt to install the dbt_utils package version 0.8.6.

Execution Table

Step	Action	Command/Content	Result
1	Create packages.yml	Add package name and version	File created with package info
2	Run dbt deps	dbt deps	dbt reads packages.yml
3	Download packages	dbt downloads dbt_utils v0.8.6	Package saved in dbt_packages
4	Verify installation	Check dbt_packages folder	dbt_utils package present
5	Use package	Reference dbt_utils in models	Package functions available
6	Exit	No more packages to install	Process complete

💡 All packages listed in packages.yml are installed and ready to use.

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
packages.yml content	empty	package: fishtown-analytics/dbt_utils v0.8.6	read by dbt deps	package downloaded	package ready in dbt_packages
dbt_packages folder	empty	empty	empty	dbt_utils v0.8.6 present	dbt_utils usable

Key Moments - 2 Insights

Why do we need to run 'dbt deps' after creating packages.yml?

Because dbt reads packages.yml only when you run 'dbt deps' to download and install the packages, as shown in steps 2 and 3 of the execution_table.

What happens if the version number in packages.yml is missing or incorrect?

dbt may download the latest version or fail to find the package. The execution_table step 3 shows the importance of specifying the correct version.

Visual Quiz - 3 Questions

Look at the execution table, what is the result after running 'dbt deps'?

A dbt reads packages.yml

B Package functions become available

C File packages.yml is created

D dbt_packages folder is deleted

💡 Hint

Check Step 2 in the execution_table where 'dbt deps' is run.

At which step does the package get downloaded into dbt_packages?

A Step 1

B Step 5

C Step 3

D Step 6

💡 Hint

Look at Step 3 in the execution_table for the download action.

If you forget to run 'dbt deps', what will happen when you try to use the package?

A dbt will automatically download the package

B The package will not be found and cause errors

C The package functions will work normally

D The packages.yml file will be deleted

💡 Hint

Refer to the key_moments about running 'dbt deps' and the execution_table steps.

Concept Snapshot

packages.yml lists packages with name and version
Run 'dbt deps' to download packages
Packages saved in dbt_packages folder
Use package functions in your dbt models
Always specify correct version
Run 'dbt deps' after editing packages.yml

Full Transcript

To install packages in dbt, you create a packages.yml file listing the packages and their versions. Then you run the command 'dbt deps' which reads this file and downloads the packages into the dbt_packages folder. After this, you can use the package functions in your dbt project. If you do not run 'dbt deps', the packages will not be downloaded and your project will not find them. Specifying the correct version in packages.yml ensures you get the right package version.