Define properties

Learn how to define properties for your resources in a properties.yml file

In dbt, you can use properties.yml files to define properties for resources. You can declare properties in .yml files, in the same directory as your resources. You can name these files whatever_you_want.yml and nest them arbitrarily in sub-folders within each directory.

We highly recommend that you define properties in dedicated paths alongside the resources they're describing.

info

schema.yml files

Previous versions of the docs referred to these as schema.yml files — we've moved away from that terminology since the word schema is used to mean other things when talking about databases, and people often thought that you had to name these files schema.yml.

Instead, we now refer to these files as properties.yml files. (Of course, you're still free to name your files schema.yml)

Which properties are not also configs?

In dbt, you can define node configs in properties.yml files, in addition to config() blocks and dbt_project.yml. However, some special properties can only be defined in the .yml file and you cannot configure them using config() blocks or the dbt_project.yml file:

Certain properties are special, because:

• They have a unique Jinja rendering context
• They create new project resources
• They don't make sense as hierarchical configuration
• They're older properties that haven't yet been redefined as configs

These properties are:

• description
• tests
• docs
• columns
• quote
• source properties (for example, loaded_at_field, freshness)
• exposure properties (for example, type, maturity)
• macro properties (for example, arguments)

Example

Here's an example that defines both sources and models for a project:

models/jaffle_shop.yml

version: 2

sources:
  - name: raw_jaffle_shop
    description: A replica of the postgres database used to power the jaffle_shop app.
    tables:
      - name: customers
        columns:
          - name: id
            description: Primary key of the table
            tests:
              - unique
              - not_null

      - name: orders
        columns:
          - name: id
            description: Primary key of the table
            tests:
              - unique
              - not_null

          - name: user_id
            description: Foreign key to customers

          - name: status
            tests:
              - accepted_values:
                  values: ['placed', 'shipped', 'completed', 'return_pending', 'returned']


models:
  - name: stg_jaffle_shop__customers
    config:
      tags: ['pii']
    columns:
      - name: customer_id
        tests:
          - unique
          - not_null

  - name: stg_jaffle_shop__orders
    config:
      materialized: view
    columns:
      - name: order_id
        tests:
          - unique
          - not_null
      - name: status
        tests:
          - accepted_values:
              values: ['placed', 'shipped', 'completed', 'return_pending', 'returned']
              config:
                severity: warn

Related documentation

You can find an exhaustive list of each supported property and config, broken down by resource type:

• Model properties and configs
• Source properties and configs
• Seed properties and configs
• Snapshot properties
• Analysis properties
• Macro properties
• Exposure properties

FAQs

Does my `.yml` file containing tests and descriptions need to be named `schema.yml`?

No! You can name this file whatever you want (including whatever_you_want.yml), so long as:

• The file is in your models/ directory¹
• The file has .yml extension

Check out the docs for more information.

¹If you're declaring properties for seeds, snapshots, or macros, you can also place this file in the related directory — seeds/, snapshots/ and macros/ respectively.

If I can name these files whatever I'd like, what should I name them?

It's up to you! Here's a few options:

• Default to the existing terminology: schema.yml (though this does make it hard to find the right file over time)
• Use the same name as your directory (assuming you're using sensible names for your directories)
• If you test and document one model (or seed, snapshot, macro etc.) per file, you can give it the same name as the model (or seed, snapshot, macro etc.)

Choose what works for your team. We have more recommendations in our guide on structuring dbt projects.

Should I use separate files to declare resource properties, or one large file?

It's up to you:

• Some folks find it useful to have one file per model (or source / snapshot / seed etc)
• Some find it useful to have one per directory, documenting and testing multiple models in one file

Choose what works for your team. We have more recommendations in our guide on structuring dbt projects.

Can I add tests and descriptions in a config block?

dbt has the ability to define node configs in .yml files, in addition to config() blocks and dbt_project.yml. But the reverse isn't always true: there are some things in .yml files that can only be defined there.

Certain properties are special, because:

• They have a unique Jinja rendering context
• They create new project resources
• They don't make sense as hierarchical configuration
• They're older properties that haven't yet been redefined as configs

These properties are:

• description
• tests
• docs
• columns
• quote
• source properties (e.g. loaded_at_field, freshness)
• exposure properties (e.g. type, maturity)
• macro properties (e.g. arguments)

Why do model and source yml files always start with `version: 2`?

Once upon a time, the structure of these .yml files was very different (s/o to anyone who was using dbt back then!). Adding version: 2 allowed us to make this structure more extensible.

Resource yml files do not currently require this config. We only support version: 2 if it's specified. Although we do not expect to update yml files to version: 3 soon, having this config will make it easier for us to introduce new structures in the future

Can I use a YAML file extension?

No. At present, dbt will only search for files with a .yml file extension. In a future release of dbt, dbt will also search for files with a .yaml file extension.

Troubleshooting common errors

 Invalid test config given in [model name]

This error occurs when your .yml file does not conform to the structure expected by dbt. A full error message might look like:

* Invalid test config given in models/schema.yml near {'namee': 'event', ...}
  Invalid arguments passed to "UnparsedNodeUpdate" instance: 'name' is a required property, Additional properties are not allowed ('namee' was unexpected)

While verbose, an error like this should help you track down the issue. Here, the name field was provided as namee by accident. To fix this error, ensure that your .yml conforms to the expected structure described in this guide.

 Invalid syntax in your schema.yml file

If your .yml file is not valid yaml, then dbt will show you an error like this:

Runtime Error
  Syntax error near line 6
  ------------------------------
  5  |   - name: events
  6  |     description; "A table containing clickstream events from the marketing website"
  7  |

  Raw Error:
  ------------------------------
  while scanning a simple key
    in "<unicode string>", line 6, column 5:
          description; "A table containing clickstream events from the marketing website"
          ^

This error occurred because a semicolon (;) was accidentally used instead of a colon (:) after the description field. To resolve issues like this, find the .yml file referenced in the error message and fix any syntax errors present in the file. There are online YAML validators that can be helpful here, but please be mindful of submitting sensitive information to third-party applications!