Skip to content

Commit bae2116

Browse files
mhagandermhagander
committed
Document which GUC settings are enums and not strings, along with a short
paragraph about what that means.
1 parent e5c032d commit bae2116

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

‎doc/src/sgml/config.sgml

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/config.sgml,v 1.196 2008/11/20 20:45:29 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/config.sgml,v 1.197 2008/11/21 19:42:12 mha Exp $ -->
22

33
<chapter Id="runtime-config">
44
<title>Server Configuration</title>
@@ -20,8 +20,8 @@
2020

2121
<para>
2222
All parameter names are case-insensitive. Every parameter takes a
23-
value of one of four types: Boolean, integer, floating point,
24-
or string. Boolean values can be written as <literal>ON</literal>,
23+
value of one of five types: Boolean, integer, floating point,
24+
string or enum. Boolean values can be written as <literal>ON</literal>,
2525
<literal>OFF</literal>, <literal>TRUE</literal>,
2626
<literal>FALSE</literal>, <literal>YES</literal>,
2727
<literal>NO</literal>, <literal>1</literal>, <literal>0</literal>
@@ -42,6 +42,13 @@
4242
for memory units is 1024, not 1000.
4343
</para>
4444

45+
<para>
46+
Settings of type 'enum' are specified the same way at string settings,
47+
but are restricted to a limited range of values. To find available
48+
values, look at <literal>pg_settings.enumvals</>. Enum settings are
49+
case insensitive.
50+
</para>
51+
4552
<para>
4653
One way to set these parameters is to edit the file
4754
<filename>postgresql.conf</><indexterm><primary>postgresql.conf</></>,
@@ -1329,7 +1336,7 @@ SET ENABLE_SEQSCAN TO OFF;
13291336
</varlistentry>
13301337

13311338
<varlistentry id="guc-wal-sync-method" xreflabel="wal_sync_method">
1332-
<term><varname>wal_sync_method</varname> (<type>string</type>)</term>
1339+
<term><varname>wal_sync_method</varname> (<type>enum</type>)</term>
13331340
<indexterm>
13341341
<primary><varname>wal_sync_method</> configuration parameter</primary>
13351342
</indexterm>
@@ -2464,7 +2471,7 @@ local0.* /var/log/postgresql
24642471
</varlistentry>
24652472

24662473
<varlistentry id="guc-syslog-facility" xreflabel="syslog_facility">
2467-
<term><varname>syslog_facility</varname> (<type>string</type>)</term>
2474+
<term><varname>syslog_facility</varname> (<type>enum</type>)</term>
24682475
<indexterm>
24692476
<primary><varname>syslog_facility</> configuration parameter</primary>
24702477
</indexterm>
@@ -2511,7 +2518,7 @@ local0.* /var/log/postgresql
25112518
<variablelist>
25122519

25132520
<varlistentry id="guc-client-min-messages" xreflabel="client_min_messages">
2514-
<term><varname>client_min_messages</varname> (<type>string</type>)</term>
2521+
<term><varname>client_min_messages</varname> (<type>enum</type>)</term>
25152522
<indexterm>
25162523
<primary><varname>client_min_messages</> configuration parameter</primary>
25172524
</indexterm>
@@ -2532,7 +2539,7 @@ local0.* /var/log/postgresql
25322539
</varlistentry>
25332540

25342541
<varlistentry id="guc-log-min-messages" xreflabel="log_min_messages">
2535-
<term><varname>log_min_messages</varname> (<type>string</type>)</term>
2542+
<term><varname>log_min_messages</varname> (<type>enum</type>)</term>
25362543
<indexterm>
25372544
<primary><varname>log_min_messages</> configuration parameter</primary>
25382545
</indexterm>
@@ -2554,7 +2561,7 @@ local0.* /var/log/postgresql
25542561
</varlistentry>
25552562

25562563
<varlistentry id="guc-log-error-verbosity" xreflabel="log_error_verbosity">
2557-
<term><varname>log_error_verbosity</varname> (<type>string</type>)</term>
2564+
<term><varname>log_error_verbosity</varname> (<type>enum</type>)</term>
25582565
<indexterm>
25592566
<primary><varname>log_error_verbosity</> configuration parameter</primary>
25602567
</indexterm>
@@ -2570,7 +2577,7 @@ local0.* /var/log/postgresql
25702577
</varlistentry>
25712578

