SPI_fnumber(3)

SPI_fnumber3

Determine the column number for the specified column name

Usage

int SPI_fnumber(TupleDesc rowdesc, const char * colname)

Overview

SPI_fnumber returns the column number for the column with the specified name.

If colname refers to a system column (e.g., ctid) then the appropriate negative column number will be returned. The caller should be careful to test the return value for exact equality to SPI_ERROR_NOATTRIBUTE to detect an error; testing the result for less than or equal to 0 is not correct unless system columns should be rejected.

Arguments

TupleDesc rowdesc

input row description

const char * colname

column name

Return value

Column number (count starts at 1 for user-defined columns), or SPI_ERROR_NOATTRIBUTE if the named column was not found.

From postgresql 18.6-4 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.