1 /*--------------------------------------------------------------------
4 * Support for grand unified configuration scheme, including SET
5 * command, configuration file, and command line options.
6 * See src/backend/utils/misc/README for more information.
9 * Copyright (c) 2000-2006, PostgreSQL Global Development Group
10 * Written by Peter Eisentraut <peter_e@gmx.net>.
13 * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.350 2006/09/02 23:12:16 momjian Exp $
15 *--------------------------------------------------------------------
29 #include "access/gin.h"
30 #include "access/twophase.h"
31 #include "access/xact.h"
32 #include "catalog/namespace.h"
33 #include "commands/async.h"
34 #include "commands/vacuum.h"
35 #include "commands/variable.h"
37 #include "libpq/auth.h"
38 #include "libpq/pqformat.h"
39 #include "miscadmin.h"
40 #include "optimizer/cost.h"
41 #include "optimizer/geqo.h"
42 #include "optimizer/paths.h"
43 #include "optimizer/planmain.h"
44 #include "parser/gramparse.h"
45 #include "parser/parse_expr.h"
46 #include "parser/parse_relation.h"
47 #include "parser/scansup.h"
49 #include "postmaster/autovacuum.h"
50 #include "postmaster/bgwriter.h"
51 #include "postmaster/postmaster.h"
52 #include "postmaster/syslogger.h"
53 #include "storage/fd.h"
54 #include "storage/freespace.h"
55 #include "tcop/tcopprot.h"
56 #include "utils/builtins.h"
57 #include "utils/guc_tables.h"
58 #include "utils/memutils.h"
59 #include "utils/pg_locale.h"
60 #include "utils/ps_status.h"
61 #include "utils/tzparser.h"
64 #define PG_KRB_SRVTAB ""
67 #define PG_KRB_SRVNAM ""
70 #define CONFIG_FILENAME "postgresql.conf"
71 #define HBA_FILENAME "pg_hba.conf"
72 #define IDENT_FILENAME "pg_ident.conf"
75 #define CONFIG_EXEC_PARAMS "global/config_exec_params"
76 #define CONFIG_EXEC_PARAMS_NEW "global/config_exec_params.new"
79 /* upper limit for GUC variables measured in kilobytes of memory */
81 #define MAX_KILOBYTES INT_MAX
83 #define MAX_KILOBYTES (INT_MAX / 1024)
86 #define KB_PER_MB (1024)
87 #define KB_PER_GB (1024*1024)
90 #define MS_PER_MIN (1000 * 60)
91 #define MS_PER_H (1000 * 60 * 60)
92 #define MS_PER_D (1000 * 60 * 60 * 24)
94 /* XXX these should appear in other modules' header files */
95 extern bool Log_disconnections;
96 extern bool check_function_bodies;
97 extern int CommitDelay;
98 extern int CommitSiblings;
99 extern char *default_tablespace;
100 extern bool fullPageWrites;
103 extern bool trace_sort;
106 static const char *assign_log_destination(const char *value,
107 bool doit, GucSource source);
110 static int syslog_facility = LOG_LOCAL0;
112 static const char *assign_syslog_facility(const char *facility,
113 bool doit, GucSource source);
114 static const char *assign_syslog_ident(const char *ident,
115 bool doit, GucSource source);
118 static const char *assign_defaultxactisolevel(const char *newval, bool doit,
120 static const char *assign_log_min_messages(const char *newval, bool doit,
122 static const char *assign_client_min_messages(const char *newval,
123 bool doit, GucSource source);
124 static const char *assign_min_error_statement(const char *newval, bool doit,
126 static const char *assign_msglvl(int *var, const char *newval, bool doit,
128 static const char *assign_log_error_verbosity(const char *newval, bool doit,
130 static const char *assign_log_statement(const char *newval, bool doit,
132 static const char *show_num_temp_buffers(void);
133 static bool assign_phony_autocommit(bool newval, bool doit, GucSource source);
134 static const char *assign_custom_variable_classes(const char *newval, bool doit,
136 static bool assign_debug_assertions(bool newval, bool doit, GucSource source);
137 static bool assign_ssl(bool newval, bool doit, GucSource source);
138 static bool assign_stage_log_stats(bool newval, bool doit, GucSource source);
139 static bool assign_log_stats(bool newval, bool doit, GucSource source);
140 static bool assign_transaction_read_only(bool newval, bool doit, GucSource source);
141 static const char *assign_canonical_path(const char *newval, bool doit, GucSource source);
142 static const char *assign_backslash_quote(const char *newval, bool doit, GucSource source);
143 static const char *assign_timezone_abbreviations(const char *newval, bool doit, GucSource source);
145 static bool assign_tcp_keepalives_idle(int newval, bool doit, GucSource source);
146 static bool assign_tcp_keepalives_interval(int newval, bool doit, GucSource source);
147 static bool assign_tcp_keepalives_count(int newval, bool doit, GucSource source);
148 static const char *show_tcp_keepalives_idle(void);
149 static const char *show_tcp_keepalives_interval(void);
150 static const char *show_tcp_keepalives_count(void);
153 * GUC option variables that are exported from this module
155 #ifdef USE_ASSERT_CHECKING
156 bool assert_enabled = true;
158 bool assert_enabled = false;
160 bool log_duration = false;
161 bool Debug_print_plan = false;
162 bool Debug_print_parse = false;
163 bool Debug_print_rewritten = false;
164 bool Debug_pretty_print = false;
165 bool Explain_pretty_print = true;
167 bool log_parser_stats = false;
168 bool log_planner_stats = false;
169 bool log_executor_stats = false;
170 bool log_statement_stats = false; /* this is sort of all three
172 bool log_btree_build_stats = false;
174 bool SQL_inheritance = true;
176 bool Password_encryption = true;
178 bool default_with_oids = false;
180 int log_min_error_statement = PANIC;
181 int log_min_messages = NOTICE;
182 int client_min_messages = NOTICE;
183 int log_min_duration_statement = -1;
185 int num_temp_buffers = 1000;
187 char *ConfigFileName;
190 char *external_pid_file;
192 int tcp_keepalives_idle;
193 int tcp_keepalives_interval;
194 int tcp_keepalives_count;
197 * These variables are all dummies that don't do anything, except in some
198 * cases provide the value for SHOW to display. The real state is elsewhere
199 * and is kept in sync by assign_hooks.
201 static char *client_min_messages_str;
202 static char *log_min_messages_str;
203 static char *log_error_verbosity_str;
204 static char *log_statement_str;
205 static char *log_min_error_statement_str;
206 static char *log_destination_string;
208 static char *syslog_facility_str;
209 static char *syslog_ident_str;
211 static bool phony_autocommit;
212 static bool session_auth_is_superuser;
213 static double phony_random_seed;
214 static char *backslash_quote_string;
215 static char *client_encoding_string;
216 static char *datestyle_string;
217 static char *default_iso_level_string;
218 static char *locale_collate;
219 static char *locale_ctype;
220 static char *regex_flavor_string;
221 static char *server_encoding_string;
222 static char *server_version_string;
223 static int server_version_num;
224 static char *timezone_string;
225 static char *timezone_abbreviations_string;
226 static char *XactIsoLevel_string;
227 static char *data_directory;
228 static char *custom_variable_classes;
229 static int max_function_args;
230 static int max_index_keys;
231 static int max_identifier_length;
232 static int block_size;
233 static bool integer_datetimes;
235 /* should be static, but commands/variable.c needs to get at these */
237 char *session_authorization_string;
241 * Displayable names for context types (enum GucContext)
243 * Note: these strings are deliberately not localized.
245 const char *const GucContext_Names[] =
247 /* PGC_INTERNAL */ "internal",
248 /* PGC_POSTMASTER */ "postmaster",
249 /* PGC_SIGHUP */ "sighup",
250 /* PGC_BACKEND */ "backend",
251 /* PGC_SUSET */ "superuser",
252 /* PGC_USERSET */ "user"
256 * Displayable names for source types (enum GucSource)
258 * Note: these strings are deliberately not localized.
260 const char *const GucSource_Names[] =
262 /* PGC_S_DEFAULT */ "default",
263 /* PGC_S_ENV_VAR */ "environment variable",
264 /* PGC_S_FILE */ "configuration file",
265 /* PGC_S_ARGV */ "command line",
266 /* PGC_S_DATABASE */ "database",
267 /* PGC_S_USER */ "user",
268 /* PGC_S_CLIENT */ "client",
269 /* PGC_S_OVERRIDE */ "override",
270 /* PGC_S_INTERACTIVE */ "interactive",
271 /* PGC_S_TEST */ "test",
272 /* PGC_S_SESSION */ "session"
276 * Displayable names for the groupings defined in enum config_group
278 const char *const config_group_names[] =
281 gettext_noop("Ungrouped"),
283 gettext_noop("File Locations"),
285 gettext_noop("Connections and Authentication"),
286 /* CONN_AUTH_SETTINGS */
287 gettext_noop("Connections and Authentication / Connection Settings"),
288 /* CONN_AUTH_SECURITY */
289 gettext_noop("Connections and Authentication / Security and Authentication"),
291 gettext_noop("Resource Usage"),
293 gettext_noop("Resource Usage / Memory"),
295 gettext_noop("Resource Usage / Free Space Map"),
296 /* RESOURCES_KERNEL */
297 gettext_noop("Resource Usage / Kernel Resources"),
299 gettext_noop("Write-Ahead Log"),
301 gettext_noop("Write-Ahead Log / Settings"),
302 /* WAL_CHECKPOINTS */
303 gettext_noop("Write-Ahead Log / Checkpoints"),
305 gettext_noop("Query Tuning"),
306 /* QUERY_TUNING_METHOD */
307 gettext_noop("Query Tuning / Planner Method Configuration"),
308 /* QUERY_TUNING_COST */
309 gettext_noop("Query Tuning / Planner Cost Constants"),
310 /* QUERY_TUNING_GEQO */
311 gettext_noop("Query Tuning / Genetic Query Optimizer"),
312 /* QUERY_TUNING_OTHER */
313 gettext_noop("Query Tuning / Other Planner Options"),
315 gettext_noop("Reporting and Logging"),
317 gettext_noop("Reporting and Logging / Where to Log"),
319 gettext_noop("Reporting and Logging / When to Log"),
321 gettext_noop("Reporting and Logging / What to Log"),
323 gettext_noop("Statistics"),
324 /* STATS_MONITORING */
325 gettext_noop("Statistics / Monitoring"),
326 /* STATS_COLLECTOR */
327 gettext_noop("Statistics / Query and Index Statistics Collector"),
329 gettext_noop("Autovacuum"),
331 gettext_noop("Client Connection Defaults"),
332 /* CLIENT_CONN_STATEMENT */
333 gettext_noop("Client Connection Defaults / Statement Behavior"),
334 /* CLIENT_CONN_LOCALE */
335 gettext_noop("Client Connection Defaults / Locale and Formatting"),
336 /* CLIENT_CONN_OTHER */
337 gettext_noop("Client Connection Defaults / Other Defaults"),
338 /* LOCK_MANAGEMENT */
339 gettext_noop("Lock Management"),
341 gettext_noop("Version and Platform Compatibility"),
342 /* COMPAT_OPTIONS_PREVIOUS */
343 gettext_noop("Version and Platform Compatibility / Previous PostgreSQL Versions"),
344 /* COMPAT_OPTIONS_CLIENT */
345 gettext_noop("Version and Platform Compatibility / Other Platforms and Clients"),
347 gettext_noop("Preset Options"),
349 gettext_noop("Customized Options"),
350 /* DEVELOPER_OPTIONS */
351 gettext_noop("Developer Options"),
352 /* help_config wants this array to be null-terminated */
357 * Displayable names for GUC variable types (enum config_type)
359 * Note: these strings are deliberately not localized.
361 const char *const config_type_names[] =
363 /* PGC_BOOL */ "bool",
364 /* PGC_INT */ "integer",
365 /* PGC_REAL */ "real",
366 /* PGC_STRING */ "string"
371 * Contents of GUC tables
373 * See src/backend/utils/misc/README for design notes.
377 * 1. Declare a global variable of type bool, int, double, or char*
378 * and make use of it.
380 * 2. Decide at what times it's safe to set the option. See guc.h for
383 * 3. Decide on a name, a default value, upper and lower bounds (if
386 * 4. Add a record below.
388 * 5. Add it to src/backend/utils/misc/postgresql.conf.sample, if
391 * 6. Add it to src/bin/psql/tab-complete.c, if it's a USERSET option.
393 * 7. Don't forget to document the option.
395 * 8. If it's a new GUC_LIST option you must edit pg_dumpall.c to ensure
396 * it is not single quoted at dump time.
400 /******** option records follow ********/
402 static struct config_bool ConfigureNamesBool[] =
405 {"enable_seqscan", PGC_USERSET, QUERY_TUNING_METHOD,
406 gettext_noop("Enables the planner's use of sequential-scan plans."),
413 {"enable_indexscan", PGC_USERSET, QUERY_TUNING_METHOD,
414 gettext_noop("Enables the planner's use of index-scan plans."),
421 {"enable_bitmapscan", PGC_USERSET, QUERY_TUNING_METHOD,
422 gettext_noop("Enables the planner's use of bitmap-scan plans."),
429 {"enable_tidscan", PGC_USERSET, QUERY_TUNING_METHOD,
430 gettext_noop("Enables the planner's use of TID scan plans."),
437 {"enable_sort", PGC_USERSET, QUERY_TUNING_METHOD,
438 gettext_noop("Enables the planner's use of explicit sort steps."),
445 {"enable_hashagg", PGC_USERSET, QUERY_TUNING_METHOD,
446 gettext_noop("Enables the planner's use of hashed aggregation plans."),
453 {"enable_nestloop", PGC_USERSET, QUERY_TUNING_METHOD,
454 gettext_noop("Enables the planner's use of nested-loop join plans."),
461 {"enable_mergejoin", PGC_USERSET, QUERY_TUNING_METHOD,
462 gettext_noop("Enables the planner's use of merge join plans."),
469 {"enable_hashjoin", PGC_USERSET, QUERY_TUNING_METHOD,
470 gettext_noop("Enables the planner's use of hash join plans."),
477 {"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
478 gettext_noop("Enables the planner to use constraints to optimize queries."),
479 gettext_noop("Child table scans will be skipped if their "
480 "constraints guarantee that no rows match the query.")
482 &constraint_exclusion,
486 {"geqo", PGC_USERSET, QUERY_TUNING_GEQO,
487 gettext_noop("Enables genetic query optimization."),
488 gettext_noop("This algorithm attempts to do planning without "
489 "exhaustive searching.")
495 /* Not for general use --- used by SET SESSION AUTHORIZATION */
496 {"is_superuser", PGC_INTERNAL, UNGROUPED,
497 gettext_noop("Shows whether the current user is a superuser."),
499 GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
501 &session_auth_is_superuser,
505 {"ssl", PGC_POSTMASTER, CONN_AUTH_SECURITY,
506 gettext_noop("Enables SSL connections."),
510 false, assign_ssl, NULL
513 {"fsync", PGC_SIGHUP, WAL_SETTINGS,
514 gettext_noop("Forces synchronization of updates to disk."),
515 gettext_noop("The server will use the fsync() system call in several places to make "
516 "sure that updates are physically written to disk. This insures "
517 "that a database cluster will recover to a consistent state after "
518 "an operating system or hardware crash.")
524 {"zero_damaged_pages", PGC_SUSET, DEVELOPER_OPTIONS,
525 gettext_noop("Continues processing past damaged page headers."),
526 gettext_noop("Detection of a damaged page header normally causes PostgreSQL to "
527 "report an error, aborting the current transaction. Setting "
528 "zero_damaged_pages to true causes the system to instead report a "
529 "warning, zero out the damaged page, and continue processing. This "
530 "behavior will destroy data, namely all the rows on the damaged page."),
537 {"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
538 gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
539 gettext_noop("A page write in process during an operating system crash might be "
540 "only partially written to disk. During recovery, the row changes "
541 "stored in WAL are not enough to recover. This option writes "
542 "pages when first modified after a checkpoint to WAL so full recovery "
549 {"silent_mode", PGC_POSTMASTER, LOGGING_WHEN,
550 gettext_noop("Runs the server silently."),
551 gettext_noop("If this parameter is set, the server will automatically run in the "
552 "background and any controlling terminals are dissociated.")
558 {"log_connections", PGC_BACKEND, LOGGING_WHAT,
559 gettext_noop("Logs each successful connection."),
566 {"log_disconnections", PGC_BACKEND, LOGGING_WHAT,
567 gettext_noop("Logs end of a session, including duration."),
574 {"debug_assertions", PGC_USERSET, DEVELOPER_OPTIONS,
575 gettext_noop("Turns on various assertion checks."),
576 gettext_noop("This is a debugging aid."),
580 #ifdef USE_ASSERT_CHECKING
585 assign_debug_assertions, NULL
588 /* currently undocumented, so don't show in SHOW ALL */
589 {"exit_on_error", PGC_USERSET, UNGROUPED,
590 gettext_noop("no description available"),
592 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
598 {"log_duration", PGC_SUSET, LOGGING_WHAT,
599 gettext_noop("Logs the duration of each completed SQL statement."),
606 {"debug_print_parse", PGC_USERSET, LOGGING_WHAT,
607 gettext_noop("Prints the parse tree to the server log."),
614 {"debug_print_rewritten", PGC_USERSET, LOGGING_WHAT,
615 gettext_noop("Prints the parse tree after rewriting to server log."),
618 &Debug_print_rewritten,
622 {"debug_print_plan", PGC_USERSET, LOGGING_WHAT,
623 gettext_noop("Prints the execution plan to server log."),
630 {"debug_pretty_print", PGC_USERSET, LOGGING_WHAT,
631 gettext_noop("Indents parse and plan tree displays."),
638 {"log_parser_stats", PGC_SUSET, STATS_MONITORING,
639 gettext_noop("Writes parser performance statistics to the server log."),
643 false, assign_stage_log_stats, NULL
646 {"log_planner_stats", PGC_SUSET, STATS_MONITORING,
647 gettext_noop("Writes planner performance statistics to the server log."),
651 false, assign_stage_log_stats, NULL
654 {"log_executor_stats", PGC_SUSET, STATS_MONITORING,
655 gettext_noop("Writes executor performance statistics to the server log."),
659 false, assign_stage_log_stats, NULL
662 {"log_statement_stats", PGC_SUSET, STATS_MONITORING,
663 gettext_noop("Writes cumulative performance statistics to the server log."),
666 &log_statement_stats,
667 false, assign_log_stats, NULL
669 #ifdef BTREE_BUILD_STATS
671 {"log_btree_build_stats", PGC_SUSET, DEVELOPER_OPTIONS,
672 gettext_noop("no description available"),
676 &log_btree_build_stats,
682 {"explain_pretty_print", PGC_USERSET, CLIENT_CONN_OTHER,
683 gettext_noop("Uses the indented output format for EXPLAIN VERBOSE."),
686 &Explain_pretty_print,
690 {"stats_start_collector", PGC_POSTMASTER, STATS_COLLECTOR,
691 gettext_noop("Starts the server statistics-collection subprocess."),
694 &pgstat_collect_startcollector,
698 {"stats_reset_on_server_start", PGC_POSTMASTER, STATS_COLLECTOR,
699 gettext_noop("Zeroes collected statistics on server restart."),
702 &pgstat_collect_resetonpmstart,
706 {"stats_row_level", PGC_SUSET, STATS_COLLECTOR,
707 gettext_noop("Collects row-level statistics on database activity."),
710 &pgstat_collect_tuplelevel,
714 {"stats_block_level", PGC_SUSET, STATS_COLLECTOR,
715 gettext_noop("Collects block-level statistics on database activity."),
718 &pgstat_collect_blocklevel,
723 {"stats_command_string", PGC_SUSET, STATS_COLLECTOR,
724 gettext_noop("Collects information about executing commands."),
725 gettext_noop("Enables the collection of information on the currently "
726 "executing command of each session, along with the time "
727 "at which that command began execution.")
729 &pgstat_collect_querystring,
734 {"update_process_title", PGC_SUSET, STATS_COLLECTOR,
735 gettext_noop("Updates the process title to show the active SQL command."),
736 gettext_noop("Enables updating of the process title every time a new SQL command is received by the server.")
738 &update_process_title,
743 {"autovacuum", PGC_SIGHUP, AUTOVACUUM,
744 gettext_noop("Starts the autovacuum subprocess."),
747 &autovacuum_start_daemon,
752 {"trace_notify", PGC_USERSET, DEVELOPER_OPTIONS,
753 gettext_noop("Generates debugging output for LISTEN and NOTIFY."),
763 {"trace_locks", PGC_SUSET, DEVELOPER_OPTIONS,
764 gettext_noop("no description available"),
772 {"trace_userlocks", PGC_SUSET, DEVELOPER_OPTIONS,
773 gettext_noop("no description available"),
781 {"trace_lwlocks", PGC_SUSET, DEVELOPER_OPTIONS,
782 gettext_noop("no description available"),
790 {"debug_deadlocks", PGC_SUSET, DEVELOPER_OPTIONS,
791 gettext_noop("no description available"),
801 {"log_hostname", PGC_SIGHUP, LOGGING_WHAT,
802 gettext_noop("Logs the host name in the connection logs."),
803 gettext_noop("By default, connection logs only show the IP address "
804 "of the connecting host. If you want them to show the host name you "
805 "can turn this on, but depending on your host name resolution "
806 "setup it might impose a non-negligible performance penalty.")
812 {"sql_inheritance", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
813 gettext_noop("Causes subtables to be included by default in various commands."),
820 {"password_encryption", PGC_USERSET, CONN_AUTH_SECURITY,
821 gettext_noop("Encrypt passwords."),
822 gettext_noop("When a password is specified in CREATE USER or "
823 "ALTER USER without writing either ENCRYPTED or UNENCRYPTED, "
824 "this parameter determines whether the password is to be encrypted.")
826 &Password_encryption,
830 {"transform_null_equals", PGC_USERSET, COMPAT_OPTIONS_CLIENT,
831 gettext_noop("Treats \"expr=NULL\" as \"expr IS NULL\"."),
832 gettext_noop("When turned on, expressions of the form expr = NULL "
833 "(or NULL = expr) are treated as expr IS NULL, that is, they "
834 "return true if expr evaluates to the null value, and false "
835 "otherwise. The correct behavior of expr = NULL is to always "
836 "return null (unknown).")
838 &Transform_null_equals,
842 {"db_user_namespace", PGC_SIGHUP, CONN_AUTH_SECURITY,
843 gettext_noop("Enables per-database user names."),
850 /* only here for backwards compatibility */
851 {"autocommit", PGC_USERSET, CLIENT_CONN_STATEMENT,
852 gettext_noop("This parameter doesn't do anything."),
853 gettext_noop("It's just here so that we won't choke on SET AUTOCOMMIT TO ON from 7.3-vintage clients."),
854 GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE
857 true, assign_phony_autocommit, NULL
860 {"default_transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
861 gettext_noop("Sets the default read-only status of new transactions."),
864 &DefaultXactReadOnly,
868 {"transaction_read_only", PGC_USERSET, CLIENT_CONN_STATEMENT,
869 gettext_noop("Sets the current transaction's read-only status."),
871 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
874 false, assign_transaction_read_only, NULL
877 {"add_missing_from", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
878 gettext_noop("Automatically adds missing table references to FROM clauses."),
885 {"check_function_bodies", PGC_USERSET, CLIENT_CONN_STATEMENT,
886 gettext_noop("Check function bodies during CREATE FUNCTION."),
889 &check_function_bodies,
893 {"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
894 gettext_noop("Enable input of NULL elements in arrays."),
895 gettext_noop("When turned on, unquoted NULL in an array input "
896 "value means a NULL value; "
897 "otherwise it is taken literally.")
903 {"default_with_oids", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
904 gettext_noop("Create new tables with OIDs by default."),
911 {"redirect_stderr", PGC_POSTMASTER, LOGGING_WHERE,
912 gettext_noop("Start a subprocess to capture stderr output into log files."),
919 {"log_truncate_on_rotation", PGC_SIGHUP, LOGGING_WHERE,
920 gettext_noop("Truncate existing log files of same name during log rotation."),
923 &Log_truncate_on_rotation,
929 {"trace_sort", PGC_USERSET, DEVELOPER_OPTIONS,
930 gettext_noop("Emit information about resource usage in sorting."),
941 {"wal_debug", PGC_SUSET, DEVELOPER_OPTIONS,
942 gettext_noop("Emit WAL-related debugging output."),
952 {"integer_datetimes", PGC_INTERNAL, PRESET_OPTIONS,
953 gettext_noop("Datetimes are integer based."),
955 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
958 #ifdef HAVE_INT64_TIMESTAMP
966 {"krb_caseins_users", PGC_POSTMASTER, CONN_AUTH_SECURITY,
967 gettext_noop("Sets whether Kerberos user names should be treated as case-insensitive."),
970 &pg_krb_caseins_users,
975 {"escape_string_warning", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
976 gettext_noop("Warn about backslash escapes in ordinary string literals."),
979 &escape_string_warning,
984 {"standard_conforming_strings", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
985 gettext_noop("'...' strings treat backslashes literally."),
989 &standard_conforming_strings,
994 {"allow_system_table_mods", PGC_POSTMASTER, DEVELOPER_OPTIONS,
995 gettext_noop("Allows modifications of the structure of system tables."),
999 &allowSystemTableMods,
1004 {"ignore_system_indexes", PGC_BACKEND, DEVELOPER_OPTIONS,
1005 gettext_noop("Disables reading from system indexes."),
1006 gettext_noop("It does not prevent updating the indexes, so it is safe "
1007 "to use. The worst consequence is slowness."),
1010 &IgnoreSystemIndexes,
1014 /* End-of-list marker */
1016 {NULL, 0, 0, NULL, NULL}, NULL, false, NULL, NULL
1021 static struct config_int ConfigureNamesInt[] =
1024 {"archive_timeout", PGC_SIGHUP, WAL_SETTINGS,
1025 gettext_noop("Forces a switch to the next xlog file if a "
1026 "new file has not been started within N seconds."),
1030 &XLogArchiveTimeout,
1031 0, 0, INT_MAX, NULL, NULL
1034 {"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
1035 gettext_noop("Waits N seconds on connection startup after authentication."),
1036 gettext_noop("This allows attaching a debugger to the process."),
1037 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1040 0, 0, INT_MAX, NULL, NULL
1043 {"default_statistics_target", PGC_USERSET, QUERY_TUNING_OTHER,
1044 gettext_noop("Sets the default statistics target."),
1045 gettext_noop("This applies to table columns that have not had a "
1046 "column-specific target set via ALTER TABLE SET STATISTICS.")
1048 &default_statistics_target,
1049 10, 1, 1000, NULL, NULL
1052 {"from_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1053 gettext_noop("Sets the FROM-list size beyond which subqueries are not "
1055 gettext_noop("The planner will merge subqueries into upper "
1056 "queries if the resulting FROM list would have no more than "
1059 &from_collapse_limit,
1060 8, 1, INT_MAX, NULL, NULL
1063 {"join_collapse_limit", PGC_USERSET, QUERY_TUNING_OTHER,
1064 gettext_noop("Sets the FROM-list size beyond which JOIN constructs are not "
1066 gettext_noop("The planner will flatten explicit JOIN "
1067 "constructs into lists of FROM items whenever a list of no more "
1068 "than this many items would result.")
1070 &join_collapse_limit,
1071 8, 1, INT_MAX, NULL, NULL
1074 {"geqo_threshold", PGC_USERSET, QUERY_TUNING_GEQO,
1075 gettext_noop("Sets the threshold of FROM items beyond which GEQO is used."),
1079 12, 2, INT_MAX, NULL, NULL
1082 {"geqo_effort", PGC_USERSET, QUERY_TUNING_GEQO,
1083 gettext_noop("GEQO: effort is used to set the default for other GEQO parameters."),
1087 DEFAULT_GEQO_EFFORT, MIN_GEQO_EFFORT, MAX_GEQO_EFFORT, NULL, NULL
1090 {"geqo_pool_size", PGC_USERSET, QUERY_TUNING_GEQO,
1091 gettext_noop("GEQO: number of individuals in the population."),
1092 gettext_noop("Zero selects a suitable default value.")
1095 0, 0, INT_MAX, NULL, NULL
1098 {"geqo_generations", PGC_USERSET, QUERY_TUNING_GEQO,
1099 gettext_noop("GEQO: number of iterations of the algorithm."),
1100 gettext_noop("Zero selects a suitable default value.")
1103 0, 0, INT_MAX, NULL, NULL
1107 {"deadlock_timeout", PGC_SIGHUP, LOCK_MANAGEMENT,
1108 gettext_noop("The time in milliseconds to wait on lock before checking for deadlock."),
1113 1000, 0, INT_MAX, NULL, NULL
1117 * Note: There is some postprocessing done in PostmasterMain() to make
1118 * sure the buffers are at least twice the number of backends, so the
1119 * constraints here are partially unused. Similarly, the superuser
1120 * reserved number is checked to ensure it is less than the max backends
1123 * MaxBackends is limited to INT_MAX/4 because some places compute
1124 * 4*MaxBackends without any overflow check. Likewise we have to limit
1125 * NBuffers to INT_MAX/2.
1128 {"max_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1129 gettext_noop("Sets the maximum number of concurrent connections."),
1133 100, 1, INT_MAX / 4, NULL, NULL
1137 {"superuser_reserved_connections", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1138 gettext_noop("Sets the number of connection slots reserved for superusers."),
1142 3, 0, INT_MAX / 4, NULL, NULL
1146 {"shared_buffers", PGC_POSTMASTER, RESOURCES_MEM,
1147 gettext_noop("Sets the number of shared memory buffers used by the server."),
1152 1000, 16, INT_MAX / 2, NULL, NULL
1156 {"temp_buffers", PGC_USERSET, RESOURCES_MEM,
1157 gettext_noop("Sets the maximum number of temporary buffers used by each session."),
1162 1000, 100, INT_MAX / 2, NULL, show_num_temp_buffers
1166 {"port", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1167 gettext_noop("Sets the TCP port the server listens on."),
1171 DEF_PGPORT, 1, 65535, NULL, NULL
1175 {"unix_socket_permissions", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1176 gettext_noop("Sets the access permissions of the Unix-domain socket."),
1177 gettext_noop("Unix-domain sockets use the usual Unix file system "
1178 "permission set. The parameter value is expected to be an numeric mode "
1179 "specification in the form accepted by the chmod and umask system "
1180 "calls. (To use the customary octal format the number must start with "
1183 &Unix_socket_permissions,
1184 0777, 0000, 0777, NULL, NULL
1188 {"work_mem", PGC_USERSET, RESOURCES_MEM,
1189 gettext_noop("Sets the maximum memory to be used for query workspaces."),
1190 gettext_noop("This much memory may be used by each internal "
1191 "sort operation and hash table before switching to "
1192 "temporary disk files."),
1196 1024, 8 * BLCKSZ / 1024, MAX_KILOBYTES, NULL, NULL
1200 {"maintenance_work_mem", PGC_USERSET, RESOURCES_MEM,
1201 gettext_noop("Sets the maximum memory to be used for maintenance operations."),
1202 gettext_noop("This includes operations such as VACUUM and CREATE INDEX."),
1205 &maintenance_work_mem,
1206 16384, 1024, MAX_KILOBYTES, NULL, NULL
1210 {"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
1211 gettext_noop("Sets the maximum stack depth, in kilobytes."),
1216 2048, 100, MAX_KILOBYTES, assign_max_stack_depth, NULL
1220 {"vacuum_cost_page_hit", PGC_USERSET, RESOURCES,
1221 gettext_noop("Vacuum cost for a page found in the buffer cache."),
1225 1, 0, 10000, NULL, NULL
1229 {"vacuum_cost_page_miss", PGC_USERSET, RESOURCES,
1230 gettext_noop("Vacuum cost for a page not found in the buffer cache."),
1233 &VacuumCostPageMiss,
1234 10, 0, 10000, NULL, NULL
1238 {"vacuum_cost_page_dirty", PGC_USERSET, RESOURCES,
1239 gettext_noop("Vacuum cost for a page dirtied by vacuum."),
1242 &VacuumCostPageDirty,
1243 20, 0, 10000, NULL, NULL
1247 {"vacuum_cost_limit", PGC_USERSET, RESOURCES,
1248 gettext_noop("Vacuum cost amount available before napping."),
1252 200, 1, 10000, NULL, NULL
1256 {"vacuum_cost_delay", PGC_USERSET, RESOURCES,
1257 gettext_noop("Vacuum cost delay in milliseconds."),
1262 0, 0, 1000, NULL, NULL
1266 {"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
1267 gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
1271 &autovacuum_vac_cost_delay,
1272 -1, -1, 1000, NULL, NULL
1276 {"autovacuum_vacuum_cost_limit", PGC_SIGHUP, AUTOVACUUM,
1277 gettext_noop("Vacuum cost amount available before napping, for autovacuum."),
1280 &autovacuum_vac_cost_limit,
1281 -1, -1, 10000, NULL, NULL
1285 {"max_files_per_process", PGC_POSTMASTER, RESOURCES_KERNEL,
1286 gettext_noop("Sets the maximum number of simultaneously open files for each server process."),
1289 &max_files_per_process,
1290 1000, 25, INT_MAX, NULL, NULL
1294 {"max_prepared_transactions", PGC_POSTMASTER, RESOURCES,
1295 gettext_noop("Sets the maximum number of simultaneously prepared transactions."),
1298 &max_prepared_xacts,
1299 5, 0, INT_MAX, NULL, NULL
1304 {"trace_lock_oidmin", PGC_SUSET, DEVELOPER_OPTIONS,
1305 gettext_noop("no description available"),
1310 FirstNormalObjectId, 0, INT_MAX, NULL, NULL
1313 {"trace_lock_table", PGC_SUSET, DEVELOPER_OPTIONS,
1314 gettext_noop("no description available"),
1319 0, 0, INT_MAX, NULL, NULL
1324 {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
1325 gettext_noop("Sets the maximum allowed duration (in milliseconds) of any statement."),
1326 gettext_noop("A value of 0 turns off the timeout."),
1330 0, 0, INT_MAX, NULL, NULL
1334 {"max_fsm_relations", PGC_POSTMASTER, RESOURCES_FSM,
1335 gettext_noop("Sets the maximum number of tables and indexes for which free space is tracked."),
1339 1000, 100, INT_MAX, NULL, NULL
1342 {"max_fsm_pages", PGC_POSTMASTER, RESOURCES_FSM,
1343 gettext_noop("Sets the maximum number of disk pages for which free space is tracked."),
1347 20000, 1000, INT_MAX, NULL, NULL
1351 {"max_locks_per_transaction", PGC_POSTMASTER, LOCK_MANAGEMENT,
1352 gettext_noop("Sets the maximum number of locks per transaction."),
1353 gettext_noop("The shared lock table is sized on the assumption that "
1354 "at most max_locks_per_transaction * max_connections distinct "
1355 "objects will need to be locked at any one time.")
1357 &max_locks_per_xact,
1358 64, 10, INT_MAX, NULL, NULL
1362 {"authentication_timeout", PGC_SIGHUP, CONN_AUTH_SECURITY,
1363 gettext_noop("Sets the maximum time in seconds to complete client authentication."),
1367 &AuthenticationTimeout,
1368 60, 1, 600, NULL, NULL
1372 /* Not for general use */
1373 {"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
1374 gettext_noop("no description available"),
1376 GUC_NOT_IN_SAMPLE | GUC_UNIT_S
1379 0, 0, 60, NULL, NULL
1383 {"checkpoint_segments", PGC_SIGHUP, WAL_CHECKPOINTS,
1384 gettext_noop("Sets the maximum distance in log segments between automatic WAL checkpoints."),
1387 &CheckPointSegments,
1388 3, 1, INT_MAX, NULL, NULL
1392 {"checkpoint_timeout", PGC_SIGHUP, WAL_CHECKPOINTS,
1393 gettext_noop("Sets the maximum time in seconds between automatic WAL checkpoints."),
1398 300, 30, 3600, NULL, NULL
1402 {"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
1403 gettext_noop("Logs if filling of checkpoint segments happens more "
1404 "frequently than this (in seconds)."),
1405 gettext_noop("Write a message to the server log if checkpoints "
1406 "caused by the filling of checkpoint segment files happens more "
1407 "frequently than this number of seconds. Zero turns off the warning.")
1410 30, 0, INT_MAX, NULL, NULL
1414 {"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
1415 gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
1419 8, 4, INT_MAX, NULL, NULL
1423 {"commit_delay", PGC_USERSET, WAL_CHECKPOINTS,
1424 gettext_noop("Sets the delay in microseconds between transaction commit and "
1425 "flushing WAL to disk."),
1429 0, 0, 100000, NULL, NULL
1433 {"commit_siblings", PGC_USERSET, WAL_CHECKPOINTS,
1434 gettext_noop("Sets the minimum concurrent open transactions before performing "
1439 5, 1, 1000, NULL, NULL
1443 {"extra_float_digits", PGC_USERSET, CLIENT_CONN_LOCALE,
1444 gettext_noop("Sets the number of digits displayed for floating-point values."),
1445 gettext_noop("This affects real, double precision, and geometric data types. "
1446 "The parameter value is added to the standard number of digits "
1447 "(FLT_DIG or DBL_DIG as appropriate).")
1449 &extra_float_digits,
1450 0, -15, 2, NULL, NULL
1454 {"log_min_duration_statement", PGC_SUSET, LOGGING_WHEN,
1455 gettext_noop("Sets the minimum execution time in milliseconds above which statements will "
1457 gettext_noop("Zero prints all queries. The default is -1 (turning this feature off)."),
1460 &log_min_duration_statement,
1461 -1, -1, INT_MAX / 1000, NULL, NULL
1465 {"bgwriter_delay", PGC_SIGHUP, RESOURCES,
1466 gettext_noop("Background writer sleep time between rounds in milliseconds"),
1471 200, 10, 10000, NULL, NULL
1475 {"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES,
1476 gettext_noop("Background writer maximum number of LRU pages to flush per round"),
1479 &bgwriter_lru_maxpages,
1480 5, 0, 1000, NULL, NULL
1484 {"bgwriter_all_maxpages", PGC_SIGHUP, RESOURCES,
1485 gettext_noop("Background writer maximum number of all pages to flush per round"),
1488 &bgwriter_all_maxpages,
1489 5, 0, 1000, NULL, NULL
1493 {"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
1494 gettext_noop("Automatic log file rotation will occur after N minutes"),
1499 HOURS_PER_DAY * MINS_PER_HOUR, 0, INT_MAX / MINS_PER_HOUR, NULL, NULL
1503 {"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
1504 gettext_noop("Automatic log file rotation will occur after N kilobytes"),
1509 10 * 1024, 0, INT_MAX / 1024, NULL, NULL
1513 {"max_function_args", PGC_INTERNAL, PRESET_OPTIONS,
1514 gettext_noop("Shows the maximum number of function arguments."),
1516 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1519 FUNC_MAX_ARGS, FUNC_MAX_ARGS, FUNC_MAX_ARGS, NULL, NULL
1523 {"max_index_keys", PGC_INTERNAL, PRESET_OPTIONS,
1524 gettext_noop("Shows the maximum number of index keys."),
1526 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1529 INDEX_MAX_KEYS, INDEX_MAX_KEYS, INDEX_MAX_KEYS, NULL, NULL
1533 {"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
1534 gettext_noop("Shows the maximum identifier length"),
1536 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1538 &max_identifier_length,
1539 NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1, NULL, NULL
1543 {"block_size", PGC_INTERNAL, PRESET_OPTIONS,
1544 gettext_noop("Shows size of a disk block"),
1546 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1549 BLCKSZ, BLCKSZ, BLCKSZ, NULL, NULL
1553 {"autovacuum_naptime", PGC_SIGHUP, AUTOVACUUM,
1554 gettext_noop("Time to sleep between autovacuum runs, in seconds."),
1558 &autovacuum_naptime,
1559 60, 1, INT_MAX, NULL, NULL
1562 {"autovacuum_vacuum_threshold", PGC_SIGHUP, AUTOVACUUM,
1563 gettext_noop("Minimum number of tuple updates or deletes prior to vacuum."),
1566 &autovacuum_vac_thresh,
1567 500, 0, INT_MAX, NULL, NULL
1570 {"autovacuum_analyze_threshold", PGC_SIGHUP, AUTOVACUUM,
1571 gettext_noop("Minimum number of tuple inserts, updates or deletes prior to analyze."),
1574 &autovacuum_anl_thresh,
1575 250, 0, INT_MAX, NULL, NULL
1579 {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
1580 gettext_noop("Seconds between issuing TCP keepalives."),
1581 gettext_noop("A value of 0 uses the system default."),
1584 &tcp_keepalives_idle,
1585 0, 0, INT_MAX, assign_tcp_keepalives_idle, show_tcp_keepalives_idle
1589 {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
1590 gettext_noop("Seconds between TCP keepalive retransmits."),
1591 gettext_noop("A value of 0 uses the system default."),
1594 &tcp_keepalives_interval,
1595 0, 0, INT_MAX, assign_tcp_keepalives_interval, show_tcp_keepalives_interval
1599 {"tcp_keepalives_count", PGC_USERSET, CLIENT_CONN_OTHER,
1600 gettext_noop("Maximum number of TCP keepalive retransmits."),
1601 gettext_noop("This controls the number of consecutive keepalive retransmits that can be "
1602 "lost before a connection is considered dead. A value of 0 uses the "
1605 &tcp_keepalives_count,
1606 0, 0, INT_MAX, assign_tcp_keepalives_count, show_tcp_keepalives_count
1610 {"gin_fuzzy_search_limit", PGC_USERSET, UNGROUPED,
1611 gettext_noop("Sets the maximum allowed result for exact search by gin."),
1615 &GinFuzzySearchLimit,
1616 0, 0, INT_MAX, NULL, NULL
1620 {"effective_cache_size", PGC_USERSET, QUERY_TUNING_COST,
1621 gettext_noop("Sets the planner's assumption about size of the disk cache."),
1622 gettext_noop("That is, the portion of the kernel's disk cache that "
1623 "will be used for PostgreSQL data files. This is measured in disk "
1624 "pages, which are normally 8 kB each."),
1627 &effective_cache_size,
1628 DEFAULT_EFFECTIVE_CACHE_SIZE, 1, INT_MAX, NULL, NULL
1632 /* Can't be set in postgresql.conf */
1633 {"server_version_num", PGC_INTERNAL, PRESET_OPTIONS,
1634 gettext_noop("Shows the server version as an integer."),
1636 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1638 &server_version_num,
1639 PG_VERSION_NUM, PG_VERSION_NUM, PG_VERSION_NUM, NULL, NULL
1642 /* End-of-list marker */
1644 {NULL, 0, 0, NULL, NULL}, NULL, 0, 0, 0, NULL, NULL
1649 static struct config_real ConfigureNamesReal[] =
1652 {"seq_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1653 gettext_noop("Sets the planner's estimate of the cost of a "
1654 "sequentially fetched disk page."),
1658 DEFAULT_SEQ_PAGE_COST, 0, DBL_MAX, NULL, NULL
1661 {"random_page_cost", PGC_USERSET, QUERY_TUNING_COST,
1662 gettext_noop("Sets the planner's estimate of the cost of a "
1663 "nonsequentially fetched disk page."),
1667 DEFAULT_RANDOM_PAGE_COST, 0, DBL_MAX, NULL, NULL
1670 {"cpu_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1671 gettext_noop("Sets the planner's estimate of the cost of "
1672 "processing each tuple (row)."),
1676 DEFAULT_CPU_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1679 {"cpu_index_tuple_cost", PGC_USERSET, QUERY_TUNING_COST,
1680 gettext_noop("Sets the planner's estimate of the cost of "
1681 "processing each index entry during an index scan."),
1684 &cpu_index_tuple_cost,
1685 DEFAULT_CPU_INDEX_TUPLE_COST, 0, DBL_MAX, NULL, NULL
1688 {"cpu_operator_cost", PGC_USERSET, QUERY_TUNING_COST,
1689 gettext_noop("Sets the planner's estimate of the cost of "
1690 "processing each operator or function call."),
1694 DEFAULT_CPU_OPERATOR_COST, 0, DBL_MAX, NULL, NULL
1698 {"geqo_selection_bias", PGC_USERSET, QUERY_TUNING_GEQO,
1699 gettext_noop("GEQO: selective pressure within the population."),
1702 &Geqo_selection_bias,
1703 DEFAULT_GEQO_SELECTION_BIAS, MIN_GEQO_SELECTION_BIAS,
1704 MAX_GEQO_SELECTION_BIAS, NULL, NULL
1708 {"bgwriter_lru_percent", PGC_SIGHUP, RESOURCES,
1709 gettext_noop("Background writer percentage of LRU buffers to flush per round"),
1712 &bgwriter_lru_percent,
1713 1.0, 0.0, 100.0, NULL, NULL
1717 {"bgwriter_all_percent", PGC_SIGHUP, RESOURCES,
1718 gettext_noop("Background writer percentage of all buffers to flush per round"),
1721 &bgwriter_all_percent,
1722 0.333, 0.0, 100.0, NULL, NULL
1726 {"seed", PGC_USERSET, UNGROUPED,
1727 gettext_noop("Sets the seed for random-number generation."),
1729 GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1732 0.5, 0.0, 1.0, assign_random_seed, show_random_seed
1736 {"autovacuum_vacuum_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1737 gettext_noop("Number of tuple updates or deletes prior to vacuum as a fraction of reltuples."),
1740 &autovacuum_vac_scale,
1741 0.2, 0.0, 100.0, NULL, NULL
1744 {"autovacuum_analyze_scale_factor", PGC_SIGHUP, AUTOVACUUM,
1745 gettext_noop("Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples."),
1748 &autovacuum_anl_scale,
1749 0.1, 0.0, 100.0, NULL, NULL
1752 /* End-of-list marker */
1754 {NULL, 0, 0, NULL, NULL}, NULL, 0.0, 0.0, 0.0, NULL, NULL
1759 static struct config_string ConfigureNamesString[] =
1762 {"archive_command", PGC_SIGHUP, WAL_SETTINGS,
1763 gettext_noop("WAL archiving command."),
1764 gettext_noop("The shell command that will be called to archive a WAL file.")
1766 &XLogArchiveCommand,
1771 {"backslash_quote", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
1772 gettext_noop("Sets whether \"\\'\" is allowed in string literals."),
1773 gettext_noop("Valid values are ON, OFF, and SAFE_ENCODING.")
1775 &backslash_quote_string,
1776 "safe_encoding", assign_backslash_quote, NULL
1780 {"client_encoding", PGC_USERSET, CLIENT_CONN_LOCALE,
1781 gettext_noop("Sets the client's character set encoding."),
1783 GUC_IS_NAME | GUC_REPORT
1785 &client_encoding_string,
1786 "SQL_ASCII", assign_client_encoding, NULL
1790 {"client_min_messages", PGC_USERSET, LOGGING_WHEN,
1791 gettext_noop("Sets the message levels that are sent to the client."),
1792 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, "
1793 "DEBUG1, LOG, NOTICE, WARNING, and ERROR. Each level includes all the "
1794 "levels that follow it. The later the level, the fewer messages are "
1797 &client_min_messages_str,
1798 "notice", assign_client_min_messages, NULL
1802 {"log_min_messages", PGC_SUSET, LOGGING_WHEN,
1803 gettext_noop("Sets the message levels that are logged."),
1804 gettext_noop("Valid values are DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, "
1805 "INFO, NOTICE, WARNING, ERROR, LOG, FATAL, and PANIC. Each level "
1806 "includes all the levels that follow it.")
1808 &log_min_messages_str,
1809 "notice", assign_log_min_messages, NULL
1813 {"log_error_verbosity", PGC_SUSET, LOGGING_WHEN,
1814 gettext_noop("Sets the verbosity of logged messages."),
1815 gettext_noop("Valid values are \"terse\", \"default\", and \"verbose\".")
1817 &log_error_verbosity_str,
1818 "default", assign_log_error_verbosity, NULL
1821 {"log_statement", PGC_SUSET, LOGGING_WHAT,
1822 gettext_noop("Sets the type of statements logged."),
1823 gettext_noop("Valid values are \"none\", \"ddl\", \"mod\", and \"all\".")
1826 "none", assign_log_statement, NULL
1830 {"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
1831 gettext_noop("Causes all statements generating error at or above this level to be logged."),
1832 gettext_noop("All SQL statements that cause an error of the "
1833 "specified level or a higher level are logged.")
1835 &log_min_error_statement_str,
1836 "panic", assign_min_error_statement, NULL
1840 {"log_line_prefix", PGC_SIGHUP, LOGGING_WHAT,
1841 gettext_noop("Controls information prefixed to each log line"),
1842 gettext_noop("if blank no prefix is used")
1850 {"DateStyle", PGC_USERSET, CLIENT_CONN_LOCALE,
1851 gettext_noop("Sets the display format for date and time values."),
1852 gettext_noop("Also controls interpretation of ambiguous "
1854 GUC_LIST_INPUT | GUC_REPORT
1857 "ISO, MDY", assign_datestyle, NULL
1861 {"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
1862 gettext_noop("Sets the default tablespace to create tables and indexes in."),
1863 gettext_noop("An empty string selects the database's default tablespace."),
1866 &default_tablespace,
1867 "", assign_default_tablespace, NULL
1871 {"default_transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
1872 gettext_noop("Sets the transaction isolation level of each new transaction."),
1873 gettext_noop("Each SQL transaction has an isolation level, which "
1874 "can be either \"read uncommitted\", \"read committed\", \"repeatable read\", or \"serializable\".")
1876 &default_iso_level_string,
1877 "read committed", assign_defaultxactisolevel, NULL
1881 {"dynamic_library_path", PGC_SUSET, CLIENT_CONN_OTHER,
1882 gettext_noop("Sets the path for dynamically loadable modules."),
1883 gettext_noop("If a dynamically loadable module needs to be opened and "
1884 "the specified name does not have a directory component (i.e., the "
1885 "name does not contain a slash), the system will search this path for "
1886 "the specified file."),
1889 &Dynamic_library_path,
1890 "$libdir", NULL, NULL
1894 {"krb_server_keyfile", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1895 gettext_noop("Sets the location of the Kerberos server key file."),
1899 &pg_krb_server_keyfile,
1900 PG_KRB_SRVTAB, NULL, NULL
1904 {"krb_srvname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1905 gettext_noop("Sets the name of the Kerberos service."),
1909 PG_KRB_SRVNAM, NULL, NULL
1913 {"krb_server_hostname", PGC_POSTMASTER, CONN_AUTH_SECURITY,
1914 gettext_noop("Sets the hostname of the Kerberos server."),
1917 &pg_krb_server_hostname,
1922 {"bonjour_name", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
1923 gettext_noop("Sets the Bonjour broadcast service name."),
1930 /* See main.c about why defaults for LC_foo are not all alike */
1933 {"lc_collate", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1934 gettext_noop("Shows the collation order locale."),
1936 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1943 {"lc_ctype", PGC_INTERNAL, CLIENT_CONN_LOCALE,
1944 gettext_noop("Shows the character classification and case conversion locale."),
1946 GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
1953 {"lc_messages", PGC_SUSET, CLIENT_CONN_LOCALE,
1954 gettext_noop("Sets the language in which messages are displayed."),
1958 "", locale_messages_assign, NULL
1962 {"lc_monetary", PGC_USERSET, CLIENT_CONN_LOCALE,
1963 gettext_noop("Sets the locale for formatting monetary amounts."),
1967 "C", locale_monetary_assign, NULL
1971 {"lc_numeric", PGC_USERSET, CLIENT_CONN_LOCALE,
1972 gettext_noop("Sets the locale for formatting numbers."),
1976 "C", locale_numeric_assign, NULL
1980 {"lc_time", PGC_USERSET, CLIENT_CONN_LOCALE,
1981 gettext_noop("Sets the locale for formatting date and time values."),
1985 "C", locale_time_assign, NULL
1989 {"shared_preload_libraries", PGC_POSTMASTER, RESOURCES_KERNEL,
1990 gettext_noop("Lists shared libraries to preload into server."),
1992 GUC_LIST_INPUT | GUC_LIST_QUOTE | GUC_SUPERUSER_ONLY
1994 &shared_preload_libraries_string,
1999 {"local_preload_libraries", PGC_BACKEND, CLIENT_CONN_OTHER,
2000 gettext_noop("Lists shared libraries to preload into each backend."),
2002 GUC_LIST_INPUT | GUC_LIST_QUOTE
2004 &local_preload_libraries_string,
2009 {"regex_flavor", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
2010 gettext_noop("Sets the regular expression \"flavor\"."),
2011 gettext_noop("This can be set to advanced, extended, or basic.")
2013 ®ex_flavor_string,
2014 "advanced", assign_regex_flavor, NULL
2018 {"search_path", PGC_USERSET, CLIENT_CONN_STATEMENT,
2019 gettext_noop("Sets the schema search order for names that are not schema-qualified."),
2021 GUC_LIST_INPUT | GUC_LIST_QUOTE
2023 &namespace_search_path,
2024 "\"$user\",public", assign_search_path, NULL
2028 /* Can't be set in postgresql.conf */
2029 {"server_encoding", PGC_INTERNAL, CLIENT_CONN_LOCALE,
2030 gettext_noop("Sets the server (database) character set encoding."),
2032 GUC_IS_NAME | GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2034 &server_encoding_string,
2035 "SQL_ASCII", NULL, NULL
2039 /* Can't be set in postgresql.conf */
2040 {"server_version", PGC_INTERNAL, PRESET_OPTIONS,
2041 gettext_noop("Shows the server version."),
2043 GUC_REPORT | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2045 &server_version_string,
2046 PG_VERSION, NULL, NULL
2050 /* Not for general use --- used by SET ROLE */
2051 {"role", PGC_USERSET, UNGROUPED,
2052 gettext_noop("Sets the current role."),
2054 GUC_IS_NAME | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2057 "none", assign_role, show_role
2061 /* Not for general use --- used by SET SESSION AUTHORIZATION */
2062 {"session_authorization", PGC_USERSET, UNGROUPED,
2063 gettext_noop("Sets the session user name."),
2065 GUC_IS_NAME | GUC_REPORT | GUC_NO_SHOW_ALL | GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2067 &session_authorization_string,
2068 NULL, assign_session_authorization, show_session_authorization
2072 {"log_destination", PGC_SIGHUP, LOGGING_WHERE,
2073 gettext_noop("Sets the destination for server log output."),
2074 gettext_noop("Valid values are combinations of \"stderr\", \"syslog\", "
2075 "and \"eventlog\", depending on the platform."),
2078 &log_destination_string,
2079 "stderr", assign_log_destination, NULL
2082 {"log_directory", PGC_SIGHUP, LOGGING_WHERE,
2083 gettext_noop("Sets the destination directory for log files."),
2084 gettext_noop("May be specified as relative to the data directory "
2085 "or as absolute path."),
2089 "pg_log", assign_canonical_path, NULL
2092 {"log_filename", PGC_SIGHUP, LOGGING_WHERE,
2093 gettext_noop("Sets the file name pattern for log files."),
2098 "postgresql-%Y-%m-%d_%H%M%S.log", NULL, NULL
2103 {"syslog_facility", PGC_SIGHUP, LOGGING_WHERE,
2104 gettext_noop("Sets the syslog \"facility\" to be used when syslog enabled."),
2105 gettext_noop("Valid values are LOCAL0, LOCAL1, LOCAL2, LOCAL3, "
2106 "LOCAL4, LOCAL5, LOCAL6, LOCAL7.")
2108 &syslog_facility_str,
2109 "LOCAL0", assign_syslog_facility, NULL
2112 {"syslog_ident", PGC_SIGHUP, LOGGING_WHERE,
2113 gettext_noop("Sets the program name used to identify PostgreSQL "
2114 "messages in syslog."),
2118 "postgres", assign_syslog_ident, NULL
2123 {"TimeZone", PGC_USERSET, CLIENT_CONN_LOCALE,
2124 gettext_noop("Sets the time zone for displaying and interpreting time stamps."),
2129 "UNKNOWN", assign_timezone, show_timezone
2132 {"timezone_abbreviations", PGC_USERSET, CLIENT_CONN_LOCALE,
2133 gettext_noop("Selects a file of timezone abbreviations"),
2136 &timezone_abbreviations_string,
2137 "UNKNOWN", assign_timezone_abbreviations, NULL
2141 {"transaction_isolation", PGC_USERSET, CLIENT_CONN_STATEMENT,
2142 gettext_noop("Sets the current transaction's isolation level."),
2144 GUC_NO_RESET_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
2146 &XactIsoLevel_string,
2147 NULL, assign_XactIsoLevel, show_XactIsoLevel
2151 {"unix_socket_group", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2152 gettext_noop("Sets the owning group of the Unix-domain socket."),
2153 gettext_noop("(The owning user of the socket is always the user "
2154 "that starts the server.)")
2161 {"unix_socket_directory", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2162 gettext_noop("Sets the directory where the Unix-domain socket will be created."),
2167 "", assign_canonical_path, NULL
2171 {"listen_addresses", PGC_POSTMASTER, CONN_AUTH_SETTINGS,
2172 gettext_noop("Sets the host name or IP address(es) to listen to."),
2177 "localhost", NULL, NULL
2181 {"wal_sync_method", PGC_SIGHUP, WAL_SETTINGS,
2182 gettext_noop("Selects the method used for forcing WAL updates out to disk."),
2186 XLOG_sync_method_default, assign_xlog_sync_method, NULL
2190 {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
2191 gettext_noop("Sets the list of known custom variable classes."),
2193 GUC_LIST_INPUT | GUC_LIST_QUOTE
2195 &custom_variable_classes,
2196 NULL, assign_custom_variable_classes, NULL
2200 {"data_directory", PGC_POSTMASTER, FILE_LOCATIONS,
2201 gettext_noop("Sets the server's data directory."),
2210 {"config_file", PGC_POSTMASTER, FILE_LOCATIONS,
2211 gettext_noop("Sets the server's main configuration file."),
2213 GUC_DISALLOW_IN_FILE | GUC_SUPERUSER_ONLY
2220 {"hba_file", PGC_POSTMASTER, FILE_LOCATIONS,
2221 gettext_noop("Sets the server's \"hba\" configuration file"),
2230 {"ident_file", PGC_POSTMASTER, FILE_LOCATIONS,
2231 gettext_noop("Sets the server's \"ident\" configuration file"),
2240 {"external_pid_file", PGC_POSTMASTER, FILE_LOCATIONS,
2241 gettext_noop("Writes the postmaster PID to the specified file."),
2246 NULL, assign_canonical_path, NULL
2249 /* End-of-list marker */
2251 {NULL, 0, 0, NULL, NULL}, NULL, NULL, NULL, NULL
2256 /******** end of options list ********/
2260 * To allow continued support of obsolete names for GUC variables, we apply
2261 * the following mappings to any unrecognized name. Note that an old name
2262 * should be mapped to a new one only if the new variable has very similar
2263 * semantics to the old.
2265 static const char *const map_old_guc_names[] = {
2266 "sort_mem", "work_mem",
2267 "vacuum_mem", "maintenance_work_mem",
2273 * Actual lookup of variables is done through this single, sorted array.
2275 static struct config_generic **guc_variables;
2277 /* Current number of variables contained in the vector */
2278 static int num_guc_variables;
2280 /* Vector capacity */
2281 static int size_guc_variables;
2284 static bool guc_dirty; /* TRUE if need to do commit/abort work */
2286 static bool reporting_enabled; /* TRUE to enable GUC_REPORT */
2289 static int guc_var_compare(const void *a, const void *b);
2290 static int guc_name_compare(const char *namea, const char *nameb);
2291 static void push_old_value(struct config_generic * gconf);
2292 static void ReportGUCOption(struct config_generic * record);
2293 static void ShowGUCConfigOption(const char *name, DestReceiver *dest);
2294 static void ShowAllGUCConfig(DestReceiver *dest);
2295 static char *_ShowOption(struct config_generic * record, bool use_units);
2296 static bool is_newvalue_equal(struct config_generic *record, const char *newvalue);
2300 * Some infrastructure for checking malloc/strdup/realloc calls
2303 guc_malloc(int elevel, size_t size)
2307 data = malloc(size);
2310 (errcode(ERRCODE_OUT_OF_MEMORY),
2311 errmsg("out of memory")));
2316 guc_realloc(int elevel, void *old, size_t size)
2320 data = realloc(old, size);
2323 (errcode(ERRCODE_OUT_OF_MEMORY),
2324 errmsg("out of memory")));
2329 guc_strdup(int elevel, const char *src)
2336 (errcode(ERRCODE_OUT_OF_MEMORY),
2337 errmsg("out of memory")));
2343 * Support for assigning to a field of a string GUC item. Free the prior
2344 * value if it's not referenced anywhere else in the item (including stacked
2348 set_string_field(struct config_string * conf, char **field, char *newval)
2350 char *oldval = *field;
2353 /* Do the assignment */
2356 /* Exit if any duplicate references, or if old value was NULL anyway */
2357 if (oldval == NULL ||
2358 oldval == *(conf->variable) ||
2359 oldval == conf->reset_val ||
2360 oldval == conf->tentative_val)
2362 for (stack = conf->gen.stack; stack; stack = stack->prev)
2364 if (oldval == stack->tentative_val.stringval ||
2365 oldval == stack->value.stringval)
2369 /* Not used anymore, so free it */
2374 * Detect whether strval is referenced anywhere in a GUC string item
2377 string_field_used(struct config_string * conf, char *strval)
2381 if (strval == *(conf->variable) ||
2382 strval == conf->reset_val ||
2383 strval == conf->tentative_val)
2385 for (stack = conf->gen.stack; stack; stack = stack->prev)
2387 if (strval == stack->tentative_val.stringval ||
2388 strval == stack->value.stringval)
2395 struct config_generic **
2396 get_guc_variables(void)
2398 return guc_variables;
2403 * Build the sorted array. This is split out so that it could be
2404 * re-executed after startup (eg, we could allow loadable modules to
2405 * add vars, and then we'd need to re-sort).
2408 build_guc_variables(void)
2412 struct config_generic **guc_vars;
2415 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2417 struct config_bool *conf = &ConfigureNamesBool[i];
2419 /* Rather than requiring vartype to be filled in by hand, do this: */
2420 conf->gen.vartype = PGC_BOOL;
2424 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2426 struct config_int *conf = &ConfigureNamesInt[i];
2428 conf->gen.vartype = PGC_INT;
2432 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2434 struct config_real *conf = &ConfigureNamesReal[i];
2436 conf->gen.vartype = PGC_REAL;
2440 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2442 struct config_string *conf = &ConfigureNamesString[i];
2444 conf->gen.vartype = PGC_STRING;
2449 * Create table with 20% slack
2451 size_vars = num_vars + num_vars / 4;
2453 guc_vars = (struct config_generic **)
2454 guc_malloc(FATAL, size_vars * sizeof(struct config_generic *));
2458 for (i = 0; ConfigureNamesBool[i].gen.name; i++)
2459 guc_vars[num_vars++] = &ConfigureNamesBool[i].gen;
2461 for (i = 0; ConfigureNamesInt[i].gen.name; i++)
2462 guc_vars[num_vars++] = &ConfigureNamesInt[i].gen;
2464 for (i = 0; ConfigureNamesReal[i].gen.name; i++)
2465 guc_vars[num_vars++] = &ConfigureNamesReal[i].gen;
2467 for (i = 0; ConfigureNamesString[i].gen.name; i++)
2468 guc_vars[num_vars++] = &ConfigureNamesString[i].gen;
2471 free(guc_variables);
2472 guc_variables = guc_vars;
2473 num_guc_variables = num_vars;
2474 size_guc_variables = size_vars;
2475 qsort((void *) guc_variables, num_guc_variables,
2476 sizeof(struct config_generic *), guc_var_compare);
2480 is_custom_class(const char *name, int dotPos)
2483 * assign_custom_variable_classes() has made sure no empty identifiers or
2484 * whitespace exists in the variable
2486 bool result = false;
2487 const char *ccs = GetConfigOption("custom_variable_classes");
2491 const char *start = ccs;
2497 if (c == 0 || c == ',')
2499 if (dotPos == ccs - start && strncmp(start, name, dotPos) == 0)
2514 * Add a new GUC variable to the list of known variables. The
2515 * list is expanded if needed.
2518 add_guc_variable(struct config_generic * var, int elevel)
2520 if (num_guc_variables + 1 >= size_guc_variables)
2523 * Increase the vector by 25%
2525 int size_vars = size_guc_variables + size_guc_variables / 4;
2526 struct config_generic **guc_vars;
2531 guc_vars = (struct config_generic **)
2532 guc_malloc(elevel, size_vars * sizeof(struct config_generic *));
2536 guc_vars = (struct config_generic **)
2537 guc_realloc(elevel, guc_variables, size_vars * sizeof(struct config_generic *));
2540 if (guc_vars == NULL)
2541 return false; /* out of memory */
2543 guc_variables = guc_vars;
2544 size_guc_variables = size_vars;
2546 guc_variables[num_guc_variables++] = var;
2547 qsort((void *) guc_variables, num_guc_variables,
2548 sizeof(struct config_generic *), guc_var_compare);
2553 * Create and add a placeholder variable. It's presumed to belong
2554 * to a valid custom variable class at this point.
2556 static struct config_string *
2557 add_placeholder_variable(const char *name, int elevel)
2559 size_t sz = sizeof(struct config_string) + sizeof(char *);
2560 struct config_string *var;
2561 struct config_generic *gen;
2563 var = (struct config_string *) guc_malloc(elevel, sz);
2570 gen->name = guc_strdup(elevel, name);
2571 if (gen->name == NULL)
2577 gen->context = PGC_USERSET;
2578 gen->group = CUSTOM_OPTIONS;
2579 gen->short_desc = "GUC placeholder variable";
2580 gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
2581 gen->vartype = PGC_STRING;
2584 * The char* is allocated at the end of the struct since we have no
2585 * 'static' place to point to.
2587 var->variable = (char **) (var + 1);
2589 if (!add_guc_variable((struct config_generic *) var, elevel))
2591 free((void *) gen->name);
2600 * Look up option NAME. If it exists, return a pointer to its record,
2603 static struct config_generic *
2604 find_option(const char *name, int elevel)
2607 const char **key = &name;
2608 struct config_generic **res;
2614 * By equating const char ** with struct config_generic *, we are assuming
2615 * the name field is first in config_generic.
2617 res = (struct config_generic **) bsearch((void *) &key,
2618 (void *) guc_variables,
2620 sizeof(struct config_generic *),
2626 * See if the name is an obsolete name for a variable. We assume that the
2627 * set of supported old names is short enough that a brute-force search is
2630 for (i = 0; map_old_guc_names[i] != NULL; i += 2)
2632 if (guc_name_compare(name, map_old_guc_names[i]) == 0)
2633 return find_option(map_old_guc_names[i + 1], elevel);
2637 * Check if the name is qualified, and if so, check if the qualifier maps
2638 * to a custom variable class.
2640 dot = strchr(name, GUC_QUALIFIER_SEPARATOR);
2641 if (dot != NULL && is_custom_class(name, dot - name))
2642 /* Add a placeholder variable for this name */
2643 return (struct config_generic *) add_placeholder_variable(name, elevel);
2651 * comparator for qsorting and bsearching guc_variables array
2654 guc_var_compare(const void *a, const void *b)
2656 struct config_generic *confa = *(struct config_generic **) a;
2657 struct config_generic *confb = *(struct config_generic **) b;
2659 return guc_name_compare(confa->name, confb->name);
2664 guc_name_compare(const char *namea, const char *nameb)
2667 * The temptation to use strcasecmp() here must be resisted, because the
2668 * array ordering has to remain stable across setlocale() calls. So, build
2669 * our own with a simple ASCII-only downcasing.
2671 while (*namea && *nameb)
2673 char cha = *namea++;
2674 char chb = *nameb++;
2676 if (cha >= 'A' && cha <= 'Z')
2678 if (chb >= 'A' && chb <= 'Z')
2684 return 1; /* a is longer */
2686 return -1; /* b is longer */
2692 * Initialize GUC options during program startup.
2694 * Note that we cannot read the config file yet, since we have not yet
2695 * processed command-line switches.
2698 InitializeGUCOptions(void)
2704 * Build sorted array of all GUC variables.
2706 build_guc_variables();
2709 * Load all variables with their compiled-in defaults, and initialize
2710 * status fields as needed.
2712 for (i = 0; i < num_guc_variables; i++)
2714 struct config_generic *gconf = guc_variables[i];
2717 gconf->reset_source = PGC_S_DEFAULT;
2718 gconf->tentative_source = PGC_S_DEFAULT;
2719 gconf->source = PGC_S_DEFAULT;
2720 gconf->stack = NULL;
2722 switch (gconf->vartype)
2726 struct config_bool *conf = (struct config_bool *) gconf;
2728 if (conf->assign_hook)
2729 if (!(*conf->assign_hook) (conf->reset_val, true,
2731 elog(FATAL, "failed to initialize %s to %d",
2732 conf->gen.name, (int) conf->reset_val);
2733 *conf->variable = conf->reset_val;
2738 struct config_int *conf = (struct config_int *) gconf;
2740 Assert(conf->reset_val >= conf->min);
2741 Assert(conf->reset_val <= conf->max);
2742 if (conf->assign_hook)
2743 if (!(*conf->assign_hook) (conf->reset_val, true,
2745 elog(FATAL, "failed to initialize %s to %d",
2746 conf->gen.name, conf->reset_val);
2747 *conf->variable = conf->reset_val;
2752 struct config_real *conf = (struct config_real *) gconf;
2754 Assert(conf->reset_val >= conf->min);
2755 Assert(conf->reset_val <= conf->max);
2756 if (conf->assign_hook)
2757 if (!(*conf->assign_hook) (conf->reset_val, true,
2759 elog(FATAL, "failed to initialize %s to %g",
2760 conf->gen.name, conf->reset_val);
2761 *conf->variable = conf->reset_val;
2766 struct config_string *conf = (struct config_string *) gconf;
2769 *conf->variable = NULL;
2770 conf->reset_val = NULL;
2771 conf->tentative_val = NULL;
2773 if (conf->boot_val == NULL)
2775 /* Cannot set value yet */
2779 str = guc_strdup(FATAL, conf->boot_val);
2780 conf->reset_val = str;
2782 if (conf->assign_hook)
2786 newstr = (*conf->assign_hook) (str, true,
2790 elog(FATAL, "failed to initialize %s to \"%s\"",
2791 conf->gen.name, str);
2793 else if (newstr != str)
2798 * See notes in set_config_option about casting
2800 str = (char *) newstr;
2801 conf->reset_val = str;
2804 *conf->variable = str;
2812 reporting_enabled = false;
2815 * Prevent any attempt to override the transaction modes from
2816 * non-interactive sources.
2818 SetConfigOption("transaction_isolation", "default",
2819 PGC_POSTMASTER, PGC_S_OVERRIDE);
2820 SetConfigOption("transaction_read_only", "no",
2821 PGC_POSTMASTER, PGC_S_OVERRIDE);
2824 * For historical reasons, some GUC parameters can receive defaults from
2825 * environment variables. Process those settings.
2828 env = getenv("PGPORT");
2830 SetConfigOption("port", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
2832 env = getenv("PGDATESTYLE");
2834 SetConfigOption("datestyle", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
2836 env = getenv("PGCLIENTENCODING");
2838 SetConfigOption("client_encoding", env, PGC_POSTMASTER, PGC_S_ENV_VAR);
2843 * Select the configuration files and data directory to be used, and
2844 * do the initial read of postgresql.conf.
2846 * This is called after processing command-line switches.
2847 * userDoption is the -D switch value if any (NULL if unspecified).
2848 * progname is just for use in error messages.
2850 * Returns true on success; on failure, prints a suitable error message
2851 * to stderr and returns false.
2854 SelectConfigFiles(const char *userDoption, const char *progname)
2858 struct stat stat_buf;
2860 /* configdir is -D option, or $PGDATA if no -D */
2862 configdir = make_absolute_path(userDoption);
2864 configdir = make_absolute_path(getenv("PGDATA"));
2867 * Find the configuration file: if config_file was specified on the
2868 * command line, use it, else use configdir/postgresql.conf. In any case
2869 * ensure the result is an absolute path, so that it will be interpreted
2870 * the same way by future backends.
2873 fname = make_absolute_path(ConfigFileName);
2876 fname = guc_malloc(FATAL,
2877 strlen(configdir) + strlen(CONFIG_FILENAME) + 2);
2878 sprintf(fname, "%s/%s", configdir, CONFIG_FILENAME);
2882 write_stderr("%s does not know where to find the server configuration file.\n"
2883 "You must specify the --config-file or -D invocation "
2884 "option or set the PGDATA environment variable.\n",
2890 * Set the ConfigFileName GUC variable to its final value, ensuring that
2891 * it can't be overridden later.
2893 SetConfigOption("config_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
2897 * Now read the config file for the first time.
2899 if (stat(ConfigFileName, &stat_buf) != 0)
2901 write_stderr("%s cannot access the server configuration file \"%s\": %s\n",
2902 progname, ConfigFileName, strerror(errno));
2906 ProcessConfigFile(PGC_POSTMASTER);
2909 * If the data_directory GUC variable has been set, use that as DataDir;
2910 * otherwise use configdir if set; else punt.
2912 * Note: SetDataDir will copy and absolute-ize its argument, so we don't
2916 SetDataDir(data_directory);
2918 SetDataDir(configdir);
2921 write_stderr("%s does not know where to find the database system data.\n"
2922 "This can be specified as \"data_directory\" in \"%s\", "
2923 "or by the -D invocation option, or by the "
2924 "PGDATA environment variable.\n",
2925 progname, ConfigFileName);
2930 * Reflect the final DataDir value back into the data_directory GUC var.
2931 * (If you are wondering why we don't just make them a single variable,
2932 * it's because the EXEC_BACKEND case needs DataDir to be transmitted to
2933 * child backends specially. XXX is that still true? Given that we now
2934 * chdir to DataDir, EXEC_BACKEND can read the config file without knowing
2935 * DataDir in advance.)
2937 SetConfigOption("data_directory", DataDir, PGC_POSTMASTER, PGC_S_OVERRIDE);
2940 * Figure out where pg_hba.conf is, and make sure the path is absolute.
2943 fname = make_absolute_path(HbaFileName);
2946 fname = guc_malloc(FATAL,
2947 strlen(configdir) + strlen(HBA_FILENAME) + 2);
2948 sprintf(fname, "%s/%s", configdir, HBA_FILENAME);
2952 write_stderr("%s does not know where to find the \"hba\" configuration file.\n"
2953 "This can be specified as \"hba_file\" in \"%s\", "
2954 "or by the -D invocation option, or by the "
2955 "PGDATA environment variable.\n",
2956 progname, ConfigFileName);
2959 SetConfigOption("hba_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
2963 * Likewise for pg_ident.conf.
2966 fname = make_absolute_path(IdentFileName);
2969 fname = guc_malloc(FATAL,
2970 strlen(configdir) + strlen(IDENT_FILENAME) + 2);
2971 sprintf(fname, "%s/%s", configdir, IDENT_FILENAME);
2975 write_stderr("%s does not know where to find the \"ident\" configuration file.\n"
2976 "This can be specified as \"ident_file\" in \"%s\", "
2977 "or by the -D invocation option, or by the "
2978 "PGDATA environment variable.\n",
2979 progname, ConfigFileName);
2982 SetConfigOption("ident_file", fname, PGC_POSTMASTER, PGC_S_OVERRIDE);
2992 * Reset all options to their saved default values (implements RESET ALL)
2995 ResetAllOptions(void)
2999 for (i = 0; i < num_guc_variables; i++)
3001 struct config_generic *gconf = guc_variables[i];
3003 /* Don't reset non-SET-able values */
3004 if (gconf->context != PGC_SUSET &&
3005 gconf->context != PGC_USERSET)
3007 /* Don't reset if special exclusion from RESET ALL */
3008 if (gconf->flags & GUC_NO_RESET_ALL)
3010 /* No need to reset if wasn't SET */
3011 if (gconf->source <= PGC_S_OVERRIDE)
3014 /* Save old value to support transaction abort */
3015 push_old_value(gconf);
3017 switch (gconf->vartype)
3021 struct config_bool *conf = (struct config_bool *) gconf;
3023 if (conf->assign_hook)
3024 if (!(*conf->assign_hook) (conf->reset_val, true,
3026 elog(ERROR, "failed to reset %s", conf->gen.name);
3027 *conf->variable = conf->reset_val;
3028 conf->tentative_val = conf->reset_val;
3029 conf->gen.source = conf->gen.reset_source;
3030 conf->gen.tentative_source = conf->gen.reset_source;
3031 conf->gen.status |= GUC_HAVE_TENTATIVE;
3037 struct config_int *conf = (struct config_int *) gconf;
3039 if (conf->assign_hook)
3040 if (!(*conf->assign_hook) (conf->reset_val, true,
3042 elog(ERROR, "failed to reset %s", conf->gen.name);
3043 *conf->variable = conf->reset_val;
3044 conf->tentative_val = conf->reset_val;
3045 conf->gen.source = conf->gen.reset_source;
3046 conf->gen.tentative_source = conf->gen.reset_source;
3047 conf->gen.status |= GUC_HAVE_TENTATIVE;
3053 struct config_real *conf = (struct config_real *) gconf;
3055 if (conf->assign_hook)
3056 if (!(*conf->assign_hook) (conf->reset_val, true,
3058 elog(ERROR, "failed to reset %s", conf->gen.name);
3059 *conf->variable = conf->reset_val;
3060 conf->tentative_val = conf->reset_val;
3061 conf->gen.source = conf->gen.reset_source;
3062 conf->gen.tentative_source = conf->gen.reset_source;
3063 conf->gen.status |= GUC_HAVE_TENTATIVE;
3069 struct config_string *conf = (struct config_string *) gconf;
3072 if (conf->reset_val == NULL)
3074 /* Nothing to reset to, as yet; so do nothing */
3078 /* We need not strdup here */
3079 str = conf->reset_val;
3081 if (conf->assign_hook)
3085 newstr = (*conf->assign_hook) (str, true,
3088 elog(ERROR, "failed to reset %s", conf->gen.name);
3089 else if (newstr != str)
3092 * See notes in set_config_option about casting
3094 str = (char *) newstr;
3098 set_string_field(conf, conf->variable, str);
3099 set_string_field(conf, &conf->tentative_val, str);
3100 conf->gen.source = conf->gen.reset_source;
3101 conf->gen.tentative_source = conf->gen.reset_source;
3102 conf->gen.status |= GUC_HAVE_TENTATIVE;
3108 if (gconf->flags & GUC_REPORT)
3109 ReportGUCOption(gconf);
3116 * Push previous state during first assignment to a GUC variable
3117 * within a particular transaction.
3119 * We have to be willing to "back-fill" the state stack if the first
3120 * assignment occurs within a subtransaction nested several levels deep.
3121 * This ensures that if an intermediate transaction aborts, it will have
3122 * the proper value available to restore the setting to.
3125 push_old_value(struct config_generic * gconf)
3127 int my_level = GetCurrentTransactionNestLevel();
3130 /* If we're not inside a transaction, do nothing */
3136 /* Done if we already pushed it at this nesting depth */
3137 if (gconf->stack && gconf->stack->nest_level >= my_level)
3141 * We keep all the stack entries in TopTransactionContext so as to
3142 * avoid allocation problems when a subtransaction back-fills stack
3143 * entries for upper transaction levels.
3145 stack = (GucStack *) MemoryContextAlloc(TopTransactionContext,
3148 stack->prev = gconf->stack;
3149 stack->nest_level = stack->prev ? stack->prev->nest_level + 1 : 1;
3150 stack->status = gconf->status;
3151 stack->tentative_source = gconf->tentative_source;
3152 stack->source = gconf->source;
3154 switch (gconf->vartype)
3157 stack->tentative_val.boolval =
3158 ((struct config_bool *) gconf)->tentative_val;
3159 stack->value.boolval =
3160 *((struct config_bool *) gconf)->variable;
3164 stack->tentative_val.intval =
3165 ((struct config_int *) gconf)->tentative_val;
3166 stack->value.intval =
3167 *((struct config_int *) gconf)->variable;
3171 stack->tentative_val.realval =
3172 ((struct config_real *) gconf)->tentative_val;
3173 stack->value.realval =
3174 *((struct config_real *) gconf)->variable;
3178 stack->tentative_val.stringval =
3179 ((struct config_string *) gconf)->tentative_val;
3180 stack->value.stringval =
3181 *((struct config_string *) gconf)->variable;
3185 gconf->stack = stack;
3187 /* Set state to indicate nothing happened yet within this level */
3188 gconf->status = GUC_HAVE_STACK;
3190 /* Ensure we remember to pop at end of xact */
3196 * Do GUC processing at transaction or subtransaction commit or abort.
3199 AtEOXact_GUC(bool isCommit, bool isSubXact)
3204 /* Quick exit if nothing's changed in this transaction */
3208 my_level = GetCurrentTransactionNestLevel();
3209 Assert(isSubXact ? (my_level > 1) : (my_level == 1));
3211 for (i = 0; i < num_guc_variables; i++)
3213 struct config_generic *gconf = guc_variables[i];
3214 int my_status = gconf->status;
3215 GucStack *stack = gconf->stack;
3220 * Skip if nothing's happened to this var in this transaction
3224 Assert(stack == NULL);
3227 /* Assert that we stacked old value before changing it */
3228 Assert(stack != NULL && (my_status & GUC_HAVE_STACK));
3229 /* However, the last change may have been at an outer xact level */
3230 if (stack->nest_level < my_level)
3232 Assert(stack->nest_level == my_level);
3235 * We will pop the stack entry. Start by restoring outer xact status
3236 * (since we may want to modify it below). Be careful to use
3237 * my_status to reference the inner xact status below this point...
3239 gconf->status = stack->status;
3242 * We have two cases:
3244 * If commit and HAVE_TENTATIVE, set actual value to tentative (this
3245 * is to override a SET LOCAL if one occurred later than SET). We keep
3246 * the tentative value and propagate HAVE_TENTATIVE to the parent
3247 * status, allowing the SET's effect to percolate up. (But if we're
3248 * exiting the outermost transaction, we'll drop the HAVE_TENTATIVE
3251 * Otherwise, we have a transaction that aborted or executed only SET
3252 * LOCAL (or no SET at all). In either case it should have no further
3253 * effect, so restore both tentative and actual values from the stack
3257 useTentative = isCommit && (my_status & GUC_HAVE_TENTATIVE) != 0;
3260 switch (gconf->vartype)
3264 struct config_bool *conf = (struct config_bool *) gconf;
3266 GucSource newsource;
3270 newval = conf->tentative_val;
3271 newsource = conf->gen.tentative_source;
3272 conf->gen.status |= GUC_HAVE_TENTATIVE;
3276 newval = stack->value.boolval;
3277 newsource = stack->source;
3278 conf->tentative_val = stack->tentative_val.boolval;
3279 conf->gen.tentative_source = stack->tentative_source;
3282 if (*conf->variable != newval)
3284 if (conf->assign_hook)
3285 if (!(*conf->assign_hook) (newval,
3286 true, PGC_S_OVERRIDE))
3287 elog(LOG, "failed to commit %s",
3289 *conf->variable = newval;
3292 conf->gen.source = newsource;
3297 struct config_int *conf = (struct config_int *) gconf;
3299 GucSource newsource;
3303 newval = conf->tentative_val;
3304 newsource = conf->gen.tentative_source;
3305 conf->gen.status |= GUC_HAVE_TENTATIVE;
3309 newval = stack->value.intval;
3310 newsource = stack->source;
3311 conf->tentative_val = stack->tentative_val.intval;
3312 conf->gen.tentative_source = stack->tentative_source;
3315 if (*conf->variable != newval)
3317 if (conf->assign_hook)
3318 if (!(*conf->assign_hook) (newval,
3319 true, PGC_S_OVERRIDE))
3320 elog(LOG, "failed to commit %s",
3322 *conf->variable = newval;
3325 conf->gen.source = newsource;
3330 struct config_real *conf = (struct config_real *) gconf;
3332 GucSource newsource;
3336 newval = conf->tentative_val;
3337 newsource = conf->gen.tentative_source;
3338 conf->gen.status |= GUC_HAVE_TENTATIVE;
3342 newval = stack->value.realval;
3343 newsource = stack->source;
3344 conf->tentative_val = stack->tentative_val.realval;
3345 conf->gen.tentative_source = stack->tentative_source;
3348 if (*conf->variable != newval)
3350 if (conf->assign_hook)
3351 if (!(*conf->assign_hook) (newval,
3352 true, PGC_S_OVERRIDE))
3353 elog(LOG, "failed to commit %s",
3355 *conf->variable = newval;
3358 conf->gen.source = newsource;
3363 struct config_string *conf = (struct config_string *) gconf;
3365 GucSource newsource;
3369 newval = conf->tentative_val;
3370 newsource = conf->gen.tentative_source;
3371 conf->gen.status |= GUC_HAVE_TENTATIVE;
3375 newval = stack->value.stringval;
3376 newsource = stack->source;
3377 set_string_field(conf, &conf->tentative_val,
3378 stack->tentative_val.stringval);
3379 conf->gen.tentative_source = stack->tentative_source;
3382 if (*conf->variable != newval)
3384 if (conf->assign_hook)
3388 newstr = (*conf->assign_hook) (newval, true,
3391 elog(LOG, "failed to commit %s",
3393 else if (newstr != newval)
3396 * If newval should now be freed, it'll be
3397 * taken care of below.
3399 * See notes in set_config_option about
3402 newval = (char *) newstr;
3406 set_string_field(conf, conf->variable, newval);
3409 conf->gen.source = newsource;
3410 /* Release stacked values if not used anymore */
3411 set_string_field(conf, &stack->value.stringval,
3413 set_string_field(conf, &stack->tentative_val.stringval,
3415 /* Don't store tentative value separately after commit */
3417 set_string_field(conf, &conf->tentative_val, NULL);
3422 /* Finish popping the state stack */
3423 gconf->stack = stack->prev;
3427 * If we're now out of all xact levels, forget TENTATIVE status bit;
3428 * there's nothing tentative about the value anymore.
3432 Assert(gconf->stack == NULL);
3436 /* Report new value if we changed it */
3437 if (changed && (gconf->flags & GUC_REPORT))
3438 ReportGUCOption(gconf);
3442 * If we're now out of all xact levels, we can clear guc_dirty. (Note: we
3443 * cannot reset guc_dirty when exiting a subtransaction, because we know
3444 * that all outer transaction levels will have stacked values to deal
3453 * Start up automatic reporting of changes to variables marked GUC_REPORT.
3454 * This is executed at completion of backend startup.
3457 BeginReportingGUCOptions(void)
3462 * Don't do anything unless talking to an interactive frontend of protocol
3465 if (whereToSendOutput != DestRemote ||
3466 PG_PROTOCOL_MAJOR(FrontendProtocol) < 3)
3469 reporting_enabled = true;
3471 /* Transmit initial values of interesting variables */
3472 for (i = 0; i < num_guc_variables; i++)
3474 struct config_generic *conf = guc_variables[i];
3476 if (conf->flags & GUC_REPORT)
3477 ReportGUCOption(conf);
3482 * ReportGUCOption: if appropriate, transmit option value to frontend
3485 ReportGUCOption(struct config_generic * record)
3487 if (reporting_enabled && (record->flags & GUC_REPORT))
3489 char *val = _ShowOption(record, false);
3490 StringInfoData msgbuf;
3492 pq_beginmessage(&msgbuf, 'S');
3493 pq_sendstring(&msgbuf, record->name);
3494 pq_sendstring(&msgbuf, val);
3495 pq_endmessage(&msgbuf);
3503 * Try to interpret value as boolean value. Valid values are: true,
3504 * false, yes, no, on, off, 1, 0. If the string parses okay, return
3505 * true, else false. If result is not NULL, return the parsing result
3509 parse_bool(const char *value, bool *result)
3511 size_t len = strlen(value);
3513 if (pg_strncasecmp(value, "true", len) == 0)
3518 else if (pg_strncasecmp(value, "false", len) == 0)
3524 else if (pg_strncasecmp(value, "yes", len) == 0)
3529 else if (pg_strncasecmp(value, "no", len) == 0)
3535 else if (pg_strcasecmp(value, "on") == 0)
3540 else if (pg_strcasecmp(value, "off") == 0)
3546 else if (pg_strcasecmp(value, "1") == 0)
3551 else if (pg_strcasecmp(value, "0") == 0)
3560 *result = false; /* suppress compiler warning */
3569 * Try to parse value as an integer. The accepted formats are the
3570 * usual decimal, octal, or hexadecimal formats. If the string parses
3571 * okay, return true, else false. If result is not NULL, return the
3575 parse_int(const char *value, int *result, int flags)
3581 val = strtol(value, &endptr, 0);
3583 if ((flags & GUC_UNIT_MEMORY) && endptr != value)
3587 while (*endptr == ' ')
3590 if (strcmp(endptr, "kB") == 0)
3595 else if (strcmp(endptr, "MB") == 0)
3601 else if (strcmp(endptr, "GB") == 0)
3608 if (used && (flags & GUC_UNIT_BLOCKS))
3609 val /= (BLCKSZ/1024);
3612 if ((flags & GUC_UNIT_TIME) && endptr != value)
3616 while (*endptr == ' ')
3619 if (strcmp(endptr, "ms") == 0)
3624 else if (strcmp(endptr, "s") == 0)
3630 else if (strcmp(endptr, "min") == 0)
3636 else if (strcmp(endptr, "h") == 0)
3642 else if (strcmp(endptr, "d") == 0)
3649 if (used && (flags & GUC_UNIT_S))
3651 else if (used && (flags & GUC_UNIT_MIN))
3655 if (endptr == value || *endptr != '\0' || errno == ERANGE
3656 #ifdef HAVE_LONG_INT_64
3657 /* if long > 32 bits, check for overflow of int4 */
3658 || val != (long) ((int32) val)
3663 *result = 0; /* suppress compiler warning */
3667 *result = (int) val;
3674 * Try to parse value as a floating point constant in the usual
3675 * format. If the value parsed okay return true, else false. If
3676 * result is not NULL, return the semantic value there.
3679 parse_real(const char *value, double *result)
3685 val = strtod(value, &endptr);
3686 if (endptr == value || *endptr != '\0' || errno == ERANGE)
3689 *result = 0; /* suppress compiler warning */
3699 * Call a GucStringAssignHook function, being careful to free the
3700 * "newval" string if the hook ereports.
3702 * This is split out of set_config_option just to avoid the "volatile"
3703 * qualifiers that would otherwise have to be plastered all over.
3706 call_string_assign_hook(GucStringAssignHook assign_hook,
3707 char *newval, bool doit, GucSource source)
3713 result = (*assign_hook) (newval, doit, source);
3727 * Sets option `name' to given value. The value should be a string
3728 * which is going to be parsed and converted to the appropriate data
3729 * type. The context and source parameters indicate in which context this
3730 * function is being called so it can apply the access restrictions
3733 * If value is NULL, set the option to its default value. If the
3734 * parameter changeVal is false then don't really set the option but do all
3735 * the checks to see if it would work.
3737 * If there is an error (non-existing option, invalid value) then an
3738 * ereport(ERROR) is thrown *unless* this is called in a context where we
3739 * don't want to ereport (currently, startup or SIGHUP config file reread).
3740 * In that case we write a suitable error message via ereport(DEBUG) and
3741 * return false. This is working around the deficiencies in the ereport
3742 * mechanism, so don't blame me. In all other cases, the function
3743 * returns true, including cases where the input is valid but we chose
3744 * not to apply it because of context or source-priority considerations.
3746 * See also SetConfigOption for an external interface.
3749 set_config_option(const char *name, const char *value,
3750 GucContext context, GucSource source,
3751 bool isLocal, bool changeVal)
3753 struct config_generic *record;
3757 if (context == PGC_SIGHUP || source == PGC_S_DEFAULT)
3760 * To avoid cluttering the log, only the postmaster bleats loudly
3761 * about problems with the config file.
3763 elevel = IsUnderPostmaster ? DEBUG2 : LOG;
3765 else if (source == PGC_S_DATABASE || source == PGC_S_USER)
3770 record = find_option(name, elevel);
3774 (errcode(ERRCODE_UNDEFINED_OBJECT),
3775 errmsg("unrecognized configuration parameter \"%s\"", name)));
3780 * Check if the option can be set at this time. See guc.h for the precise
3781 * rules. Note that we don't want to throw errors if we're in the SIGHUP
3782 * context. In that case we just ignore the attempt and return true.
3784 switch (record->context)
3787 if (context == PGC_SIGHUP)
3789 if (context != PGC_INTERNAL)
3792 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3793 errmsg("parameter \"%s\" cannot be changed",
3798 case PGC_POSTMASTER:
3799 if (context == PGC_SIGHUP)
3801 if (changeVal && !is_newvalue_equal(record, value))
3803 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3804 errmsg("parameter \"%s\" cannot be changed after server start; configuration file change ignored",
3809 if (context != PGC_POSTMASTER)
3812 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3813 errmsg("parameter \"%s\" cannot be changed after server start",
3819 if (context != PGC_SIGHUP && context != PGC_POSTMASTER)
3822 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3823 errmsg("parameter \"%s\" cannot be changed now",
3829 * Hmm, the idea of the SIGHUP context is "ought to be global, but
3830 * can be changed after postmaster start". But there's nothing
3831 * that prevents a crafty administrator from sending SIGHUP
3832 * signals to individual backends only.
3836 if (context == PGC_SIGHUP)
3839 * If a PGC_BACKEND parameter is changed in the config file,
3840 * we want to accept the new value in the postmaster (whence
3841 * it will propagate to subsequently-started backends), but
3842 * ignore it in existing backends. This is a tad klugy, but
3843 * necessary because we don't re-read the config file during
3846 if (IsUnderPostmaster)
3849 else if (context != PGC_BACKEND && context != PGC_POSTMASTER)
3852 (errcode(ERRCODE_CANT_CHANGE_RUNTIME_PARAM),
3853 errmsg("parameter \"%s\" cannot be set after connection start",
3859 if (context == PGC_USERSET || context == PGC_BACKEND)
3862 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
3863 errmsg("permission denied to set parameter \"%s\"",
3874 * Should we set reset/stacked values? (If so, the behavior is not
3877 makeDefault = changeVal && (source <= PGC_S_OVERRIDE) && (value != NULL);
3880 * Ignore attempted set if overridden by previously processed setting.
3881 * However, if changeVal is false then plow ahead anyway since we are
3882 * trying to find out if the value is potentially good, not actually use
3883 * it. Also keep going if makeDefault is true, since we may want to set
3884 * the reset/stacked values even if we can't set the variable itself.
3886 if (record->source > source)
3888 if (changeVal && !makeDefault)
3890 elog(DEBUG3, "\"%s\": setting ignored because previous source is higher priority",
3898 * Evaluate value and set variable.
3900 switch (record->vartype)
3904 struct config_bool *conf = (struct config_bool *) record;
3909 if (!parse_bool(value, &newval))
3912 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3913 errmsg("parameter \"%s\" requires a Boolean value",
3920 newval = conf->reset_val;
3921 source = conf->gen.reset_source;
3924 if (conf->assign_hook)
3925 if (!(*conf->assign_hook) (newval, changeVal, source))
3928 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3929 errmsg("invalid value for parameter \"%s\": %d",
3930 name, (int) newval)));
3934 if (changeVal || makeDefault)
3936 /* Save old value to support transaction abort */
3938 push_old_value(&conf->gen);
3941 *conf->variable = newval;
3942 conf->gen.source = source;
3948 if (conf->gen.reset_source <= source)
3950 conf->reset_val = newval;
3951 conf->gen.reset_source = source;
3953 for (stack = conf->gen.stack; stack; stack = stack->prev)
3955 if (stack->source <= source)
3957 stack->value.boolval = newval;
3958 stack->source = source;
3964 conf->gen.status |= GUC_HAVE_LOCAL;
3969 conf->tentative_val = newval;
3970 conf->gen.tentative_source = source;
3971 conf->gen.status |= GUC_HAVE_TENTATIVE;
3980 struct config_int *conf = (struct config_int *) record;
3985 if (!parse_int(value, &newval, conf->gen.flags))
3988 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3989 errmsg("parameter \"%s\" requires an integer value",
3993 if (newval < conf->min || newval > conf->max)
3996 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
3997 errmsg("%d is outside the valid range for parameter \"%s\" (%d .. %d)",
3998 newval, name, conf->min, conf->max)));
4004 newval = conf->reset_val;
4005 source = conf->gen.reset_source;
4008 if (conf->assign_hook)
4009 if (!(*conf->assign_hook) (newval, changeVal, source))
4012 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4013 errmsg("invalid value for parameter \"%s\": %d",
4018 if (changeVal || makeDefault)
4020 /* Save old value to support transaction abort */
4022 push_old_value(&conf->gen);
4025 *conf->variable = newval;
4026 conf->gen.source = source;
4032 if (conf->gen.reset_source <= source)
4034 conf->reset_val = newval;
4035 conf->gen.reset_source = source;
4037 for (stack = conf->gen.stack; stack; stack = stack->prev)
4039 if (stack->source <= source)
4041 stack->value.intval = newval;
4042 stack->source = source;
4048 conf->gen.status |= GUC_HAVE_LOCAL;
4053 conf->tentative_val = newval;
4054 conf->gen.tentative_source = source;
4055 conf->gen.status |= GUC_HAVE_TENTATIVE;
4064 struct config_real *conf = (struct config_real *) record;
4069 if (!parse_real(value, &newval))
4072 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4073 errmsg("parameter \"%s\" requires a numeric value",
4077 if (newval < conf->min || newval > conf->max)
4080 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4081 errmsg("%g is outside the valid range for parameter \"%s\" (%g .. %g)",
4082 newval, name, conf->min, conf->max)));
4088 newval = conf->reset_val;
4089 source = conf->gen.reset_source;
4092 if (conf->assign_hook)
4093 if (!(*conf->assign_hook) (newval, changeVal, source))
4096 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4097 errmsg("invalid value for parameter \"%s\": %g",
4102 if (changeVal || makeDefault)
4104 /* Save old value to support transaction abort */
4106 push_old_value(&conf->gen);
4109 *conf->variable = newval;
4110 conf->gen.source = source;
4116 if (conf->gen.reset_source <= source)
4118 conf->reset_val = newval;
4119 conf->gen.reset_source = source;
4121 for (stack = conf->gen.stack; stack; stack = stack->prev)
4123 if (stack->source <= source)
4125 stack->value.realval = newval;
4126 stack->source = source;
4132 conf->gen.status |= GUC_HAVE_LOCAL;
4137 conf->tentative_val = newval;
4138 conf->gen.tentative_source = source;
4139 conf->gen.status |= GUC_HAVE_TENTATIVE;
4148 struct config_string *conf = (struct config_string *) record;
4153 newval = guc_strdup(elevel, value);
4157 * The only sort of "parsing" check we need to do is
4158 * apply truncation if GUC_IS_NAME.
4160 if (conf->gen.flags & GUC_IS_NAME)
4161 truncate_identifier(newval, strlen(newval), true);
4163 else if (conf->reset_val)
4166 * We could possibly avoid strdup here, but easier to make
4167 * this case work the same as the normal assignment case.
4169 newval = guc_strdup(elevel, conf->reset_val);
4172 source = conf->gen.reset_source;
4176 /* Nothing to reset to, as yet; so do nothing */
4180 if (conf->assign_hook)
4182 const char *hookresult;
4185 * If the hook ereports, we have to make sure we free
4186 * newval, else it will be a permanent memory leak.
4188 hookresult = call_string_assign_hook(conf->assign_hook,
4192 if (hookresult == NULL)
4196 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4197 errmsg("invalid value for parameter \"%s\": \"%s\"",
4198 name, value ? value : "")));
4201 else if (hookresult != newval)
4206 * Having to cast away const here is annoying, but the
4207 * alternative is to declare assign_hooks as returning
4208 * char*, which would mean they'd have to cast away
4209 * const, or as both taking and returning char*, which
4210 * doesn't seem attractive either --- we don't want
4211 * them to scribble on the passed str.
4213 newval = (char *) hookresult;
4217 if (changeVal || makeDefault)
4219 /* Save old value to support transaction abort */
4221 push_old_value(&conf->gen);
4224 set_string_field(conf, conf->variable, newval);
4225 conf->gen.source = source;
4231 if (conf->gen.reset_source <= source)
4233 set_string_field(conf, &conf->reset_val, newval);
4234 conf->gen.reset_source = source;
4236 for (stack = conf->gen.stack; stack; stack = stack->prev)
4238 if (stack->source <= source)
4240 set_string_field(conf, &stack->value.stringval,
4242 stack->source = source;
4245 /* Perhaps we didn't install newval anywhere */
4246 if (!string_field_used(conf, newval))
4251 conf->gen.status |= GUC_HAVE_LOCAL;
4256 set_string_field(conf, &conf->tentative_val, newval);
4257 conf->gen.tentative_source = source;
4258 conf->gen.status |= GUC_HAVE_TENTATIVE;
4268 if (changeVal && (record->flags & GUC_REPORT))
4269 ReportGUCOption(record);
4276 * Set a config option to the given value. See also set_config_option,
4277 * this is just the wrapper to be called from outside GUC. NB: this
4278 * is used only for non-transactional operations.
4281 SetConfigOption(const char *name, const char *value,
4282 GucContext context, GucSource source)
4284 (void) set_config_option(name, value, context, source, false, true);
4290 * Fetch the current value of the option `name'. If the option doesn't exist,
4291 * throw an ereport and don't return.
4293 * The string is *not* allocated for modification and is really only
4294 * valid until the next call to configuration related functions.
4297 GetConfigOption(const char *name)
4299 struct config_generic *record;
4300 static char buffer[256];
4302 record = find_option(name, ERROR);
4305 (errcode(ERRCODE_UNDEFINED_OBJECT),
4306 errmsg("unrecognized configuration parameter \"%s\"", name)));
4307 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
4309 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4310 errmsg("must be superuser to examine \"%s\"", name)));
4312 switch (record->vartype)
4315 return *((struct config_bool *) record)->variable ? "on" : "off";
4318 snprintf(buffer, sizeof(buffer), "%d",
4319 *((struct config_int *) record)->variable);
4323 snprintf(buffer, sizeof(buffer), "%g",
4324 *((struct config_real *) record)->variable);
4328 return *((struct config_string *) record)->variable;
4334 * Get the RESET value associated with the given option.
4337 GetConfigOptionResetString(const char *name)
4339 struct config_generic *record;
4340 static char buffer[256];
4342 record = find_option(name, ERROR);
4345 (errcode(ERRCODE_UNDEFINED_OBJECT),
4346 errmsg("unrecognized configuration parameter \"%s\"", name)));
4347 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
4349 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4350 errmsg("must be superuser to examine \"%s\"", name)));
4352 switch (record->vartype)
4355 return ((struct config_bool *) record)->reset_val ? "on" : "off";
4358 snprintf(buffer, sizeof(buffer), "%d",
4359 ((struct config_int *) record)->reset_val);
4363 snprintf(buffer, sizeof(buffer), "%g",
4364 ((struct config_real *) record)->reset_val);
4368 return ((struct config_string *) record)->reset_val;
4374 * Detect whether the given configuration option can only be set by
4378 IsSuperuserConfigOption(const char *name)
4380 struct config_generic *record;
4382 record = find_option(name, ERROR);
4383 /* On an unrecognized name, don't error, just return false. */
4386 return (record->context == PGC_SUSET);
4391 * flatten_set_variable_args
4392 * Given a parsenode List as emitted by the grammar for SET,
4393 * convert to the flat string representation used by GUC.
4395 * We need to be told the name of the variable the args are for, because
4396 * the flattening rules vary (ugh).
4398 * The result is NULL if input is NIL (ie, SET ... TO DEFAULT), otherwise
4399 * a palloc'd string.
4402 flatten_set_variable_args(const char *name, List *args)
4404 struct config_generic *record;
4410 * Fast path if just DEFAULT. We do not check the variable name in this
4411 * case --- necessary for RESET ALL to work correctly.
4416 /* Else get flags for the variable */
4417 record = find_option(name, ERROR);
4420 (errcode(ERRCODE_UNDEFINED_OBJECT),
4421 errmsg("unrecognized configuration parameter \"%s\"", name)));
4423 flags = record->flags;
4425 /* Complain if list input and non-list variable */
4426 if ((flags & GUC_LIST_INPUT) == 0 &&
4427 list_length(args) != 1)
4429 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
4430 errmsg("SET %s takes only one argument", name)));
4432 initStringInfo(&buf);
4436 A_Const *arg = (A_Const *) lfirst(l);
4439 if (l != list_head(args))
4440 appendStringInfo(&buf, ", ");
4442 if (!IsA(arg, A_Const))
4443 elog(ERROR, "unrecognized node type: %d", (int) nodeTag(arg));
4445 switch (nodeTag(&arg->val))
4448 appendStringInfo(&buf, "%ld", intVal(&arg->val));
4451 /* represented as a string, so just copy it */
4452 appendStringInfoString(&buf, strVal(&arg->val));
4455 val = strVal(&arg->val);
4456 if (arg->typename != NULL)
4459 * Must be a ConstInterval argument for TIME ZONE. Coerce
4460 * to interval and back to normalize the value and account
4467 DirectFunctionCall3(interval_in,
4468 CStringGetDatum(val),
4469 ObjectIdGetDatum(InvalidOid),
4470 Int32GetDatum(arg->typename->typmod));
4473 DatumGetCString(DirectFunctionCall1(interval_out,
4475 appendStringInfo(&buf, "INTERVAL '%s'", intervalout);
4480 * Plain string literal or identifier. For quote mode,
4481 * quote it if it's not a vanilla identifier.
4483 if (flags & GUC_LIST_QUOTE)
4484 appendStringInfoString(&buf, quote_identifier(val));
4486 appendStringInfoString(&buf, val);
4490 elog(ERROR, "unrecognized node type: %d",
4491 (int) nodeTag(&arg->val));
4504 SetPGVariable(const char *name, List *args, bool is_local)
4506 char *argstring = flatten_set_variable_args(name, args);
4508 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
4509 set_config_option(name,
4511 (superuser() ? PGC_SUSET : PGC_USERSET),
4518 * SET command wrapped as a SQL callable function.
4521 set_config_by_name(PG_FUNCTION_ARGS)
4529 if (PG_ARGISNULL(0))
4531 (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
4532 errmsg("SET requires parameter name")));
4534 /* Get the GUC variable name */
4535 name = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0)));
4537 /* Get the desired value or set to NULL for a reset request */
4538 if (PG_ARGISNULL(1))
4541 value = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(1)));
4544 * Get the desired state of is_local. Default to false if provided value
4547 if (PG_ARGISNULL(2))
4550 is_local = PG_GETARG_BOOL(2);
4552 /* Note SET DEFAULT (argstring == NULL) is equivalent to RESET */
4553 set_config_option(name,
4555 (superuser() ? PGC_SUSET : PGC_USERSET),
4560 /* get the new current value */
4561 new_value = GetConfigOptionByName(name, NULL);
4563 /* Convert return string to text */
4564 result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(new_value)));
4567 PG_RETURN_TEXT_P(result_text);
4571 define_custom_variable(struct config_generic * variable)
4573 const char *name = variable->name;
4574 const char **nameAddr = &name;
4576 struct config_string *pHolder;
4577 struct config_generic **res = (struct config_generic **) bsearch(
4579 (void *) guc_variables,
4581 sizeof(struct config_generic *),
4586 add_guc_variable(variable, ERROR);
4591 * This better be a placeholder
4593 if (((*res)->flags & GUC_CUSTOM_PLACEHOLDER) == 0)
4595 (errcode(ERRCODE_INTERNAL_ERROR),
4596 errmsg("attempt to redefine parameter \"%s\"", name)));
4598 Assert((*res)->vartype == PGC_STRING);
4599 pHolder = (struct config_string *) * res;
4601 /* We have the same name, no sorting is necessary */
4604 value = *pHolder->variable;
4607 * Assign the string value stored in the placeholder to the real variable.
4609 * XXX this is not really good enough --- it should be a nontransactional
4610 * assignment, since we don't want it to roll back if the current xact
4613 set_config_option(name, value,
4614 pHolder->gen.context, pHolder->gen.source,
4618 * Free up as much as we conveniently can of the placeholder structure
4619 * (this neglects any stack items...)
4621 set_string_field(pHolder, pHolder->variable, NULL);
4622 set_string_field(pHolder, &pHolder->reset_val, NULL);
4623 set_string_field(pHolder, &pHolder->tentative_val, NULL);
4629 init_custom_variable(struct config_generic * gen,
4631 const char *short_desc,
4632 const char *long_desc,
4634 enum config_type type)
4636 gen->name = guc_strdup(ERROR, name);
4637 gen->context = context;
4638 gen->group = CUSTOM_OPTIONS;
4639 gen->short_desc = short_desc;
4640 gen->long_desc = long_desc;
4641 gen->vartype = type;
4645 DefineCustomBoolVariable(const char *name,
4646 const char *short_desc,
4647 const char *long_desc,
4650 GucBoolAssignHook assign_hook,
4651 GucShowHook show_hook)
4653 size_t sz = sizeof(struct config_bool);
4654 struct config_bool *var = (struct config_bool *) guc_malloc(ERROR, sz);
4657 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_BOOL);
4659 var->variable = valueAddr;
4660 var->reset_val = *valueAddr;
4661 var->assign_hook = assign_hook;
4662 var->show_hook = show_hook;
4663 define_custom_variable(&var->gen);
4667 DefineCustomIntVariable(const char *name,
4668 const char *short_desc,
4669 const char *long_desc,
4674 GucIntAssignHook assign_hook,
4675 GucShowHook show_hook)
4677 size_t sz = sizeof(struct config_int);
4678 struct config_int *var = (struct config_int *) guc_malloc(ERROR, sz);
4681 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_INT);
4683 var->variable = valueAddr;
4684 var->reset_val = *valueAddr;
4685 var->min = minValue;
4686 var->max = maxValue;
4687 var->assign_hook = assign_hook;
4688 var->show_hook = show_hook;
4689 define_custom_variable(&var->gen);
4693 DefineCustomRealVariable(const char *name,
4694 const char *short_desc,
4695 const char *long_desc,
4700 GucRealAssignHook assign_hook,
4701 GucShowHook show_hook)
4703 size_t sz = sizeof(struct config_real);
4704 struct config_real *var = (struct config_real *) guc_malloc(ERROR, sz);
4707 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_REAL);
4709 var->variable = valueAddr;
4710 var->reset_val = *valueAddr;
4711 var->min = minValue;
4712 var->max = maxValue;
4713 var->assign_hook = assign_hook;
4714 var->show_hook = show_hook;
4715 define_custom_variable(&var->gen);
4719 DefineCustomStringVariable(const char *name,
4720 const char *short_desc,
4721 const char *long_desc,
4724 GucStringAssignHook assign_hook,
4725 GucShowHook show_hook)
4727 size_t sz = sizeof(struct config_string);
4728 struct config_string *var = (struct config_string *) guc_malloc(ERROR, sz);
4731 init_custom_variable(&var->gen, name, short_desc, long_desc, context, PGC_STRING);
4733 var->variable = valueAddr;
4734 var->reset_val = *valueAddr;
4735 var->assign_hook = assign_hook;
4736 var->show_hook = show_hook;
4737 define_custom_variable(&var->gen);
4741 EmitWarningsOnPlaceholders(const char *className)
4743 struct config_generic **vars = guc_variables;
4744 struct config_generic **last = vars + num_guc_variables;
4746 int nameLen = strlen(className);
4750 struct config_generic *var = *vars++;
4752 if ((var->flags & GUC_CUSTOM_PLACEHOLDER) != 0 &&
4753 strncmp(className, var->name, nameLen) == 0 &&
4754 var->name[nameLen] == GUC_QUALIFIER_SEPARATOR)
4757 (errcode(ERRCODE_UNDEFINED_OBJECT),
4758 errmsg("unrecognized configuration parameter \"%s\"", var->name)));
4768 GetPGVariable(const char *name, DestReceiver *dest)
4770 if (pg_strcasecmp(name, "all") == 0)
4771 ShowAllGUCConfig(dest);
4773 ShowGUCConfigOption(name, dest);
4777 GetPGVariableResultDesc(const char *name)
4781 if (pg_strcasecmp(name, "all") == 0)
4783 /* need a tuple descriptor representing three TEXT columns */
4784 tupdesc = CreateTemplateTupleDesc(3, false);
4785 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4787 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4789 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
4795 const char *varname;
4797 /* Get the canonical spelling of name */
4798 (void) GetConfigOptionByName(name, &varname);
4800 /* need a tuple descriptor representing a single TEXT column */
4801 tupdesc = CreateTemplateTupleDesc(1, false);
4802 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
4812 ResetPGVariable(const char *name)
4814 if (pg_strcasecmp(name, "all") == 0)
4817 set_config_option(name,
4819 (superuser() ? PGC_SUSET : PGC_USERSET),
4830 ShowGUCConfigOption(const char *name, DestReceiver *dest)
4832 TupOutputState *tstate;
4834 const char *varname;
4837 /* Get the value and canonical spelling of name */
4838 value = GetConfigOptionByName(name, &varname);
4840 /* need a tuple descriptor representing a single TEXT column */
4841 tupdesc = CreateTemplateTupleDesc(1, false);
4842 TupleDescInitEntry(tupdesc, (AttrNumber) 1, varname,
4845 /* prepare for projection of tuples */
4846 tstate = begin_tup_output_tupdesc(dest, tupdesc);
4849 do_text_output_oneline(tstate, value);
4851 end_tup_output(tstate);
4858 ShowAllGUCConfig(DestReceiver *dest)
4860 bool am_superuser = superuser();
4862 TupOutputState *tstate;
4866 /* need a tuple descriptor representing three TEXT columns */
4867 tupdesc = CreateTemplateTupleDesc(3, false);
4868 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
4870 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
4872 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "description",
4876 /* prepare for projection of tuples */
4877 tstate = begin_tup_output_tupdesc(dest, tupdesc);
4879 for (i = 0; i < num_guc_variables; i++)
4881 struct config_generic *conf = guc_variables[i];
4883 if ((conf->flags & GUC_NO_SHOW_ALL) ||
4884 ((conf->flags & GUC_SUPERUSER_ONLY) && !am_superuser))
4887 /* assign to the values array */
4888 values[0] = (char *) conf->name;
4889 values[1] = _ShowOption(conf, true);
4890 values[2] = (char *) conf->short_desc;
4892 /* send it to dest */
4893 do_tup_output(tstate, values);
4896 if (values[1] != NULL)
4900 end_tup_output(tstate);
4904 * Return GUC variable value by name; optionally return canonical
4905 * form of name. Return value is palloc'd.
4908 GetConfigOptionByName(const char *name, const char **varname)
4910 struct config_generic *record;
4912 record = find_option(name, ERROR);
4915 (errcode(ERRCODE_UNDEFINED_OBJECT),
4916 errmsg("unrecognized configuration parameter \"%s\"", name)));
4917 if ((record->flags & GUC_SUPERUSER_ONLY) && !superuser())
4919 (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
4920 errmsg("must be superuser to examine \"%s\"", name)));
4923 *varname = record->name;
4925 return _ShowOption(record, true);
4929 * Return GUC variable value by variable number; optionally return canonical
4930 * form of name. Return value is palloc'd.
4933 GetConfigOptionByNum(int varnum, const char **values, bool *noshow)
4936 struct config_generic *conf;
4938 /* check requested variable number valid */
4939 Assert((varnum >= 0) && (varnum < num_guc_variables));
4941 conf = guc_variables[varnum];
4945 if ((conf->flags & GUC_NO_SHOW_ALL) ||
4946 ((conf->flags & GUC_SUPERUSER_ONLY) && !superuser()))
4952 /* first get the generic attributes */
4955 values[0] = conf->name;
4957 /* setting : use _ShowOption in order to avoid duplicating the logic */
4958 values[1] = _ShowOption(conf, false);
4961 if (conf->vartype == PGC_INT)
4963 if (conf->flags & GUC_UNIT_KB)
4965 else if (conf->flags & GUC_UNIT_BLOCKS)
4969 snprintf(buf, sizeof(buf), "%dkB", BLCKSZ/1024);
4972 else if (conf->flags & GUC_UNIT_MS)
4974 else if (conf->flags & GUC_UNIT_S)
4976 else if (conf->flags & GUC_UNIT_MIN)
4985 values[3] = config_group_names[conf->group];
4988 values[4] = conf->short_desc;
4991 values[5] = conf->long_desc;
4994 values[6] = GucContext_Names[conf->context];
4997 values[7] = config_type_names[conf->vartype];
5000 values[8] = GucSource_Names[conf->source];
5002 /* now get the type specifc attributes */
5003 switch (conf->vartype)
5017 struct config_int *lconf = (struct config_int *) conf;
5020 snprintf(buffer, sizeof(buffer), "%d", lconf->min);
5021 values[9] = pstrdup(buffer);
5024 snprintf(buffer, sizeof(buffer), "%d", lconf->max);
5025 values[10] = pstrdup(buffer);
5031 struct config_real *lconf = (struct config_real *) conf;
5034 snprintf(buffer, sizeof(buffer), "%g", lconf->min);
5035 values[9] = pstrdup(buffer);
5038 snprintf(buffer, sizeof(buffer), "%g", lconf->max);
5039 values[10] = pstrdup(buffer);
5056 * should never get here, but in case we do, set 'em to NULL
5070 * Return the total number of GUC variables
5073 GetNumConfigOptions(void)
5075 return num_guc_variables;
5079 * show_config_by_name - equiv to SHOW X command but implemented as
5083 show_config_by_name(PG_FUNCTION_ARGS)
5089 /* Get the GUC variable name */
5090 varname = DatumGetCString(DirectFunctionCall1(textout, PG_GETARG_DATUM(0)));
5093 varval = GetConfigOptionByName(varname, NULL);
5095 /* Convert to text */
5096 result_text = DatumGetTextP(DirectFunctionCall1(textin, CStringGetDatum(varval)));
5099 PG_RETURN_TEXT_P(result_text);
5103 * show_all_settings - equiv to SHOW ALL command but implemented as
5106 #define NUM_PG_SETTINGS_ATTS 11
5109 show_all_settings(PG_FUNCTION_ARGS)
5111 FuncCallContext *funcctx;
5115 AttInMetadata *attinmeta;
5116 MemoryContext oldcontext;
5118 /* stuff done only on the first call of the function */
5119 if (SRF_IS_FIRSTCALL())
5121 /* create a function context for cross-call persistence */
5122 funcctx = SRF_FIRSTCALL_INIT();
5125 * switch to memory context appropriate for multiple function calls
5127 oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
5130 * need a tuple descriptor representing NUM_PG_SETTINGS_ATTS columns
5131 * of the appropriate types
5133 tupdesc = CreateTemplateTupleDesc(NUM_PG_SETTINGS_ATTS, false);
5134 TupleDescInitEntry(tupdesc, (AttrNumber) 1, "name",
5136 TupleDescInitEntry(tupdesc, (AttrNumber) 2, "setting",
5138 TupleDescInitEntry(tupdesc, (AttrNumber) 3, "unit",
5140 TupleDescInitEntry(tupdesc, (AttrNumber) 4, "category",
5142 TupleDescInitEntry(tupdesc, (AttrNumber) 5, "short_desc",
5144 TupleDescInitEntry(tupdesc, (AttrNumber) 6, "extra_desc",
5146 TupleDescInitEntry(tupdesc, (AttrNumber) 7, "context",
5148 TupleDescInitEntry(tupdesc, (AttrNumber) 8, "vartype",
5150 TupleDescInitEntry(tupdesc, (AttrNumber) 9, "source",
5152 TupleDescInitEntry(tupdesc, (AttrNumber) 10, "min_val",
5154 TupleDescInitEntry(tupdesc, (AttrNumber) 11, "max_val",
5158 * Generate attribute metadata needed later to produce tuples from raw
5161 attinmeta = TupleDescGetAttInMetadata(tupdesc);
5162 funcctx->attinmeta = attinmeta;
5164 /* total number of tuples to be returned */
5165 funcctx->max_calls = GetNumConfigOptions();
5167 MemoryContextSwitchTo(oldcontext);
5170 /* stuff done on every call of the function */
5171 funcctx = SRF_PERCALL_SETUP();
5173 call_cntr = funcctx->call_cntr;
5174 max_calls = funcctx->max_calls;
5175 attinmeta = funcctx->attinmeta;
5177 if (call_cntr < max_calls) /* do when there is more left to send */
5179 char *values[NUM_PG_SETTINGS_ATTS];
5185 * Get the next visible GUC variable name and value
5189 GetConfigOptionByNum(call_cntr, (const char **) values, &noshow);
5192 /* bump the counter and get the next config setting */
5193 call_cntr = ++funcctx->call_cntr;
5195 /* make sure we haven't gone too far now */
5196 if (call_cntr >= max_calls)
5197 SRF_RETURN_DONE(funcctx);
5202 tuple = BuildTupleFromCStrings(attinmeta, values);
5204 /* make the tuple into a datum */
5205 result = HeapTupleGetDatum(tuple);
5207 SRF_RETURN_NEXT(funcctx, result);
5211 /* do when there is no more left */
5212 SRF_RETURN_DONE(funcctx);
5217 _ShowOption(struct config_generic * record, bool use_units)
5222 switch (record->vartype)
5226 struct config_bool *conf = (struct config_bool *) record;
5228 if (conf->show_hook)
5229 val = (*conf->show_hook) ();
5231 val = *conf->variable ? "on" : "off";
5237 struct config_int *conf = (struct config_int *) record;
5239 if (conf->show_hook)
5240 val = (*conf->show_hook) ();
5244 int result = *conf->variable;
5246 if (use_units && result > 0 && (record->flags & GUC_UNIT_MEMORY))
5248 if (record->flags & GUC_UNIT_BLOCKS)
5249 result *= BLCKSZ/1024;
5251 if (result % KB_PER_GB == 0)
5253 result /= KB_PER_GB;
5256 else if (result % KB_PER_MB == 0)
5258 result /= KB_PER_MB;
5266 else if (use_units && result > 0 && (record->flags & GUC_UNIT_TIME))
5268 if (record->flags & GUC_UNIT_S)
5269 result = result * MS_PER_S;
5270 else if (record->flags & GUC_UNIT_MIN)
5271 result = result * MS_PER_MIN;
5273 if (result % MS_PER_D == 0)
5278 else if (result % MS_PER_H == 0)
5283 else if (result % MS_PER_MIN == 0)
5285 result /= MS_PER_MIN;
5286 strcpy(unit, "min");
5288 else if (result % MS_PER_S == 0)
5301 snprintf(buffer, sizeof(buffer), "%d%s",
5310 struct config_real *conf = (struct config_real *) record;
5312 if (conf->show_hook)
5313 val = (*conf->show_hook) ();
5316 snprintf(buffer, sizeof(buffer), "%g",
5325 struct config_string *conf = (struct config_string *) record;
5327 if (conf->show_hook)
5328 val = (*conf->show_hook) ();
5329 else if (*conf->variable && **conf->variable)
5330 val = *conf->variable;
5337 /* just to keep compiler quiet */
5342 return pstrdup(val);
5347 is_newvalue_equal(struct config_generic *record, const char *newvalue)
5349 switch (record->vartype)
5353 struct config_bool *conf = (struct config_bool *) record;
5356 return parse_bool(newvalue, &newval) && *conf->variable == newval;
5360 struct config_int *conf = (struct config_int *) record;
5363 return parse_int(newvalue, &newval, record->flags) && *conf->variable == newval;
5367 struct config_real *conf = (struct config_real *) record;
5370 return parse_real(newvalue, &newval) && *conf->variable == newval;
5374 struct config_string *conf = (struct config_string *) record;
5376 return strcmp(*conf->variable, newvalue) == 0;
5387 * This routine dumps out all non-default GUC options into a binary
5388 * file that is read by all exec'ed backends. The format is:
5390 * variable name, string, null terminated
5391 * variable value, string, null terminated
5392 * variable source, integer
5395 write_nondefault_variables(GucContext context)
5401 Assert(context == PGC_POSTMASTER || context == PGC_SIGHUP);
5403 elevel = (context == PGC_SIGHUP) ? LOG : ERROR;
5408 fp = AllocateFile(CONFIG_EXEC_PARAMS_NEW, "w");
5412 (errcode_for_file_access(),
5413 errmsg("could not write to file \"%s\": %m",
5414 CONFIG_EXEC_PARAMS_NEW)));
5418 for (i = 0; i < num_guc_variables; i++)
5420 struct config_generic *gconf = guc_variables[i];
5422 if (gconf->source != PGC_S_DEFAULT)
5424 fprintf(fp, "%s", gconf->name);
5427 switch (gconf->vartype)
5431 struct config_bool *conf = (struct config_bool *) gconf;
5433 if (*conf->variable == 0)
5434 fprintf(fp, "false");
5436 fprintf(fp, "true");
5442 struct config_int *conf = (struct config_int *) gconf;
5444 fprintf(fp, "%d", *conf->variable);
5450 struct config_real *conf = (struct config_real *) gconf;
5452 /* Could lose precision here? */
5453 fprintf(fp, "%f", *conf->variable);
5459 struct config_string *conf = (struct config_string *) gconf;
5461 fprintf(fp, "%s", *conf->variable);
5468 fwrite(&gconf->source, sizeof(gconf->source), 1, fp);
5475 (errcode_for_file_access(),
5476 errmsg("could not write to file \"%s\": %m",
5477 CONFIG_EXEC_PARAMS_NEW)));
5482 * Put new file in place. This could delay on Win32, but we don't hold
5483 * any exclusive locks.
5485 rename(CONFIG_EXEC_PARAMS_NEW, CONFIG_EXEC_PARAMS);
5490 * Read string, including null byte from file
5492 * Return NULL on EOF and nothing read
5495 read_string_with_null(FILE *fp)
5504 if ((ch = fgetc(fp)) == EOF)
5509 elog(FATAL, "invalid format of exec config params file");
5512 str = guc_malloc(FATAL, maxlen);
5513 else if (i == maxlen)
5514 str = guc_realloc(FATAL, str, maxlen *= 2);
5523 * This routine loads a previous postmaster dump of its non-default
5527 read_nondefault_variables(void)
5537 fp = AllocateFile(CONFIG_EXEC_PARAMS, "r");
5540 /* File not found is fine */
5541 if (errno != ENOENT)
5543 (errcode_for_file_access(),
5544 errmsg("could not read from file \"%s\": %m",
5545 CONFIG_EXEC_PARAMS)));
5551 struct config_generic *record;
5553 if ((varname = read_string_with_null(fp)) == NULL)
5556 if ((record = find_option(varname, FATAL)) == NULL)
5557 elog(FATAL, "failed to locate variable %s in exec config params file", varname);
5558 if ((varvalue = read_string_with_null(fp)) == NULL)
5559 elog(FATAL, "invalid format of exec config params file");
5560 if (fread(&varsource, sizeof(varsource), 1, fp) == 0)
5561 elog(FATAL, "invalid format of exec config params file");
5563 (void) set_config_option(varname, varvalue, record->context,
5564 varsource, false, true);
5571 #endif /* EXEC_BACKEND */
5575 * A little "long argument" simulation, although not quite GNU
5576 * compliant. Takes a string of the form "some-option=some value" and
5577 * returns name = "some_option" and value = "some value" in malloc'ed
5578 * storage. Note that '-' is converted to '_' in the option name. If
5579 * there is no '=' in the input string then value will be NULL.
5582 ParseLongOption(const char *string, char **name, char **value)
5591 equal_pos = strcspn(string, "=");
5593 if (string[equal_pos] == '=')
5595 *name = guc_malloc(FATAL, equal_pos + 1);
5596 strncpy(*name, string, equal_pos);
5597 (*name)[equal_pos] = '\0';
5599 *value = guc_strdup(FATAL, &string[equal_pos + 1]);
5603 /* no equal sign in string */
5604 *name = guc_strdup(FATAL, string);
5608 for (cp = *name; *cp; cp++)
5615 * Handle options fetched from pg_database.datconfig or pg_authid.rolconfig.
5616 * The array parameter must be an array of TEXT (it must not be NULL).
5619 ProcessGUCArray(ArrayType *array, GucSource source)
5623 Assert(array != NULL);
5624 Assert(ARR_ELEMTYPE(array) == TEXTOID);
5625 Assert(ARR_NDIM(array) == 1);
5626 Assert(ARR_LBOUND(array)[0] == 1);
5627 Assert(source == PGC_S_DATABASE || source == PGC_S_USER);
5629 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
5637 d = array_ref(array, 1, &i,
5638 -1 /* varlenarray */ ,
5639 -1 /* TEXT's typlen */ ,
5640 false /* TEXT's typbyval */ ,
5641 'i' /* TEXT's typalign */ ,
5647 s = DatumGetCString(DirectFunctionCall1(textout, d));
5649 ParseLongOption(s, &name, &value);
5653 (errcode(ERRCODE_SYNTAX_ERROR),
5654 errmsg("could not parse setting for parameter \"%s\"", name)));
5660 * We process all these options at SUSET level. We assume that the
5661 * right to insert an option into pg_database or pg_authid was checked
5662 * when it was inserted.
5664 SetConfigOption(name, value, PGC_SUSET, source);
5674 * Add an entry to an option array. The array parameter may be NULL
5675 * to indicate the current table entry is NULL.
5678 GUCArrayAdd(ArrayType *array, const char *name, const char *value)
5680 const char *varname;
5688 /* test if the option is valid */
5689 set_config_option(name, value,
5690 superuser() ? PGC_SUSET : PGC_USERSET,
5691 PGC_S_TEST, false, false);
5693 /* convert name to canonical spelling, so we can use plain strcmp */
5694 (void) GetConfigOptionByName(name, &varname);
5697 newval = palloc(strlen(name) + 1 + strlen(value) + 1);
5698 sprintf(newval, "%s=%s", name, value);
5699 datum = DirectFunctionCall1(textin, CStringGetDatum(newval));
5707 Assert(ARR_ELEMTYPE(array) == TEXTOID);
5708 Assert(ARR_NDIM(array) == 1);
5709 Assert(ARR_LBOUND(array)[0] == 1);
5711 index = ARR_DIMS(array)[0] + 1; /* add after end */
5713 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
5718 d = array_ref(array, 1, &i,
5719 -1 /* varlenarray */ ,
5720 -1 /* TEXT's typlen */ ,
5721 false /* TEXT's typbyval */ ,
5722 'i' /* TEXT's typalign */ ,
5726 current = DatumGetCString(DirectFunctionCall1(textout, d));
5727 if (strncmp(current, newval, strlen(name) + 1) == 0)
5734 a = array_set(array, 1, &index,
5737 -1 /* varlena array */ ,
5738 -1 /* TEXT's typlen */ ,
5739 false /* TEXT's typbyval */ ,
5740 'i' /* TEXT's typalign */ );
5743 a = construct_array(&datum, 1,
5752 * Delete an entry from an option array. The array parameter may be NULL
5753 * to indicate the current table entry is NULL. Also, if the return value
5754 * is NULL then a null should be stored.
5757 GUCArrayDelete(ArrayType *array, const char *name)
5759 const char *varname;
5760 ArrayType *newarray;
5766 /* test if the option is valid */
5767 set_config_option(name, NULL,
5768 superuser() ? PGC_SUSET : PGC_USERSET,
5769 PGC_S_TEST, false, false);
5771 /* convert name to canonical spelling, so we can use plain strcmp */
5772 (void) GetConfigOptionByName(name, &varname);
5775 /* if array is currently null, then surely nothing to delete */
5782 for (i = 1; i <= ARR_DIMS(array)[0]; i++)
5788 d = array_ref(array, 1, &i,
5789 -1 /* varlenarray */ ,
5790 -1 /* TEXT's typlen */ ,
5791 false /* TEXT's typbyval */ ,
5792 'i' /* TEXT's typalign */ ,
5796 val = DatumGetCString(DirectFunctionCall1(textout, d));
5798 /* ignore entry if it's what we want to delete */
5799 if (strncmp(val, name, strlen(name)) == 0
5800 && val[strlen(name)] == '=')
5803 /* else add it to the output array */
5806 newarray = array_set(newarray, 1, &index,
5809 -1 /* varlenarray */ ,
5810 -1 /* TEXT's typlen */ ,
5811 false /* TEXT's typbyval */ ,
5812 'i' /* TEXT's typalign */ );
5815 newarray = construct_array(&d, 1,
5827 * assign_hook subroutines
5831 assign_log_destination(const char *value, bool doit, GucSource source)
5838 /* Need a modifiable copy of string */
5839 rawstring = pstrdup(value);
5841 /* Parse string into list of identifiers */
5842 if (!SplitIdentifierString(rawstring, ',', &elemlist))
5844 /* syntax error in list */
5846 list_free(elemlist);
5847 if (source >= PGC_S_INTERACTIVE)
5849 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5850 errmsg("invalid list syntax for parameter \"log_destination\"")));
5854 foreach(l, elemlist)
5856 char *tok = (char *) lfirst(l);
5858 if (pg_strcasecmp(tok, "stderr") == 0)
5859 newlogdest |= LOG_DESTINATION_STDERR;
5861 else if (pg_strcasecmp(tok, "syslog") == 0)
5862 newlogdest |= LOG_DESTINATION_SYSLOG;
5865 else if (pg_strcasecmp(tok, "eventlog") == 0)
5866 newlogdest |= LOG_DESTINATION_EVENTLOG;
5870 if (source >= PGC_S_INTERACTIVE)
5872 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
5873 errmsg("unrecognized \"log_destination\" key word: \"%s\"",
5876 list_free(elemlist);
5882 Log_destination = newlogdest;
5885 list_free(elemlist);
5893 assign_syslog_facility(const char *facility, bool doit, GucSource source)
5897 if (pg_strcasecmp(facility, "LOCAL0") == 0)
5898 syslog_fac = LOG_LOCAL0;
5899 else if (pg_strcasecmp(facility, "LOCAL1") == 0)
5900 syslog_fac = LOG_LOCAL1;
5901 else if (pg_strcasecmp(facility, "LOCAL2") == 0)
5902 syslog_fac = LOG_LOCAL2;
5903 else if (pg_strcasecmp(facility, "LOCAL3") == 0)
5904 syslog_fac = LOG_LOCAL3;
5905 else if (pg_strcasecmp(facility, "LOCAL4") == 0)
5906 syslog_fac = LOG_LOCAL4;
5907 else if (pg_strcasecmp(facility, "LOCAL5") == 0)
5908 syslog_fac = LOG_LOCAL5;
5909 else if (pg_strcasecmp(facility, "LOCAL6") == 0)
5910 syslog_fac = LOG_LOCAL6;
5911 else if (pg_strcasecmp(facility, "LOCAL7") == 0)
5912 syslog_fac = LOG_LOCAL7;
5914 return NULL; /* reject */
5918 syslog_facility = syslog_fac;
5919 set_syslog_parameters(syslog_ident_str ? syslog_ident_str : "postgres",
5927 assign_syslog_ident(const char *ident, bool doit, GucSource source)
5930 set_syslog_parameters(ident, syslog_facility);
5934 #endif /* HAVE_SYSLOG */
5938 assign_defaultxactisolevel(const char *newval, bool doit, GucSource source)
5940 if (pg_strcasecmp(newval, "serializable") == 0)
5943 DefaultXactIsoLevel = XACT_SERIALIZABLE;
5945 else if (pg_strcasecmp(newval, "repeatable read") == 0)
5948 DefaultXactIsoLevel = XACT_REPEATABLE_READ;
5950 else if (pg_strcasecmp(newval, "read committed") == 0)
5953 DefaultXactIsoLevel = XACT_READ_COMMITTED;
5955 else if (pg_strcasecmp(newval, "read uncommitted") == 0)
5958 DefaultXactIsoLevel = XACT_READ_UNCOMMITTED;
5966 assign_log_min_messages(const char *newval,
5967 bool doit, GucSource source)
5969 return (assign_msglvl(&log_min_messages, newval, doit, source));
5973 assign_client_min_messages(const char *newval, bool doit, GucSource source)
5975 return (assign_msglvl(&client_min_messages, newval, doit, source));
5979 assign_min_error_statement(const char *newval, bool doit, GucSource source)
5981 return (assign_msglvl(&log_min_error_statement, newval, doit, source));
5985 assign_msglvl(int *var, const char *newval, bool doit, GucSource source)
5987 if (pg_strcasecmp(newval, "debug") == 0)
5992 else if (pg_strcasecmp(newval, "debug5") == 0)
5997 else if (pg_strcasecmp(newval, "debug4") == 0)
6002 else if (pg_strcasecmp(newval, "debug3") == 0)
6007 else if (pg_strcasecmp(newval, "debug2") == 0)
6012 else if (pg_strcasecmp(newval, "debug1") == 0)
6017 else if (pg_strcasecmp(newval, "log") == 0)
6024 * Client_min_messages always prints 'info', but we allow it as a value
6027 else if (pg_strcasecmp(newval, "info") == 0)
6032 else if (pg_strcasecmp(newval, "notice") == 0)
6037 else if (pg_strcasecmp(newval, "warning") == 0)
6042 else if (pg_strcasecmp(newval, "error") == 0)
6047 /* We allow FATAL/PANIC for client-side messages too. */
6048 else if (pg_strcasecmp(newval, "fatal") == 0)
6053 else if (pg_strcasecmp(newval, "panic") == 0)
6059 return NULL; /* fail */
6060 return newval; /* OK */
6064 assign_log_error_verbosity(const char *newval, bool doit, GucSource source)
6066 if (pg_strcasecmp(newval, "terse") == 0)
6069 Log_error_verbosity = PGERROR_TERSE;
6071 else if (pg_strcasecmp(newval, "default") == 0)
6074 Log_error_verbosity = PGERROR_DEFAULT;
6076 else if (pg_strcasecmp(newval, "verbose") == 0)
6079 Log_error_verbosity = PGERROR_VERBOSE;
6082 return NULL; /* fail */
6083 return newval; /* OK */
6087 assign_log_statement(const char *newval, bool doit, GucSource source)
6089 if (pg_strcasecmp(newval, "none") == 0)
6092 log_statement = LOGSTMT_NONE;
6094 else if (pg_strcasecmp(newval, "ddl") == 0)
6097 log_statement = LOGSTMT_DDL;
6099 else if (pg_strcasecmp(newval, "mod") == 0)
6102 log_statement = LOGSTMT_MOD;
6104 else if (pg_strcasecmp(newval, "all") == 0)
6107 log_statement = LOGSTMT_ALL;
6110 return NULL; /* fail */
6111 return newval; /* OK */
6115 show_num_temp_buffers(void)
6118 * We show the GUC var until local buffers have been initialized, and
6119 * NLocBuffer afterwards.
6121 static char nbuf[32];
6123 sprintf(nbuf, "%d", NLocBuffer ? NLocBuffer : num_temp_buffers);
6128 assign_phony_autocommit(bool newval, bool doit, GucSource source)
6132 if (doit && source >= PGC_S_INTERACTIVE)
6134 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
6135 errmsg("SET AUTOCOMMIT TO OFF is no longer supported")));
6142 assign_custom_variable_classes(const char *newval, bool doit, GucSource source)
6145 * Check syntax. newval must be a comma separated list of identifiers.
6146 * Whitespace is allowed but skipped.
6148 bool hasSpaceAfterToken = false;
6149 const char *cp = newval;
6154 initStringInfo(&buf);
6155 while ((c = *cp++) != 0)
6160 hasSpaceAfterToken = true;
6166 hasSpaceAfterToken = false;
6170 appendStringInfoChar(&buf, ',');
6175 if (hasSpaceAfterToken || !isalnum(c))
6178 * Syntax error due to token following space after token or non
6179 * alpha numeric character
6182 (errcode(ERRCODE_SYNTAX_ERROR),
6183 errmsg("invalid syntax for \"custom_variable_classes\": \"%s\"", newval)));
6188 appendStringInfoChar(&buf, (char) c);
6191 /* Remove stray ',' at end */
6192 if (symLen == 0 && buf.len > 0)
6193 buf.data[--buf.len] = '\0';
6198 newval = strdup(buf.data);
6205 assign_debug_assertions(bool newval, bool doit, GucSource source)
6207 #ifndef USE_ASSERT_CHECKING
6210 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6211 errmsg("assertion checking is not supported by this build")));
6217 assign_ssl(bool newval, bool doit, GucSource source)
6222 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6223 errmsg("SSL is not supported by this build")));
6229 assign_stage_log_stats(bool newval, bool doit, GucSource source)
6231 if (newval && log_statement_stats)
6233 if (source >= PGC_S_INTERACTIVE)
6235 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6236 errmsg("cannot enable parameter when \"log_statement_stats\" is true")));
6237 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
6238 else if (source != PGC_S_OVERRIDE)
6245 assign_log_stats(bool newval, bool doit, GucSource source)
6248 (log_parser_stats || log_planner_stats || log_executor_stats))
6250 if (source >= PGC_S_INTERACTIVE)
6252 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6253 errmsg("cannot enable \"log_statement_stats\" when "
6254 "\"log_parser_stats\", \"log_planner_stats\", "
6255 "or \"log_executor_stats\" is true")));
6256 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
6257 else if (source != PGC_S_OVERRIDE)
6264 assign_transaction_read_only(bool newval, bool doit, GucSource source)
6266 /* Can't go to r/w mode inside a r/o transaction */
6267 if (newval == false && XactReadOnly && IsSubTransaction())
6269 if (source >= PGC_S_INTERACTIVE)
6271 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
6272 errmsg("cannot set transaction read-write mode inside a read-only transaction")));
6273 /* source == PGC_S_OVERRIDE means do it anyway, eg at xact abort */
6274 else if (source != PGC_S_OVERRIDE)
6281 assign_canonical_path(const char *newval, bool doit, GucSource source)
6285 char *canon_val = guc_strdup(ERROR, newval);
6287 canonicalize_path(canon_val);
6295 assign_backslash_quote(const char *newval, bool doit, GucSource source)
6297 BackslashQuoteType bq;
6301 * Although only "on", "off", and "safe_encoding" are documented,
6302 * we use parse_bool so we can accept all the likely variants of
6305 if (pg_strcasecmp(newval, "safe_encoding") == 0)
6306 bq = BACKSLASH_QUOTE_SAFE_ENCODING;
6307 else if (parse_bool(newval, &bqbool))
6309 bq = bqbool ? BACKSLASH_QUOTE_ON : BACKSLASH_QUOTE_OFF;
6312 return NULL; /* reject */
6315 backslash_quote = bq;
6321 assign_timezone_abbreviations(const char *newval, bool doit, GucSource source)
6324 * The powerup value shown above for timezone_abbreviations is "UNKNOWN".
6325 * When we see this we just do nothing. If this value isn't overridden
6326 * from the config file then pg_timezone_abbrev_initialize() will
6327 * eventually replace it with "Default". This hack has two purposes:
6328 * to avoid wasting cycles loading values that might soon be overridden
6329 * from the config file, and to avoid trying to read the timezone abbrev
6330 * files during InitializeGUCOptions(). The latter doesn't work in an
6331 * EXEC_BACKEND subprocess because my_exec_path hasn't been set yet and
6332 * so we can't locate PGSHAREDIR. (Essentially the same hack is used
6333 * to delay initializing TimeZone ... if we have any more, we should
6334 * try to clean up and centralize this mechanism ...)
6336 if (strcmp(newval, "UNKNOWN") == 0)
6341 /* Loading abbrev file is expensive, so only do it when value changes */
6342 if (timezone_abbreviations_string == NULL ||
6343 strcmp(timezone_abbreviations_string, newval) != 0)
6348 * If reading config file, only the postmaster should bleat loudly
6349 * about problems. Otherwise, it's just this one process doing it,
6350 * and we use WARNING message level.
6352 if (source == PGC_S_FILE)
6353 elevel = IsUnderPostmaster ? DEBUG2 : LOG;
6356 if (!load_tzoffsets(newval, doit, elevel))
6363 * pg_timezone_abbrev_initialize --- set default value if not done already
6365 * This is called after initial loading of postgresql.conf. If no
6366 * timezone_abbreviations setting was found therein, select default.
6369 pg_timezone_abbrev_initialize(void)
6371 if (strcmp(timezone_abbreviations_string, "UNKNOWN") == 0)
6373 SetConfigOption("timezone_abbreviations", "Default",
6374 PGC_POSTMASTER, PGC_S_ARGV);
6379 assign_tcp_keepalives_idle(int newval, bool doit, GucSource source)
6382 return (pq_setkeepalivesidle(newval, MyProcPort) == STATUS_OK);
6388 show_tcp_keepalives_idle(void)
6390 static char nbuf[16];
6392 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesidle(MyProcPort));
6397 assign_tcp_keepalives_interval(int newval, bool doit, GucSource source)
6400 return (pq_setkeepalivesinterval(newval, MyProcPort) == STATUS_OK);
6406 show_tcp_keepalives_interval(void)
6408 static char nbuf[16];
6410 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivesinterval(MyProcPort));
6415 assign_tcp_keepalives_count(int newval, bool doit, GucSource source)
6418 return (pq_setkeepalivescount(newval, MyProcPort) == STATUS_OK);
6424 show_tcp_keepalives_count(void)
6426 static char nbuf[16];
6428 snprintf(nbuf, sizeof(nbuf), "%d", pq_getkeepalivescount(MyProcPort));
6433 #include "guc-file.c"