docs: add documentation for drop_materialized_column Dagster job#53810
Open
inkeep[bot] wants to merge 1 commit intomasterfrom
Open
docs: add documentation for drop_materialized_column Dagster job#53810inkeep[bot] wants to merge 1 commit intomasterfrom
inkeep[bot] wants to merge 1 commit intomasterfrom
Conversation
Documents the new `drop_materialized_column` Dagster job from PR #53792 that allows engineers to drop unused materialized columns from ClickHouse to reclaim storage space.
Contributor
|
Docs from this PR will be published at posthog.com
Preview will be ready in ~10 minutes. Click Preview link above to access docs at |
Contributor
|
Comment on lines
+87
to
+89
| - **`table`** - The ClickHouse table to drop columns from (`events` or `person`, defaults to `events`) | ||
| - **`column_names`** - List of materialized column names to drop | ||
| - **`dry_run`** - Set to `true` (default) to preview what would be dropped without making changes |
Contributor
There was a problem hiding this comment.
Inconsistent config-option formatting
The new section uses **\field`** - Description(dash separator), while the existing "Manual materialization" section uses`field`: Description` (colon separator). Keeping the style consistent makes the page easier to scan.
Suggested change
| - **`table`** - The ClickHouse table to drop columns from (`events` or `person`, defaults to `events`) | |
| - **`column_names`** - List of materialized column names to drop | |
| - **`dry_run`** - Set to `true` (default) to preview what would be dropped without making changes | |
| - **`table`**: The ClickHouse table to drop columns from (`events` or `person`, defaults to `events`) | |
| - **`column_names`**: List of materialized column names to drop | |
| - **`dry_run`**: Set to `true` (default) to preview what would be dropped without making changes |
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/published/handbook/engineering/databases/materialized-columns.md
Line: 87-89
Comment:
**Inconsistent config-option formatting**
The new section uses `**\`field\`** - Description` (dash separator), while the existing "Manual materialization" section uses `**\`field\`**: Description` (colon separator). Keeping the style consistent makes the page easier to scan.
```suggestion
- **`table`**: The ClickHouse table to drop columns from (`events` or `person`, defaults to `events`)
- **`column_names`**: List of materialized column names to drop
- **`dry_run`**: Set to `true` (default) to preview what would be dropped without making changes
```
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
This file contains hidden or 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
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.
Changes
This PR updates the internal engineering documentation to include the new
drop_materialized_columnDagster job added in #53792.What's added
docs/published/handbook/engineering/databases/materialized-columns.mddrop_materialized_columnjobtable,column_names, anddry_runRelated PR
This PR was created by the Inkeep Content Writer agent, which is maintained by the Docs and Wizard team. Please reach out on Slack for help if needed.