begriffs open source - ai-pg/blob - full-docs/txt/textsearch-configuration.txt

   1
   2 12.7. Configuration Example #
   3
   4    A text search configuration specifies all options necessary to
   5    transform a document into a tsvector: the parser to use to break text
   6    into tokens, and the dictionaries to use to transform each token into a
   7    lexeme. Every call of to_tsvector or to_tsquery needs a text search
   8    configuration to perform its processing. The configuration parameter
   9    default_text_search_config specifies the name of the default
  10    configuration, which is the one used by text search functions if an
  11    explicit configuration parameter is omitted. It can be set in
  12    postgresql.conf, or set for an individual session using the SET
  13    command.
  14
  15    Several predefined text search configurations are available, and you
  16    can create custom configurations easily. To facilitate management of
  17    text search objects, a set of SQL commands is available, and there are
  18    several psql commands that display information about text search
  19    objects (Section 12.10).
  20
  21    As an example we will create a configuration pg, starting by
  22    duplicating the built-in english configuration:
  23 CREATE TEXT SEARCH CONFIGURATION public.pg ( COPY = pg_catalog.english );
  24
  25    We will use a PostgreSQL-specific synonym list and store it in
  26    $SHAREDIR/tsearch_data/pg_dict.syn. The file contents look like:
  27 postgres    pg
  28 pgsql       pg
  29 postgresql  pg
  30
  31    We define the synonym dictionary like this:
  32 CREATE TEXT SEARCH DICTIONARY pg_dict (
  33     TEMPLATE = synonym,
  34     SYNONYMS = pg_dict
  35 );
  36
  37    Next we register the Ispell dictionary english_ispell, which has its
  38    own configuration files:
  39 CREATE TEXT SEARCH DICTIONARY english_ispell (
  40     TEMPLATE = ispell,
  41     DictFile = english,
  42     AffFile = english,
  43     StopWords = english
  44 );
  45
  46    Now we can set up the mappings for words in configuration pg:
  47 ALTER TEXT SEARCH CONFIGURATION pg
  48     ALTER MAPPING FOR asciiword, asciihword, hword_asciipart,
  49                       word, hword, hword_part
  50     WITH pg_dict, english_ispell, english_stem;
  51
  52    We choose not to index or search some token types that the built-in
  53    configuration does handle:
  54 ALTER TEXT SEARCH CONFIGURATION pg
  55     DROP MAPPING FOR email, url, url_path, sfloat, float;
  56
  57    Now we can test our configuration:
  58 SELECT * FROM ts_debug('public.pg', '
  59 PostgreSQL, the highly scalable, SQL compliant, open source object-relational
  60 database management system, is now undergoing beta testing of the next
  61 version of our software.
  62 ');
  63
  64    The next step is to set the session to use the new configuration, which
  65    was created in the public schema:
  66 => \dF
  67    List of text search configurations
  68  Schema  | Name | Description
  69 ---------+------+-------------
  70  public  | pg   |
  71
  72 SET default_text_search_config = 'public.pg';
  73 SET
  74
  75 SHOW default_text_search_config;
  76  default_text_search_config
  77 ----------------------------
  78  public.pg