Skip to content

refactor: rename reports for consistent categories#88

Merged
NikolayS merged 1 commit intomasterfrom
refactor/rename-reports
Feb 10, 2026
Merged

refactor: rename reports for consistent categories#88
NikolayS merged 1 commit intomasterfrom
refactor/rename-reports

Conversation

@NikolayS
Copy link
Owner

Report IDs should reflect their category. Three renames:

Old New Why
b6 c1 Buffer cache ≠ bloat. New c (cache) category
c1 p1 Index creation progress → p (progress)
p1 x1 Alignment padding → x (experimental)

Updated: menu, README, CI, release notes. All 28 non-interactive reports pass on PG17.

- 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.
@NikolayS NikolayS merged commit ea23c3f into master Feb 10, 2026
6 checks passed
@NikolayS NikolayS deleted the refactor/rename-reports branch February 10, 2026 03:41
\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)'
Copy link

Choose a reason for hiding this comment

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

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)'
Copy link

Choose a reason for hiding this comment

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

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?'
Copy link

Choose a reason for hiding this comment

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

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)'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments