1SPI_REGISTER_RELATION(3) PostgreSQL 13.3 DocumentationSPI_REGISTER_RELATION(3)
2
3
4
6 SPI_register_relation - make an ephemeral named relation available by
7 name in SPI queries
8
10 int SPI_register_relation(EphemeralNamedRelation enr)
11
13 SPI_register_relation makes an ephemeral named relation, with
14 associated information, available to queries planned and executed
15 through the current SPI connection.
16
18 EphemeralNamedRelation enr
19 the ephemeral named relation registry entry
20
22 If the execution of the command was successful then the following
23 (nonnegative) value will be returned:
24
25 SPI_OK_REL_REGISTER
26 if the relation has been successfully registered by name
27
28 On error, one of the following negative values is returned:
29
30 SPI_ERROR_ARGUMENT
31 if enr is NULL or its name field is NULL
32
33 SPI_ERROR_UNCONNECTED
34 if called from an unconnected C function
35
36 SPI_ERROR_REL_DUPLICATE
37 if the name specified in the name field of enr is already
38 registered for this connection
39
40
41
42PostgreSQL 13.3 2021 SPI_REGISTER_RELATION(3)