begriffs open source - ai-pg/blob - full-docs/txt/spi-spi-register-relation.txt

   1
   2 SPI_register_relation
   3
   4    SPI_register_relation — make an ephemeral named relation available by
   5    name in SPI queries
   6
   7 Synopsis
   8
   9 int SPI_register_relation(EphemeralNamedRelation enr)
  10
  11 Description
  12
  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
  17 Arguments
  18
  19    EphemeralNamedRelation enr
  20           the ephemeral named relation registry entry
  21
  22 Return Value
  23
  24    If the execution of the command was successful then the following
  25    (nonnegative) value will be returned:
  26
  27    SPI_OK_REL_REGISTER
  28           if the relation has been successfully registered by name
  29
  30    On error, one of the following negative values is returned:
  31
  32    SPI_ERROR_ARGUMENT
  33           if enr is NULL or its name field is NULL
  34
  35    SPI_ERROR_UNCONNECTED
  36           if called from an unconnected C function
  37
  38    SPI_ERROR_REL_DUPLICATE
  39           if the name specified in the name field of enr is already
  40           registered for this connection