Clean up some stray references to tsearch2.
authorTom Lane <tgl@sss.pgh.pa.us>
Tue, 13 Nov 2007 23:36:26 +0000 (23:36 +0000)
committerTom Lane <tgl@sss.pgh.pa.us>
Tue, 13 Nov 2007 23:36:26 +0000 (23:36 +0000)
doc/src/sgml/gin.sgml
doc/src/sgml/gist.sgml
doc/src/sgml/indices.sgml
doc/src/sgml/trgm.sgml
src/backend/access/gin/README

index 1a16b3f3a54263fd5ce1b41ff6e47e67b894efc7..d438db20a00a5ccd318987afbaf1fbe38e950002 100644 (file)
 
  <para>
   The <productname>PostgreSQL</productname> source distribution includes
-  <acronym>GIN</acronym> classes for one-dimensional arrays of all internal
-  types.  The following
+  <acronym>GIN</acronym> operator classes for <type>tsvector</> and
+  for one-dimensional arrays of all internal types.  The following
   <filename>contrib</> modules also contain <acronym>GIN</acronym>
   operator classes:
  </para>
 
  <variablelist>
+  <varlistentry>
+   <term>hstore</term>
+   <listitem>
+    <para>Module for storing (key, value) pairs</para>
+   </listitem>
+  </varlistentry>
+
   <varlistentry>
    <term>intarray</term>
    <listitem>
   </varlistentry>
 
   <varlistentry>
-   <term>tsearch2</term>
+   <term>pg_trgm</term>
    <listitem>
-    <para>Support for inverted text indexing.  This is much faster for very
-     large, mostly-static sets of documents.
-    </para>
+    <para>Text similarity using trigram matching</para>
    </listitem>
   </varlistentry>
  </variablelist>
index 6bfcac69113468eba9270bf1865df8f96266d420..387e8b8540ac8607241ff09788a520c96ce1bce8 100644 (file)
  <para>
   The <productname>PostgreSQL</productname> source distribution includes
   several examples of index methods implemented using
-  <acronym>GiST</acronym>.  The core system currently provides R-Tree
-  equivalent functionality for some of the built-in geometric data types
+  <acronym>GiST</acronym>.  The core system currently provides text search
+  support (indexing for <type>tsvector</> and <type>tsquery</>) as well as
+  R-Tree equivalent functionality for some of the built-in geometric data types
   (see <filename>src/backend/access/gist/gistproc.c</>).  The following
   <filename>contrib</> modules also contain <acronym>GiST</acronym>
   operator classes: 
    </listitem>
   </varlistentry>
 
+  <varlistentry>
+   <term>hstore</term>
+   <listitem>
+    <para>Module for storing (key, value) pairs</para>
+   </listitem>
+  </varlistentry>
+
   <varlistentry>
    <term>intarray</term>
    <listitem>
     <para>Indexing for <quote>float ranges</quote></para>
    </listitem>
   </varlistentry>
-
-  <varlistentry>
-   <term>tsearch2</term>
-   <listitem>
-    <para>Full text indexing</para>
-   </listitem>
-  </varlistentry>
  </variablelist>
 
 </sect1>
index eea4b8641a25d58a8c5c1bb3bfde6a2e2e22f21d..b10e2c2f395910123ae26e696481134b2f7be976 100644 (file)
@@ -235,8 +235,6 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
 
    (See <xref linkend="functions-geometry"> for the meaning of
    these operators.)
-   Also, an <literal>IS NULL</> condition on
-   an index column can be used with a GiST index.
    Many other GiST operator
    classes are available in the <literal>contrib</> collection or as separate
    projects.  For more information see <xref linkend="GiST">.
@@ -269,10 +267,9 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
 
    (See <xref linkend="functions-array"> for the meaning of
    these operators.)
-   GIN indexes cannot use <literal>IS NULL</> as a search condition.
-   Other GIN operator classes are available in the <literal>contrib</>
-   <literal>tsearch2</literal> and <literal>intarray</literal> modules.
-   For more information see <xref linkend="GIN">.
+   Many other GIN operator
+   classes are available in the <literal>contrib</> collection or as separate
+   projects.  For more information see <xref linkend="GIN">.
   </para>
  </sect1>
 
index 6d61404a4a17b3f3ea5c0303dc36552e162a3c87..63f677a6475142d39cc41882bf1420368df1fc43 100644 (file)
@@ -131,24 +131,24 @@ ORDER BY
  </sect2>
 
  <sect2>
-  <title>Tsearch2 Integration</title>
+  <title>Text Search Integration</title>
   <para>
    Trigram matching is a very useful tool when used in conjunction
-   with a text index created by the Tsearch2 contrib module. (See
-   contrib/tsearch2)
+   with a full text index.
   </para>
   <para>
    The first step is to generate an auxiliary table containing all
-   the unique words in the Tsearch2 index:
+   the unique words in the documents:
   </para>
   <programlisting>
 CREATE TABLE words AS SELECT word FROM 
         stat('SELECT to_tsvector(''simple'', bodytext) FROM documents');
   </programlisting>
   <para>
-   Where 'documents' is a table that has a text field 'bodytext'
-   that TSearch2 is used to search.  The use of the 'simple' dictionary
-   with the to_tsvector function, instead of just using the already
+   where <structname>documents</> is a table that has a text field
+   <structfield>bodytext</> that we wish to search.  The use of the
+   <literal>simple</> configuration with the <function>to_tsvector</>
+   function, instead of just using the already
    existing vector is to avoid creating a list of already stemmed
    words.  This way, only the original, unstemmed words are added
    to the word list.
@@ -174,9 +174,9 @@ CREATE INDEX words_idx ON words USING gin(word gist_trgm_ops);
   <para>
    <note>
     <para>
-     Since the 'words' table has been generated as a separate,
+     Since the <structname>words</> table has been generated as a separate,
      static table, it will need to be periodically regenerated so that
-     it remains up to date with the word list in the Tsearch2 index.
+     it remains up to date with the document collection.
     </para>
    </note>
   </para>
@@ -184,14 +184,14 @@ CREATE INDEX words_idx ON words USING gin(word gist_trgm_ops);
 
  <sect2>
   <title>References</title>
-  <para>
-   Tsearch2 Development Site
-   <ulink url="http://www.sai.msu.su/~megera/postgres/gist/tsearch/V2/"></ulink>
-  </para>
   <para>
    GiST Development Site
    <ulink url="http://www.sai.msu.su/~megera/postgres/gist/"></ulink>
   </para>
+  <para>
+   Tsearch2 Development Site
+   <ulink url="http://www.sai.msu.su/~megera/postgres/gist/tsearch/V2/"></ulink>
+  </para>
  </sect2>
 
  <sect2>
index aa9ae3db3b930533b485c57e8abce323679b68e0..c914759aa82a9edde48bf756743ade25b80d1a58 100644 (file)
@@ -48,7 +48,7 @@ Features
   * User-defined opclasses.  (The scheme is similar to GiST.)
   * Optimized index creation (Makes use of maintenance_work_mem to accumulate
     postings in memory.)
-  * Tsearch2 support via an opclass
+  * Text search support via an opclass
   * Soft upper limit on the returned results set using a GUC variable:
     gin_fuzzy_search_limit