jsonb_populate_record_valid() — PostgreSQL JSON function

jsonb_populate_record_valid(): test get record fields from a jsonb object. PostgreSQL json functions — signature, volatility, version applicability and an illustrative example.

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

Summary

jsonb_populate_record_valid is a PostgreSQL built-in function in the JSON Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “test get tuple/">record fields from a jsonb object”.

Signature

jsonb_populate_record_valid(anyelement, jsonb) → boolean

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: boolean

Example

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

SELECT jsonb_populate_record_valid(1, '{"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

Based on the catalog across releases, jsonb_populate_record_valid first appears in PostgreSQL 17. It is present in: 17, 18, 19.

Related & references

Reference: PostgreSQL documentation — JSON Functions.