database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-04-18 13:44:19 +03:00
Code

Doc: do a little copy-editing on Index Storage Parameters list.

Browse Source 
Add a paragraph break per suggestion from David G. Johnston.
Use a consistent voice for all the different parameter
descriptions, and fix a couple of grammatical issues.

Reported-by: Igor Korot <ikorot01@gmail.com>
Co-authored-by: "David G. Johnston" <david.g.johnston@gmail.com>
Co-authored-by: Tom Lane <tgl@sss.pgh.pa.us>
Discussion: https://postgr.es/m/CA+FnnTz=EW1VQRpWB9J+G-NSchrPFcw4nR7d0JqzEK9jWKB35A@mail.gmail.com
This commit is contained in:
Tom Lane 2025-04-12 13:42:31 -04:00
parent e708ffe79d
commit 78637a8be2
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/src/sgml/ref/create_index.sgml
View File

@ -387,9 +387,13 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
<para> <para>
The optional <literal>WITH</literal> clause specifies <firstterm>storage The optional <literal>WITH</literal> clause specifies <firstterm>storage
parameters</firstterm> for the index. Each index method has its own set of allowed parameters</firstterm> for the index. Each index method has its own set
storage parameters. The B-tree, hash, GiST and SP-GiST index methods all of allowed storage parameters.
accept this parameter: </para>
<para>
The B-tree, hash, GiST and SP-GiST index methods all accept this
parameter:
</para> </para>
<variablelist> <variablelist>
@ -401,7 +405,7 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</term> </term>
<listitem> <listitem>
<para> <para>
The fillfactor for an index is a percentage that determines how full Controls how full
the index method will try to pack index pages. For B-trees, leaf pages the index method will try to pack index pages. For B-trees, leaf pages
are filled to this percentage during initial index builds, and also are filled to this percentage during initial index builds, and also
when extending the index at the right (adding new largest key values). when extending the index at the right (adding new largest key values).
@ -488,7 +492,7 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</term> </term>
<listitem> <listitem>
<para> <para>
Determines whether the buffered build technique described in Controls whether the buffered build technique described in
<xref linkend="gist-buffering-build"/> is used to build the index. With <xref linkend="gist-buffering-build"/> is used to build the index. With
<literal>OFF</literal> buffering is disabled, with <literal>ON</literal> <literal>OFF</literal> buffering is disabled, with <literal>ON</literal>
it is enabled, and with <literal>AUTO</literal> it is initially disabled, it is enabled, and with <literal>AUTO</literal> it is initially disabled,
@ -503,7 +507,7 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</variablelist> </variablelist>
<para> <para>
GIN indexes accept different parameters: GIN indexes accept these parameters:
</para> </para>
<variablelist> <variablelist>
@ -515,8 +519,8 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</term> </term>
<listitem> <listitem>
<para> <para>
This setting controls usage of the fast update technique described in Controls usage of the fast update technique described in
<xref linkend="gin-fast-update"/>. It is a Boolean parameter: <xref linkend="gin-fast-update"/>.
<literal>ON</literal> enables fast update, <literal>OFF</literal> disables it. <literal>ON</literal> enables fast update, <literal>OFF</literal> disables it.
The default is <literal>ON</literal>. The default is <literal>ON</literal>.
</para> </para>
@ -525,8 +529,9 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
<para> <para>
Turning <literal>fastupdate</literal> off via <command>ALTER INDEX</command> prevents Turning <literal>fastupdate</literal> off via <command>ALTER INDEX</command> prevents
future insertions from going into the list of pending index entries, future insertions from going into the list of pending index entries,
but does not in itself flush previous entries. You might want to but does not in itself flush existing entries. You might want to
<command>VACUUM</command> the table or call <function>gin_clean_pending_list</function> <command>VACUUM</command> the table or call
the <function>gin_clean_pending_list</function>
function afterward to ensure the pending list is emptied. function afterward to ensure the pending list is emptied.
</para> </para>
</note> </note>
@ -544,7 +549,8 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</term> </term>
<listitem> <listitem>
<para> <para>
Custom <xref linkend="guc-gin-pending-list-limit"/> parameter. Overrides the global setting of
<xref linkend="guc-gin-pending-list-limit"/> for this index.
This value is specified in kilobytes. This value is specified in kilobytes.
</para> </para>
</listitem> </listitem>
@ -552,7 +558,7 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</variablelist> </variablelist>
<para> <para>
<acronym>BRIN</acronym> indexes accept different parameters: <acronym>BRIN</acronym> indexes accept these parameters:
</para> </para>
<variablelist> <variablelist>
@ -580,8 +586,8 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
<listitem> <listitem>
<para> <para>
Defines whether a summarization run is queued for the previous page Defines whether a summarization run is queued for the previous page
range whenever an insertion is detected on the next one. range whenever an insertion is detected on the next one
See <xref linkend="brin-operation"/> for more details. (see <xref linkend="brin-operation"/> for more details).
The default is <literal>off</literal>. The default is <literal>off</literal>.
</para> </para>
</listitem> </listitem>