shobj_description() — PostgreSQL hashing/encoding function

shobj_description(): get description for object id and shared catalog name. PostgreSQL hashing & encoding functions — signature, volatility, version applicability and an illustrative example.

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

Summary

shobj_description is a PostgreSQL built-in function in the Hashing & Encoding Functions group. PostgreSQL’s system catalog (pg_proc) describes it as: “get description for object id and shared catalog name”.

Signature

shobj_description(oid, name) → text

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: Hashing & Encoding 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: text

Example

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

SELECT shobj_description(42, '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

shobj_description 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 — Hashing & Encoding Functions.