Add log_line_prefix placeholder %e to contain the current SQL state
[PostgreSQL.git] / src / backend / utils / misc / postgresql.conf.sample
blobc1b888c0d4663088fbd3f40f6949316a5583c13f
1 # -----------------------------
2 # PostgreSQL configuration file
3 # -----------------------------
5 # This file consists of lines of the form:
7 #   name = value
9 # (The "=" is optional.)  Whitespace may be used.  Comments are introduced with
10 # "#" anywhere on a line.  The complete list of parameter names and allowed
11 # values can be found in the PostgreSQL documentation.
13 # The commented-out settings shown in this file represent the default values.
14 # Re-commenting a setting is NOT sufficient to revert it to the default value;
15 # you need to reload the server.
17 # This file is read on server startup and when the server receives a SIGHUP
18 # signal.  If you edit the file on a running system, you have to SIGHUP the
19 # server for the changes to take effect, or use "pg_ctl reload".  Some
20 # parameters, which are marked below, require a server shutdown and restart to
21 # take effect.
23 # Any parameter can also be given as a command-line option to the server, e.g.,
24 # "postgres -c log_connections=on".  Some parameters can be changed at run time
25 # with the "SET" SQL command.
27 # Memory units:  kB = kilobytes        Time units:  ms  = milliseconds
28 #                MB = megabytes                     s   = seconds
29 #                GB = gigabytes                     min = minutes
30 #                                                   h   = hours
31 #                                                   d   = days
34 #------------------------------------------------------------------------------
35 # FILE LOCATIONS
36 #------------------------------------------------------------------------------
38 # The default values of these variables are driven from the -D command-line
39 # option or PGDATA environment variable, represented here as ConfigDir.
41 #data_directory = 'ConfigDir'           # use data in another directory
42                                         # (change requires restart)
43 #hba_file = 'ConfigDir/pg_hba.conf'     # host-based authentication file
44                                         # (change requires restart)
45 #ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
46                                         # (change requires restart)
48 # If external_pid_file is not explicitly set, no extra PID file is written.
49 #external_pid_file = '(none)'           # write an extra PID file
50                                         # (change requires restart)
53 #------------------------------------------------------------------------------
54 # CONNECTIONS AND AUTHENTICATION
55 #------------------------------------------------------------------------------
57 # - Connection Settings -
59 #listen_addresses = 'localhost'         # what IP address(es) to listen on;
60                                         # comma-separated list of addresses;
61                                         # defaults to 'localhost', '*' = all
62                                         # (change requires restart)
63 #port = 5432                            # (change requires restart)
64 #max_connections = 100                  # (change requires restart)
65 # Note:  Increasing max_connections costs ~400 bytes of shared memory per 
66 # connection slot, plus lock space (see max_locks_per_transaction).
67 #superuser_reserved_connections = 3     # (change requires restart)
68 #unix_socket_directory = ''             # (change requires restart)
69 #unix_socket_group = ''                 # (change requires restart)
70 #unix_socket_permissions = 0777         # begin with 0 to use octal notation
71                                         # (change requires restart)
72 #bonjour_name = ''                      # defaults to the computer name
73                                         # (change requires restart)
75 # - Security and Authentication -
77 #authentication_timeout = 1min          # 1s-600s
78 #ssl = off                              # (change requires restart)
79 #ssl_ciphers = 'ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH'      # allowed SSL ciphers
80                                         # (change requires restart)
81 #password_encryption = on
82 #db_user_namespace = off
84 # Kerberos and GSSAPI
85 #krb_server_keyfile = ''
86 #krb_srvname = 'postgres'               # (Kerberos only)
87 #krb_caseins_users = off
89 # - TCP Keepalives -
90 # see "man 7 tcp" for details
92 #tcp_keepalives_idle = 0                # TCP_KEEPIDLE, in seconds;
93                                         # 0 selects the system default
94 #tcp_keepalives_interval = 0            # TCP_KEEPINTVL, in seconds;
95                                         # 0 selects the system default
96 #tcp_keepalives_count = 0               # TCP_KEEPCNT;
97                                         # 0 selects the system default
100 #------------------------------------------------------------------------------
101 # RESOURCE USAGE (except WAL)
102 #------------------------------------------------------------------------------
104 # - Memory -
106 #shared_buffers = 32MB                  # min 128kB
107                                         # (change requires restart)
108 #temp_buffers = 8MB                     # min 800kB
109 #max_prepared_transactions = 0          # zero disables the feature
110                                         # (change requires restart)
111 # Note:  Increasing max_prepared_transactions costs ~600 bytes of shared memory
112 # per transaction slot, plus lock space (see max_locks_per_transaction).
113 # It is not advisable to set max_prepared_transactions nonzero unless you
114 # actively intend to use prepared transactions.
115 #work_mem = 1MB                         # min 64kB
116 #maintenance_work_mem = 16MB            # min 1MB
117 #max_stack_depth = 2MB                  # min 100kB
119 # - Kernel Resource Usage -
121 #max_files_per_process = 1000           # min 25
122                                         # (change requires restart)
123 #shared_preload_libraries = ''          # (change requires restart)
125 # - Cost-Based Vacuum Delay -
127 #vacuum_cost_delay = 0ms                # 0-100 milliseconds
128 #vacuum_cost_page_hit = 1               # 0-10000 credits
129 #vacuum_cost_page_miss = 10             # 0-10000 credits
130 #vacuum_cost_page_dirty = 20            # 0-10000 credits
131 #vacuum_cost_limit = 200                # 1-10000 credits
133 # - Background Writer -
135 #bgwriter_delay = 200ms                 # 10-10000ms between rounds
136 #bgwriter_lru_maxpages = 100            # 0-1000 max buffers written/round
137 #bgwriter_lru_multiplier = 2.0          # 0-10.0 multipler on buffers scanned/round
139 # - Asynchronous Behavior -
141 #effective_io_concurrency = 1           # 1-1000. 0 disables prefetching
144 #------------------------------------------------------------------------------
145 # WRITE AHEAD LOG
146 #------------------------------------------------------------------------------
148 # - Settings -
150 #fsync = on                             # turns forced synchronization on or off
151 #synchronous_commit = on                # immediate fsync at commit
152 #wal_sync_method = fsync                # the default is the first option 
153                                         # supported by the operating system:
154                                         #   open_datasync
155                                         #   fdatasync
156                                         #   fsync
157                                         #   fsync_writethrough
158                                         #   open_sync
159 #full_page_writes = on                  # recover from partial page writes
160 #wal_buffers = 64kB                     # min 32kB
161                                         # (change requires restart)
162 #wal_writer_delay = 200ms               # 1-10000 milliseconds
164 #commit_delay = 0                       # range 0-100000, in microseconds
165 #commit_siblings = 5                    # range 1-1000
167 # - Checkpoints -
169 #checkpoint_segments = 3                # in logfile segments, min 1, 16MB each
170 #checkpoint_timeout = 5min              # range 30s-1h
171 #checkpoint_completion_target = 0.5     # checkpoint target duration, 0.0 - 1.0
172 #checkpoint_warning = 30s               # 0 disables
174 # - Archiving -
176 #archive_mode = off             # allows archiving to be done
177                                 # (change requires restart)
178 #archive_command = ''           # command to use to archive a logfile segment
179 #archive_timeout = 0            # force a logfile segment switch after this
180                                 # number of seconds; 0 disables
183 #------------------------------------------------------------------------------
184 # QUERY TUNING
185 #------------------------------------------------------------------------------
187 # - Planner Method Configuration -
189 #enable_bitmapscan = on
190 #enable_hashagg = on
191 #enable_hashjoin = on
192 #enable_indexscan = on
193 #enable_mergejoin = on
194 #enable_nestloop = on
195 #enable_seqscan = on
196 #enable_sort = on
197 #enable_tidscan = on
199 # - Planner Cost Constants -
201 #seq_page_cost = 1.0                    # measured on an arbitrary scale
202 #random_page_cost = 4.0                 # same scale as above
203 #cpu_tuple_cost = 0.01                  # same scale as above
204 #cpu_index_tuple_cost = 0.005           # same scale as above
205 #cpu_operator_cost = 0.0025             # same scale as above
206 #effective_cache_size = 128MB
208 # - Genetic Query Optimizer -
210 #geqo = on
211 #geqo_threshold = 12
212 #geqo_effort = 5                        # range 1-10
213 #geqo_pool_size = 0                     # selects default based on effort
214 #geqo_generations = 0                   # selects default based on effort
215 #geqo_selection_bias = 2.0              # range 1.5-2.0
217 # - Other Planner Options -
219 #default_statistics_target = 100        # range 1-10000
220 #constraint_exclusion = partition       # on, off, or partition
221 #cursor_tuple_fraction = 0.1            # range 0.0-1.0
222 #from_collapse_limit = 8
223 #join_collapse_limit = 8                # 1 disables collapsing of explicit 
224                                         # JOIN clauses
227 #------------------------------------------------------------------------------
228 # ERROR REPORTING AND LOGGING
229 #------------------------------------------------------------------------------
231 # - Where to Log -
233 #log_destination = 'stderr'             # Valid values are combinations of
234                                         # stderr, csvlog, syslog and eventlog,
235                                         # depending on platform.  csvlog
236                                         # requires logging_collector to be on.
238 # This is used when logging to stderr:
239 #logging_collector = off                # Enable capturing of stderr and csvlog
240                                         # into log files. Required to be on for
241                                         # csvlogs.
242                                         # (change requires restart)
244 # These are only used if logging_collector is on:
245 #log_directory = 'pg_log'               # directory where log files are written,
246                                         # can be absolute or relative to PGDATA
247 #log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log'        # log file name pattern,
248                                         # can include strftime() escapes
249 #log_truncate_on_rotation = off         # If on, an existing log file of the
250                                         # same name as the new log file will be
251                                         # truncated rather than appended to.
252                                         # But such truncation only occurs on
253                                         # time-driven rotation, not on restarts
254                                         # or size-driven rotation.  Default is
255                                         # off, meaning append to existing files
256                                         # in all cases.
257 #log_rotation_age = 1d                  # Automatic rotation of logfiles will
258                                         # happen after that time.  0 disables.
259 #log_rotation_size = 10MB               # Automatic rotation of logfiles will 
260                                         # happen after that much log output.
261                                         # 0 disables.
263 # These are relevant when logging to syslog:
264 #syslog_facility = 'LOCAL0'
265 #syslog_ident = 'postgres'
268 # - When to Log -
270 #client_min_messages = notice           # values in order of decreasing detail:
271                                         #   debug5
272                                         #   debug4
273                                         #   debug3
274                                         #   debug2
275                                         #   debug1
276                                         #   log
277                                         #   notice
278                                         #   warning
279                                         #   error
281 #log_min_messages = warning             # values in order of decreasing detail:
282                                         #   debug5
283                                         #   debug4
284                                         #   debug3
285                                         #   debug2
286                                         #   debug1
287                                         #   info
288                                         #   notice
289                                         #   warning
290                                         #   error
291                                         #   log
292                                         #   fatal
293                                         #   panic
295 #log_error_verbosity = default          # terse, default, or verbose messages
297 #log_min_error_statement = error        # values in order of decreasing detail:
298                                         #   debug5
299                                         #   debug4
300                                         #   debug3
301                                         #   debug2
302                                         #   debug1
303                                         #   info
304                                         #   notice
305                                         #   warning
306                                         #   error
307                                         #   log
308                                         #   fatal
309                                         #   panic (effectively off)
311 #log_min_duration_statement = -1        # -1 is disabled, 0 logs all statements
312                                         # and their durations, > 0 logs only
313                                         # statements running at least this number
314                                         # of milliseconds
316 #silent_mode = off                      # DO NOT USE without syslog or
317                                         # logging_collector
318                                         # (change requires restart)
320 # - What to Log -
322 #debug_print_parse = off
323 #debug_print_rewritten = off
324 #debug_print_plan = off
325 #debug_pretty_print = on
326 #log_checkpoints = off
327 #log_connections = off
328 #log_disconnections = off
329 #log_duration = off
330 #log_hostname = off
331 #log_line_prefix = ''                   # special values:
332                                         #   %u = user name
333                                         #   %d = database name
334                                         #   %r = remote host and port
335                                         #   %h = remote host
336                                         #   %p = process ID
337                                         #   %t = timestamp without milliseconds
338                                         #   %m = timestamp with milliseconds
339                                         #   %i = command tag
340                                         #   %e = SQL state
341                                         #   %c = session ID
342                                         #   %l = session line number
343                                         #   %s = session start timestamp
344                                         #   %v = virtual transaction ID
345                                         #   %x = transaction ID (0 if none)
346                                         #   %q = stop here in non-session
347                                         #        processes
348                                         #   %% = '%'
349                                         # e.g. '<%u%%%d> '
350 #log_lock_waits = off                   # log lock waits >= deadlock_timeout
351 #log_statement = 'none'                 # none, ddl, mod, all
352 #log_temp_files = -1                    # log temporary files equal or larger
353                                         # than the specified size in kilobytes;
354                                         # -1 disables, 0 logs all temp files
355 #log_timezone = unknown                 # actually, defaults to TZ environment
356                                         # setting
359 #------------------------------------------------------------------------------
360 # RUNTIME STATISTICS
361 #------------------------------------------------------------------------------
363 # - Query/Index Statistics Collector -
365 #track_activities = on
366 #track_counts = on
367 #track_functions = none                 # none, pl, all
368 #track_activity_query_size = 1024
369 #update_process_title = on
370 #stats_temp_directory = 'pg_stat_tmp'
373 # - Statistics Monitoring -
375 #log_parser_stats = off
376 #log_planner_stats = off
377 #log_executor_stats = off
378 #log_statement_stats = off
381 #------------------------------------------------------------------------------
382 # AUTOVACUUM PARAMETERS
383 #------------------------------------------------------------------------------
385 #autovacuum = on                        # Enable autovacuum subprocess?  'on' 
386                                         # requires track_counts to also be on.
387 #log_autovacuum_min_duration = -1       # -1 disables, 0 logs all actions and
388                                         # their durations, > 0 logs only
389                                         # actions running at least this number
390                                         # of milliseconds.
391 #autovacuum_max_workers = 3             # max number of autovacuum subprocesses
392 #autovacuum_naptime = 1min              # time between autovacuum runs
393 #autovacuum_vacuum_threshold = 50       # min number of row updates before
394                                         # vacuum
395 #autovacuum_analyze_threshold = 50      # min number of row updates before 
396                                         # analyze
397 #autovacuum_vacuum_scale_factor = 0.2   # fraction of table size before vacuum
398 #autovacuum_analyze_scale_factor = 0.1  # fraction of table size before analyze
399 #autovacuum_freeze_max_age = 200000000  # maximum XID age before forced vacuum
400                                         # (change requires restart)
401 #autovacuum_vacuum_cost_delay = 20ms    # default vacuum cost delay for
402                                         # autovacuum, in milliseconds;
403                                         # -1 means use vacuum_cost_delay
404 #autovacuum_vacuum_cost_limit = -1      # default vacuum cost limit for
405                                         # autovacuum, -1 means use
406                                         # vacuum_cost_limit
409 #------------------------------------------------------------------------------
410 # CLIENT CONNECTION DEFAULTS
411 #------------------------------------------------------------------------------
413 # - Statement Behavior -
415 #search_path = '"$user",public'         # schema names
416 #default_tablespace = ''                # a tablespace name, '' uses the default
417 #temp_tablespaces = ''                  # a list of tablespace names, '' uses
418                                         # only default tablespace
419 #check_function_bodies = on
420 #default_transaction_isolation = 'read committed'
421 #default_transaction_read_only = off
422 #session_replication_role = 'origin'
423 #statement_timeout = 0                  # in milliseconds, 0 is disabled
424 #vacuum_freeze_min_age = 50000000
425 #vacuum_freeze_table_age = 150000000
426 #xmlbinary = 'base64'
427 #xmloption = 'content'
429 # - Locale and Formatting -
431 #datestyle = 'iso, mdy'
432 #intervalstyle = 'postgres'
433 #timezone = unknown                     # actually, defaults to TZ environment
434                                         # setting
435 #timezone_abbreviations = 'Default'     # Select the set of available time zone
436                                         # abbreviations.  Currently, there are
437                                         #   Default
438                                         #   Australia
439                                         #   India
440                                         # You can create your own file in
441                                         # share/timezonesets/.
442 #extra_float_digits = 0                 # min -15, max 2
443 #client_encoding = sql_ascii            # actually, defaults to database
444                                         # encoding
446 # These settings are initialized by initdb, but they can be changed.
447 #lc_messages = 'C'                      # locale for system error message
448                                         # strings
449 #lc_monetary = 'C'                      # locale for monetary formatting
450 #lc_numeric = 'C'                       # locale for number formatting
451 #lc_time = 'C'                          # locale for time formatting
453 # default configuration for text search
454 #default_text_search_config = 'pg_catalog.simple'
456 # - Other Defaults -
458 #dynamic_library_path = '$libdir'
459 #local_preload_libraries = ''
462 #------------------------------------------------------------------------------
463 # LOCK MANAGEMENT
464 #------------------------------------------------------------------------------
466 #deadlock_timeout = 1s
467 #max_locks_per_transaction = 64         # min 10
468                                         # (change requires restart)
469 # Note:  Each lock table slot uses ~270 bytes of shared memory, and there are
470 # max_locks_per_transaction * (max_connections + max_prepared_transactions)
471 # lock table slots.
474 #------------------------------------------------------------------------------
475 # VERSION/PLATFORM COMPATIBILITY
476 #------------------------------------------------------------------------------
478 # - Previous PostgreSQL Versions -
480 #add_missing_from = off
481 #array_nulls = on
482 #backslash_quote = safe_encoding        # on, off, or safe_encoding
483 #default_with_oids = off
484 #escape_string_warning = on
485 #regex_flavor = advanced                # advanced, extended, or basic
486 #sql_inheritance = on
487 #standard_conforming_strings = off
488 #synchronize_seqscans = on
490 # - Other Platforms and Clients -
492 #transform_null_equals = off
495 #------------------------------------------------------------------------------
496 # CUSTOMIZED OPTIONS
497 #------------------------------------------------------------------------------
499 #custom_variable_classes = ''           # list of custom variable class names