jsonb_path_query_tz() — PostgreSQL JSON function

jsonb_path_query_tz(): jsonpath query with timezone. PostgreSQL json functions — signature, volatility, version applicability and an illustrative example.

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

Summary

jsonb_path_query_tz is a PostgreSQL built-in function in the JSON Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “jsonpath query with timezone”.

Signature

jsonb_path_query_tz(jsonb, jsonpath, jsonb, boolean) → setof jsonb

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: jsonb (set-returning)

Example

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

SELECT * FROM jsonb_path_query_tz('{"k":1}'::jsonb, '$.k'::jsonpath, '{"k":1}'::jsonb, true);

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

jsonb_path_query_tz is present across the surveyed releases (PostgreSQL 15, 16, 17, 18). 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.