Skip to content

Manifest Checks: Snapshots#

Note

The below checks require manifest.json to be present.

Classes:

Name Description
CheckSnapshotHasTags

Snapshots must have the specified tags.
CheckSnapshotNames

Snapshots must have a name that matches the supplied regex.

CheckSnapshotHasTags #

Snapshots must have the specified tags.

Parameters:

Name Type Description Default
snapshot DbtBouncerSnapshotBase

The DbtBouncerSnapshotBase 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 snapshot path. Snapshot paths that match the pattern will not be checked.
include Optional[str]

Regex pattern to match the snapshot path. Only snapshot paths that match the pattern will be checked.
severity Optional[Literal['error', 'warn']]

Severity level of the check. Default: error.

Example(s): 

manifest_checks:
    - name: check_snapshot_has_tags
      tags:
        - tag_1
        - tag_2

Source code in src/dbt_bouncer/checks/manifest/check_snapshots.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class CheckSnapshotHasTags(BaseCheck):
    """Snapshots must have the specified tags.

    Parameters:
        snapshot (DbtBouncerSnapshotBase): The DbtBouncerSnapshotBase object to check.
        tags (List[str]): List of tags to check for.

    Other Parameters:
        exclude (Optional[str]): Regex pattern to match the snapshot path. Snapshot paths that match the pattern will not be checked.
        include (Optional[str]): Regex pattern to match the snapshot path. Only snapshot paths that match the pattern will be checked.
        severity (Optional[Literal["error", "warn"]]): Severity level of the check. Default: `error`.

    Example(s):
        ```yaml
        manifest_checks:
            - name: check_snapshot_has_tags
              tags:
                - tag_1
                - tag_2
        ```

    """

    name: Literal["check_snapshot_has_tags"]
    snapshot: "DbtBouncerSnapshotBase" = Field(default=None)
    tags: List[str]

    def execute(self) -> None:
        """Execute the check."""
        missing_tags = [tag for tag in self.tags if tag not in self.snapshot.tags]
        assert not missing_tags, (
            f"`{self.snapshot.name}` is missing required tags: {missing_tags}."
        )

CheckSnapshotNames #

Snapshots must have a name that matches the supplied regex.

Parameters:

Name Type Description Default
snapshot_name_pattern str

Regexp the snapshot name must match.

 required

Receives at execution time:

Name Type Description
snapshot DbtBouncerSnapshotBase

The DbtBouncerSnapshotBase object to check.

Other Parameters (passed via config file):

Name Type Description
exclude Optional[str]

Regex pattern to match the snapshot path. Snapshot paths that match the pattern will not be checked.
include Optional[str]

Regex pattern to match the snapshot path. Only snapshot paths that match the pattern will be checked.
severity Optional[Literal['error', 'warn']]

Severity level of the check. Default: error.

Example(s): 

manifest_checks:
    - name: check_snapshot_names
      include: ^snapshots/erp
      snapshot_name_pattern: ^erp

Source code in src/dbt_bouncer/checks/manifest/check_snapshots.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class CheckSnapshotNames(BaseCheck):
    """Snapshots must have a name that matches the supplied regex.

    Parameters:
        snapshot_name_pattern (str): Regexp the snapshot name must match.

    Receives:
        snapshot (DbtBouncerSnapshotBase): The DbtBouncerSnapshotBase object to check.

    Other Parameters:
        exclude (Optional[str]): Regex pattern to match the snapshot path. Snapshot paths that match the pattern will not be checked.
        include (Optional[str]): Regex pattern to match the snapshot path. Only snapshot paths that match the pattern will be checked.
        severity (Optional[Literal["error", "warn"]]): Severity level of the check. Default: `error`.

    Example(s):
        ```yaml
        manifest_checks:
            - name: check_snapshot_names
              include: ^snapshots/erp
              snapshot_name_pattern: ^erp
        ```

    """

    name: Literal["check_snapshot_names"]
    snapshot: "DbtBouncerSnapshotBase" = Field(default=None)
    snapshot_name_pattern: str

    def execute(self) -> None:
        """Execute the check."""
        assert (
            re.compile(self.snapshot_name_pattern.strip()).match(self.snapshot.name)
            is not None
        ), (
            f"`{self.snapshot.name}` does not match the supplied regex `{self.snapshot_name_pattern.strip()})`."
        )