SPI_REGISTER_RELATION(3pg16)

🌸 NAME 🌸

okay so this is the SPI_REGISTER_RELATION(3pg16) page from the PostgreSQL 16.15 docs — welcome to the bestie edition 💖

SPI_register_relation — makes an ephemeral named relation available by name in SPI queries. Periodt.

✨ SYNOPSIS ✨

int SPI_register_relation(EphemeralNamedRelation enr)

🦋 DESCRIPTION 🦋

okay so SPI_register_relation makes an ephemeral named relation — with all its associated information — available to queries that are planned and executed through the current SPI connection. It’s giving “hey bestie, meet your queries” energy, but make it C API 🌈

🎀 ARGUMENTS 🎀

• EphemeralNamedRelation enr — the ephemeral named relation registry entry. That’s the one, no cap 💅

👑 RETURN VALUE 👑

If the execution of the command was successful, then the following (nonnegative) value will be returned:

• SPI_OK_REL_REGISTER — if the relation has been successfully registered by name. slay ✨

On error, one of the following negative values is returned:

• SPI_ERROR_ARGUMENT — if enr is NULL or its name field is NULL.
• SPI_ERROR_UNCONNECTED — if called from an unconnected C function.
• SPI_ERROR_REL_DUPLICATE — if the name specified in the name field of enr is already registered for this connection.

bestie, negative return values mean something went wrong — check which one you got 👀

xoxo, from PostgreSQL 16.15, dated 2026 — bye bestie, go register those ephemeral named relations responsibly 🫶💖