44.12. Советы по разработке на PL/pgSQL
Хороший способ разрабатывать на PL/pgSQL заключается в том, чтобы в одном окне с текстовым редактором по выбору создавать тексты функций, а в другом окне с psql загружать и тестировать эти функции. В таком случае удобно записывать функцию, используя CREATE OR REPLACE FUNCTION
. Таким образом, можно легко загрузить файл для обновления определения функции. Например:
CREATE OR REPLACE FUNCTION testfunc(integer) RETURNS integer AS $$ .... $$ LANGUAGE plpgsql;
В psql, можно загрузить или перезагрузить такой файл определения функции, выполнив:
\i filename.sql
а затем сразу выполнять команды SQL для тестирования функции.
Ещё один хороший способ разрабатывать на PL/pgSQL связан с использованием GUI инструментов, облегчающих разработку на процедурном языке. Один из примеров такого инструмента pgAdmin, хотя есть и другие. Такие инструменты часто предоставляют удобные возможности, такие как экранирование одинарных кавычек, отладка и повторное создание функций.
44.12.1. Обработка кавычек
Код функции на PL/pgSQL указывается в команде CREATE FUNCTION
в виде строки. Если записывать строку как обычно, внутри одинарных кавычек, то любой символ одинарной кавычки должен дублироваться, так же как и должен дублироваться каждый знак обратной косой черты (если используется синтаксис с экранированием в строках). Дублирование кавычек в лучшем случае утомительно, а в более сложных случаях код может стать совершенно непонятным, так как легко может потребоваться четыре или более идущих подряд кавычек. Вместо этого при создании тела функции рекомендуется использовать знаки доллара в качестве кавычек (см. Подраздел 4.1.2.4). При таком подходе никогда не потребуется дублировать кавычки, но придётся позаботиться о том, чтобы иметь разные долларовые разделители для каждого уровня вложенности. Например, команду CREATE FUNCTION
можно записать так:
CREATE OR REPLACE FUNCTION testfunc(integer) RETURNS integer AS $PROC$ .... $PROC$ LANGUAGE plpgsql;
Внутри можно использовать кавычки для простых текстовых строк и $$
для разграничения фрагментов SQL-команды, собираемой из отдельных строк. Если нужно взять в кавычки текст, который включает $$
, можно использовать $Q$
, и так далее.
Следующая таблица показывает, как применяются знаки кавычек, если не используется экранирование долларами. Это может быть полезно при переводе кода, не использующего экранирование знаками доллара, в нечто более понятное.
- 1 кавычка
В начале и конце тела функции, например:
CREATE FUNCTION foo() RETURNS integer AS ' .... ' LANGUAGE plpgsql;
Внутри такой функции любая кавычка должна дублироваться.
- 2 кавычки
Для строковых литералов внутри тела функции, например:
a_output := ''Blah''; SELECT * FROM users WHERE f_name=''foobar'';
При использовании знаков доллара можно просто написать:
a_output := 'Blah'; SELECT * FROM users WHERE f_name='foobar';
и именно это увидит исполнитель PL/pgSQL в обоих случаях.
- 4 кавычки
Когда нужны одинарные кавычки в строковой константе внутри тела функции, например:
a_output := a_output || '' AND name LIKE ''''foobar'''' AND xyz''
К
a_output
будет добавлено:AND name LIKE 'foobar' AND xyz
При использовании знаков доллара это записывается так:
a_output := a_output || $$ AND name LIKE 'foobar' AND xyz$$
будьте внимательны, при этом не должно быть внешнего долларового разделителя
$$
.- 6 кавычек
Когда нужны одинарные кавычки в строковой константе внутри тела функции, при этом кавычки находятся в конце строковой константы. Например:
a_output := a_output || '' AND name LIKE ''''foobar''''''
К
a_output
будет добавлено:AND name LIKE 'foobar'
.При использовании знаков доллара это записывается так:
a_output := a_output || $$ AND name LIKE 'foobar'$$
- 10 кавычек
Когда нужны две одиночные кавычки в строковой константе (это уже 8 кавычек), примыкающие к концу строковой константы (ещё 2). Вероятно, такое может понадобиться при разработке функции, которая генерирует другие функции, как показано в Примере 44.10. Например:
a_output := a_output || '' if v_'' || referrer_keys.kind || '' like '''''''''' || referrer_keys.key_string || '''''''''' then return '''''' || referrer_keys.referrer_type || ''''''; end if;'';
Значение
a_output
затем будет:if v_... like ''...'' then return ''...''; end if;
При использовании знаков доллара:
a_output := a_output || $$ if v_$$ || referrer_keys.kind || $$ like '$$ || referrer_keys.key_string || $$' then return '$$ || referrer_keys.referrer_type || $$'; end if;$$;
где предполагается, что нужны только одиночные кавычки в
a_output
, так как потребуется повторное взятие в кавычки перед использованием.
44.12.2. Дополнительные проверки во время компиляции
Чтобы помочь найти и предупредить простые, но часто встречающиеся проблемы, PL/PgSQL предоставляет дополнительные проверки
. Если они включены в конфигурации, то во время компиляции функций будут выдаваться дополнительные сообщения WARNING
или ошибки ERROR
. Функция, при компиляции которой выдавалось WARNING
, при последующем выполнении не будет выдавать это сообщение и её можно протестировать в отдельной среде разработки.
Для включения этих проверок используются параметры конфигурации plpgsql.extra_warnings
для предупреждений и plpgsql.extra_errors
для ошибок. Каждому из параметров можно присвоить список значений, разделённых запятыми, значение "none"
или "all"
. По умолчанию используется "none"
. В настоящий момент доступна только одна проверка:
shadowed_variables
Проверяет, что объявление новой переменной не скрывает ранее объявленную переменную.
Следующий пример показывает эффект присваивания plpgsql.extra_warnings
значения shadowed_variables
:
SET plpgsql.extra_warnings TO 'shadowed_variables'; CREATE FUNCTION foo(f1 int) RETURNS int AS $$ DECLARE f1 int; BEGIN RETURN f1; END; $$ LANGUAGE plpgsql; WARNING: variable "f1" shadows a previously defined variable LINE 3: f1 int; ^ CREATE FUNCTION
Bibliography
Selected references and readings for SQL and PostgreSQL.
Some white papers and technical reports from the original POSTGRES development team are available at the University of California, Berkeley, Computer Science Department web site.
SQL Reference Books
[bowman01] The Practical SQL Handbook. Using SQL Variants. Fourth Edition. ISBN 0-201-70309-2. Addison-Wesley Professional. 2001.
[date97] A Guide to the SQL Standard. A user's guide to the standard database language SQL. Fourth Edition. ISBN 0-201-96426-0. Addison-Wesley. 1997.
[date04] An Introduction to Database Systems. Eighth Edition. ISBN 0-321-19784-4. Addison-Wesley. 2003.
[elma04] Fundamentals of Database Systems. Fourth Edition. ISBN 0-321-12226-7. Addison-Wesley. 2003.
[melt93] Understanding the New SQL. A complete guide. ISBN 1-55860-245-3. Morgan Kaufmann. 1993.
[ull88] Principles of Database and Knowledge-Base Systems. Classical Database Systems. Computer Science Press. 1988.
PostgreSQL-specific Documentation
[sim98] Enhancement of the ANSI SQL Implementation of PostgreSQL. Department of Information Systems, Vienna University of Technology. Vienna, Austria. November 29, 1998.
[yu95] The Postgres95. User Manual. University of California. Berkeley, California. Sept. 5, 1995.
[fong] The design and implementation of the POSTGRES query optimizer. University of California, Berkeley, Computer Science Department.
Proceedings and Articles
[ports12] “Serializable Snapshot Isolation in PostgreSQL”. VLDB Conference, August 2012.
[berenson95] “A Critique of ANSI SQL Isolation Levels”. ACM-SIGMOD Conference on Management of Data, June 1995.
[olson93] Partial indexing in POSTGRES: research project. UCB Engin T7.49.1993 O676. University of California. Berkeley, California. 1993.
[ong90] “A Unified Framework for Version Modeling Using Production Rules in a Database System”. ERL Technical Memorandum M90/33. University of California. Berkeley, California. April, 1990.
[rowe87] “The POSTGRES data model”. VLDB Conference, Sept. 1987.
[seshadri95] “Generalized Partial Indexes”. Eleventh International Conference on Data Engineering, 6-10 March 1995. Cat. No.95CH35724. IEEE Computer Society Press. Los Alamitos, California. 1995. 420-7.
[ston86] “The design of POSTGRES”. ACM-SIGMOD Conference on Management of Data, May 1986.
[ston87a] “The design of the POSTGRES rules system”. IEEE Conference on Data Engineering, Feb. 1987.
[ston87b] “The design of the POSTGRES storage system”. VLDB Conference, Sept. 1987.
[ston89] “A commentary on the POSTGRES rules system”. SIGMOD Record 18(3). Sept. 1989.
[ston89b] “The case for partial indexes”. SIGMOD Record 18(4). Dec. 1989. 4-11.
[ston90a] “The implementation of POSTGRES”. Transactions on Knowledge and Data Engineering 2(1). IEEE. March 1990.
[ston90b] “On Rules, Procedures, Caching and Views in Database Systems”. ACM-SIGMOD Conference on Management of Data, June 1990.