From 2ae98ea5ab8f22ece06bb206e6a298ecc5770ed4 Mon Sep 17 00:00:00 2001 From: Melanie Plageman Date: Tue, 14 Jan 2025 15:30:13 -0500 Subject: [PATCH] Synchronize guc_tables.c categories with vacuum docs categories MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ca9c6a5680d consolidated most of the vacuum-related GUCs' documentation into a new subsection. af2317652d5daf8b then enforced this order in postgresql.conf.sample. This commit reorganizes the GUC groups in guc_tables.c/h to match the updated ordering in the docs. Reported-by: Álvaro Herrera Reviewed-by: Álvaro Herrera, Alena Rybakina Discussion: https://postgr.es/m/202501132046.m4mcvxxswznu%40alvherre.pgsql --- src/backend/utils/misc/guc_tables.c | 55 +++++++++++++++-------------- src/include/utils/guc_tables.h | 5 +-- 2 files changed, 31 insertions(+), 29 deletions(-) diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c index c9d8cd796a8..38cb9e970d5 100644 --- a/src/backend/utils/misc/guc_tables.c +++ b/src/backend/utils/misc/guc_tables.c @@ -681,7 +681,6 @@ const char *const config_group_names[] = [RESOURCES_MEM] = gettext_noop("Resource Usage / Memory"), [RESOURCES_DISK] = gettext_noop("Resource Usage / Disk"), [RESOURCES_KERNEL] = gettext_noop("Resource Usage / Kernel Resources"), - [RESOURCES_VACUUM_DELAY] = gettext_noop("Resource Usage / Cost-Based Vacuum Delay"), [RESOURCES_BGWRITER] = gettext_noop("Resource Usage / Background Writer"), [RESOURCES_ASYNCHRONOUS] = gettext_noop("Resource Usage / Asynchronous Behavior"), [WAL_SETTINGS] = gettext_noop("Write-Ahead Log / Settings"), @@ -705,7 +704,9 @@ const char *const config_group_names[] = [PROCESS_TITLE] = gettext_noop("Reporting and Logging / Process Title"), [STATS_MONITORING] = gettext_noop("Statistics / Monitoring"), [STATS_CUMULATIVE] = gettext_noop("Statistics / Cumulative Query and Index Statistics"), - [AUTOVACUUM] = gettext_noop("Autovacuum"), + [VACUUM_AUTOVACUUM] = gettext_noop("Vacuuming / Automatic Vacuuming"), + [VACUUM_COST_DELAY] = gettext_noop("Vacuuming / Cost-Based Vacuum Delay"), + [VACUUM_FREEZING] = gettext_noop("Vacuuming / Freezing"), [CLIENT_CONN_STATEMENT] = gettext_noop("Client Connection Defaults / Statement Behavior"), [CLIENT_CONN_LOCALE] = gettext_noop("Client Connection Defaults / Locale and Formatting"), [CLIENT_CONN_PRELOAD] = gettext_noop("Client Connection Defaults / Shared Library Preloading"), @@ -1499,7 +1500,7 @@ struct config_bool ConfigureNamesBool[] = }, { - {"autovacuum", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Starts the autovacuum subprocess."), NULL }, @@ -2583,7 +2584,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES_VACUUM_DELAY, + {"vacuum_cost_page_hit", PGC_USERSET, VACUUM_COST_DELAY, gettext_noop("Vacuum cost for a page found in the buffer cache."), NULL }, @@ -2593,7 +2594,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES_VACUUM_DELAY, + {"vacuum_cost_page_miss", PGC_USERSET, VACUUM_COST_DELAY, gettext_noop("Vacuum cost for a page not found in the buffer cache."), NULL }, @@ -2603,7 +2604,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES_VACUUM_DELAY, + {"vacuum_cost_page_dirty", PGC_USERSET, VACUUM_COST_DELAY, gettext_noop("Vacuum cost for a page dirtied by vacuum."), NULL }, @@ -2613,7 +2614,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_cost_limit", PGC_USERSET, RESOURCES_VACUUM_DELAY, + {"vacuum_cost_limit", PGC_USERSET, VACUUM_COST_DELAY, gettext_noop("Vacuum cost amount available before napping."), NULL }, @@ -2623,7 +2624,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Vacuum cost amount available before napping, for autovacuum."), NULL }, @@ -2734,7 +2735,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT, + {"vacuum_freeze_min_age", PGC_USERSET, VACUUM_FREEZING, gettext_noop("Minimum age at which VACUUM should freeze a table row."), NULL }, @@ -2744,7 +2745,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT, + {"vacuum_freeze_table_age", PGC_USERSET, VACUUM_FREEZING, gettext_noop("Age at which VACUUM should scan whole table to freeze tuples."), NULL }, @@ -2754,7 +2755,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_multixact_freeze_min_age", PGC_USERSET, CLIENT_CONN_STATEMENT, + {"vacuum_multixact_freeze_min_age", PGC_USERSET, VACUUM_FREEZING, gettext_noop("Minimum age at which VACUUM should freeze a MultiXactId in a table row."), NULL }, @@ -2764,7 +2765,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_multixact_freeze_table_age", PGC_USERSET, CLIENT_CONN_STATEMENT, + {"vacuum_multixact_freeze_table_age", PGC_USERSET, VACUUM_FREEZING, gettext_noop("Multixact age at which VACUUM should scan whole table to freeze tuples."), NULL }, @@ -2774,7 +2775,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"vacuum_failsafe_age", PGC_USERSET, CLIENT_CONN_STATEMENT, + {"vacuum_failsafe_age", PGC_USERSET, VACUUM_FREEZING, gettext_noop("Age at which VACUUM should trigger failsafe to avoid a wraparound outage."), NULL }, @@ -2783,7 +2784,7 @@ struct config_int ConfigureNamesInt[] = NULL, NULL, NULL }, { - {"vacuum_multixact_failsafe_age", PGC_USERSET, CLIENT_CONN_STATEMENT, + {"vacuum_multixact_failsafe_age", PGC_USERSET, VACUUM_FREEZING, gettext_noop("Multixact age at which VACUUM should trigger failsafe to avoid a wraparound outage."), NULL }, @@ -3407,7 +3408,7 @@ struct config_int ConfigureNamesInt[] = }, { - {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_naptime", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Time to sleep between autovacuum runs."), NULL, GUC_UNIT_S @@ -3417,7 +3418,7 @@ struct config_int ConfigureNamesInt[] = NULL, NULL, NULL }, { - {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_vacuum_threshold", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."), NULL }, @@ -3426,7 +3427,7 @@ struct config_int ConfigureNamesInt[] = NULL, NULL, NULL }, { - {"autovacuum_vacuum_insert_threshold", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_vacuum_insert_threshold", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Minimum number of tuple inserts prior to vacuum, or -1 to disable insert vacuums."), NULL }, @@ -3435,7 +3436,7 @@ struct config_int ConfigureNamesInt[] = NULL, NULL, NULL }, { - {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_analyze_threshold", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Minimum number of tuple inserts, updates, or deletes prior to analyze."), NULL }, @@ -3445,7 +3446,7 @@ struct config_int ConfigureNamesInt[] = }, { /* see varsup.c for why this is PGC_POSTMASTER not PGC_SIGHUP */ - {"autovacuum_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM, + {"autovacuum_freeze_max_age", PGC_POSTMASTER, VACUUM_AUTOVACUUM, gettext_noop("Age at which to autovacuum a table to prevent transaction ID wraparound."), NULL }, @@ -3457,7 +3458,7 @@ struct config_int ConfigureNamesInt[] = }, { /* see multixact.c for why this is PGC_POSTMASTER not PGC_SIGHUP */ - {"autovacuum_multixact_freeze_max_age", PGC_POSTMASTER, AUTOVACUUM, + {"autovacuum_multixact_freeze_max_age", PGC_POSTMASTER, VACUUM_AUTOVACUUM, gettext_noop("Multixact age at which to autovacuum a table to prevent multixact wraparound."), NULL }, @@ -3467,7 +3468,7 @@ struct config_int ConfigureNamesInt[] = }, { /* see max_connections */ - {"autovacuum_worker_slots", PGC_POSTMASTER, AUTOVACUUM, + {"autovacuum_worker_slots", PGC_POSTMASTER, VACUUM_AUTOVACUUM, gettext_noop("Sets the number of backend slots to allocate for autovacuum workers."), NULL }, @@ -3476,7 +3477,7 @@ struct config_int ConfigureNamesInt[] = NULL, NULL, NULL }, { - {"autovacuum_max_workers", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_max_workers", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Sets the maximum number of simultaneously running autovacuum worker processes."), NULL }, @@ -3941,7 +3942,7 @@ struct config_real ConfigureNamesReal[] = }, { - {"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY, + {"vacuum_cost_delay", PGC_USERSET, VACUUM_COST_DELAY, gettext_noop("Vacuum cost delay in milliseconds."), NULL, GUC_UNIT_MS @@ -3952,7 +3953,7 @@ struct config_real ConfigureNamesReal[] = }, { - {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."), NULL, GUC_UNIT_MS @@ -3963,7 +3964,7 @@ struct config_real ConfigureNamesReal[] = }, { - {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."), NULL }, @@ -3973,7 +3974,7 @@ struct config_real ConfigureNamesReal[] = }, { - {"autovacuum_vacuum_insert_scale_factor", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_vacuum_insert_scale_factor", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Number of tuple inserts prior to vacuum as a fraction of reltuples."), NULL }, @@ -3983,7 +3984,7 @@ struct config_real ConfigureNamesReal[] = }, { - {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM, + {"autovacuum_analyze_scale_factor", PGC_SIGHUP, VACUUM_AUTOVACUUM, gettext_noop("Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples."), NULL }, diff --git a/src/include/utils/guc_tables.h b/src/include/utils/guc_tables.h index 65a46b8565c..3f18ff451ef 100644 --- a/src/include/utils/guc_tables.h +++ b/src/include/utils/guc_tables.h @@ -63,7 +63,6 @@ enum config_group RESOURCES_MEM, RESOURCES_DISK, RESOURCES_KERNEL, - RESOURCES_VACUUM_DELAY, RESOURCES_BGWRITER, RESOURCES_ASYNCHRONOUS, WAL_SETTINGS, @@ -87,7 +86,9 @@ enum config_group PROCESS_TITLE, STATS_MONITORING, STATS_CUMULATIVE, - AUTOVACUUM, + VACUUM_AUTOVACUUM, + VACUUM_COST_DELAY, + VACUUM_FREEZING, CLIENT_CONN_STATEMENT, CLIENT_CONN_LOCALE, CLIENT_CONN_PRELOAD,