dbt-contracts 0.1.0

Enforce standards for your dbt projects through automated checks and generators

dbt-contracts

Enforce standards for your dbt projects through automated checks and generators

Contents

• Installation
• Contracts Reference
  • Models
  • Model Columns
  • Sources
  • Source Columns
  • Macros
  • Macro Arguments

Installation

Install through pip using one of the following commands:

pip install dbt-contracts

python -m pip install dbt-contracts

Contracts Reference

Below you will find a list of all available contracts grouped by the dbt object it operates on. Refer to this list to help when designing your contract file.

Models

Filters

• is_materialized: Check whether the given node is configured to be materialized.
• meta: Check whether a given resource has any matching meta to the accepted_values.
• name: Check whether a given item has a valid name.
• paths: Check whether a given item has a valid path.

Enforcements

• exists: Check whether the node exists in the database.
• has_all_columns: Check whether the node properties contain all available columns of the node.
• has_constraints: Check whether the given node has an appropriate number of constraints.
• has_contract: Check whether the node properties define a contract.
• has_description: Check whether the given resource has a description set.
• has_expected_columns: Check whether the node properties contain the expected set of columns.
• has_matching_description: Check whether the given node has a description configured which matches the remote resource.
• has_no_final_semicolon: Check whether the given node has a no closing semicolon at the end of the script.
• has_no_hardcoded_refs: Check whether the given node has a no hardcoded upstream references.
• has_properties: Check whether the given resource has properties set in an appropriate properties file.
• has_tests: Check whether the given node has an appropriate number of tests.
• has_valid_macro_dependencies: Check whether the given node has valid upstream macro dependencies.
• has_valid_ref_dependencies: Check whether the given node has valid upstream ref dependencies.
• has_valid_source_dependencies: Check whether the given node has valid upstream source dependencies.
• meta_has_accepted_values: Check whether the resource's meta config is configured as expected.
• meta_has_allowed_keys: Check whether the resource's meta config contains only allowed keys.
• meta_has_required_keys: Check whether the resource's meta config contains all required keys.
• tags_have_allowed_values: Check whether the given resource has properties set in an appropriate properties file.
• tags_have_required_values: Check whether the given resource has properties set in an appropriate properties file.

Model Columns

Filters

• meta: Check whether a given resource has any matching meta to the accepted_values.
• name: Check whether a given item has a valid name.

Enforcements

• exists: Check whether the column exists in the database.
• has_data_type: Check whether the given column of the given parent has a data type set.
• has_description: Check whether the given resource has a description set.
• has_expected_name: Check whether the given column of the given parent has a name that matches some expectation.
• has_matching_data_type: Check whether the given column of the given parent
• has_matching_description: Check whether the given column of the given parent
• has_matching_index: Check whether the given column of the given parent
• has_tests: Check whether the given column of the given parent has an appropriate number of tests.
• meta_has_accepted_values: Check whether the resource's meta config is configured as expected.
• meta_has_allowed_keys: Check whether the resource's meta config contains only allowed keys.
• meta_has_required_keys: Check whether the resource's meta config contains all required keys.
• tags_have_allowed_values: Check whether the given resource has properties set in an appropriate properties file.
• tags_have_required_values: Check whether the given resource has properties set in an appropriate properties file.

Sources

Filters

• is_enabled: Check whether the given source is enabled.
• meta: Check whether a given resource has any matching meta to the accepted_values.
• name: Check whether a given item has a valid name.
• paths: Check whether a given item has a valid path.

Enforcements

• exists: Check whether the node exists in the database.
• has_all_columns: Check whether the node properties contain all available columns of the node.
• has_description: Check whether the given resource has a description set.
• has_downstream_dependencies: Check whether the given source has freshness configured.
• has_expected_columns: Check whether the node properties contain the expected set of columns.
• has_freshness: Check whether the given source has freshness configured.
• has_loader: Check whether the given source has a loader configured.
• has_matching_description: Check whether the given node has a description configured which matches the remote resource.
• has_properties: Check whether the given resource has properties set in an appropriate properties file.
• has_tests: Check whether the given node has an appropriate number of tests.
• meta_has_accepted_values: Check whether the resource's meta config is configured as expected.
• meta_has_allowed_keys: Check whether the resource's meta config contains only allowed keys.
• meta_has_required_keys: Check whether the resource's meta config contains all required keys.
• tags_have_allowed_values: Check whether the given resource has properties set in an appropriate properties file.
• tags_have_required_values: Check whether the given resource has properties set in an appropriate properties file.

Source Columns

Filters

• meta: Check whether a given resource has any matching meta to the accepted_values.
• name: Check whether a given item has a valid name.

Enforcements

• exists: Check whether the column exists in the database.
• has_data_type: Check whether the given column of the given parent has a data type set.
• has_description: Check whether the given resource has a description set.
• has_expected_name: Check whether the given column of the given parent has a name that matches some expectation.
• has_matching_data_type: Check whether the given column of the given parent
• has_matching_description: Check whether the given column of the given parent
• has_matching_index: Check whether the given column of the given parent
• has_tests: Check whether the given column of the given parent has an appropriate number of tests.
• meta_has_accepted_values: Check whether the resource's meta config is configured as expected.
• meta_has_allowed_keys: Check whether the resource's meta config contains only allowed keys.
• meta_has_required_keys: Check whether the resource's meta config contains all required keys.
• tags_have_allowed_values: Check whether the given resource has properties set in an appropriate properties file.
• tags_have_required_values: Check whether the given resource has properties set in an appropriate properties file.

Macros

Filters

• name: Check whether a given item has a valid name.
• paths: Check whether a given item has a valid path.

Enforcements

• has_description: Check whether the given resource has a description set.
• has_properties: Check whether the given resource has properties set in an appropriate properties file.

Macro Arguments

Filters

• name: Check whether a given item has a valid name.

Enforcements

• has_description: Check whether the given resource has a description set.
• has_type: Check whether the given argument has its type set in an appropriate properties file.