PostgreSQL 教程

Appearance

9.13. 文本搜索函数和运算符# ​

表 9.42、表 9.43和表 9.44总结了全文搜索提供的函数和运算符。有关PostgreSQL文本搜索工具的详细说明，请参阅第 12 章。

表 9.42. 文本搜索运算符

运算符

说明

示例

tsvector @@ tsquery → boolean

tsquery @@ tsvector → boolean

tsvector 是否匹配 tsquery？（参数可以按任何顺序给出。）

to_tsvector('fat cats ate rats') @@ to_tsquery('cat & rat') → t

text @@ tsquery → boolean

隐式调用 to_tsvector() 后的文本字符串是否匹配 tsquery？

'fat cats ate rats' @@ to_tsquery('cat & rat') → t

tsvector @@@ tsquery → boolean

tsquery @@@ tsvector → boolean

这是 @@ 的弃用同义词。

to_tsvector('fat cats ate rats') @@@ to_tsquery('cat & rat') → t

tsvector || tsvector → tsvector

连接两个 tsvector。如果两个输入都包含词素位置，则第二个输入的位置将相应调整。

'a:1 b:2'::tsvector || 'c:1 d:2 b:3'::tsvector → 'a':1 'b':2,5 'c':3 'd':4

tsquery && tsquery → tsquery

将两个 tsquery 连接成 AND，生成一个匹配同时匹配两个输入查询的文档的查询。

'fat | rat'::tsquery && 'cat'::tsquery → ( 'fat' | 'rat' ) & 'cat'

tsquery || tsquery → tsquery

将两个 tsquery 组合在一起，生成一个查询，该查询匹配与任一输入查询匹配的文档。

'fat | rat'::tsquery || 'cat'::tsquery → 'fat' | 'rat' | 'cat'

!! tsquery → tsquery

否定 tsquery，生成一个查询，该查询匹配与输入查询不匹配的文档。

!! 'cat'::tsquery → !'cat'

tsquery <-> tsquery → tsquery

构造一个短语查询，如果两个输入查询在连续词素处匹配，则匹配。

to_tsquery('fat') <-> to_tsquery('rat') → 'fat' <-> 'rat'

tsquery @> tsquery → boolean

第一个 tsquery 是否包含第二个？（这仅考虑一个查询中出现的词素是否全部出现在另一个查询中，而忽略组合运算符。）

'cat'::tsquery @> 'cat & rat'::tsquery → f

tsquery <@ tsquery → boolean

第一个 tsquery 是否包含在第二个中？（这仅考虑一个查询中出现的词素是否全部出现在另一个查询中，而忽略组合运算符。）

'cat'::tsquery <@ 'cat & rat'::tsquery → t

'cat'::tsquery <@ '!cat & rat'::tsquery → t

除了这些专门的运算符之外，表 9.1中显示的常用比较运算符也可用于tsvector和tsquery类型。这些对于文本搜索并不是很有用，但允许在这些类型的列上构建唯一索引。

表 9.43 文本搜索函数

函数

说明

示例

array_to_tsvector ( text[] ) → tsvector

将文本字符串数组转换为 tsvector。给定的字符串按原样用作词素，无需进一步处理。数组元素不能是空字符串或 NULL。

array_to_tsvector('{fat,cat,rat}'::text[]) → 'cat' 'fat' 'rat'

get_current_ts_config ( ) → regconfig

返回当前默认文本搜索配置的 OID（由 default_text_search_config 设置）。

get_current_ts_config() → english

length ( tsvector ) → integer

返回 tsvector 中的词素数。

length('fat:2,4 cat:3 rat:5A'::tsvector) → 3

numnode ( tsquery ) → integer

返回 tsquery 中的词素和运算符数。

numnode('(fat & rat) | cat'::tsquery) → 5

plainto_tsquery ( [ config regconfig, ] query text ) → tsquery

