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

   1
   2 SPI_unregister_relation
   3
   4    SPI_unregister_relation — remove an ephemeral named relation from the
   5    registry
   6
   7 Synopsis
   8
   9 int SPI_unregister_relation(const char * name)
  10
  11 Description
  12
  13    SPI_unregister_relation removes an ephemeral named relation from the
  14    registry for the current connection.
  15
  16 Arguments
  17
  18    const char * name
  19           the relation registry entry name
  20
  21 Return Value
  22
  23    If the execution of the command was successful then the following
  24    (nonnegative) value will be returned:
  25
  26    SPI_OK_REL_UNREGISTER
  27           if the tuplestore has been successfully removed from the
  28           registry
  29
  30    On error, one of the following negative values is returned:
  31
  32    SPI_ERROR_ARGUMENT
  33           if name is NULL
  34
  35    SPI_ERROR_UNCONNECTED
  36           if called from an unconnected C function
  37
  38    SPI_ERROR_REL_NOT_FOUND
  39           if name is not found in the registry for the current connection