Functions / Text Search Functions And Operators

ts_headline

Displays, in an abbreviated form, the match(es) for the query in the document, which must be raw text not a tsvector.

Reading PG 18current·documented in 20 of 27 versions, 8.3 to 20

7.1 7.2 7.3 7.4 8.0 8.1 8.2 8.3 8.4 9.0 9.1 9.2 9.3 9.4 9.5 9.6 10 11 12 13 14 15 16 17 18 19 20

Signatures & examples

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

Displays, in an abbreviated form, the match(es) for the query in the document, which must be raw text not a tsvector. Words in the document are normalized according to the specified or default configuration before matching to the query. Use of this function is discussed in Section 12.3.4, which also describes the available 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

Displays, in an abbreviated form, match(es) for the query that occur in string values within the JSON document. See Section 12.3.4 for more details.

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

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

Displays, in an abbreviated form, match(es) for the query that occur in string values within the JSON document. See Section 12.3.4 for more details.

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

Version history 3

12 → 13 changed
9.6 → 10 changed
8.2 → 8.3 added

Definition snapshot: b7bd9cda · English manual source