Re: Updated tsearch documentation - Mailing list pgsql-hackers

Oleg Bartunov wrote:
> On Wed, 20 Jun 2007, Bruce Momjian wrote:
> >>
> >> We need to decide if we need oids as user-visible argument. I don't see
> >> any value, probably Teodor think other way.
> >
> > This is a good time to clean up the API because there are going to be
> > user-visible changes anyway.
>
> Bruce, just remove oid argument specification from documentation.

Done.  I am attaching the current function prototypes.  If they don't
match the C code, please let me know.

I have also updated with some minor corrections I received from Erik.  I
will be adding more to the documentation hopefully this week:

    http://momjian.us/expire/fulltext/HTML/

--
  Bruce Momjian  <bruce@momjian.us>          http://momjian.us
  EnterpriseDB                               http://www.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +
*** /pgsgml/fulltext-opfunc.sgml    Sat Jun 16 23:30:11 2007
--- fulltext-opfunc.sgml    Mon Jul  2 21:17:15 2007
***************
*** 141,147 ****

  <term>
  <synopsis>
! to_tsvector(<optional><replaceable class="PARAMETER">configuration</replaceable>,</optional>  <replaceable
class="PARAMETER">document</replaceable>TEXT) returns TSVECTOR 
  </synopsis>
  </term>

--- 141,147 ----

  <term>
  <synopsis>
! to_tsvector(<optional><replaceable class="PARAMETER">conf_name</replaceable></optional>,  <replaceable
class="PARAMETER">document</replaceable>TEXT) returns TSVECTOR 
  </synopsis>
  </term>

***************
*** 285,306 ****

  <term>
  <synopsis>
! tsearch(<replaceable class="PARAMETER">vector_column_name</replaceable><optional>, (<replaceable
class="PARAMETER">my_filter_name</replaceable>| <replaceable class="PARAMETER">text_column_name1</replaceable>)
<optional>...</optional></optional>, <replaceable class="PARAMETER">text_column_nameN</replaceable>) 
  </synopsis>
  </term>

***************
*** 323,329 ****

  <term>
  <synopsis>
! stat(<replaceable class="PARAMETER">sqlquery</replaceable> text <optional>, weight text </optional>) returns SETOF
statinfo
  </synopsis>

  <listitem>
--- 322,328 ----

  <term>
  <synopsis>
! stat(<optional><replaceable class="PARAMETER">sqlquery</replaceable> text </optional>, weight text </optional>)
returnsSETOF statinfo 
  </synopsis>

  <listitem>
***************
*** 403,409 ****

  <term>
  <synopsis>
! to_tsquery(<optional><replaceable class="PARAMETER">configuration</replaceable>,</optional> <replaceable
class="PARAMETER">querytext</replaceable>text) returns TSQUERY 
  </synopsis>
  </term>

--- 402,408 ----

  <term>
  <synopsis>
! to_tsquery(<optional><replaceable class="PARAMETER">conf_name</replaceable></optional>, <replaceable
class="PARAMETER">querytext</replaceable>text) returns TSQUERY 
  </synopsis>
  </term>

***************
*** 446,452 ****

  <term>
  <synopsis>
! plainto_tsquery(<optional><replaceable class="PARAMETER">configuration</replaceable>,</optional>  <replaceable
class="PARAMETER">querytext</replaceable>text) returns TSQUERY 
  </synopsis>
  </term>

--- 445,451 ----

  <term>
  <synopsis>
! plainto_tsquery(<optional><replaceable class="PARAMETER">conf_name</replaceable></optional>,  <replaceable
class="PARAMETER">querytext</replaceable>text) returns TSQUERY 
  </synopsis>
  </term>

***************
*** 989,995 ****

  <term>
  <synopsis>
! rank(<optional> <replaceable class="PARAMETER">weights</replaceable> float4[], </optional> <replaceable
class="PARAMETER">vector</replaceable>TSVECTOR, <replaceable class="PARAMETER">query</replaceable> TSQUERY, <optional>
<replaceableclass="PARAMETER">normalization</replaceable> int4 </optional>) returns float4 
  </synopsis>
  </term>

--- 988,994 ----

  <term>
  <synopsis>
! rank(<optional> <replaceable class="PARAMETER">weights</replaceable> float4[]</optional>, <replaceable
class="PARAMETER">vector</replaceable>TSVECTOR, <replaceable class="PARAMETER">query</replaceable> TSQUERY, <optional>
<replaceableclass="PARAMETER">normalization</replaceable> int4 </optional>) returns float4 
  </synopsis>
  </term>

***************
*** 1084,1090 ****

  <term>
  <synopsis>
! headline(<optional> <replaceable class="PARAMETER">id</replaceable> int4, | <replaceable
class="PARAMETER">ts_name</replaceable>text, </optional> <replaceable class="PARAMETER">document</replaceable> text,
<replaceableclass="PARAMETER">query</replaceable> TSQUERY, <optional> <replaceable
class="PARAMETER">options</replaceable>text </optional>) returns text 
  </synopsis>
  </term>

--- 1083,1089 ----

  <term>
  <synopsis>
! headline(<optional> <replaceable class="PARAMETER">ts_name</replaceable> text</optional>, <replaceable
class="PARAMETER">document</replaceable>text, <replaceable class="PARAMETER">query</replaceable> TSQUERY, <optional>
<replaceableclass="PARAMETER">options</replaceable> text </optional>) returns text 
  </synopsis>
  </term>

***************
*** 1351,1357 ****

  <term>
  <synopsis>
! lexize(<optional> <replaceable class="PARAMETER">oid</replaceable>, | <replaceable
class="PARAMETER">dict_name</replaceable>text, <replaceable class="PARAMETER">lexeme</replaceable> text) returns text[] 
  </synopsis>
  </term>

--- 1350,1356 ----

  <term>
  <synopsis>
! lexize(<optional> <replaceable class="PARAMETER">dict_name</replaceable> text</optional>, <replaceable
class="PARAMETER">lexeme</replaceable>text) returns text[] 
  </synopsis>
  </term>

***************
*** 1858,1878 ****
  <title>Debugging</title>

  <para>
! Function <function>ts_debug</function> allows easy testing of your full text indexing
  configuration.
  </para>

  <synopsis>
! ts_debug(<optional><replaceable class="PARAMETER">cfgname</replaceable> | <replaceable
class="PARAMETER">oid</replaceable></optional>,<replaceable class="PARAMETER">document</replaceable> TEXT) returns
SETOFtsdebug 
  </synopsis>

  <para>
--- 1852,1870 ----
  <title>Debugging</title>

  <para>
! Function <function>ts_debug</function> allows easy testing of your full text searching
  configuration.
  </para>

  <synopsis>
! ts_debug(<optional><replaceable class="PARAMETER">conf_name</replaceable></optional>, <replaceable
class="PARAMETER">document</replaceable>TEXT) returns SETOF tsdebug 
  </synopsis>