public inbox for [email protected]  
help / color / mirror / Atom feed
From: Tom Lane <[email protected]>
To: Peter Geoghegan <[email protected]>
Cc: [email protected]
Cc: Pg Docs <[email protected]>
Cc: Jonathan S. Katz <[email protected]>
Subject: Re: "GIN and GiST Index Types" page is about usage in full text search, but looks general purpose
Date: Tue, 12 Apr 2022 16:28:47 -0400
Message-ID: <[email protected]> (raw)
In-Reply-To: <CAH2-Wzm-YYq2f1Hy7HoazKmC6co3YmYKArN1civ20PnCSVHpBA@mail.gmail.com>
References: <[email protected]>
	<CAH2-Wz=+5kzq8A6Uo_t7F0URwztb74-O+UuFcAh1iixTME-WXQ@mail.gmail.com>
	<[email protected]>
	<CAH2-Wzm-YYq2f1Hy7HoazKmC6co3YmYKArN1civ20PnCSVHpBA@mail.gmail.com>

Peter Geoghegan <[email protected]> writes:
> On Tue, Apr 12, 2022 at 12:49 PM Tom Lane <[email protected]> wrote:
>> I think we should take the index type names out of the section title
>> entirely, and name it something generic like "Preferred Index Types for
>> Full Text Search".

> Agreed.

Proposed patch attached.  The existing text already says "GIN indexes are
the preferred text search index type", so I'm not sure we need to go
further than that about guiding people which one to use.  In particular,
since GIN can't support included columns, we can't really deprecate GiST
altogether here.

> There is always the extreme option of excluding older versions in
> robots.txt. I bet that would work.

Yeah, I was wondering about that too.  It's sort of the nuclear option,
but if we don't want to modify EOL'd versions then we may not have any
other way to keep Google from glomming onto them.

			regards, tom lane



Attachments:

  [text/x-diff] doc-tweak-full-text-index-docs.patch (1016B, 2-doc-tweak-full-text-index-docs.patch)
  download | inline diff:
diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml
index 20db7b7afe..6afaf9e62c 100644
--- a/doc/src/sgml/textsearch.sgml
+++ b/doc/src/sgml/textsearch.sgml
@@ -3618,7 +3618,7 @@ SELECT plainto_tsquery('supernovae stars');
  </sect1>
 
  <sect1 id="textsearch-indexes">
-  <title>GIN and GiST Index Types</title>
+  <title>Preferred Index Types for Text Search</title>
 
   <indexterm zone="textsearch-indexes">
    <primary>text search</primary>
@@ -3627,10 +3627,16 @@ SELECT plainto_tsquery('supernovae stars');
 
   <para>
    There are two kinds of indexes that can be used to speed up full text
-   searches.
+   searches:
+   <link linkend="gin"><acronym>GIN</acronym></link> and
+   <link linkend="gist"><acronym>GiST</acronym></link>.
    Note that indexes are not mandatory for full text searching, but in
    cases where a column is searched on a regular basis, an index is
    usually desirable.
+  </para>
+
+  <para>
+   To create such an index, do one of:
 
    <variablelist>
 


reply

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: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: "GIN and GiST Index Types" page is about usage in full text search, but looks general purpose
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox