select open change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Supported versions: Current (18) / 17 / 16 / 15 / 14
Development versions: 19 / devel
Unsupported versions: 13 / 12 / 11 / 10
Historical version. PostgreSQL 10 reached end of support in November 2022. See the current version for supported releases.

SPI_unregister_relation

SPI_unregister_relation — remove an ephemeral named relation from the registry

Synopsis

int SPI_unregister_relation(const char * name)

Description

SPI_unregister_relation removes an ephemeral named relation from the registry for the current connection.

Arguments

const char * name

the relation registry entry name

Return Value

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

SPI_OK_REL_UNREGISTER

if the tuplestore has been successfully removed from the registry

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

SPI_ERROR_ARGUMENT

if name is NULL

SPI_ERROR_UNCONNECTED

if called from an unconnected procedure

SPI_ERROR_REL_NOT_FOUND

if name is not found in the registry for the current connection

Report a documentation issue

Read the upstream documentation. For corrections, first check the current version.