Skip to content

Commit

Permalink
Remove scary callout (#5337)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Updated the Materialized page (as shown below) so we can remove the
scary callout:

<img width="500" alt="Screenshot 2024-04-23 at 3 22 09 PM"
src="https://github.com/dbt-labs/docs.getdbt.com/assets/107218380/d8a658e8-2cd9-4215-a23b-d4a4f58f9747">

closes #4694 

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Needs DX review
  • Loading branch information
nghi-ly authored Apr 24, 2024
2 parents 54e2f02 + 451f356 commit 0787b90
Showing 1 changed file with 80 additions and 4 deletions.
84 changes: 80 additions & 4 deletions website/docs/reference/resource-configs/materialized.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,83 @@
:::danger
---
resource_types: [models]
description: "Materialized - Read this in-depth guide to learn about materializations in dbt."
datatype: "string"
---

These docs are a placeholder for a yet-to-be-written reference section.
<Tabs
groupId="config-languages"
defaultValue="project-yaml"
values={[
{ label: 'Project file', value: 'project-yaml', },
{ label: 'Property file', value: 'property-yaml', },
{ label: 'Config block', value: 'config', },
]
}>

Please refer to the [guide on materializations](/docs/build/materializations) for current documentation.

:::
<TabItem value="project-yaml">

<File name='dbt_project.yml'>

```yaml
[config-version](/reference/project-configs/config-version): 2

models:
[<resource-path>](/reference/resource-configs/resource-path):
+materialized: [<materialization_name>](https://docs.getdbt.com/docs/build/materializations#materializations)
```
</File>
</TabItem>
<TabItem value="property-yaml">
<File name='models/properties.yml'>
```yaml
version: 2

models:
- name: <model_name>
config:
materialized: [<materialization_name>](https://docs.getdbt.com/docs/build/materializations#materializations)

```

</File>

</TabItem>


<TabItem value="config">

<File name='models/<model_name>.sql'>

```jinja
{{ config(
materialized="[<materialization_name>](https://docs.getdbt.com/docs/build/materializations#materializations)"
) }}
select ...
```

</File>

</TabItem>

</Tabs>

## Definition

[Materializations](/docs/build/materializations#materializations) are strategies for persisting dbt models in a warehouse. These are the materialization types built into dbt:

- `ephemeral` &mdash; [ephemeral](/docs/build/materializations#ephemeral) models are not directly built into the database
- `table` &mdash; a model is rebuilt as a [table](/docs/build/materializations#table) on each run
- `view` &mdash; a model is rebuilt as a [view](/docs/build/materializations#view) on each run
- `materialized_view` &mdash; allows the creation and maintenance of [materialized views](/docs/build/materializations#materialized-view) in the target database
- `incremental` &mdash; [incremental](/docs/build/materializations#incremental) models allow dbt to insert or update records into a table since the last time that model was run

You can also configure [custom materializations](/guides/create-new-materializations?step=1) in dbt. Custom materializations are a powerful way to extend dbt's functionality to meet your specific needs.

0 comments on commit 0787b90

Please sign in to comment.