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

Fix store_failures schema documentation #5047

Merged
merged 8 commits into from
Jul 30, 2024
Merged

Fix store_failures schema documentation #5047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
686e61d
Update schema.md
brunokim Mar 6, 2024
c15ea62
Update store_failures.md
brunokim Mar 6, 2024
a1cef9f
Update schema.md
brunokim Mar 6, 2024
c528025
Update schema.md
brunokim Mar 6, 2024
7cf1e74
Merge branch 'current' into current
mirnawong1 Mar 22, 2024
996f208
Merge branch 'current' into current
mirnawong1 Jul 2, 2024
a56df2f
Merge branch 'current' into current
matthewshaver Jul 30, 2024
efe1446
Merge branch 'current' into current
matthewshaver Jul 30, 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
6 changes: 4 additions & 2 deletions website/docs/reference/resource-configs/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,16 @@ seeds:

### Tests

Customize the name of the schema in which tests [configured to store failures](/reference/resource-configs/store_failures) will save their results:
Customize the name of the schema in which tests [configured to store failures](/reference/resource-configs/store_failures) will save their results.
The resulting schema is `{{ profile.schema }}_{{ tests.schema }}`, with a default suffix of `dbt_test__audit`.
To use the same profile schema, set `+schema: null`.

<File name='dbt_project.yml'>

```yml
tests:
+store_failures: true
+schema: the_island_of_misfit_tests
+schema: _sad_test_failures # Will write tables to my_database.my_schema__sad_test_failures
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hiya @brunokim

This is really good and great use of the example!

Kind Regards
Natalie

```

</File>
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/resource-configs/store_failures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Optionally set a test to always or never store its failures in the database.
- If specified as `true` or `false`, the
`store_failures` config will take precedence over the presence or absence of the `--store-failures` flag.
- If the `store_failures` config is `none` or omitted, the resource will use the value of the `--store-failures` flag.
- When true, `store_failures` saves all the record(s) that failed the test only if [limit](/reference/resource-configs/limit) is not set or if there are fewer records than the limit. `store_failures` are saved in a new table with the name of the test.
- When true, `store_failures` saves all records (up to [limit](/reference/resource-configs/limit)) that failed the test. Failures are saved in a new table with the name of the test. By default, `store_failures` uses the schema `{{ profile.schema }}_dbt_test__audit`, but you can [configure](/reference/resource-configs/schema#tests) the schema suffix to a different value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hiya @brunokim,

Thanks for flagging this. This looks really good. I have no changes or suggestions on my end. I'll also look at the merge conflict for you.

Kind Regards
Natalie

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @brunokim and @nataliefiann , fixed up the merge conflict!

- A test's results will always **replace** previous failures for the same test, even if that test results in no failures.
- By default, `store_failures` uses a schema named `dbt_test__audit`, but, you can [configure](/reference/resource-configs/schema#tests) the schema to a different value. Ensure you have the authorization to create or access schemas for your work. For more details, refer to the [FAQ](#faqs).

Expand Down
Loading