dbt-audit-helper 使用教程

dbt-audit-helper 使用教程

dbt-audit-helperUseful macros when performing data audits项目地址:https://gitcode.com/gh_mirrors/db/dbt-audit-helper

1. 项目的目录结构及介绍

dbt-audit-helper/
├── README.md
├── dbt_project.yml
├── models/
│   ├── example/
│   │   ├── example_audit_helper.sql
│   │   └── example_audit_helper.yml
│   └── macros/
│       ├── audit_helper.sql
│       └── __init__.py
├── tests/
│   └── example/
│       └── example_audit_helper_test.sql
└── .github/
    └── workflows/
        └── ci.yml

• README.md: 项目介绍文档。
• dbt_project.yml: dbt 项目配置文件。
• models/: 包含项目中的模型文件。
  • example/: 示例模型文件夹。
    • example_audit_helper.sql: 示例模型 SQL 文件。
    • example_audit_helper.yml: 示例模型配置文件。
  • macros/: 包含宏文件。
    • audit_helper.sql: 审计辅助宏文件。
    • __init__.py: Python 初始化文件。
• tests/: 包含测试文件。
  • example/: 示例测试文件夹。
    • example_audit_helper_test.sql: 示例测试 SQL 文件。
• .github/: GitHub 相关配置文件。
  • workflows/: GitHub Actions 工作流配置文件。
    • ci.yml: 持续集成配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 dbt_project.yml 文件，该文件包含了 dbt 项目的配置信息，如项目名称、版本、模型路径等。以下是一个示例配置：

name: 'dbt_audit_helper'
version: '1.0.0'
config-version: 2

profile: 'default'

source-paths: ["models"]
analysis-paths: ["analysis"]
test-paths: ["tests"]
data-paths: ["data"]
macro-paths: ["macros"]
snapshot-paths: ["snapshots"]

target-path: "target"
clean-targets:
    - "target"
    - "dbt_modules"
    - "logs"

models:
  dbt_audit_helper:
    example:
      +materialized: view

3. 项目的配置文件介绍

项目的配置文件主要是 dbt_project.yml 和 models/example/example_audit_helper.yml 文件。

dbt_project.yml

该文件包含了 dbt 项目的全局配置，如项目名称、版本、模型路径等。具体配置项如下：

• name: 项目名称。
• version: 项目版本。
• config-version: 配置版本。
• profile: 使用的 dbt 配置文件。
• source-paths: 模型文件路径。
• analysis-paths: 分析文件路径。
• test-paths: 测试文件路径。
• data-paths: 数据文件路径。
• macro-paths: 宏文件路径。
• snapshot-paths: 快照文件路径。
• target-path: 目标文件路径。
• clean-targets: 清理目标。

models/example/example_audit_helper.yml

该文件包含了示例模型的配置信息，如模型名称、材料化类型等。具体配置项如下：

version: 2

models:
  - name: example_audit_helper
    description: "示例审计辅助模型"
    columns:
      - name: order_id
        description: "订单ID"
      - name: customer_id
        description: "客户ID"

以上是 dbt-audit-helper 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

dbt-audit-helperUseful macros when performing data audits项目地址:https://gitcode.com/gh_mirrors/db/dbt-audit-helper