SPI_GETBINVAL(3)

🎀 NAME 🎀

okay bestie, this is the SPI_GETBINVAL(3) page 💅 and it's literally about SPI_getbinval — the function that returns the binary value of the specified column. slay.

✨ SYNOPSIS ✨

Datum SPI_getbinval(HeapTuple row, TupleDesc rowdesc, int colnumber,
                    bool * isnull)

💖 DESCRIPTION 💖

SPI_getbinval returns the value of the specified column in the internal form (as type Datum). periodt.

This function does not allocate new space for the datum. the way that matters: in the case of a pass-by-reference data type, the return value will be a pointer into the passed row. no cap. 🫶

🫶 ARGUMENTS 🫶

• HeapTuple row — input row to be examined 👀
• TupleDesc rowdesc — input row description 📝
• int colnumber — column number (count starts at 1) 🔢
• bool * isnull — flag for a null value in the column 🚩

🔥 RETURN VALUE 🔥

The binary value of the column is returned. The variable pointed to by isnull is set to true if the column is null, else to false. 💖

⚠️ on error: SPI_result is set to SPI_ERROR_NOATTRIBUTE. that's the error vibe check, bestie.

mwah 💋 — source/version: PostgreSQL 13.23 documentation; date: 2025.