Skip to content

Commit c8e0f6b

Browse files
MasaoFujiiMasaoFujii
committed
Add index terms for reloptions in documentation.
Author: Fujii Masao Reviewed-By: Alvaro Herrera, Michael Paquier Discussion: https://postgr.es/m/CAHGQGwHyKt9-xkibVguPzYqKgb_2tdw14Ub1XDTu08kyHMiTQA@mail.gmail.com
1 parent e446cde commit c8e0f6b

File tree

3 files changed

+196
-65
lines changed

3 files changed

+196
-65
lines changed

‎doc/src/sgml/config.sgml‎

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6934,7 +6934,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
69346934
<varlistentry id="guc-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration">
69356935
<term><varname>log_autovacuum_min_duration</varname> (<type>integer</type>)
69366936
<indexterm>
6937-
<primary><varname>log_autovacuum_min_duration</varname> configuration parameter</primary>
6937+
<primary><varname>log_autovacuum_min_duration</varname></primary>
6938+
<secondary>configuration parameter</secondary>
69386939
</indexterm>
69396940
</term>
69406941
<listitem>
@@ -6993,7 +6994,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
69936994
<varlistentry id="guc-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold">
69946995
<term><varname>autovacuum_vacuum_threshold</varname> (<type>integer</type>)
69956996
<indexterm>
6996-
<primary><varname>autovacuum_vacuum_threshold</varname> configuration parameter</primary>
6997+
<primary><varname>autovacuum_vacuum_threshold</varname></primary>
6998+
<secondary>configuration parameter</secondary>
69976999
</indexterm>
69987000
</term>
69997001
<listitem>
@@ -7012,7 +7014,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
70127014
<varlistentry id="guc-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold">
70137015
<term><varname>autovacuum_analyze_threshold</varname> (<type>integer</type>)
70147016
<indexterm>
7015-
<primary><varname>autovacuum_analyze_threshold</varname> configuration parameter</primary>
7017+
<primary><varname>autovacuum_analyze_threshold</varname></primary>
7018+
<secondary>configuration parameter</secondary>
70167019
</indexterm>
70177020
</term>
70187021
<listitem>
@@ -7031,7 +7034,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
70317034
<varlistentry id="guc-autovacuum-vacuum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor">
70327035
<term><varname>autovacuum_vacuum_scale_factor</varname> (<type>floating point</type>)
70337036
<indexterm>
7034-
<primary><varname>autovacuum_vacuum_scale_factor</varname> configuration parameter</primary>
7037+
<primary><varname>autovacuum_vacuum_scale_factor</varname></primary>
7038+
<secondary>configuration parameter</secondary>
70357039
</indexterm>
70367040
</term>
70377041
<listitem>
@@ -7051,7 +7055,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
70517055
<varlistentry id="guc-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor">
70527056
<term><varname>autovacuum_analyze_scale_factor</varname> (<type>floating point</type>)
70537057
<indexterm>
7054-
<primary><varname>autovacuum_analyze_scale_factor</varname> configuration parameter</primary>
7058+
<primary><varname>autovacuum_analyze_scale_factor</varname></primary>
7059+
<secondary>configuration parameter</secondary>
70557060
</indexterm>
70567061
</term>
70577062
<listitem>
@@ -7071,7 +7076,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
70717076
<varlistentry id="guc-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age">
70727077
<term><varname>autovacuum_freeze_max_age</varname> (<type>integer</type>)
70737078
<indexterm>
7074-
<primary><varname>autovacuum_freeze_max_age</varname> configuration parameter</primary>
7079+
<primary><varname>autovacuum_freeze_max_age</varname></primary>
7080+
<secondary>configuration parameter</secondary>
70757081
</indexterm>
70767082
</term>
70777083
<listitem>
@@ -7099,7 +7105,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
70997105
<varlistentry id="guc-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age">
71007106
<term><varname>autovacuum_multixact_freeze_max_age</varname> (<type>integer</type>)
71017107
<indexterm>
7102-
<primary><varname>autovacuum_multixact_freeze_max_age</varname> configuration parameter</primary>
7108+
<primary><varname>autovacuum_multixact_freeze_max_age</varname></primary>
7109+
<secondary>configuration parameter</secondary>
71037110
</indexterm>
71047111
</term>
71057112
<listitem>
@@ -7127,7 +7134,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
71277134
<varlistentry id="guc-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay">
71287135
<term><varname>autovacuum_vacuum_cost_delay</varname> (<type>floating point</type>)
71297136
<indexterm>
7130-
<primary><varname>autovacuum_vacuum_cost_delay</varname> configuration parameter</primary>
7137+
<primary><varname>autovacuum_vacuum_cost_delay</varname></primary>
7138+
<secondary>configuration parameter</secondary>
71317139
</indexterm>
71327140
</term>
71337141
<listitem>
@@ -7147,7 +7155,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
71477155
<varlistentry id="guc-autovacuum-vacuum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit">
71487156
<term><varname>autovacuum_vacuum_cost_limit</varname> (<type>integer</type>)
71497157
<indexterm>
7150-
<primary><varname>autovacuum_vacuum_cost_limit</varname> configuration parameter</primary>
7158+
<primary><varname>autovacuum_vacuum_cost_limit</varname></primary>
7159+
<secondary>configuration parameter</secondary>
71517160
</indexterm>
71527161
</term>
71537162
<listitem>
@@ -7746,7 +7755,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
77467755
<varlistentry id="guc-vacuum-cleanup-index-scale-factor" xreflabel="vacuum_cleanup_index_scale_factor">
77477756
<term><varname>vacuum_cleanup_index_scale_factor</varname> (<type>floating point</type>)
77487757
<indexterm>
7749-
<primary><varname>vacuum_cleanup_index_scale_factor</varname> configuration parameter</primary>
7758+
<primary><varname>vacuum_cleanup_index_scale_factor</varname></primary>
7759+
<secondary>configuration parameter</secondary>
77507760
</indexterm>
77517761
</term>
77527762
<listitem>
@@ -7865,7 +7875,8 @@ SET XML OPTION { DOCUMENT | CONTENT };
78657875
<varlistentry id="guc-gin-pending-list-limit" xreflabel="gin_pending_list_limit">
78667876
<term><varname>gin_pending_list_limit</varname> (<type>integer</type>)
78677877
<indexterm>
7868-
<primary><varname>gin_pending_list_limit</varname> configuration parameter</primary>
7878+
<primary><varname>gin_pending_list_limit</varname></primary>
7879+
<secondary>configuration parameter</secondary>
78697880
</indexterm>
78707881
</term>
78717882
<listitem>

