Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting custom materializations #5211

Merged
merged 3 commits into from
Apr 4, 2024
Merged

Documenting custom materializations #5211

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e8bd05
Documenting custom materializations
dbeatty10 Apr 2, 2024
b668c7a
Update website/docs/faqs/Docs/documenting-macros.md
mirnawong1 Apr 4, 2024
bb2f218
Merge branch 'current' into dbeatty10-patch-1
mirnawong1 Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions website/docs/faqs/Docs/documenting-macros.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,26 @@ macros:
```

</File>

## Document a custom materialization

When you create a [custom materialization](/guides/create-new-materializations), dbt creates an associated macro with the following format:
```
materialization_{materialization_name}_{adapter}
```

To document a custom materialization, use the previously mentioned format to determine the associated macro name(s) to document.

<File name='macros/properties.yml'>

```yaml
version: 2

macros:
- name: materialization_my_materialization_name_default
description: A custom materialization to insert records into an append-only table and track when they were added.
- name: materialization_my_materialization_name_xyz
description: A custom materialization to insert records into an append-only table and track when they were added.
```

</File>
Loading