Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SPI_REGI...GGER_DATA(3)   PostgreSQL 18.4 Documentation  SPI_REGI...GGER_DATA(3)

NAME
     SPI_register_trigger_data	-  make  ephemeral trigger data available in SPI
     queries

SYNOPSIS
     int SPI_register_trigger_data(TriggerData *tdata)

DESCRIPTION
     SPI_register_trigger_data makes any ephemeral relations captured by a trig-
     ger available to queries planned and executed through the current SPI  con-
     nection.  Currently,  this means the transition tables captured by an AFTER
     trigger defined with a REFERENCING OLD/NEW TABLE AS ... clause. This  func-
     tion should be called by a PL trigger handler function after connecting.

ARGUMENTS
     TriggerData *tdata
	 the  TriggerData  object  passed  to  a  trigger  handler  function  as
	 fcinfo->context

RETURN VALUE
     If the execution of the command was successful then the following (nonnega-
     tive) value will be returned:

     SPI_OK_TD_REGISTER
	 if the captured trigger data (if any) has been successfully registered

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

     SPI_ERROR_ARGUMENT
	 if tdata is NULL

     SPI_ERROR_UNCONNECTED
	 if called from an unconnected C function

     SPI_ERROR_REL_DUPLICATE
	 if the name of any trigger data transient relation  is  already  regis-
	 tered for this connection

PostgreSQL 18.4 		      2026		 SPI_REGI...GGER_DATA(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=SPI_register_trigger_data&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help