44.11. Пакеты #

Функции PL/pgSQL могут работать с объектами, собранными в пакеты. Пакет — это по сути схема, которая помогает организовать взаимосвязанные именованные объекты, поэтому его можно создать как обычной командой CREATE SCHEMA, так и специальной командой CREATE PACKAGE. Однако пакет может содержать только функции, процедуры и составные типы.

Когда вы создаёте пакет, вы также должны создать функцию инициализации. Функция инициализации представляет собой функцию PL/pgSQL с именем __init__, которая не имеет аргументов и возвращает void. Обратите внимание, что функция инициализации должна быть определена до любой другой функции пакета, а все переменные, объявленные в функции инициализации, являются глобальными, поэтому к ним могут обращаться функции других пакетов, используя запись с точкой. Например, на переменную bar, объявленную в функции __init__ пакета foo, можно ссылаться как foo.bar.

В Postgres Pro Shardman предоставляются модификаторы определения функций для работы с пакетами. Модификатор #package определяет, что это функция пакета и она может напрямую использовать переменные этого пакета. Модификатор #import определяет, что функция может обращаться к переменным других пакетов, используя запись с точкой, как описано выше. При создании функций внутри пакета командой CREATE PACKAGE модификатор #package опускается. Модификатор #private определяет, что функция является внутренней, то есть на неё нельзя ссылаться снаружи пакета, но она необходима для обслуживающих процессов пакета. Модификатор #export определяет, что переменная пакета является публичной, то есть на неё можно ссылаться снаружи пакета. Когда вызывается функция с модификатором #package, содержащий её пакет инициализируется, если он ещё не был инициализирован в текущем сеансе. Функцию с модификатором #package можно создать только в схеме, содержащей функцию инициализации. Эти пакеты инициализируются автоматически, если они ещё не были инициализированы в текущем сеансе. Если указан модификатор #import, функция будет иметь доступ к переменным пакетов, указанных в списке через запятую. Эти пакеты инициализируются автоматически, если они ещё не были инициализированы в текущем сеансе. Модификатор #import, указанный для функции инициализации, влияет на все функции пакета. Модификатор #import также можно использовать в анонимных блоках кода.

В следующем примере использования модификатора #import процедура showValues вызывает функцию p из пакета htp и функцию set_action из пакета dbms_application_info.

CREATE OR REPLACE PROCEDURE showValues(p_Str varchar) AS $$
#import htp, dbms_application_info
BEGIN
  CALL dbms_application_info.set_action('Show hello');

  CALL htp.p('<p>' || p_Str || '</p>');
END;
$$LANGUAGE plpgsql;

В PL/pgSQL имеется встроенная функция plpgsql_reset_packages(), которая сбрасывает состояние всех пакетов в данном сеансе.

SELECT plpgsql_reset_packages();

44.11. Packages #

PL/pgSQL can be used to define functions for working with packages. A package is essentially a schema that helps to organize the named objects with a related purpose so it can be created using CREATE SCHEMA or a special CREATE PACKAGE command. A package should contain only functions, procedures and composite types.

When you create a package, you must also create the initialization function. The initialization function is a PL/pgSQL function named __init__ that has no arguments and returns void. Note that the initialization function must be defined before any other package function, and all the variables declared in the initialization function are global so they can be used by functions of other packages using dot notation. For example, the bar variable declared in the __init__ function of the foo package can be referenced as foo.bar.

Postgres Pro Shardman provides function creation modifiers for working with packages. The #package modifier defines that it is a package function and it can use variables of this package directly. The #import modifier defines that the function can use variables of other packages using the dot notation as described above. The #package modifier is omitted when creating functions inside a package using the CREATE PACKAGE command. The #private modifier indicates that the function is private, meaning that it cannot be referenced from outside the package, but it is necessary for the internal processes of the package. The modifier #export indicates that the package variable is public, meaning it can be referenced from outside the package. When a function with the #package modifier is called, the containing package is initialized if it has not been initialized already in the current session. You can create a function with the #package modifier only in the schema containing the initialization function. If the #import modifier is specified, the function will have access to the variables of the packages specified in a comma-separated list. These packages are initialized automatically if they have not been initialized already in the current session. #import specified for the initialization function affects all package functions. The #import modifier can also be used in anonymous code blocks.

In the below example of using the #import modifier, the showValues procedure calls p of the htp package and set_action of the dbms_application_info package.

CREATE OR REPLACE PROCEDURE showValues(p_Str varchar) AS $$
#import htp, dbms_application_info
BEGIN
  CALL dbms_application_info.set_action('Show hello');

  CALL htp.p('<p>' || p_Str || '</p>');
END;
$$LANGUAGE plpgsql;

PL/pgSQL also provides a built-in function plpgsql_reset_packages() that deinstantiates all the packages in this session to bring the session to the original state.

SELECT plpgsql_reset_packages();

FAQ