ts_headline() — PostgreSQL JSON function

ts_headline(): generate headline. PostgreSQL json functions — signature, volatility, version applicability and an illustrative example.

The Sev-1 Admin
The Sev-1 Admin  ·  2 min read

Summary

ts_headline is a PostgreSQL built-in function in the JSON Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “generate headline”.

Signature

ts_headline has 12 documented overloaded forms:

ts_headline(regconfig, text, tsquery, text) → text
ts_headline(regconfig, text, tsquery) → text
ts_headline(text, tsquery, text) → text
ts_headline(text, tsquery) → text
ts_headline(regconfig, jsonb, tsquery, text) → jsonb
ts_headline(regconfig, jsonb, tsquery) → jsonb
ts_headline(jsonb, tsquery, text) → jsonb
ts_headline(jsonb, tsquery) → jsonb
ts_headline(regconfig, json, tsquery, text) → json
ts_headline(regconfig, json, tsquery) → json
ts_headline(json, tsquery, text) → json
ts_headline(json, tsquery) → json

Argument and return types are taken from the pg_proc catalog; internal type names are shown using their readable SQL spellings (for example int4 is shown as integer). (Derived from the catalog — see the linked reference for the canonical documentation.)

Classification

  • Category: JSON Functions
  • Kind: Function
  • Volatility: IMMUTABLE — Marked IMMUTABLE — it always returns the same result for the same arguments and can be used in indexes and other contexts that require immutability.
  • Returns: json, jsonb, text

Example

Illustrative form (replace placeholder values with your own data):

SELECT ts_headline(NULL::regconfig, 'abc', to_tsquery('cat'), 'abc');

The example above is illustrative and is meant to show calling syntax only; consult the linked PostgreSQL documentation for exact semantics, edge cases and accepted argument combinations.

Version applicability

ts_headline is present across the surveyed releases (PostgreSQL 15, 16, 17, 18, 19). On older major versions, behaviour may differ in detail — always check the documentation for the version you run.

Related & references

Reference: PostgreSQL documentation — JSON Functions.