25722579
<varlistentry id="guc-log-min-error-statement" xreflabel="log_min_error_statement">
2573-
<term><varname>log_min_error_statement</varname> (<type>string</type>)</term>
2580+
<term><varname>log_min_error_statement</varname> (<type>enum</type>)</term>
25742581
<indexterm>
25752582
<primary><varname>log_min_error_statement</> configuration parameter</primary>
25762583
</indexterm>
@@ -3056,7 +3063,7 @@ local0.* /var/log/postgresql
30563063
</varlistentry>
30573064

30583065
<varlistentry id="guc-log-statement" xreflabel="log_statement">
3059-
<term><varname>log_statement</varname> (<type>string</type>)</term>
3066+
<term><varname>log_statement</varname> (<type>enum</type>)</term>
30603067
<indexterm>
30613068
<primary><varname>log_statement</> configuration parameter</primary>
30623069
</indexterm>
@@ -3314,7 +3321,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
33143321
</varlistentry>
33153322

33163323
<varlistentry id="guc-track-functions" xreflabel="track_functions">
3317-
<term><varname>track_functions</varname> (<type>string</type>)</term>
3324+
<term><varname>track_functions</varname> (<type>enum</type>)</term>
33183325
<indexterm>
33193326
<primary><varname>track_functions</> configuration parameter</primary>
33203327
</indexterm>
@@ -3828,7 +3835,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
38283835
<indexterm>
38293836
<primary><varname>default_transaction_isolation</> configuration parameter</primary>
38303837
</indexterm>
3831-
<term><varname>default_transaction_isolation</varname> (<type>string</type>)</term>
3838+
<term><varname>default_transaction_isolation</varname> (<type>enum</type>)</term>
38323839
<listitem>
38333840
<para>
38343841
Each SQL transaction has an isolation level, which can be
@@ -3871,7 +3878,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
38713878
</varlistentry>
38723879

38733880
<varlistentry id="guc-session-replication-role" xreflabel="session_replication_role">
3874-
<term><varname>session_replication_role</varname> (<type>string</type>)</term>
3881+
<term><varname>session_replication_role</varname> (<type>enum</type>)</term>
38753882
<indexterm>
38763883
<primary><varname>session_replication_role</> configuration parameter</primary>
38773884
</indexterm>
@@ -3933,7 +3940,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
39333940
</varlistentry>
39343941

39353942
<varlistentry id="guc-xmlbinary" xreflabel="xmlbinary">
3936-
<term><varname>xmlbinary</varname> (<type>string</type>)</term>
3943+
<term><varname>xmlbinary</varname> (<type>enum</type>)</term>
39373944
<indexterm>
39383945
<primary><varname>xmlbinary</> configuration parameter</primary>
39393946
</indexterm>
@@ -3960,7 +3967,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
39603967
</varlistentry>
39613968

39623969
<varlistentry id="guc-xmloption" xreflabel="xmloption">
3963-
<term><varname>xmloption</varname> (<type>string</type>)</term>
3970+
<term><varname>xmloption</varname> (<type>enum</type>)</term>
39643971
<indexterm>
39653972
<primary><varname>xmloption</> configuration parameter</primary>
39663973
</indexterm>
@@ -4026,7 +4033,7 @@ SET XML OPTION { DOCUMENT | CONTENT };
40264033
</varlistentry>
40274034

40284035
<varlistentry id="guc-intervalstyle" xreflabel="IntervalStyle">
4029-
<term><varname>IntervalStyle</varname> (<type>string</type>)</term>
4036+
<term><varname>IntervalStyle</varname> (<type>enum</type>)</term>
40304037
<indexterm>
40314038
<primary><varname>IntervalStyle</> configuration parameter</primary>
40324039
</indexterm>
@@ -4514,7 +4521,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
45144521
</varlistentry>
45154522

45164523
<varlistentry id="guc-backslash-quote" xreflabel="backslash_quote">
4517-
<term><varname>backslash_quote</varname> (<type>string</type>)</term>
4524+
<term><varname>backslash_quote</varname> (<type>enum</type>)</term>
45184525
<indexterm><primary>strings</><secondary>backslash quotes</></>
45194526
<indexterm>
45204527
<primary><varname>backslash_quote</> configuration parameter</primary>
@@ -4602,7 +4609,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
46024609
</varlistentry>
46034610

46044611
<varlistentry id="guc-regex-flavor" xreflabel="regex_flavor">
4605-
<term><varname>regex_flavor</varname> (<type>string</type>)</term>
4612+
<term><varname>regex_flavor</varname> (<type>enum</type>)</term>
46064613
<indexterm><primary>regular expressions</></>
46074614
<indexterm>
46084615
<primary><varname>regex_flavor</> configuration parameter</primary>

0 commit comments

Comments
 (0)