2024 年 9 月 26 日:PostgreSQL 17 发布!
支持版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3

12.8. 测试和调试文本搜索 #

自定义文本搜索配置的行为很容易变得混乱。本节中描述的函数对测试文本搜索对象很有用。您可以测试完整的配置,或者单独测试解析器和词典。

12.8.1. 配置测试 #

函数 ts_debug 允许轻松测试文本搜索配置。

ts_debug([ config regconfig, ] document text,
         OUT alias text,
         OUT description text,
         OUT token text,
         OUT dictionaries regdictionary[],
         OUT dictionary regdictionary,
         OUT lexemes text[])
         returns setof record

ts_debug 显示关于 document 中由解析器生成并由配置词典处理的每个标记的信息。它使用由 config 指定的配置,如果省略该参数,则使用 default_text_search_config

ts_debug 为解析器在文本中识别的每个标记返回一行。返回的列为

  • alias text — 标记类型的简称

  • description text — 标记类型的描述

  • token text — 标记的文本

  • dictionaries regdictionary[] — 配置为该标记类型选择的词典

  • dictionary regdictionary — 识别标记的词典,如果不存在则为 NULL

  • lexemes text[] — 由识别标记的词典生成的词素(一个或多个),如果不存在则为 NULL;空数组 ({}) 表示它是被识别为停用词

以下是一个简单的例子

SELECT * FROM ts_debug('english', 'a fat  cat sat on a mat - it ate a fat rats');
   alias   |   description   | token |  dictionaries  |  dictionary  | lexemes
-----------+-----------------+-------+----------------+--------------+---------
 asciiword | Word, all ASCII | a     | {english_stem} | english_stem | {}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | fat   | {english_stem} | english_stem | {fat}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | cat   | {english_stem} | english_stem | {cat}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | sat   | {english_stem} | english_stem | {sat}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | on    | {english_stem} | english_stem | {}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | a     | {english_stem} | english_stem | {}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | mat   | {english_stem} | english_stem | {mat}
 blank     | Space symbols   |       | {}             |              |
 blank     | Space symbols   | -     | {}             |              |
 asciiword | Word, all ASCII | it    | {english_stem} | english_stem | {}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | ate   | {english_stem} | english_stem | {ate}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | a     | {english_stem} | english_stem | {}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | fat   | {english_stem} | english_stem | {fat}
 blank     | Space symbols   |       | {}             |              |
 asciiword | Word, all ASCII | rats  | {english_stem} | english_stem | {rat}

为了更广泛的演示,我们首先为英语创建一个 public.english 配置和 Ispell 词典

CREATE TEXT SEARCH CONFIGURATION public.english ( COPY = pg_catalog.english );

CREATE TEXT SEARCH DICTIONARY english_ispell (
    TEMPLATE = ispell,
    DictFile = english,
    AffFile = english,
    StopWords = english
);

ALTER TEXT SEARCH CONFIGURATION public.english
   ALTER MAPPING FOR asciiword WITH english_ispell, english_stem;
SELECT * FROM ts_debug('public.english', 'The Brightest supernovaes');
   alias   |   description   |    token    |         dictionaries          |   dictionary   |   lexemes
-----------+-----------------+-------------+-------------------------------+----------------+-------------
 asciiword | Word, all ASCII | The         | {english_ispell,english_stem} | english_ispell | {}
 blank     | Space symbols   |             | {}                            |                |
 asciiword | Word, all ASCII | Brightest   | {english_ispell,english_stem} | english_ispell | {bright}
 blank     | Space symbols   |             | {}                            |                |
 asciiword | Word, all ASCII | supernovaes | {english_ispell,english_stem} | english_stem   | {supernova}

在此示例中,单词 Brightest 被解析器识别为 ASCII word(别名为 asciiword)。对于这种标记类型,词典列表为 english_ispellenglish_stem。该词被 english_ispell 识别,将其缩减为名词 bright。单词 supernovaesenglish_ispell 词典来说是未知的,因此它被传递到下一个词典,幸运的是,它被识别(事实上,english_stem 是一个 Snowball 词典,它可以识别所有内容;这就是为什么它被放在词典列表的末尾)。

