Manifest Checks: Models#
Note
The below checks require manifest.json
to be present.
Classes:
Name | Description |
---|---|
CheckModelAccess |
Models must have the specified access attribute. Requires dbt 1.7+. |
CheckModelCodeDoesNotContainRegexpPattern |
The raw code for a model must not match the specified regexp pattern. |
CheckModelContractsEnforcedForPublicModel |
Public models must have contracts enforced. |
CheckModelDependsOnMultipleSources |
Models cannot reference more than one source. |
CheckModelDescriptionPopulated |
Models must have a populated description. |
CheckModelDirectories |
Only specified sub-directories are permitted. |
CheckModelDocumentedInSameDirectory |
Models must be documented in the same directory where they are defined (i.e. |
CheckModelHasContractsEnforced |
Model must have contracts enforced. |
CheckModelHasMetaKeys |
The |
CheckModelHasNoUpstreamDependencies |
Identify if models have no upstream dependencies as this likely indicates hard-coded tables references. |
CheckModelHasTags |
Models must have the specified tags. |
CheckModelHasUniqueTest |
Models must have a test for uniqueness of a column. |
CheckModelHasUnitTests |
Models must have more than the specified number of unit tests. |
CheckModelMaxChainedViews |
Models cannot have more than the specified number of upstream dependents that are not tables. |
CheckModelMaxFanout |
Models cannot have more than the specified number of downstream models. |
CheckModelMaxNumberOfLines |
Models may not have more than the specified number of lines. |
CheckModelMaxUpstreamDependencies |
Limit the number of upstream dependencies a model has. |
CheckModelNames |
Models must have a name that matches the supplied regex. |
CheckModelPropertyFileLocation |
Model properties files must follow the guidance provided by dbt here. |
CheckModelsDocumentationCoverage |
Set the minimum percentage of models that have a populated description. |
CheckModelsTestCoverage |
Set the minimum percentage of models that have at least one test. |
CheckModelAccess
#
Models must have the specified access attribute. Requires dbt 1.7+.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
access
|
Literal['private', 'protected', 'public']
|
The access level to check for. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
manifest_checks:
# Align with dbt best practices that marts should be `public`, everything else should be `protected`
- name: check_model_access
access: protected
include: ^models/intermediate
- name: check_model_access
access: public
include: ^models/marts
- name: check_model_access
access: protected
include: ^models/staging
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelCodeDoesNotContainRegexpPattern
#
The raw code for a model must not match the specified regexp pattern.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
regexp_pattern
|
str
|
The regexp pattern that should not be matched by the model code. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
manifest_checks:
# Prefer `coalesce` over `ifnull`: https://docs.sqlfluff.com/en/stable/rules.html#sqlfluff.rules.sphinx.Rule_CV02
- name: check_model_code_does_not_contain_regexp_pattern
regexp_pattern: .*[i][f][n][u][l][l].*
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelContractsEnforcedForPublicModel
#
Public models must have contracts enforced.
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelDependsOnMultipleSources
#
Models cannot reference more than one source.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
required |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelDescriptionPopulated
#
Models must have a populated description.
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelDirectories
#
Only specified sub-directories are permitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
include
|
str
|
Regex pattern to the directory to check. |
required |
permitted_sub_directories
|
List[str]
|
List of permitted sub-directories. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Example(s):
manifest_checks:
- name: check_model_directories
include: models
permitted_sub_directories:
- intermediate
- marts
- staging
# Restrict sub-directories within `./models/staging`
- name: check_model_directories
include: ^models/staging
permitted_sub_directories:
- crm
- payments
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelDocumentedInSameDirectory
#
Models must be documented in the same directory where they are defined (i.e. .yml
and .sql
files are in the same directory).
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelHasContractsEnforced
#
Model must have contracts enforced.
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelHasMetaKeys
#
The meta
config for models must have the specified keys.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
keys
|
NestedDict
|
A list (that may contain sub-lists) of required keys. |
required |
model
|
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
required |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelHasNoUpstreamDependencies
#
Identify if models have no upstream dependencies as this likely indicates hard-coded tables references.
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelHasTags
#
Models must have the specified tags.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
required |
tags
|
List[str]
|
List of tags to check for. |
required |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelHasUniqueTest
#
Models must have a test for uniqueness of a column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
accepted_uniqueness_tests
|
Optional[List[str]]
|
List of tests that are accepted as uniqueness tests. |
required |
model
|
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
required |
tests
|
List[DbtBouncerTestBase]
|
List of DbtBouncerTestBase objects parsed from |
required |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
manifest_checks:
# Example of allowing a custom uniqueness test
- name: check_model_has_unique_test
accepted_uniqueness_tests:
- expect_compound_columns_to_be_unique
- my_custom_uniqueness_test
- unique
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelHasUnitTests
#
Models must have more than the specified number of unit tests.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
min_number_of_unit_tests
|
Optional[int]
|
The minimum number of unit tests that a model must have. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
manifest_obj |
DbtBouncerManifest
|
The DbtBouncerManifest object parsed from |
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
unit_tests |
List[UnitTests]
|
List of UnitTests objects parsed from |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Warning
This check is only supported for dbt 1.8.0 and above.
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelMaxChainedViews
#
Models cannot have more than the specified number of upstream dependents that are not tables.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
materializations_to_include
|
Optional[List[str]]
|
List of materializations to include in the check. |
required |
max_chained_views
|
Optional[int]
|
The maximum number of upstream dependents that are not tables. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
models |
List[DbtBouncerModelBase]
|
List of DbtBouncerModelBase objects parsed from |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
manifest_checks:
- name: check_model_max_chained_views
materializations_to_include:
- ephemeral
- my_custom_materialization
- view
max_chained_views: 5
Source code in src/dbt_bouncer/checks/manifest/check_models.py
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 |
|
CheckModelMaxFanout
#
Models cannot have more than the specified number of downstream models.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
max_downstream_models
|
Optional[int]
|
The maximum number of permitted downstream models. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
models |
List[DbtBouncerModelBase]
|
List of DbtBouncerModelBase objects parsed from |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelMaxNumberOfLines
#
Models may not have more than the specified number of lines.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
max_number_of_lines
|
int
|
The maximum number of permitted lines. |
required |
model
|
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
required |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelMaxUpstreamDependencies
#
Limit the number of upstream dependencies a model has.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
max_upstream_macros
|
Optional[int]
|
The maximum number of permitted upstream macros. |
required |
max_upstream_models
|
Optional[int]
|
The maximum number of permitted upstream models. |
required |
max_upstream_sources
|
Optional[int]
|
The maximum number of permitted upstream sources. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelNames
#
Models must have a name that matches the supplied regex.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_name_pattern
|
str
|
Regexp the model name must match. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
model |
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
manifest_checks:
- name: check_model_names
include: ^models/intermediate
model_name_pattern: ^int_
- name: check_model_names
include: ^models/staging
model_name_pattern: ^stg_
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelPropertyFileLocation
#
Model properties files must follow the guidance provided by dbt here.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model
|
DbtBouncerModelBase
|
The DbtBouncerModelBase object to check. |
required |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
exclude |
Optional[str]
|
Regex pattern to match the model path. Model paths that match the pattern will not be checked. |
include |
Optional[str]
|
Regex pattern to match the model path. Only model paths that match the pattern will be checked. |
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelsDocumentationCoverage
#
Set the minimum percentage of models that have a populated description.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
min_model_documentation_coverage_pct
|
float
|
The minimum percentage of models that must have a populated description. |
required |
Receives at execution time:
Name | Type | Description |
---|---|---|
models |
List[DbtBouncerModelBase]
|
List of DbtBouncerModelBase objects parsed from |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):
manifest_checks:
- name: check_model_documentation_coverage
min_model_documentation_coverage_pct: 90
Source code in src/dbt_bouncer/checks/manifest/check_models.py
CheckModelsTestCoverage
#
Set the minimum percentage of models that have at least one test.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
min_model_test_coverage_pct
|
float
|
The minimum percentage of models that must have at least one test. |
required |
models
|
List[DbtBouncerModelBase]
|
List of DbtBouncerModelBase objects parsed from |
required |
tests
|
List[DbtBouncerTestBase]
|
List of DbtBouncerTestBase objects parsed from |
required |
Other Parameters (passed via config file):
Name | Type | Description |
---|---|---|
severity |
Optional[Literal['error', 'warn']]
|
Severity level of the check. Default: |
Example(s):