Update cumulative-metrics.md #6316
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clarify different syntaxes for type_params::measure (shorthand and object syntax) raised in [internal slack thread](https://dbt-labs.slack.com/archives/C03KHQRQUBX/p1729214331646699)
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
mirnawong1
commented
Oct 18, 2024
courtneyholcomb
approved these changes
Oct 18, 2024
mirnawong1
commented
Oct 18, 2024
| | `measure::fill_nulls_with` | Sets a value (e.g., zero) to replace nulls in the metric definition. | Optional | | ||
| | `measure::join_to_timespine` | Boolean indicating if the aggregated measure should be joined to the time spine table to fill in missing dates. Default is `false`. | Optional | | ||
| | `type_params::cumulative_type_params` | Allows configuration of attributes like `window`, `period_agg`, and `grain_to_date` for cumulative metrics. | Optional | | ||
| | `cumulative_type_params::window` | Specifies the accumulation window, such as 1 month, 7 days, or 1 year. Cannot be used with `grain_to_date`. | Optional | |
There was a problem hiding this comment.
We should highlight the examples here in the format they would be entered and highlight with a code block.
Same as the above feedback, this would benefit from having a separate example field.
There was a problem hiding this comment.
will address in issue created
There was a problem hiding this comment.
Are the examples above in the proper format thought? We could quickly do this as a placeholder
Suggested change
| | `cumulative_type_params::window` | Specifies the accumulation window, such as 1 month, 7 days, or 1 year. Cannot be used with `grain_to_date`. | Optional | | |
| | `cumulative_type_params::window` | Specifies the accumulation window, such as `1 month`, `7 days`, or `1 year`. Cannot be used with `grain_to_date`. | Optional | |
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
1 task
matthewshaver
approved these changes
Oct 18, 2024
mirnawong1
commented
Oct 18, 2024
| | `measure::fill_nulls_with` | Sets a value (for example, 0) to replace nulls in the metric definition. | Optional | | ||
| | `measure::join_to_timespine` | Boolean indicating if the aggregated measure should be joined to the time spine table to fill in missing dates. Default is `false`. | Optional | | ||
| | `type_params::cumulative_type_params` | Configures the attributes like `window`, `period_agg`, and `grain_to_date` for cumulative metrics. | Optional | | ||
| | `cumulative_type_params::window` | Specifies the accumulation window, such as `1 month`, `7 days`, or `1 year`. Cannot be used with `grain_to_date`. | Optional | |
There was a problem hiding this comment.
added the backticks here @matthewshaver
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
clarify different syntaxes for type_params::measure (shorthand and object syntax)
raised in internal slack thread
🚀 Deployment available! Here are the direct links to the updated files: