Postgres Pro Standard : Документация: 16: SPI_register_trigger

SPI_register_trigger_data
Пред.	Наверх	46.1. Интерфейсные функции	Начало	След.

SPI_register_trigger_data

SPI_register_trigger_data — сделать эфемерные данные триггера доступными в запросах SPI

Синтаксис

int SPI_register_trigger_data(TriggerData *tdata)

Описание

SPI_register_trigger_data делает эфемерные отношения, которые перехватывает триггер, доступными для запросов, планируемых и выполняемых через текущее подключение SPI. В настоящее время это переходные таблицы, перехватываемые триггером AFTER, определённым с предложением REFERENCING OLD/NEW TABLE AS. Эта функция должна вызываться функцией, реализующей триггер на языке программирования, после подключения.

Аргументы

TriggerData *tdata: объект TriggerData, передаваемый функцией, реализующей триггер, через fcinfo->context

Возвращаемое значение

Если команда была выполнена успешно, возвращается следующее (неотрицательное) значение:

SPI_OK_TD_REGISTER: если перехваченные данные триггера (при наличии) были успешно зарегистрированы

В случае ошибки возвращается одно из следующих отрицательных значений:

SPI_ERROR_ARGUMENT: если в tdata передан NULL
SPI_ERROR_UNCONNECTED: если вызывается из неподключённой функции на C
SPI_ERROR_REL_DUPLICATE: если имя в любом из переходных отношений в данных триггера уже зарегистрировано для этого подключения

Пред.	Наверх	След.
SPI_unregister_relation	Начало	46.2. Вспомогательные интерфейсные функции

SPI_register_trigger_data
Prev	Up	46.1. Interface Functions	Home	Next

SPI_register_trigger_data

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 trigger available to queries planned and executed through the current SPI connection. Currently, this means the transition tables captured by an AFTER trigger defined with a REFERENCING OLD/NEW TABLE AS ... clause. This function 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 (nonnegative) 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 registered for this connection

Prev	Up	Next
SPI_unregister_relation	Home	46.2. Interface Support Functions