F.59. spi — особенности/примеры использования интерфейса программирования сервера #
Модуль spi предоставляет несколько рабочих примеров использования Интерфейса программирования сервера (Server Programming Interface, SPI) и триггеров. Хотя эти функции имеют некоторую ценность сами по себе, они ещё более полезны как заготовки, которые можно приспособить под собственные нужды. Эти функции достаточно общие, чтобы работать с любой таблицей, но вы должны явно указать имена таблицы и полей (как описано ниже) при создании триггера.
Каждая группа функций, описанная ниже, представлена в виде отдельно устанавливаемого расширения.
F.59.1. refint — функции для реализации ссылочной целостности #
Функции check_primary_key()
и check_foreign_key()
применяются для проверки ограничений внешних ключей. (Эта функциональность уже давно вытеснена встроенным механизмом внешних ключей, но этот модуль всё ещё полезен в качестве примера.)
Функция check_primary_key()
проверяет ссылающуюся таблицу. Чтобы воспользоваться ей, создайте триггер BEFORE INSERT OR UPDATE
с этой функцией для таблицы, ссылающейся на другую. Укажите в аргументах триггера: имена столбцов ссылающейся таблицы, образующих внешний ключ, имя целевой таблицы и имена столбцов в ней, образующих первичный/уникальный ключ. Чтобы контролировать несколько внешних ключей, создайте триггер для каждой такой ссылки.
Функция check_foreign_key()
проверяет целевую таблицу. Чтобы использовать её, создайте триггер BEFORE DELETE OR UPDATE
с этой функцией для таблицы, на которую ссылаются другие. Укажите в аргументах триггера: число ссылающихся таблиц, для которых функция должна выполнить проверки, действие в случае обнаружения ссылающегося ключа (cascade
— удалить ссылающуюся строку, restrict
— прервать транзакцию, setnull
— установить в ссылающихся полях значения NULL), имена столбцов целевой таблицы, образующих первичный/уникальный ключ, а затем имена таблиц и столбцов (в количестве, задаваемом первым аргументом). Заметьте, что поля первичных/уникальных столбцов должны иметь пометку NOT NULL и по ним должен быть создан уникальный индекс.
Примеры приведены в refint.example
.
F.59.2. autoinc — функции для автоувеличения полей #
Функция autoinc()
реализует код триггера, сохраняющего следующее значение последовательности в целочисленном поле. Это в некоторой степени пересекается со встроенной функциональностью столбца «serial», но есть и отличия: autoinc()
препятствует попыткам вставить другое значение поля при добавлении строк и может увеличивать значение поля при изменениях.
Чтобы использовать её, создайте триггер BEFORE INSERT
(или BEFORE INSERT OR UPDATE
) с этой функцией. Передайте триггеру два аргумента: имя целочисленного столбца, который будет меняться, и имя объекта последовательности, который будет поставлять значения. (Вообще вы можете задать любое число пар таких имён, если хотите поддерживать несколько автоувеличивающихся столбцов.)
Пример приведён в autoinc.example
.
F.59.3. insert_username — функции для отслеживания пользователя, вносящего изменения #
Функция insert_username()
реализует код триггера, сохраняющего имя текущего пользователя в текстовом поле. Это может быть полезно для отслеживания пользователя, изменившего конкретную строку таблицы последним.
Чтобы использовать её, создайте триггер BEFORE INSERT
и/или UPDATE
с этой функцией. Передайте триггеру один аргумент: имя целевого текстового столбца.
Пример приведён в insert_username.example
.
F.59.4. moddatetime — функции для отслеживания времени последнего изменения #
Функция moddatetime()
реализует код триггера, сохраняющего текущее время в поле типа timestamp
. Это может быть полезно для отслеживания времени последней модификации конкретной строки таблицы.
Чтобы использовать её, создайте триггер BEFORE UPDATE
с этой функцией. Передайте триггеру один аргумент: имя целевого столбца. Столбец должен иметь тип timestamp
или timestamp with time zone
.
Пример приведён в moddatetime.example
.
F.59. spi — Server Programming Interface features/examples #
The spi module provides several workable examples of using the Server Programming Interface (SPI) and triggers. While these functions are of some value in their own right, they are even more useful as examples to modify for your own purposes. The functions are general enough to be used with any table, but you have to specify table and field names (as described below) while creating a trigger.
Each of the groups of functions described below is provided as a separately-installable extension.
F.59.1. refint — Functions for Implementing Referential Integrity #
check_primary_key()
and check_foreign_key()
are used to check foreign key constraints. (This functionality is long since superseded by the built-in foreign key mechanism, of course, but the module is still useful as an example.)
check_primary_key()
checks the referencing table. To use, create a BEFORE INSERT OR UPDATE
trigger using this function on a table referencing another table. Specify as the trigger arguments: the referencing table's column name(s) which form the foreign key, the referenced table name, and the column names in the referenced table which form the primary/unique key. To handle multiple foreign keys, create a trigger for each reference.
check_foreign_key()
checks the referenced table. To use, create a BEFORE DELETE OR UPDATE
trigger using this function on a table referenced by other table(s). Specify as the trigger arguments: the number of referencing tables for which the function has to perform checking, the action if a referencing key is found (cascade
— to delete the referencing row, restrict
— to abort transaction if referencing keys exist, setnull
— to set referencing key fields to null), the triggered table's column names which form the primary/unique key, then the referencing table name and column names (repeated for as many referencing tables as were specified by first argument). Note that the primary/unique key columns should be marked NOT NULL and should have a unique index.
There are examples in refint.example
.
F.59.2. autoinc — Functions for Autoincrementing Fields #
autoinc()
is a trigger that stores the next value of a sequence into an integer field. This has some overlap with the built-in “serial column” feature, but it is not the same: autoinc()
will override attempts to substitute a different field value during inserts, and optionally it can be used to increment the field during updates, too.
To use, create a BEFORE INSERT
(or optionally BEFORE INSERT OR UPDATE
) trigger using this function. Specify two trigger arguments: the name of the integer column to be modified, and the name of the sequence object that will supply values. (Actually, you can specify any number of pairs of such names, if you'd like to update more than one autoincrementing column.)
There is an example in autoinc.example
.
F.59.3. insert_username — Functions for Tracking Who Changed a Table #
insert_username()
is a trigger that stores the current user's name into a text field. This can be useful for tracking who last modified a particular row within a table.
To use, create a BEFORE INSERT
and/or UPDATE
trigger using this function. Specify a single trigger argument: the name of the text column to be modified.
There is an example in insert_username.example
.
F.59.4. moddatetime — Functions for Tracking Last Modification Time #
moddatetime()
is a trigger that stores the current time into a timestamp
field. This can be useful for tracking the last modification time of a particular row within a table.
To use, create a BEFORE UPDATE
trigger using this function. Specify a single trigger argument: the name of the column to be modified. The column must be of type timestamp
or timestamp with time zone
.
There is an example in moddatetime.example
.