Re: pgsql: Consolidate docs for vacuum-related GUCs in new subsection

Melanie Plageman <melanieplageman@gmail.com>

From: Melanie Plageman <melanieplageman@gmail.com>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>
Cc: Tom Lane <tgl@sss.pgh.pa.us>, Daniel Gustafsson <daniel@yesql.se>, PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2025-01-14T19:01:13Z
Lists: pgsql-hackers
On Tue, Jan 14, 2025 at 1:21 PM Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
>
> On 2025-Jan-13, Melanie Plageman wrote:
>
> > I've gone with VACUUM_AUTOVACUUM, VACUUM_COST_DELAY, and
> > VACUUM_FREEZING, but I am open to feedback.
>
> Looks good to me.  I checked these two queries, whose results appear
> correct:
>
> 55432 18devel 560655=# select name, category from pg_settings where category ilike '%vacuum%';
>                  name                  │              category
> ───────────────────────────────────────┼─────────────────────────────────────
>  autovacuum                            │ Vacuuming / Automatic Vacuuming
>  autovacuum_analyze_scale_factor       │ Vacuuming / Automatic Vacuuming
>  autovacuum_analyze_threshold          │ Vacuuming / Automatic Vacuuming
>  autovacuum_freeze_max_age             │ Vacuuming / Automatic Vacuuming
>  autovacuum_max_workers                │ Vacuuming / Automatic Vacuuming
>  autovacuum_multixact_freeze_max_age   │ Vacuuming / Automatic Vacuuming
>  autovacuum_naptime                    │ Vacuuming / Automatic Vacuuming
>  autovacuum_vacuum_cost_delay          │ Vacuuming / Automatic Vacuuming
>  autovacuum_vacuum_cost_limit          │ Vacuuming / Automatic Vacuuming
>  autovacuum_vacuum_insert_scale_factor │ Vacuuming / Automatic Vacuuming
>  autovacuum_vacuum_insert_threshold    │ Vacuuming / Automatic Vacuuming
>  autovacuum_vacuum_scale_factor        │ Vacuuming / Automatic Vacuuming
>  autovacuum_vacuum_threshold           │ Vacuuming / Automatic Vacuuming
>  autovacuum_worker_slots               │ Vacuuming / Automatic Vacuuming
>  vacuum_cost_delay                     │ Vacuuming / Cost-Based Vacuum Delay
>  vacuum_cost_limit                     │ Vacuuming / Cost-Based Vacuum Delay
>  vacuum_cost_page_dirty                │ Vacuuming / Cost-Based Vacuum Delay
>  vacuum_cost_page_hit                  │ Vacuuming / Cost-Based Vacuum Delay
>  vacuum_cost_page_miss                 │ Vacuuming / Cost-Based Vacuum Delay
>  vacuum_failsafe_age                   │ Vacuuming / Freezing
>  vacuum_freeze_min_age                 │ Vacuuming / Freezing
>  vacuum_freeze_table_age               │ Vacuuming / Freezing
>  vacuum_multixact_failsafe_age         │ Vacuuming / Freezing
>  vacuum_multixact_freeze_min_age       │ Vacuuming / Freezing
>  vacuum_multixact_freeze_table_age     │ Vacuuming / Freezing
>
>
> 55432 18devel 560655=# select name, category from pg_settings where (short_desc ilike '%vacuum%' or extra_desc ilike '%vacuum%') and category not ilike '%vacuum%';
>             name             │              category
> ─────────────────────────────┼─────────────────────────────────────
>  autovacuum_work_mem         │ Resource Usage / Memory
>  log_autovacuum_min_duration │ Reporting and Logging / What to Log
>  maintenance_work_mem        │ Resource Usage / Memory
>  vacuum_buffer_usage_limit   │ Resource Usage / Memory

Yea, Alena also mentioned these GUCs that are in different groups. I
think it is okay for these four to remain in their current locations
as their current groupings seem descriptive enough.

- Melanie



Commits

  1. Synchronize guc_tables.c categories with vacuum docs categories

  2. Reorder vacuum GUCs in postgresql.conf.sample to match docs

  3. Consolidate docs for vacuum-related GUCs in new subsection