SPI_UNRE..._RELATION(3)

πŸ“¦ version 13.23, in opensuse-leap 16.0

πŸ’– SPI_UNRE..._RELATION(3) β€” fresh from the PostgreSQL 13.23 Documentation, bestie!

πŸŽ€ NAME πŸŽ€

SPI_unregister_relation β€” remove an ephemeral named relation from the registry. That's the whole assignment, no cap. 🫢

✨ SYNOPSIS ✨

The signature is giving exactly this:

int SPI_unregister_relation(const char * name)

πŸ’… DESCRIPTION πŸ’…

Okay so SPI_unregister_relation removes an ephemeral named relation from the registry for the current connection. That's it β€” iconic, focused, does one thing. ✨

🫢 ARGUMENTS 🫢

  • const char * name β€” the relation registry entry name. Literally the name of the entry in the relation registry. πŸŽ€

🌈 RETURN VALUE 🌈

If the command runs successfully, you get this (nonnegative) value back:

  • SPI_OK_REL_UNREGISTER β€” if the tuplestore has been successfully removed from the registry. Slay. πŸ’–

On error, one of these negative values comes back:

  • SPI_ERROR_ARGUMENT β€” if name is NULL
  • SPI_ERROR_UNCONNECTED β€” if called from an unconnected C function
  • SPI_ERROR_REL_NOT_FOUND β€” if name is not found in the registry for the current connection

xoxo, PostgreSQL 13.23 Documentation, 2025 πŸ’œβœ¨

πŸ“¦ where this page comes from