pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedCREATE INDEX USING documentation
3+ messages / 2 participants
[nested] [flat]
* CREATE INDEX USING documentation
@ 2022-01-15 23:01 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 3+ messages in thread
From: PG Doc comments form @ 2022-01-15 23:01 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: robertcorrington@gmail.com
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).
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.
Thanks,
-r
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: CREATE INDEX USING documentation
@ 2022-07-23 16:46 Bruce Momjian <bruce@momjian.us>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 3+ messages in thread
From: Bruce Momjian @ 2022-07-23 16:46 UTC (permalink / raw)
To: robertcorrington@gmail.com; pgsql-docs@lists.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.sgml
index 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>
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: CREATE INDEX USING documentation
@ 2022-08-12 15:26 Bruce Momjian <bruce@momjian.us>
parent: Bruce Momjian <bruce@momjian.us>
0 siblings, 0 replies; 3+ messages in thread
From: Bruce Momjian @ 2022-08-12 15:26 UTC (permalink / raw)
To: robertcorrington@gmail.com; pgsql-docs@lists.postgresql.org
On Sat, Jul 23, 2022 at 12:46:31PM -0400, Bruce Momjian wrote:
> 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.
Backpatched to PG 10. Thanks for the report, and it is very odd this
was undocumented for so long.
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com
Indecision is a decision. Inaction is an action. Mark Batterson
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2022-08-12 15:26 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2022-01-15 23:01 CREATE INDEX USING documentation PG Doc comments form <noreply@postgresql.org>
2022-07-23 16:46 ` Bruce Momjian <bruce@momjian.us>
2022-08-12 15:26 ` Bruce Momjian <bruce@momjian.us>
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