Skip to content

Loader#

Note

The below checks require manifest.json to be present.

Checks related to source loaders.

Functions:

Name Description
check_source_loader_populated

Sources must have a populated loader.

check_source_loader_populated #

Sources must have a populated loader.

Parameters:

Name Type Description Default
source SourceNode

The SourceNode object to check.

required

Other Parameters (passed via config file):

Name Type Description
description str | None

Description of what the check does and why it is implemented.

exclude str | None

Regex pattern to match the source path (i.e the .yml file where the source is configured). Source paths that match the pattern will not be checked.

include str | None

Regex pattern to match the source path (i.e the .yml file where the source is configured). Only source paths that match the pattern will be checked.

severity Literal[error, warn] | None

Severity level of the check. Default: error.

Example(s):

manifest_checks:
    - name: check_source_loader_populated

Source code in src/dbt_bouncer/checks/manifest/sources/loader.py
@check
def check_source_loader_populated(source):
    """Sources must have a populated loader.

    Parameters:
        source (SourceNode): The SourceNode object to check.

    Other Parameters:
        description (str | None): Description of what the check does and why it is implemented.
        exclude (str | None): Regex pattern to match the source path (i.e the .yml file where the source is configured). Source paths that match the pattern will not be checked.
        include (str | None): Regex pattern to match the source path (i.e the .yml file where the source is configured). Only source paths that match the pattern will be checked.
        severity (Literal["error", "warn"] | None): Severity level of the check. Default: `error`.

    Example(s):
        ```yaml
        manifest_checks:
            - name: check_source_loader_populated
        ```

    """
    if source.loader == "":
        fail(f"`{source.source_name}.{source.name}` does not have a populated loader.")