单词 Theenglish_ispell 词典识别为停用词 (第 12.6.1 节),并且不会被索引。空格也被丢弃,因为配置没有为它们提供任何词典。

您可以通过明确指定要查看的列来减少输出的宽度

SELECT alias, token, dictionary, lexemes
FROM ts_debug('public.english', 'The Brightest supernovaes');
   alias   |    token    |   dictionary   |   lexemes
-----------+-------------+----------------+-------------
 asciiword | The         | english_ispell | {}
 blank     |             |                |
 asciiword | Brightest   | english_ispell | {bright}
 blank     |             |                |
 asciiword | supernovaes | english_stem   | {supernova}

12.8.2. 解析器测试 #

以下函数允许直接测试文本搜索解析器。

ts_parse(parser_name text, document text,
         OUT tokid integer, OUT token text) returns setof record
ts_parse(parser_oid oid, document text,
         OUT tokid integer, OUT token text) returns setof record

ts_parse 解析给定的 document 并返回一系列记录,每个记录对应解析器生成的每个标记。每个记录都包含一个 tokid,它显示了分配的标记类型,以及一个 token,它是标记的文本。例如

SELECT * FROM ts_parse('default', '123 - a number');
 tokid | token
-------+--------
    22 | 123
    12 |
    12 | -
     1 | a
    12 |
     1 | number
ts_token_type(parser_name text, OUT tokid integer,
              OUT alias text, OUT description text) returns setof record
ts_token_type(parser_oid oid, OUT tokid integer,
              OUT alias text, OUT description text) returns setof record

ts_token_type 返回一个表,该表描述了指定的解析器可以识别的每种标记类型。对于每种标记类型,该表都会给出解析器用于标记该类型标记的整数 tokid、配置命令中使用的标记类型别名 alias 以及一个简短的 description。例如

SELECT * FROM ts_token_type('default');
 tokid |      alias      |               description
-------+-----------------+------------------------------------------
     1 | asciiword       | Word, all ASCII
     2 | word            | Word, all letters
     3 | numword         | Word, letters and digits
     4 | email           | Email address
     5 | url             | URL
     6 | host            | Host
     7 | sfloat          | Scientific notation
     8 | version         | Version number
     9 | hword_numpart   | Hyphenated word part, letters and digits
    10 | hword_part      | Hyphenated word part, all letters
    11 | hword_asciipart | Hyphenated word part, all ASCII
    12 | blank           | Space symbols
    13 | tag             | XML tag
    14 | protocol        | Protocol head
    15 | numhword        | Hyphenated word, letters and digits
    16 | asciihword      | Hyphenated word, all ASCII
    17 | hword           | Hyphenated word, all letters
    18 | url_path        | URL path
    19 | file            | File or path name
    20 | float           | Decimal notation
    21 | int             | Signed integer
    22 | uint            | Unsigned integer
    23 | entity          | XML entity

12.8.3. 词典测试 #

函数 ts_lexize 有助于词典测试。

ts_lexize(dict regdictionary, token text) returns text[]

ts_lexize 如果输入 token 被词典识别,则返回一个词素数组;如果标记被词典识别,但它是停用词,则返回一个空数组;如果它是未知词,则返回 NULL

示例

SELECT ts_lexize('english_stem', 'stars');
 ts_lexize
-----------
 {star}

SELECT ts_lexize('english_stem', 'a');
 ts_lexize
-----------
 {}

注意

函数 ts_lexize 期望一个单个 token,而不是文本。以下情况可能会令人困惑

SELECT ts_lexize('thesaurus_astro', 'supernovae stars') is null;
 ?column?
----------
 t

同义词词典 thesaurus_astro 确实知道短语 supernovae stars,但 ts_lexize 失败,因为它没有解析输入文本,而是将其视为单个标记。使用 plainto_tsqueryto_tsvector 来测试同义词词典,例如

SELECT plainto_tsquery('supernovae stars');
 plainto_tsquery
-----------------
 'sn'

提交更正

如果您在文档中发现任何不正确的内容、与您对特定功能的体验不符的内容或需要进一步澄清的内容,请使用 此表格 报告文档问题。