From: Bruce Momjian <bruce@momjian.us>
To: robertcorrington@gmail.com
To: pgsql-docs@lists.postgresql.org
Subject: Re: CREATE INDEX USING documentation
Date: Sat, 23 Jul 2022 12:46:31 -0400
Message-ID: <Ytwl51UFbzkxR0Cs@momjian.us> (raw)
In-Reply-To: <164228771825.31954.2719791849363756957@wrigleys.postgresql.org>
References: <164228771825.31954.2719791849363756957@wrigleys.postgresql.org>
On Sat, Jan 15, 2022 at 11:01:58PM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/14/sql-createindex.html
> Description:
>
> In the CREATE INDEX
> synopsis(https://www.postgresql.org/docs/current/sql-createindex.html), the
> USING method parameter is listed, however in the PARAMETERS section USING is
> never fully described, nor is there a link to the very help 11.2 Index Types
> page (https://www.postgresql.org/docs/14/indexes-types.html).
Well, that is certainly odd. The attached patch adds a description of
the option, and a link to the chapter you suggested.
> On a related note, the CREATE INDEX page provides the following blurb:
>
> "Prior releases of PostgreSQL also had an R-tree index method. This method
> has been removed because it had no significant advantages over the GiST
> method. If USING rtree is specified, CREATE INDEX will interpret it as USING
> gist, to simplify conversion of old databases to GiST."
>
> But there is no such blurb on the 11.2 Index Types page.
We think of backward compatibility stuff as operational, meaning it
appears in the command manual page but not necessarily in the main docs.
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com
Indecision is a decision. Inaction is an action. Mark Batterson
Attachments:
[text/x-diff] using.diff (838B, ../Ytwl51UFbzkxR0Cs@momjian.us/2-using.diff)
download | inline diff:diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgmlindex a5bac9f737..944fdb4b09 100644--- a/doc/src/sgml/ref/create_index.sgml+++ b/doc/src/sgml/ref/create_index.sgml@@ -149,6 +149,18 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</listitem>
</varlistentry>
+ <varlistentry>+ <term><literal>USING</literal></term>+ <listitem>+ <para>+ The optional <literal>USING</literal> clause specifies an index+ type as described in <xref linkend="indexes-types"/>. If not+ specified, a default index type will be used based on the+ data types of the columns.+ </para>+ </listitem>+ </varlistentry>+
<varlistentry>
<term><literal>INCLUDE</literal></term>
<listitem>
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: bruce@momjian.us, robertcorrington@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: CREATE INDEX USING documentation
In-Reply-To: <Ytwl51UFbzkxR0Cs@momjian.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox