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

9.13. 文本搜索函数和操作符 #

表 9.42表 9.43表 9.44 总结了为全文搜索提供的函数和操作符。有关 PostgreSQL 文本搜索功能的详细解释,请参阅 第 12 章

表 9.42. 文本搜索操作符

运算符

描述

示例

tsvector @@ tsqueryboolean

tsquery @@ tsvectorboolean

是否 tsvector 匹配 tsquery?(参数可以按任意顺序给出。)

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

text @@ tsqueryboolean

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

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

tsvector || tsvectortsvector

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

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

tsquery && tsquerytsquery

将两个 tsquery 进行 AND 操作,产生一个匹配两个输入查询的文档的查询。

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

tsquery || tsquerytsquery

将两个 tsquery 进行 OR 操作,产生一个匹配任一输入查询的文档的查询。

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

!! tsquerytsquery

否定一个 tsquery,产生一个匹配不匹配输入查询的文档的查询。

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

tsquery <-> tsquerytsquery

构建一个短语查询,当两个输入查询在连续的词位上匹配时,该查询将匹配。

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

tsquery @> tsqueryboolean

第一个 tsquery 是否包含第二个?(这仅考虑一个查询中出现的所有词位是否出现在另一个查询中,忽略组合操作符。)

'cat'::tsquery @> 'cat & rat'::tsqueryf

tsquery <@ tsqueryboolean

第一个 tsquery 是否包含在第二个中?(这仅考虑一个查询中出现的所有词位是否出现在另一个查询中,忽略组合操作符。)

'cat'::tsquery <@ 'cat & rat'::tsqueryt

'cat'::tsquery <@ '!cat & rat'::tsqueryt


除了这些专用操作符之外,表 9.1 中显示的常用比较操作符也可用于 tsvectortsquery 类型。这些操作符对于文本搜索用处不大,但允许例如在这些类型的列上构建唯一索引。

表 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

vector 的每个元素分配指定的 weight

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

vector 中列在 lexemes 中的元素分配指定的 weightlexemes 中的字符串将按原样用作词位,无需进一步处理。与 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

以摘要形式显示 querydocument 中的匹配项,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

计算一个分数,显示 vectorquery 的匹配程度。有关详细信息,请参阅 第 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

使用覆盖密度算法计算一个分数,显示 vectorquery 的匹配程度。有关详细信息,请参阅 第 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 命令获得的 targetsubstitute 来替换 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

构建一个短语查询,搜索 query1query2 在连续词位上的匹配(与 <-> 操作符相同)。

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

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

构建一个短语查询,搜索 query1query2 相距正好 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) ...


提交更正

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