9.13. Text Search Functions and Operators
Prev	Up	Chapter 9. Functions and Operators	Home	Next

9.13. Text Search Functions and Operators

Table 9.37, Table 9.38 and Table 9.39 summarize the functions and operators that are provided for full text searching. See Chapter 12 for a detailed explanation of Postgres Pro's text search facility.

Table 9.37. Text Search Operators

Operator	Description	Example	Result
`@@`	`tsvector` matches `tsquery` ?	`to_tsvector('fat cats ate rats') @@ to_tsquery('cat & rat')`	`t`
`@@@`	deprecated synonym for `@@`	`to_tsvector('fat cats ate rats') @@@ to_tsquery('cat & rat')`	`t`
`\|\|`	concatenate `tsvector`s	`'a:1 b:2'::tsvector \|\| 'c:1 d:2 b:3'::tsvector`	`'a':1 'b':2,5 'c':3 'd':4`
`&&`	AND `tsquery`s together	`'fat \| rat'::tsquery && 'cat'::tsquery`	`( 'fat' \| 'rat' ) & 'cat'`
`\|\|`	OR `tsquery`s together	`'fat \| rat'::tsquery \|\| 'cat'::tsquery`	`( 'fat' \| 'rat' ) \| 'cat'`
`!!`	negate a `tsquery`	`!! 'cat'::tsquery`	`!'cat'`
`<->`	`tsquery` followed by `tsquery`	`to_tsquery('fat') <-> to_tsquery('rat')`	`'fat' <-> 'rat'`
`@>`	`tsquery` contains another ?	`'cat'::tsquery @> 'cat & rat'::tsquery`	`f`
`<@`	`tsquery` is contained in ?	`'cat'::tsquery <@ 'cat & rat'::tsquery`	`t`

Note

The tsquery containment operators consider only the lexemes listed in the two queries, ignoring the combining operators.

In addition to the operators shown in the table, the ordinary B-tree comparison operators (=, <, etc) are defined for types tsvector and tsquery. These are not very useful for text searching but allow, for example, unique indexes to be built on columns of these types.

Table 9.38. Text Search Functions

Function	Return Type	Description	Example	Result
`get_current_ts_config()`	`regconfig`	get default text search configuration	`get_current_ts_config()`	`english`
`length(tsvector)`	`integer`	number of lexemes in `tsvector`	`length('fat:2,4 cat:3 rat:5A'::tsvector)`	`3`
`numnode(tsquery)`	`integer`	number of lexemes plus operators in `tsquery`	`numnode('(fat & rat) \| cat'::tsquery)`	`5`
`plainto_tsquery([configregconfig , ] querytext)`	`tsquery`	produce `tsquery` ignoring punctuation	`plainto_tsquery('english', 'The Fat Rats')`	`'fat' & 'rat'`
`phraseto_tsquery([configregconfig , ] querytext)`	`tsquery`	produce `tsquery` ignoring punctuation	`phraseto_tsquery('english', 'The Fat Rats')`	`'fat' <-> 'rat'`
`querytree(querytsquery)`	`text`	get indexable part of a `tsquery`	`querytree('foo & ! bar'::tsquery)`	`'foo'`
`setweight(tsvector, "char")`	`tsvector`	assign weight to each element of `tsvector`	`setweight('fat:2,4 cat:3 rat:5B'::tsvector, 'A')`	`'cat':3A 'fat':2A,4A 'rat':5A`
`setweight(tsquery, "char")`	`tsquery`	add weight to each element of `tsquery`	`setweight('fat ? cat & rat:B'::tsquery, 'A')`	`( 'fat':A ? 'cat':A ) & 'rat':AB`
`strip(tsvector)`	`tsvector`	remove positions and weights from `tsvector`	`strip('fat:2,4 cat:3 rat:5A'::tsvector)`	`'cat' 'fat' 'rat'`
`to_tsquery([configregconfig , ] querytext)`	`tsquery`	normalize words and convert to `tsquery`	`to_tsquery('english', 'The & Fat & Rats')`	`'fat' & 'rat'`
`to_tsvector([configregconfig , ] documenttext)`	`tsvector`	reduce document text to `tsvector`	`to_tsvector('english', 'The Fat Rats')`	`'fat':2 'rat':3`
`ts_headline([configregconfig, ] documenttext, querytsquery [, optionstext])`	`text`	display a query match	`ts_headline('x y z', 'z'::tsquery)`	`x y <b>z</b>`
`ts_rank([weightsfloat4[], ] vectortsvector, querytsquery [, normalizationinteger])`	`float4`	rank document for query	`ts_rank(textsearch, query)`	`0.818`
`ts_rank_cd([weightsfloat4[], ] vectortsvector, querytsquery [, normalizationinteger])`	`float4`	rank document for query using cover density	`ts_rank_cd('{0.1, 0.2, 0.4, 1.0}', textsearch, query)`	`2.01317`
`ts_rewrite(querytsquery, targettsquery, substitutetsquery)`	`tsquery`	replace target with substitute within query	`ts_rewrite('a & b'::tsquery, 'a'::tsquery, 'foo\|bar'::tsquery)`	`'b' & ( 'foo' \| 'bar' )`
`ts_rewrite(querytsquery, selecttext)`	`tsquery`	replace using targets and substitutes from a `SELECT` command	`SELECT ts_rewrite('a & b'::tsquery, 'SELECT t,s FROM aliases')`	`'b' & ( 'foo' \| 'bar' )`
`tsquery_phrase(query1tsquery, query2tsquery)`	`tsquery`	implementation of `<->` (FOLLOWED BY) operator	`tsquery_phrase(to_tsquery('fat'), to_tsquery('cat'))`	`'fat' <-> 'cat'`
`tsquery_phrase(query1tsquery, query2tsquery, distanceinteger)`	`tsquery`	phrase-concatenate with distance	`tsquery_phrase(to_tsquery('fat'), to_tsquery('cat'), 10)`	`'fat' <10> 'cat'`
`tsvector_update_trigger()`	`trigger`	trigger function for automatic `tsvector` column update	`CREATE TRIGGER ... tsvector_update_trigger(tsvcol, 'pg_catalog.swedish', title, body)`
`tsvector_update_trigger_column()`	`trigger`	trigger function for automatic `tsvector` column update	`CREATE TRIGGER ... tsvector_update_trigger_column(tsvcol, configcol, title, body)`

