https://github.com/aranke-archive/dbt-yaml-check

dbt-yaml-check checks that columns defined in YAML also exist in SQL.
https://github.com/aranke-archive/dbt-yaml-check

dbt python yaml

Last synced: 3 months ago
JSON representation

dbt-yaml-check checks that columns defined in YAML also exist in SQL.

• Host: GitHub
• URL: https://github.com/aranke-archive/dbt-yaml-check
• Owner: aranke-archive
• License: mit
• Archived: true
• Created: 2022-06-07T00:50:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-09T21:05:49.000Z (over 2 years ago)
• Last Synced: 2024-07-28T21:57:04.404Z (3 months ago)
• Topics: dbt, python, yaml
• Language: Python
• Homepage:
• Size: 42 KB
• Stars: 31
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-dbt - dbt-yaml-check - Checks that columns defined in YAML also exist in SQL. (Packages)

README

        
# dbt-yaml-check

![PyPI](https://img.shields.io/pypi/v/dbt-yaml-check)

[![test](https://github.com/k-aranke/dbt-yaml-check/actions/workflows/test.yml/badge.svg)](https://github.com/k-aranke/dbt-yaml-check/actions/workflows/test.yml)

`dbt-yaml-check` checks that columns defined in YAML also exist in SQL.

This is particularly useful for identifying extraneous columns and typos in column names.

## Installation

`dbt-yaml-check` requires Python version 3.7 or higher.

```shell

pip install dbt-yaml-check

```

## Usage

```shell

$ cd jaffle_shop

$ dbt run

$ dbt docs generate

$ dbt-yaml-check

+-----------+--------------------+-----+------+

|   Model   |       Column       | SQL | YAML |

+-----------+--------------------+-----+------+

| customers | total_order_amount |  ✕  |  ✓   |

+-----------+--------------------+-----+------+

```

## FAQ

### How can I specify a custom target directory?

Use the `target-dir` option like so: `dbt-yaml-check --target-dir `.