PostgreSQL Source Code git master
guc_hooks.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * guc_hooks.h
4 * Declarations of per-variable callback functions used by GUC.
5 *
6 * These functions are scattered throughout the system, but we
7 * declare them all here to avoid having to propagate guc.h into
8 * a lot of unrelated header files.
9 *
10 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
11 *
12 * src/include/utils/guc_hooks.h
13 *
14 *-------------------------------------------------------------------------
15 */
16#ifndef GUC_HOOKS_H
17#define GUC_HOOKS_H 1
18
19#include "utils/guc.h"
20
21/*
22 * See guc.h for the typedefs that these hook functions should match
23 * (GucBoolCheckHook and so on).
24 *
25 * Please keep the declarations in order by GUC variable name.
26 */
27
28extern bool check_application_name(char **newval, void **extra,
29 GucSource source);
30extern void assign_application_name(const char *newval, void *extra);
31extern const char *show_archive_command(void);
32extern bool check_autovacuum_work_mem(int *newval, void **extra,
33 GucSource source);
34extern bool check_vacuum_buffer_usage_limit(int *newval, void **extra,
35 GucSource source);
36extern bool check_backtrace_functions(char **newval, void **extra,
37 GucSource source);
38extern void assign_backtrace_functions(const char *newval, void *extra);
39extern bool check_bonjour(bool *newval, void **extra, GucSource source);
40extern bool check_canonical_path(char **newval, void **extra, GucSource source);
41extern void assign_checkpoint_completion_target(double newval, void *extra);
42extern bool check_client_connection_check_interval(int *newval, void **extra,
43 GucSource source);
44extern bool check_client_encoding(char **newval, void **extra, GucSource source);
45extern void assign_client_encoding(const char *newval, void *extra);
46extern bool check_cluster_name(char **newval, void **extra, GucSource source);
47extern bool check_commit_ts_buffers(int *newval, void **extra,
48 GucSource source);
49extern const char *show_data_directory_mode(void);
50extern bool check_datestyle(char **newval, void **extra, GucSource source);
51extern void assign_datestyle(const char *newval, void *extra);
52extern bool check_debug_io_direct(char **newval, void **extra, GucSource source);
53extern void assign_debug_io_direct(const char *newval, void *extra);
54extern bool check_log_connections(char **newval, void **extra, GucSource source);
55extern void assign_log_connections(const char *newval, void *extra);
56extern bool check_default_table_access_method(char **newval, void **extra,
57 GucSource source);
58extern bool check_default_tablespace(char **newval, void **extra,
59 GucSource source);
60extern bool check_default_text_search_config(char **newval, void **extra, GucSource source);
61extern void assign_default_text_search_config(const char *newval, void *extra);
62extern bool check_default_with_oids(bool *newval, void **extra,
63 GucSource source);
64extern bool check_huge_page_size(int *newval, void **extra, GucSource source);
65extern void assign_io_method(int newval, void *extra);
66extern bool check_io_max_concurrency(int *newval, void **extra, GucSource source);
67extern const char *show_in_hot_standby(void);
68extern bool check_locale_messages(char **newval, void **extra, GucSource source);
69extern void assign_locale_messages(const char *newval, void *extra);
70extern bool check_locale_monetary(char **newval, void **extra, GucSource source);
71extern void assign_locale_monetary(const char *newval, void *extra);
72extern bool check_locale_numeric(char **newval, void **extra, GucSource source);
73extern void assign_locale_numeric(const char *newval, void *extra);
74extern bool check_locale_time(char **newval, void **extra, GucSource source);
75extern void assign_locale_time(const char *newval, void *extra);
76extern bool check_log_destination(char **newval, void **extra,
77 GucSource source);
78extern void assign_log_destination(const char *newval, void *extra);
79extern const char *show_log_file_mode(void);
80extern bool check_log_stats(bool *newval, void **extra, GucSource source);
81extern bool check_log_timezone(char **newval, void **extra, GucSource source);
82extern void assign_log_timezone(const char *newval, void *extra);
83extern const char *show_log_timezone(void);
84extern void assign_maintenance_io_concurrency(int newval, void *extra);
85extern void assign_io_max_combine_limit(int newval, void *extra);
86extern void assign_io_combine_limit(int newval, void *extra);
87extern void assign_max_wal_size(int newval, void *extra);
88extern bool check_max_stack_depth(int *newval, void **extra, GucSource source);
89extern void assign_max_stack_depth(int newval, void *extra);
90extern bool check_multixact_member_buffers(int *newval, void **extra,
91 GucSource source);
92extern bool check_multixact_offset_buffers(int *newval, void **extra,
93 GucSource source);
94extern bool check_notify_buffers(int *newval, void **extra, GucSource source);
95extern bool check_primary_slot_name(char **newval, void **extra,
96 GucSource source);
97extern bool check_random_seed(double *newval, void **extra, GucSource source);
98extern void assign_random_seed(double newval, void *extra);
99extern const char *show_random_seed(void);
100extern bool check_recovery_prefetch(int *new_value, void **extra,
101 GucSource source);
102extern void assign_recovery_prefetch(int new_value, void *extra);
103extern bool check_recovery_target(char **newval, void **extra,
104 GucSource source);
105extern void assign_recovery_target(const char *newval, void *extra);
106extern bool check_recovery_target_lsn(char **newval, void **extra,
107 GucSource source);
108extern void assign_recovery_target_lsn(const char *newval, void *extra);
109extern bool check_recovery_target_name(char **newval, void **extra,
110 GucSource source);
111extern void assign_recovery_target_name(const char *newval, void *extra);
112extern bool check_recovery_target_time(char **newval, void **extra,
113 GucSource source);
114extern void assign_recovery_target_time(const char *newval, void *extra);
115extern bool check_recovery_target_timeline(char **newval, void **extra,
116 GucSource source);
117extern void assign_recovery_target_timeline(const char *newval, void *extra);
118extern bool check_recovery_target_xid(char **newval, void **extra,
119 GucSource source);
120extern void assign_recovery_target_xid(const char *newval, void *extra);
121extern bool check_role(char **newval, void **extra, GucSource source);
122extern void assign_role(const char *newval, void *extra);
123extern const char *show_role(void);
124extern bool check_restrict_nonsystem_relation_kind(char **newval, void **extra,
125 GucSource source);
126extern void assign_restrict_nonsystem_relation_kind(const char *newval, void *extra);
127extern bool check_search_path(char **newval, void **extra, GucSource source);
128extern void assign_search_path(const char *newval, void *extra);
129extern bool check_serial_buffers(int *newval, void **extra, GucSource source);
130extern bool check_session_authorization(char **newval, void **extra, GucSource source);
131extern void assign_session_authorization(const char *newval, void *extra);
132extern void assign_session_replication_role(int newval, void *extra);
133extern void assign_stats_fetch_consistency(int newval, void *extra);
134extern bool check_ssl(bool *newval, void **extra, GucSource source);
135extern bool check_stage_log_stats(bool *newval, void **extra, GucSource source);
136extern bool check_subtrans_buffers(int *newval, void **extra,
137 GucSource source);
138extern bool check_synchronous_standby_names(char **newval, void **extra,
139 GucSource source);
140extern void assign_synchronous_standby_names(const char *newval, void *extra);
141extern void assign_synchronous_commit(int newval, void *extra);
142extern void assign_syslog_facility(int newval, void *extra);
143extern void assign_syslog_ident(const char *newval, void *extra);
144extern void assign_tcp_keepalives_count(int newval, void *extra);
145extern const char *show_tcp_keepalives_count(void);
146extern void assign_tcp_keepalives_idle(int newval, void *extra);
147extern const char *show_tcp_keepalives_idle(void);
148extern void assign_tcp_keepalives_interval(int newval, void *extra);
149extern const char *show_tcp_keepalives_interval(void);
150extern void assign_tcp_user_timeout(int newval, void *extra);
151extern const char *show_tcp_user_timeout(void);
152extern bool check_temp_buffers(int *newval, void **extra, GucSource source);
153extern bool check_temp_tablespaces(char **newval, void **extra,
154 GucSource source);
155extern void assign_temp_tablespaces(const char *newval, void *extra);
156extern bool check_timezone(char **newval, void **extra, GucSource source);
157extern void assign_timezone(const char *newval, void *extra);
158extern const char *show_timezone(void);
159extern bool check_timezone_abbreviations(char **newval, void **extra,
160 GucSource source);
161extern void assign_timezone_abbreviations(const char *newval, void *extra);
162extern bool check_transaction_buffers(int *newval, void **extra, GucSource source);
163extern bool check_transaction_deferrable(bool *newval, void **extra, GucSource source);
164extern bool check_transaction_isolation(int *newval, void **extra, GucSource source);
165extern bool check_transaction_read_only(bool *newval, void **extra, GucSource source);
166extern void assign_transaction_timeout(int newval, void *extra);
167extern const char *show_unix_socket_permissions(void);
168extern bool check_wal_buffers(int *newval, void **extra, GucSource source);
169extern bool check_wal_consistency_checking(char **newval, void **extra,
170 GucSource source);
171extern void assign_wal_consistency_checking(const char *newval, void *extra);
172extern bool check_wal_segment_size(int *newval, void **extra, GucSource source);
173extern void assign_wal_sync_method(int new_wal_sync_method, void *extra);
174extern bool check_synchronized_standby_slots(char **newval, void **extra,
175 GucSource source);
176extern void assign_synchronized_standby_slots(const char *newval, void *extra);
177
178#endif /* GUC_HOOKS_H */
newval
#define newval
GucSource
GucSource
Definition: guc.h:112
assign_wal_sync_method
void assign_wal_sync_method(int new_wal_sync_method, void *extra)
Definition: xlog.c:8717
assign_application_name
void assign_application_name(const char *newval, void *extra)
Definition: variable.c:1108
assign_syslog_facility
void assign_syslog_facility(int newval, void *extra)
Definition: elog.c:2359
check_primary_slot_name
bool check_primary_slot_name(char **newval, void **extra, GucSource source)
Definition: xlogrecovery.c:4796
check_bonjour
bool check_bonjour(bool *newval, void **extra, GucSource source)
Definition: variable.c:1221
assign_transaction_timeout
void assign_transaction_timeout(int newval, void *extra)
Definition: postgres.c:3600
assign_io_combine_limit
void assign_io_combine_limit(int newval, void *extra)
Definition: variable.c:1169
assign_recovery_target_xid
void assign_recovery_target_xid(const char *newval, void *extra)
Definition: xlogrecovery.c:5118
assign_tcp_keepalives_count
void assign_tcp_keepalives_count(int newval, void *extra)
Definition: pqcomm.c:2010
check_subtrans_buffers
bool check_subtrans_buffers(int *newval, void **extra, GucSource source)
Definition: subtrans.c:253
assign_syslog_ident
void assign_syslog_ident(const char *newval, void *extra)
Definition: elog.c:2327
check_recovery_target
bool check_recovery_target(char **newval, void **extra, GucSource source)
Definition: xlogrecovery.c:4847
assign_restrict_nonsystem_relation_kind
void assign_restrict_nonsystem_relation_kind(const char *newval, void *extra)
Definition: postgres.c:3671
assign_synchronized_standby_slots
void assign_synchronized_standby_slots(const char *newval, void *extra)
Definition: slot.c:2853
assign_session_authorization
void assign_session_authorization(const char *newval, void *extra)
Definition: variable.c:912
show_tcp_keepalives_interval
const char * show_tcp_keepalives_interval(void)
Definition: pqcomm.c:1997
check_transaction_deferrable
bool check_transaction_deferrable(bool *newval, void **extra, GucSource source)
Definition: variable.c:624
check_canonical_path
bool check_canonical_path(char **newval, void **extra, GucSource source)
Definition: variable.c:1059
check_log_connections
bool check_log_connections(char **newval, void **extra, GucSource source)
Definition: backend_startup.c:1081
assign_synchronous_commit
void assign_synchronous_commit(int newval, void *extra)
Definition: syncrep.c:1123
assign_wal_consistency_checking
void assign_wal_consistency_checking(const char *newval, void *extra)
Definition: xlog.c:4813
check_transaction_isolation
bool check_transaction_isolation(int *newval, void **extra, GucSource source)
Definition: variable.c:586
check_default_with_oids
bool check_default_with_oids(bool *newval, void **extra, GucSource source)
Definition: variable.c:1234
check_recovery_target_timeline
bool check_recovery_target_timeline(char **newval, void **extra, GucSource source)
Definition: xlogrecovery.c:5033
assign_synchronous_standby_names
void assign_synchronous_standby_names(const char *newval, void *extra)
Definition: syncrep.c:1117
assign_timezone_abbreviations
void assign_timezone_abbreviations(const char *newval, void *extra)
Definition: variable.c:519
show_tcp_keepalives_count
const char * show_tcp_keepalives_count(void)
Definition: pqcomm.c:2020
check_max_stack_depth
bool check_max_stack_depth(int *newval, void **extra, GucSource source)
Definition: stack_depth.c:142
check_application_name
bool check_application_name(char **newval, void **extra, GucSource source)
Definition: variable.c:1080
assign_search_path
void assign_search_path(const char *newval, void *extra)
Definition: namespace.c:4783
assign_timezone
void assign_timezone(const char *newval, void *extra)
Definition: variable.c:381
assign_locale_time
void assign_locale_time(const char *newval, void *extra)
Definition: pg_locale.c:367
check_default_text_search_config
bool check_default_text_search_config(char **newval, void **extra, GucSource source)
Definition: ts_cache.c:604
check_role
bool check_role(char **newval, void **extra, GucSource source)
Definition: variable.c:933
assign_debug_io_direct
void assign_debug_io_direct(const char *newval, void *extra)
Definition: fd.c:4091
check_cluster_name
bool check_cluster_name(char **newval, void **extra, GucSource source)
Definition: variable.c:1118
check_locale_time
bool check_locale_time(char **newval, void **extra, GucSource source)
Definition: pg_locale.c:361
assign_checkpoint_completion_target
void assign_checkpoint_completion_target(double newval, void *extra)
Definition: xlog.c:2210
show_random_seed
const char * show_random_seed(void)
Definition: variable.c:677
assign_recovery_target
void assign_recovery_target(const char *newval, void *extra)
Definition: xlogrecovery.c:4861
check_default_table_access_method
bool check_default_table_access_method(char **newval, void **extra, GucSource source)
Definition: tableamapi.c:102
assign_io_method
void assign_io_method(int newval, void *extra)
Definition: aio.c:1322
assign_backtrace_functions
void assign_backtrace_functions(const char *newval, void *extra)
Definition: elog.c:2245
check_log_stats
bool check_log_stats(bool *newval, void **extra, GucSource source)
Definition: postgres.c:3585
check_default_tablespace
bool check_default_tablespace(char **newval, void **extra, GucSource source)
Definition: tablespace.c:1091
show_archive_command
const char * show_archive_command(void)
Definition: xlog.c:4866
assign_io_max_combine_limit
void assign_io_max_combine_limit(int newval, void *extra)
Definition: variable.c:1164
check_vacuum_buffer_usage_limit
bool check_vacuum_buffer_usage_limit(int *newval, void **extra, GucSource source)
Definition: vacuum.c:139
check_autovacuum_work_mem
bool check_autovacuum_work_mem(int *newval, void **extra, GucSource source)
Definition: autovacuum.c:3449
check_backtrace_functions
bool check_backtrace_functions(char **newval, void **extra, GucSource source)
Definition: elog.c:2184
check_temp_buffers
bool check_temp_buffers(int *newval, void **extra, GucSource source)
Definition: localbuf.c:877
check_session_authorization
bool check_session_authorization(char **newval, void **extra, GucSource source)
Definition: variable.c:815
show_tcp_keepalives_idle
const char * show_tcp_keepalives_idle(void)
Definition: pqcomm.c:1974
show_log_file_mode
const char * show_log_file_mode(void)
Definition: variable.c:1194
check_transaction_read_only
bool check_transaction_read_only(bool *newval, void **extra, GucSource source)
Definition: variable.c:546
show_in_hot_standby
const char * show_in_hot_standby(void)
Definition: xlog.c:4878
check_huge_page_size
bool check_huge_page_size(int *newval, void **extra, GucSource source)
Definition: sysv_shmem.c:578
assign_stats_fetch_consistency
void assign_stats_fetch_consistency(int newval, void *extra)
Definition: pgstat.c:2069
check_synchronized_standby_slots
bool check_synchronized_standby_slots(char **newval, void **extra, GucSource source)
Definition: slot.c:2797
assign_maintenance_io_concurrency
void assign_maintenance_io_concurrency(int newval, void *extra)
Definition: variable.c:1146
check_commit_ts_buffers
bool check_commit_ts_buffers(int *newval, void **extra, GucSource source)
Definition: commit_ts.c:582
check_log_destination
bool check_log_destination(char **newval, void **extra, GucSource source)
Definition: elog.c:2254
check_transaction_buffers
bool check_transaction_buffers(int *newval, void **extra, GucSource source)
Definition: clog.c:820
assign_max_wal_size
void assign_max_wal_size(int newval, void *extra)
Definition: xlog.c:2203
check_timezone_abbreviations
bool check_timezone_abbreviations(char **newval, void **extra, GucSource source)
Definition: variable.c:487
assign_recovery_target_name
void assign_recovery_target_name(const char *newval, void *extra)
Definition: xlogrecovery.c:4937
check_locale_numeric
bool check_locale_numeric(char **newval, void **extra, GucSource source)
Definition: pg_locale.c:349
show_log_timezone
const char * show_log_timezone(void)
Definition: variable.c:465
assign_temp_tablespaces
void assign_temp_tablespaces(const char *newval, void *extra)
Definition: tablespace.c:1306
assign_recovery_target_time
void assign_recovery_target_time(const char *newval, void *extra)
Definition: xlogrecovery.c:5017
check_recovery_target_xid
bool check_recovery_target_xid(char **newval, void **extra, GucSource source)
Definition: xlogrecovery.c:5093
assign_locale_numeric
void assign_locale_numeric(const char *newval, void *extra)
Definition: pg_locale.c:355
assign_client_encoding
void assign_client_encoding(const char *newval, void *extra)
Definition: variable.c:786
check_recovery_target_time
bool check_recovery_target_time(char **newval, void **extra, GucSource source)
Definition: xlogrecovery.c:4962
check_locale_messages
bool check_locale_messages(char **newval, void **extra, GucSource source)
Definition: pg_locale.c:383
assign_role
void assign_role(const char *newval, void *extra)
Definition: variable.c:1026
assign_tcp_keepalives_idle
void assign_tcp_keepalives_idle(int newval, void *extra)
Definition: pqcomm.c:1954
check_timezone
bool check_timezone(char **newval, void **extra, GucSource source)
Definition: variable.c:261
check_ssl
bool check_ssl(bool *newval, void **extra, GucSource source)
Definition: variable.c:1249
assign_datestyle
void assign_datestyle(const char *newval, void *extra)
Definition: variable.c:244
assign_random_seed
void assign_random_seed(double newval, void *extra)
Definition: variable.c:668
assign_recovery_prefetch
void assign_recovery_prefetch(int new_value, void *extra)
Definition: xlogprefetcher.c:1095
assign_max_stack_depth
void assign_max_stack_depth(int newval, void *extra)
Definition: stack_depth.c:159
show_role
const char * show_role(void)
Definition: variable.c:1034
check_log_timezone
bool check_log_timezone(char **newval, void **extra, GucSource source)
Definition: variable.c:418
assign_locale_messages
void assign_locale_messages(const char *newval, void *extra)
Definition: pg_locale.c:406
check_temp_tablespaces
bool check_temp_tablespaces(char **newval, void **extra, GucSource source)
Definition: tablespace.c:1198
show_tcp_user_timeout
const char * show_tcp_user_timeout(void)
Definition: pqcomm.c:2043
check_random_seed
bool check_random_seed(double *newval, void **extra, GucSource source)
Definition: variable.c:656
assign_default_text_search_config
void assign_default_text_search_config(const char *newval, void *extra)
Definition: ts_cache.c:672
assign_recovery_target_lsn
void assign_recovery_target_lsn(const char *newval, void *extra)
Definition: xlogrecovery.c:4902
check_recovery_target_lsn
bool check_recovery_target_lsn(char **newval, void **extra, GucSource source)
Definition: xlogrecovery.c:4877
check_wal_segment_size
bool check_wal_segment_size(int *newval, void **extra, GucSource source)
Definition: xlog.c:2217
assign_tcp_user_timeout
void assign_tcp_user_timeout(int newval, void *extra)
Definition: pqcomm.c:2033
show_unix_socket_permissions
const char * show_unix_socket_permissions(void)
Definition: variable.c:1206
assign_session_replication_role
void assign_session_replication_role(int newval, void *extra)
Definition: trigger.c:6666
show_timezone
const char * show_timezone(void)
Definition: variable.c:392
check_client_connection_check_interval
bool check_client_connection_check_interval(int *newval, void **extra, GucSource source)
Definition: postgres.c:3550
assign_log_connections
void assign_log_connections(const char *newval, void *extra)
Definition: backend_startup.c:1125
check_wal_consistency_checking
bool check_wal_consistency_checking(char **newval, void **extra, GucSource source)
Definition: xlog.c:4726
check_serial_buffers
bool check_serial_buffers(int *newval, void **extra, GucSource source)
Definition: predicate.c:847
check_datestyle
bool check_datestyle(char **newval, void **extra, GucSource source)
Definition: variable.c:52
check_search_path
bool check_search_path(char **newval, void **extra, GucSource source)
Definition: namespace.c:4727
check_client_encoding
bool check_client_encoding(char **newval, void **extra, GucSource source)
Definition: variable.c:688
check_synchronous_standby_names
bool check_synchronous_standby_names(char **newval, void **extra, GucSource source)
Definition: syncrep.c:1058
check_wal_buffers
bool check_wal_buffers(int *newval, void **extra, GucSource source)
Definition: xlog.c:4691
check_restrict_nonsystem_relation_kind
bool check_restrict_nonsystem_relation_kind(char **newval, void **extra, GucSource source)
Definition: postgres.c:3619
check_recovery_target_name
bool check_recovery_target_name(char **newval, void **extra, GucSource source)
Definition: xlogrecovery.c:4921
assign_tcp_keepalives_interval
void assign_tcp_keepalives_interval(int newval, void *extra)
Definition: pqcomm.c:1987
assign_locale_monetary
void assign_locale_monetary(const char *newval, void *extra)
Definition: pg_locale.c:343
check_multixact_offset_buffers
bool check_multixact_offset_buffers(int *newval, void **extra, GucSource source)
Definition: multixact.c:2005
assign_recovery_target_timeline
void assign_recovery_target_timeline(const char *newval, void *extra)
Definition: xlogrecovery.c:5080
check_recovery_prefetch
bool check_recovery_prefetch(int *new_value, void **extra, GucSource source)
Definition: xlogprefetcher.c:1081
show_data_directory_mode
const char * show_data_directory_mode(void)
Definition: variable.c:1182
assign_log_timezone
void assign_log_timezone(const char *newval, void *extra)
Definition: variable.c:456
check_multixact_member_buffers
bool check_multixact_member_buffers(int *newval, void **extra, GucSource source)
Definition: multixact.c:2014
check_io_max_concurrency
bool check_io_max_concurrency(int *newval, void **extra, GucSource source)
Definition: aio.c:1331
check_debug_io_direct
bool check_debug_io_direct(char **newval, void **extra, GucSource source)
Definition: fd.c:4004
check_notify_buffers
bool check_notify_buffers(int *newval, void **extra, GucSource source)
Definition: async.c:2514
check_locale_monetary
bool check_locale_monetary(char **newval, void **extra, GucSource source)
Definition: pg_locale.c:337
assign_log_destination
void assign_log_destination(const char *newval, void *extra)
Definition: elog.c:2318
check_stage_log_stats
bool check_stage_log_stats(bool *newval, void **extra, GucSource source)
Definition: postgres.c:3571
source
static rewind_source * source
Definition: pg_rewind.c:89