Note

All the text search functions that accept an optional regconfig argument will use the configuration specified by default_text_search_config when that argument is omitted.

The functions in Table 9.39 are listed separately because they are not usually used in everyday text searching operations. They are helpful for development and debugging of new text search configurations.

Table 9.39. Text Search Debugging Functions

Function	Return Type	Description	Example	Result
`ts_debug([configregconfig, ] documenttext, OUT aliastext, OUT descriptiontext, OUT tokentext, OUT dictionariesregdictionary[], OUT dictionaryregdictionary, OUT lexemestext[])`	`setof record`	test a configuration	`ts_debug('english', 'The Brightest supernovaes')`	`(asciiword,"Word, all ASCII",The,{english_stem},english_stem,{}) ...`
`ts_lexize(dictregdictionary, tokentext)`	`text[]`	test a dictionary	`ts_lexize('english_stem', 'stars')`	`{star}`
`ts_parse(parser_nametext, documenttext, OUT tokidinteger, OUT tokentext)`	`setof record`	test a parser	`ts_parse('default', 'foo - bar')`	`(1,foo) ...`
`ts_parse(parser_oidoid, documenttext, OUT tokidinteger, OUT tokentext)`	`setof record`	test a parser	`ts_parse(3722, 'foo - bar')`	`(1,foo) ...`
`ts_token_type(parser_nametext, OUT tokidinteger, OUT aliastext, OUT descriptiontext)`	`setof record`	get token types defined by parser	`ts_token_type('default')`	`(1,asciiword,"Word, all ASCII") ...`
`ts_token_type(parser_oidoid, OUT tokidinteger, OUT aliastext, OUT descriptiontext)`	`setof record`	get token types defined by parser	`ts_token_type(3722)`	`(1,asciiword,"Word, all ASCII") ...`
`ts_stat(sqlquerytext, [weightstext, ] OUT wordtext, OUT ndocinteger, OUT nentryinteger)`	`setof record`	get statistics of a `tsvector` column	`ts_stat('SELECT vector from apod')`	`(foo,10,15) ...`

Prev	Up	Next
9.12. Network Address Functions and Operators	Home	9.14. XML Functions

pdf epub