json_to_tsvector() — PostgreSQL JSON function

json_to_tsvector(): transform specified values from json to tsvector. PostgreSQL json functions — signature, volatility, version applicability and an illustrative example.

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

Summary

json_to_tsvector is a PostgreSQL built-in function in the JSON Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “transform specified values from json to tsvector”.

Signature

json_to_tsvector has 2 documented overloaded forms:

json_to_tsvector(json, jsonb) → tsvector
json_to_tsvector(regconfig, json, jsonb) → tsvector

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: STABLE — Marked STABLE — within a single statement it returns a consistent result for the same arguments, but the result can change between statements.
  • Returns: tsvector

Example

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

SELECT json_to_tsvector('{"k":1}'::json, '{"k":1}'::jsonb);

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

json_to_tsvector 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.