refactor: rename reports for consistent categories#88
Merged
Conversation
- b6 → c1: buffer cache is not bloat, new 'cache' category - c1 → p1: index creation progress, new 'progress' category - p1 → x1: alignment padding (experimental), new 'experimental' category Updated: start.psql menu, README, CI regression tests, release notes.
| \echo ' b5 – Tables and columns without stats (so bloat cannot be estimated)' | ||
| \echo ' b6 – Buffer cache contents (requires pg_buffercache; expensive)' | ||
| \echo ' c1 – Index (re)creation progress (CREATE INDEX / REINDEX)' | ||
| \echo ' c1 – Buffer cache contents (requires pg_buffercache; expensive)' |
There was a problem hiding this comment.
Might be worth adding the previous ID in the menu text for a release or two so existing docs/muscle-memory can map quickly.
Suggested change
| \echo ' c1 – Buffer cache contents (requires pg_buffercache; expensive)' | |
| \echo ' c1 – Buffer cache contents (requires pg_buffercache; expensive; was b6)' |
| \echo ' l1 – Lock trees (lightweight)' | ||
| \echo ' l2 – Lock trees, detailed (based on pg_blocking_pids())' | ||
| \echo ' p1 – [EXP] Alignment padding: how many bytes can be saved if columns are reordered?' | ||
| \echo ' p1 – Index (re)creation progress (CREATE INDEX / REINDEX)' |
There was a problem hiding this comment.
Same idea here (helps folks who remember the old IDs).
Suggested change
| \echo ' p1 – Index (re)creation progress (CREATE INDEX / REINDEX)' | |
| \echo ' p1 – Index (re)creation progress (CREATE INDEX / REINDEX) (was c1)' |
| \echo ' t2 – Objects with custom storage parameters' | ||
| \echo ' v1 – Vacuum: current activity' | ||
| \echo ' v2 – VACUUM progress and autovacuum queue' | ||
| \echo ' x1 – [EXP] Alignment padding: how many bytes can be saved if columns are reordered?' |
There was a problem hiding this comment.
Optional, but having the old ID visible in-menu reduces confusion during the transition.
Suggested change
| \echo ' x1 – [EXP] Alignment padding: how many bytes can be saved if columns are reordered?' | |
| \echo ' x1 – [EXP] Alignment padding: how many bytes can be saved if columns are reordered? (was p1)' |
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.
Report IDs should reflect their category. Three renames:
b6c1c1p1p1x1Updated: menu, README, CI, release notes. All 28 non-interactive reports pass on PG17.