‎doc/src/sgml/ref/create_index.sgml‎

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -361,8 +361,12 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
361361
</para>
362362

363363
<variablelist>
364-
<varlistentry>
365-
<term><literal>fillfactor</literal></term>
364+
<varlistentry id="index-reloption-fillfactor" xreflabel="fillfactor">
365+
<term><literal>fillfactor</literal>
366+
<indexterm>
367+
<primary><varname>fillfactor</varname> storage parameter</primary>
368+
</indexterm>
369+
</term>
366370
<listitem>
367371
<para>
368372
The fillfactor for an index is a percentage that determines how full
@@ -388,8 +392,13 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
388392
</para>
389393

390394
<variablelist>
391-
<varlistentry>
392-
<term><literal>vacuum_cleanup_index_scale_factor</literal></term>
395+
<varlistentry id="index-reloption-vacuum-cleanup-index-scale-factor" xreflabel="vacuum_cleanup_index_scale_factor">
396+
<term><literal>vacuum_cleanup_index_scale_factor</literal>
397+
<indexterm>
398+
<primary><varname>vacuum_cleanup_index_scale_factor</varname></primary>
399+
<secondary>storage parameter</secondary>
400+
</indexterm>
401+
</term>
393402
<listitem>
394403
<para>
395404
Per-index value for <xref linkend="guc-vacuum-cleanup-index-scale-factor"/>.
@@ -403,8 +412,12 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
403412
</para>
404413

405414
<variablelist>
406-
<varlistentry>
407-
<term><literal>buffering</literal></term>
415+
<varlistentry id="index-reloption-buffering" xreflabel="buffering">
416+
<term><literal>buffering</literal>
417+
<indexterm>
418+
<primary><varname>buffering</varname> storage parameter</primary>
419+
</indexterm>
420+
</term>
408421
<listitem>
409422
<para>
410423
Determines whether the buffering build technique described in
@@ -422,8 +435,12 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
422435
</para>
423436

424437
<variablelist>
425-
<varlistentry>
426-
<term><literal>fastupdate</literal></term>
438+
<varlistentry id="index-reloption-fastupdate" xreflabel="fastupdate">
439+
<term><literal>fastupdate</literal>
440+
<indexterm>
441+
<primary><varname>fastupdate</varname> storage parameter</primary>
442+
</indexterm>
443+
</term>
427444
<listitem>
428445
<para>
429446
This setting controls usage of the fast update technique described in
@@ -446,9 +463,15 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
446463
</listitem>
447464
</varlistentry>
448465
</variablelist>
466+
449467
<variablelist>
450-
<varlistentry>
451-
<term><literal>gin_pending_list_limit</literal></term>
468+
<varlistentry id="index-reloption-gin-pending-list-limit" xreflabel="gin_pending_list_limit">
469+
<term><literal>gin_pending_list_limit</literal>
470+
<indexterm>
471+
<primary><varname>gin_pending_list_limit</varname></primary>
472+
<secondary>storage parameter</secondary>
473+
</indexterm>
474+
</term>
452475
<listitem>
453476
<para>
454477
Custom <xref linkend="guc-gin-pending-list-limit"/> parameter.
@@ -463,8 +486,12 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
463486
</para>
464487

465488
<variablelist>
466-
<varlistentry>
467-
<term><literal>pages_per_range</literal></term>
489+
<varlistentry id="index-reloption-pages-per-range" xreflabel="pages_per_range">
490+
<term><literal>pages_per_range</literal>
491+
<indexterm>
492+
<primary><varname>pages_per_range</varname> storage parameter</primary>
493+
</indexterm>
494+
</term>
468495
<listitem>
469496
<para>
470497
Defines the number of table blocks that make up one block range for
@@ -474,8 +501,12 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
474501
</listitem>
475502
</varlistentry>
476503

477-
<varlistentry>
478-
<term><literal>autosummarize</literal></term>
504+
<varlistentry id="index-reloption-autosummarize" xreflabel="autosummarize">
505+
<term><literal>autosummarize</literal>
506+
<indexterm>
507+
<primary><varname>autosummarize</varname> storage parameter</primary>
508+
</indexterm>
509+
</term>
479510
<listitem>
480511
<para>
481512
Defines whether a summarization run is invoked for the previous page

0 commit comments

Comments
 (0)