Skip to content

How to Read This Reference

This is the complete technical reference for every public function and procedure in pg_health_framework's pghf schema — what each one does, its parameters (their type, and whether you must supply them), and what it returns. Where the User Guide explains concepts and walks through examples, this book is for looking up an exact signature once you already know what you're trying to do.

A few conventions used throughout this reference:

  • Entries are grouped by function area — matching the architecture described in the User Guide — and listed alphabetically by name within each group.
  • Mandatory means the parameter has no default value, so you must supply it. A parameter with a default is optional — the listed default applies whenever you leave it out.
  • Only the public interface is documented here — functions meant to be called directly. A handful of internal helper functions exist purely as implementation details behind the ones below; they aren't part of the supported interface, and calling them directly is blocked. Where one of them matters to understanding a public function's behaviour, it's mentioned in that function's own description.
  • SECURITY DEFINER is PostgreSQL's term for a function that runs with the privileges of whoever defined it (normally the extension's owner), rather than whoever is calling it. This framework uses that narrowly — only for the registration functions and the read-only reporting functions — and deliberately never for anything that dynamically calls a function read out of a table. See each entry below, and The Access Model in the User Guide, for the full reasoning.
  • Function versus procedure: a function is called with SELECT or used inside an expression, and works normally inside a transaction. A procedure is called with a standalone CALL statement, and several of them (the collection engine, the evaluation engine, and the combined convenience call) commit internally as they run — which is exactly why they must be called as a bare CALL, never nested inside your own explicit transaction block.

Function areas

Continue to Types.