json_strip_nulls() — PostgreSQL JSON function

json_strip_nulls(): remove object fields with null values from json. PostgreSQL json functions — signature, volatility, version applicability and an illustrative example.

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

Summary

json_strip_nulls is a PostgreSQL built-in function in the JSON Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “remove object fields with null values from json”.

Signature

json_strip_nulls(json, boolean) → 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

Example

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

SELECT json_strip_nulls('{"k":1}'::json, 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

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