Full-Text Search in PostgreSQL: A Gentle Introduction
Prev	Fast Backward	Chapter 2. FTS Operators and Functions	Fast Forward	Next

2.11. Psql support

Information about FTS objects can be obtained in psql using a set of commands

\dF{,d,p}[+] [PATTERN]

Optional + used to produce more details.

Optional parameter PATTERN is a name (can be schema-qualified) of the FTS object. If PATTERN is not specified, then information about default object (configuration, parser, dictionaries) will be displayed. Visibility of FTS objects conforms PostgreSQL rule. PATTERN can be a regular expression and should apply separately to schema name and object name. Following examples illustrate this.

=# \dF *fts*
       List of fulltext configurations
 Schema |  Name   |   Locale    | Description
--------+---------+-------------+-------------
 public | fts_cfg | ru_RU.UTF-8 |

=# \dF *.fts*
       List of fulltext configurations
 Schema |  Name   |   Locale    | Description
--------+---------+-------------+-------------
 fts    | fts_cfg | ru_RU.UTF-8 |
 public | fts_cfg | ru_RU.UTF-8 |

\dF[+] [PATTERN]

List full-text configurations (add "+" for more detail)

By default (without PATTERN), information about all visible full-text configurations will be displayed.

=# \dF russian_utf8
                               List of fulltext configurations
   Schema   |     Name     |   Locale    | Default |               Description
------------+--------------+-------------+---------+-----------------------------------------
 pg_catalog | russian_utf8 | ru_RU.UTF-8 | Y       | default configuration for Russian/UTF-8

=# \dF+ russian_utf8
Configuration "pg_catalog.russian_utf8"
Parser name: "pg_catalog.default"
Locale: 'ru_RU.UTF-8' (default)
    Token     |      Dictionaries
--------------+-------------------------
 email        | pg_catalog.simple
 file         | pg_catalog.simple
 float        | pg_catalog.simple
 host         | pg_catalog.simple
 hword        | pg_catalog.ru_stem_utf8
 int          | pg_catalog.simple
 lhword       | public.tz_simple
 lpart_hword  | public.tz_simple
 lword        | public.tz_simple
 nlhword      | pg_catalog.ru_stem_utf8
 nlpart_hword | pg_catalog.ru_stem_utf8
 nlword       | pg_catalog.ru_stem_utf8
 part_hword   | pg_catalog.simple
 sfloat       | pg_catalog.simple
 uint         | pg_catalog.simple
 uri          | pg_catalog.simple
 url          | pg_catalog.simple
 version      | pg_catalog.simple
 word         | pg_catalog.ru_stem_utf8

\dFd[+] [PATTERN]

List full-text dictionaries (add "+" for more detail).

By default (without PATTERN), information about all visible dictionaries will be displayed.

postgres=# \dFd
                                 List of fulltext dictionaries
   Schema   |         Name          |                        Description
------------+-----------------------+-----------------------------------------------------------
 pg_catalog | danish_iso_8859_1     | Snowball stemmer
 pg_catalog | danish_utf_8          | Snowball stemmer
 pg_catalog | dutch_iso_8859_1      | Snowball stemmer
 pg_catalog | dutch_utf_8           | Snowball stemmer
 pg_catalog | en_stem               | English stemmer. Snowball.
 pg_catalog | finnish_iso_8859_1    | Snowball stemmer
 pg_catalog | finnish_utf_8         | Snowball stemmer
 pg_catalog | french_iso_8859_1     | Snowball stemmer
 pg_catalog | french_utf_8          | Snowball stemmer
 pg_catalog | german_iso_8859_1     | Snowball stemmer
 pg_catalog | german_utf_8          | Snowball stemmer
 pg_catalog | hungarian_iso_8859_1  | Snowball stemmer
 pg_catalog | hungarian_utf_8       | Snowball stemmer
 pg_catalog | ispell_template       | Ispell dictionary template
 pg_catalog | italian_iso_8859_1    | Snowball stemmer
 pg_catalog | italian_utf_8         | Snowball stemmer
 pg_catalog | norwegian_iso_8859_1  | Snowball stemmer
 pg_catalog | norwegian_utf_8       | Snowball stemmer
 pg_catalog | portuguese_iso_8859_1 | Snowball stemmer
 pg_catalog | portuguese_utf_8      | Snowball stemmer
 pg_catalog | ru_stem_koi8          | KOI-8 russian stemmer. Snowball.
 pg_catalog | ru_stem_utf8          | UTF-8 russian stemmer. Snowball.
 pg_catalog | ru_stem_win1251       | WIN1251 russian stemmer. Snowball.
 pg_catalog | simple                | simple dictionary: just lower case and check for stopword
 pg_catalog | spanish_iso_8859_1    | Snowball stemmer
 pg_catalog | spanish_utf_8         | Snowball stemmer
.......................................................
 pg_catalog | synonym               | synonym dictionary: replace word by its synonym
 pg_catalog | thesaurus_template    | Thesaurus template. Phrase by phrase substitution

\dFp[+] [PATTERN]

List full-text parsers (add "+" for more detail)

By default (without PATTERN), information about all visible full-text parsers will be displayed.

postgres=# \dFp
          List of fulltext parsers
   Schema   |  Name   |     Description
------------+---------+---------------------
 pg_catalog | default | default word parser
(1 row)
postgres=# \dFp+
            Fulltext parser "pg_catalog.default"
      Method       |         Function          | Description
-------------------+---------------------------+-------------
 Start parse       | pg_catalog.prsd_start     |
 Get next token    | pg_catalog.prsd_nexttoken |
 End parse         | pg_catalog.prsd_end       |
 Get headline      | pg_catalog.prsd_headline  |
 Get lexeme's type | pg_catalog.prsd_lextype   |

  Token's types for parser "pg_catalog.default"
  Token name  |            Description
--------------+-----------------------------------
 blank        | Space symbols
 email        | Email
 entity       | HTML Entity
 file         | File or path name
 float        | Decimal notation
 host         | Host
 hword        | Hyphenated word
 int          | Signed integer
 lhword       | Latin hyphenated word
 lpart_hword  | Latin part of hyphenated word
 lword        | Latin word
 nlhword      | Non-latin hyphenated word
 nlpart_hword | Non-latin part of hyphenated word
 nlword       | Non-latin word
 part_hword   | Part of hyphenated word
 protocol     | Protocol head
 sfloat       | Scientific notation
 tag          | HTML Tag
 uint         | Unsigned integer
 uri          | URI
 url          | URL
 version      | VERSION
 word         | Word
(23 rows)

Prev	Home	Next
Debugging	Up	FTS Reference