Skip to content

Commit

Permalink
Add websearch_to_tsquery doc (PostgREST#226)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eduardo Jorge authored and steve-chavez committed Jul 24, 2019
1 parent 59816e6 commit 5ad1afb
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ is checking for exact equality (null,true,false) :code:`IS`
fts :ref:`fts` using to_tsquery :code:`@@`
plfts :ref:`fts` using plainto_tsquery :code:`@@`
phfts :ref:`fts` using phraseto_tsquery :code:`@@`
wfts :ref:`fts` using websearch_to_tsquery :code:`@@`
cs contains e.g. :code:`?tags=cs.{example, new}` :code:`@>`
cd contained in e.g. :code:`?values=cd.{1,2,3}` :code:`<@`
ov overlap (have points in common), :code:`&&`
Expand Down Expand Up @@ -132,8 +133,14 @@ The :code:`fts` filter mentioned above has a number of options to support flexib
GET /tsearch?my_tsv=not.phfts(english).The%20Fat%20Cats HTTP/1.1
.. code-block:: http
GET /tsearch?my_tsv=not.wfts(french).amusant HTTP/1.1
Using phrase search mode requires PostgreSQL of version at least 9.6 and will raise an error in earlier versions of the database.

Using `websearch_to_tsquery` requires PostgreSQL of version at least 11.0 and will raise an error in earlier versions of the database.

.. _v_filter:

Vertical Filtering (Columns)
Expand Down

0 comments on commit 5ad1afb

Please sign in to comment.