Supported Versions: Current (16) / 15 / 14 / 13 / 12
Development Versions: 17 / devel
Unsupported versions: 11 / 10


SPI_register_relation — make an ephemeral named relation available by name in SPI queries


int SPI_register_relation(EphemeralNamedRelation enr)


SPI_register_relation makes an ephemeral named relation, with associated information, available to queries planned and executed through the current SPI connection.


EphemeralNamedRelation enr

the ephemeral named relation registry entry

Return Value

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


if the relation has been successfully registered by name

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


if enr is NULL or its name field is NULL


if called from an unconnected C function


if the name specified in the name field of enr is already registered for this connection

Submit correction

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.