根据指定配置或默认配置对单词进行规范化，将文本转换为 tsquery。字符串中的所有标点符号都将被忽略（它不确定查询运算符）。结果查询匹配包含文本中所有非停用词的文档。

plainto_tsquery('english', 'The Fat Rats') → 'fat' & 'rat'

phraseto_tsquery ( [ config regconfig, ] query text ) → tsquery

根据指定配置或默认配置对单词进行规范化，将文本转换为 tsquery。字符串中的所有标点符号都将被忽略（它不确定查询运算符）。结果查询匹配包含文本中所有非停用词的短语。

phraseto_tsquery('english', 'The Fat Rats') → 'fat' <-> 'rat'

phraseto_tsquery('english', 'The Cat and Rats') → 'cat' <2> 'rat'

websearch_to_tsquery ( [ config regconfig, ] query text ) → tsquery

根据指定或默认配置对单词进行规范化，将文本转换为 tsquery。带引号的单词序列将转换为短语测试。单词 “or” 被理解为生成 OR 运算符，破折号生成 NOT 运算符；其他标点符号将被忽略。这近似于一些常见网络搜索工具的行为。

websearch_to_tsquery('english', '"fat rat" or cat dog') → 'fat' <-> 'rat' | 'cat' & 'dog'

querytree ( tsquery ) → text

生成 tsquery 可索引部分的表示形式。如果结果为空或仅为 T，则表示非可索引查询。

querytree('foo & ! bar'::tsquery) → 'foo'

setweight ( vector tsvector, weight "char" ) → tsvector

将指定的 weight 分配给 vector 的每个元素。

setweight('fat:2,4 cat:3 rat:5B'::tsvector, 'A') → 'cat':3A 'fat':2A,4A 'rat':5A

setweight ( vector tsvector, weight "char", lexemes text[] ) → tsvector

将指定的 weight 分配给 vector 中列在 lexemes 中的元素。lexemes 中的字符串被视为原样词素，无需进一步处理。与 vector 中的任何词素不匹配的字符串将被忽略。

setweight('fat:2,4 cat:3 rat:5,6B'::tsvector, 'A', '{cat,rat}') → 'cat':3A 'fat':2,4 'rat':5A,6A

strip ( tsvector ) → tsvector

从 tsvector 中移除位置和权重。

strip('fat:2,4 cat:3 rat:5A'::tsvector) → 'cat' 'fat' 'rat'

to_tsquery ( [ config regconfig, ] query text ) → tsquery

根据指定的或默认配置对单词进行规范化，将文本转换为 tsquery。这些单词必须通过有效的 tsquery 运算符进行组合。

to_tsquery('english', 'The & Fat & Rats') → 'fat' & 'rat'

to_tsvector ( [ config regconfig, ] document text ) → tsvector

根据指定的或默认配置对单词进行规范化，将文本转换为 tsvector。结果中包含位置信息。

to_tsvector('english', 'The Fat Rats') → 'fat':2 'rat':3

to_tsvector ( [ config regconfig, ] document json ) → tsvector

to_tsvector ( [ config regconfig, ] document jsonb ) → tsvector

将 JSON 文档中的每个字符串值转换为 tsvector，根据指定的或默认配置对单词进行规范化。然后按文档顺序连接结果以生成输出。位置信息生成方式如下：每对字符串值之间存在一个停用词。（请注意，当输入为 jsonb 时，JSON 对象字段的““文档顺序””取决于实现；请注意示例中的差异。）

to_tsvector('english', '{"aa": "The Fat Rats", "b": "dog"}'::json) → 'dog':5 'fat':2 'rat':3

to_tsvector('english', '{"aa": "The Fat Rats", "b": "dog"}'::jsonb) → 'dog':1 'fat':4 'rat':5

json_to_tsvector ( [ config regconfig, ] document json, filter jsonb ) → tsvector

jsonb_to_tsvector ( [ config regconfig, ] document jsonb, filter jsonb ) → tsvector

根据 filter 请求 JSON 文档中的每个项目，并将每个项目转换为 tsvector，根据指定或默认配置对单词进行规范化。然后按文档顺序连接结果以生成输出。位置信息生成方式如下：在每对选定项目之间存在一个停用词。（请注意，当输入为 jsonb 时，JSON 对象字段的“文档顺序”取决于实现。）filter 必须是一个 jsonb 数组，其中包含以下零个或多个关键字："string"（包含所有字符串值），"numeric"（包含所有数字值），"boolean"（包含所有布尔值），"key"（包含所有键）或 "all"（包含以上所有内容）。作为特殊情况，filter 还可以是这些关键字之一的简单 JSON 值。

json_to_tsvector('english', '{"a": "The Fat Rats", "b": 123}'::json, '["string", "numeric"]') → '123':5 'fat':2 'rat':3

json_to_tsvector('english', '{"cat": "The Fat Rats", "dog": 123}'::json, '"all"') → '123':9 'cat':1 'dog':7 'fat':4 'rat':5

ts_delete ( vector tsvector, lexeme text ) → tsvector

从 vector 中删除给定 lexeme 的任何出现。将 lexeme 字符串视为一个词素，无需进一步处理。

ts_delete('fat:2,4 cat:3 rat:5A'::tsvector, 'fat') → 'cat':3 'rat':5A

ts_delete ( vector tsvector, lexemes text[] ) → tsvector

从 vector 中删除 lexemes 中词素的任何出现。将 lexemes 中的字符串视为词素，无需进一步处理。不匹配 vector 中任何词素的字符串将被忽略。

ts_delete('fat:2,4 cat:3 rat:5A'::tsvector, ARRAY['fat','rat']) → 'cat':3

ts_filter ( vector tsvector, weights "char"[] ) → tsvector

仅从 vector 中选择具有给定 weights 的元素。

ts_filter('fat:2,4 cat:3b,7c rat:5A'::tsvector, '{a,b}') → 'cat':3B 'rat':5A

ts_headline ( [ config regconfig, ] document text, query tsquery [, options text ] ) → text

以缩略形式显示 document 中 query 的匹配项，document 必须是原始文本，而不是 tsvector。匹配查询之前，文档中的单词会根据指定或默认配置进行规范化。有关此函数的用法，请参阅 第 12.3.4 节，其中还介绍了可用的 options。

ts_headline('The fat cat ate the rat.', 'cat') → The fat <b>cat</b> ate the rat.

ts_headline ( [ config regconfig, ] document json, query tsquery [, options text ] ) → text

ts_headline ( [ config regconfig, ] document jsonb, query tsquery [, options text ] ) → text

以缩略形式显示 JSON document 中字符串值中出现的 query 的匹配项。有关更多详细信息，请参阅 第 12.3.4 节。

ts_headline('{"cat":"raining cats and dogs"}'::jsonb, 'cat') → {"cat": "raining <b>cats</b> and dogs"}

ts_rank ( [ weights real[], ] vector tsvector, query tsquery [, normalization integer ] ) → real

计算一个分数，显示 vector 与 query 的匹配程度。有关详细信息，请参阅 第 12.3.3 节。

ts_rank(to_tsvector('raining cats and dogs'), 'cat') → 0.06079271

ts_rank_cd ( [ weights real[], ] vector tsvector, query tsquery [, normalization integer ] ) → real

计算一个分数，显示 vector 与 query 的匹配程度，使用覆盖密度算法。有关详细信息，请参阅 第 12.3.3 节。

ts_rank_cd(to_tsvector('raining cats and dogs'), 'cat') → 0.1

ts_rewrite ( query tsquery, target tsquery, substitute tsquery ) → tsquery

在 query 中用 substitute 替换 target 的出现。有关详细信息，请参阅 第 12.4.2.1 节。

ts_rewrite('a & b'::tsquery, 'a'::tsquery, 'foo|bar'::tsquery) → 'b' & ( 'foo' | 'bar' )

ts_rewrite ( query tsquery, select text ) → tsquery

