On Wed, Aug 17, 2022 at 11:21:58PM -0400, Bruce Momjian wrote:
> On Wed, Aug 17, 2022 at 05:11:23PM -0400, Jeff Janes wrote:
> > That looks good to me. But now looking over the linked pages more, it seems
> > like https://www.postgresql.org/docs/current/indexes-types.html was never
> > changed to admit the possibility of custom index access methods (like bloom)
>
> Uh, bloom is in /contrib, so we wouldn't mention that in the main docs,
> I think. However, it might be nice to mention you can add others.
>
> > and neither was the 'replaceable class="parameter">method' section of
> > https://
> > www.postgresql.org/docs/current/sql-createindex.html.
>
> Yes, seems we should say that you can install your own methods that can
> be used, e.g., bloom.
>
> > Also, is it odd that we say essentially the same thing for literal USING as
> > we
> > say for the replaceable /method/?
>
> Well, this is embarrassing. Someone reported there was no mention of
> USING in the CREATE INDEX docs, and I didn't see it either, so I added
> it.
>
> However, CREATE INDEX just lists the parameters, not the keywords, so it
> was already there as 'method', as you mentioned above. I will just
> remove the USING section I recently added.
I wrote the attached patch to address the issues above.
--
Bruce Momjian <[email protected]> https://momjian.us
EDB https://enterprisedb.com
Indecision is a decision. Inaction is an action. Mark Batterson
diff --git a/doc/src/sgml/indices.sgml b/doc/src/sgml/indices.sgml
index 2a70e02f7c..0c3fcfd62f 100644
--- a/doc/src/sgml/indices.sgml
+++ b/doc/src/sgml/indices.sgml
@@ -117,7 +117,8 @@ CREATE INDEX test1_id_index ON test1 (id);
<para>
<productname>PostgreSQL</productname> provides several index types:
- B-tree, Hash, GiST, SP-GiST, GIN and BRIN.
+ B-tree, Hash, GiST, SP-GiST, GIN, BRIN, and the extension <link
+ linkend="bloom">bloom</link>.
Each index type uses a different
algorithm that is best suited to different types of queries.
By default, the <link linkend="sql-createindex"><command>CREATE
diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml
index 944fdb4b09..40986aa502 100644
--- a/doc/src/sgml/ref/create_index.sgml
+++ b/doc/src/sgml/ref/create_index.sgml
@@ -149,18 +149,6 @@ 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>
@@ -250,8 +238,9 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
<para>
The name of the index method to be used. Choices are
<literal>btree</literal>, <literal>hash</literal>,
- <literal>gist</literal>, <literal>spgist</literal>, <literal>gin</literal>, and
- <literal>brin</literal>.
+ <literal>gist</literal>, <literal>spgist</literal>, <literal>gin</literal>,
+ <literal>brin</literal>, or user-installed access methods like
+ <link linkend="bloom">bloom</link>.
The default method is <literal>btree</literal>.
</para>
</listitem>