根据通过执行 SELECT 命令获得的目标和替换，替换 query 的部分。有关详细信息，请参阅 第 12.4.2.1 节。

SELECT ts_rewrite('a & b'::tsquery, 'SELECT t,s FROM aliases') → 'b' & ( 'foo' | 'bar' )

tsquery_phrase ( query1 tsquery, query2 tsquery ) → tsquery

构造一个短语查询，搜索 query1 和 query2 在连续词素（与 <-> 运算符相同）中的匹配项。

tsquery_phrase(to_tsquery('fat'), to_tsquery('cat')) → 'fat' <-> 'cat'

tsquery_phrase ( query1 tsquery, query2 tsquery, distance integer ) → tsquery

构造一个短语查询，搜索 query1 和 query2 的匹配项，这些匹配项正好相隔 distance 个词素。

tsquery_phrase(to_tsquery('fat'), to_tsquery('cat'), 10) → 'fat' <10> 'cat'

tsvector_to_array ( tsvector ) → text[]

将 tsvector 转换为词素数组。

tsvector_to_array('fat:2,4 cat:3 rat:5A'::tsvector) → {cat,fat,rat}

unnest ( tsvector ) → setof record ( lexeme text, positions smallint[], weights text )

将 tsvector 扩展为一组行，每行一个词素。

select * from unnest('cat:3 fat:2,4 rat:5A'::tsvector) →

 lexeme | positions | weights
--------+-----------+---------
 cat    | {3}       | {D}
 fat    | {2,4}     | {D,D}
 rat    | {5}       | {A}

注意

所有接受可选regconfig参数的文本搜索函数在省略该参数时将使用default_text_search_config指定的配置。

表 9.44中的函数单独列出，因为它们通常不用于日常文本搜索操作。它们主要有助于新文本搜索配置的开发和调试。

表 9.44. 文本搜索调试函数

函数

说明

示例

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

根据指定或默认的文本搜索配置从 document 中提取和规范化标记，并返回有关如何处理每个标记的信息。有关详细信息，请参见 第 12.8.1 节。

ts_debug('english', 'The Brightest supernovaes') → (asciiword,"Word, all ASCII",The,{english_stem},english_stem,{}) ...

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

如果输入标记为词典所知，则返回替换词素数组；如果标记为词典所知但为停用词，则返回空数组；如果为未知单词，则返回 NULL。有关详细信息，请参见第 12.8.3 节。

ts_lexize('english_stem', 'stars') → {star}

ts_parse ( parser_name text, document text ) → setof record ( tokid integer, token text )

使用指定名称的解析器从document中提取标记。有关详细信息，请参见第 12.8.2 节。

ts_parse('default', 'foo - bar') → (1,foo) ...

ts_parse ( parser_oid oid, document text ) → setof record ( tokid integer, token text )

使用由 OID 指定的解析器从document中提取标记。有关详细信息，请参见第 12.8.2 节。

ts_parse(3722, 'foo - bar') → (1,foo) ...

ts_token_type ( parser_name text ) → setof record ( tokid integer, alias text, description text )

返回一个表，描述指定名称的解析器可以识别的每种标记类型。有关详细信息，请参见第 12.8.2 节。

ts_token_type('default') → (1,asciiword,"Word, all ASCII") ...

ts_token_type ( parser_oid oid ) → setof record ( tokid integer, alias text, description text )

返回一个表，描述 OID 指定的解析器可以识别的每种类型的标记。有关详细信息，请参见 第 12.8.2 节。

ts_token_type(3722) → (1,asciiword,"Word, all ASCII") ...

ts_stat ( sqlquery text [, weights text ] ) → setof record ( word text, ndoc integer, nentry integer )

执行 sqlquery，它必须返回一个 tsvector 列，并返回数据中包含的每个不同词素的统计信息。有关详细信息，请参见 第 12.4.4 节。

ts_stat('SELECT vector FROM apod') → (foo,10,15) ...