К сожалению, многие программисты не склонны тратить время на то, чтобы застраховать свой код PL/SQL от всех возможных неожиданностей. У большинства из нас хватает проблем с написанием кода, реализующего положительные аспекты приложения: управление данными клиентов, построение счетов и т. д.; вдобавок это увеличивает объем работы. Всегда бывает дьявольски сложно — как с психологической точки зрения, так и в отношении расходования ресурсов — сосредоточиться на негативных аспектах работы системы: что, если пользователь нажмет не ту клавишу? А что делать, если база данных Oracle недоступна?
В результате мы пишем приложения PL/SQL, предназначенные для работы в «идеальном мире», где в программах не бывает ошибок, пользователи вводят лишь правильные данные, а все системы — и аппаратные и программные — всегда в полном порядке.
Конечно, жестокая реальность устанавливает свои правила: как бы вы ни старались, в приложении все равно отыщется еще одна ошибка. А ваши пользователи всегда постараются отыскать последовательность нажатий клавиш, от которых форма перестанет работать. Проблема проста: либо вы выделяете время на отладку и защиту своих программ, либо вам придется вести бесконечные бои в отступлении, принимая отчаянные звонки от пользователей и пытаясь потушить разгорающееся пламя.
К счастью, PL/SQL предоставляет достаточно мощный и гибкий механизм перехвата и обработки ошибок. И вполне возможно написать на языке PL/SQL такое приложение, которое полностью защитит от ошибок и всех пользователей, и базу данных Oracle.
Основные концепции и терминология обработки исключений
В языке PL/SQL ошибки всех видов интерпретируются как исключения — ситуации, которые не должны возникать при нормальном выполнении программы.
К числу исключений относятся:
- ошибки, генерируемые системой (например, нехватка памяти или повторяющееся значение индекса);
- ошибки, вызванные действиями пользователя;
- предупреждения, выдаваемые приложением пользователю.
PL/SQL перехватывает ошибки и реагирует на них при помощи так называемых обработчиков исключений. Механизм обработчиков исключений позволяет четко отделить код обработки ошибок от основной логики программы, а также дает возможность реализовать обработку ошибок, управляемую событиями (в отличие от старой линейной модели). Независимо от того, как и по какой причине возникло конкретное исключение, оно всегда обрабатывается одним и тем же обработчиком в разделе исключений.
При возникновении ошибки — как системной, так и ошибки в приложении — в PL/SQL инициируется исключение. В результате выполнение блока прерывается, и управление передается для обработки в раздел исключений текущего блока, если он имеется. После обработки исключения возврат в тот блок, где исключение было инициировано, невозможен, поэтому управление передается во внешний блок.
Схема передачи управления при возникновении исключения показана на рис. 1.
Рис. 1. Архитектура обработки исключений
Существует два типа исключений:
- Системное исключение определяется в Oracle и обычно инициируется исполняемым ядром PL/SQL, обнаружившим ошибку. Одним системным исключениям присваиваются имена (например,
NO_DATA_FOUND
), другие ограничиваются номерами и описаниями. - Исключение, определяемое программистом, актуально только для конкретного приложения. Имя исключения можно связать с конкретной ошибкой Oracle с помощью директивы компилятора
EXCEPTION_INIT
или же назначить ошибке номер и описание процедуройRAISE_APPLICATION_ERROR
.
В этом блоге будут использоваться следующие термины:
- Раздел исключений — необязательный раздел блока PL/SQL (анонимного блока, процедуры, функции, триггера или инициализационного раздела пакета), содержащий один или несколько обработчиков исключений. Структура раздела исключений очень похожа на структуру команды
CASE
, о которой рассказывалось в этом блоге. - Инициировать исключение — значит остановить выполнение текущего блока PL/SQL, оповещая исполняемое ядро об ошибке. Исключение может инициировать либо Oracle, либо ваш собственный программный код при помощи команды
RAISE
или процедурыRAISE_APPLICATION_ERROR
. - Обработать исключение — значит перехватить ошибку, передав управление обработчику исключения. Написанный программистом обработчик может содержать код, который в ответ на исключение выполняет определенные действия (например, записывает информацию об ошибке в журнал, выводит сообщение для пользователя или передает исключение во внешний блок).
- Область действия — часть кода (конкретный блок или весь раздел), в котором может инициироваться исключение, а также часть кода, инициируемые исключения которого могут перехватываться и обрабатываться соответствующим разделом исключений.
- Передача исключения — процесс передачи исключения во внешний блок, если в текущем блоке это исключение не обработано.
- Необработанное исключение — исключение, которое передается без обработки из «самого внешнего» блока PL/SQL. После этого управление передается исполнительной среде, которая уже сама определяет, как отреагировать на исключение (выполнить откат транзакции, вывести сообщение об ошибке, проигнорировать ее и т. д.).
- Анонимное исключение — исключение, с которым связан код ошибки и описание. Такое исключение не имеет имени, которое можно было бы использовать в команде
RAISE
или секцииWHEN
обработчика исключений. - Именованное исключение — исключение, которому имя присвоено либо Oracle (в одном из встроенных пакетов), либо разработчиком. В частности, для этой цели можно использовать директиву компилятора
EXCEPTION_INIT
(в таком случае имя можно будет применять и для инициирования, и для обработки исключения).
Определение исключений
Прежде чем исключение можно будет инициировать и обрабатывать, его необходимо определить. В Oracle заранее определены тысячи исключений, большинство из которых имеют только номера и пояснительные сообщения. Имена присваиваются только самым распространенным исключениям.
Имена присваиваются в пакете STANDARD
(одном из двух пакетов по умолчанию PL/SQL; другой пакет — DBMS_STANDARD
), а также в других встроенных пакетах, таких как UTL_FILE
и DBMS_SQL
. Код, используемый Oracle для определения исключений (таких, как NO_DATA_FOUND
), не отличается от кода, который вы будете использовать для определения или объявления ваших собственных исключений.
Это можно сделать двумя способами, описанными ниже.
Объявление именованных исключений
Исключения PL/SQL, объявленные в пакете STANDARD
и в других встроенных пакетах, представляют внутренние (то есть системные) ошибки. Однако многие проблемы, с которыми будет сталкиваться пользователь приложения, актуальны только в этом конкретном приложении. Возможно, вашей программе придется перехватывать и обрабатывать такие ошибки, как «отрицательный баланс счета» или «дата обращения не может быть меньше текущей даты». Хотя эти ошибки имеют иную природу, нежели, скажем, ошибки «деления на нуль», они также относятся к разряду исключений, связанных с нормальной работой программы, и должны обрабатываться этой программой.
Одной из самых полезных особенностей обработки исключений PL/SQL является отсутствие структурных различий между внутренними ошибками и ошибками конкретных приложений. Любое исключение может и должно обрабатываться в разделе исключений независимо от типа ошибки.
Конечно, для обработки исключения необходимо знать его имя. Поскольку в PL/SQL имена пользовательским исключениям автоматически не назначаются, вы должны делать это самостоятельно, определяя исключения в разделе объявлений блока PL/SQL. При этом задается имя исключения, за которым следует ключевое слово EXCEPTION
:
имя_исключения EXCEPTION;
Следующий раздел объявлений процедуры calc_annual_sales
содержит два объявления исключений, определяемых программистом:
PROCEDURE calc_annual_sales(company_id_in IN company.company_id%TYPE)
IS
invalid_company_id EXCEPTION;
negative_balance EXCEPTION;
duplicate_company BOOLEAN;
BEGIN
... исполняемые команды ...
EXCEPTION
WHEN NO_DATA_FOUND -- системное исключение
THEN
...
WHEN invalid_company_id
THEN
WHEN negative_balance
THEN
...
END;
По своему формату имена исключений схожи с именами других переменных, но ссылаться на них можно только двумя способами:
- В команде RAISE, находящейся в исполняемом разделе программы (для инициирования исключения):
RAISE invalid_company_id;
- В секции WHEN раздела исключений (для обработки инициированного исключения):
WHEN invalid_company_id THEN
Связывание имени исключения с кодом ошибки
В Oracle, как уже было сказано, имена определены лишь для самых распространенных исключений. Тысячи других ошибок в СУБД имеют лишь номера и снабжены пояснительными сообщениями. Вдобавок инициировать исключение с номером ошибки (в диапазоне от –20 999 до –20 000) может и разработчик приложения, воспользовавшись для этой цели процедурой RAISE_APPLICATION_ERROR
(см. далее раздел «Инициирование исключений»).
Наличие в программном коде исключений без имен вполне допустимо, но такой код малопонятен и его трудно сопровождать. Допустим, вы написали программу, при выполнении которой Oracle выдает ошибку, связанную с данными, например ORA-01843: not a valid month
. Для перехвата этой ошибки в программу включается обработчик следующего вида:
EXCEPTION
WHEN OTHERS THEN
IF SQLCODE = -1843 THEN
Но код получается совершенно непонятным. Чтобы сделать смысл этого кода более очевидным, следует воспользоваться директивой EXCEPTION_INIT
.
Встроенная функция SQLCODE возвращает номер последней сгенерированной ошибки. Она будет рассмотрена далее в разделе «Обработка исключений» этой статьи.
Директива EXCEPTION_INIT
Директива компилятора EXCEPTION_INIT
(команда, выполняемая во время компиляции) связывает идентификатор, объявленный с ключевым словом EXCEPTION
, с внутренним кодом ошибки. Установив такую связь, можно инициировать исключение по имени и указать это имя в условии WHEN
обработчика ошибок.
С директивой EXCEPTION_INIT
условие WHEN
, использованное в предыдущем примере, приводится к следующему виду:
PROCEDURE my_procedure
IS
invalid_month EXCEPTION;
PRAGMA EXCEPTION_INIT (invalid_month, −1843);
BEGIN
...
EXCEPTION
WHEN invalid_month THEN
Жесткое кодирование номера ошибки становится излишним; имя ошибки говорит само за себя.
Директива EXCEPTION_INIT
должна располагаться в разделе объявлений блока. Указанное в ней исключение должно быть объявлено либо в том же блоке, либо во внешнем, либо в спецификации пакета. Синтаксис директивы в анонимном блоке:
DECLARE
имя_исключения EXCEPTION;
PRAGMA EXCEPTION_INIT (имя_исключения, целое_число);
Здесь имя_исключения
— имя исключения, объявляемого программистом, а целое_число
— номер ошибки Oracle, которую следует связать с данным исключением. Номером ошибки может служить любое число со следующими ограничениями:
- Номер ошибки не может быть равен –1403 (один из двух кодов ошибок
NO_DATA_FOUND
). Если вы по какой-либо причине захотите связать свое именованное исключение с этой ошибкой, передайте директивеEXCEPTION_INIT
значение 100. - Номер ошибки не может быть равен 0 или любому положительному числу, кроме 100.
- Номер ошибки не может быть отрицательным числом, меньшим –1 000 000.
Рассмотрим пример возможного объявления исключения. В приведенном ниже программном коде я объявляю и связываю исключение со следующим номером:
ORA-2292 integrity constraint (OWNER.CONSTRAINT) violated -
child record found.
Ошибка происходит при попытке удаления родительской записи, у которой в таблице имеются дочерние записи (то есть записи с внешним ключом, ссылающимся на родительскую запись):
PROCEDURE delete_company (company_id_in IN NUMBER)
IS
/* Объявление исключения. */
still_have_employees EXCEPTION;
/* Имя исключения связывается с номером ошибки. */
PRAGMA EXCEPTION_INIT (still_have_employees, 2292);
BEGIN
/* Попытка удаления информации о компании. */
DELETE FROM company
WHERE company_id = company_id_in;
EXCEPTION
/* При обнаружении дочерних записей инициируется это исключение! */
WHEN still_have_employees
THEN
DBMS_OUTPUT.PUT_LINE
('Пожалуйста, сначала удалите данные о служащих компании.');
END;
Рекомендации по использованию EXCEPTION_INIT
Директиву EXCEPTION_INIT
целесообразно использовать в двух ситуациях:
- при необходимости присвоить имя безымянному системному исключению, задействованному в программе (следовательно, если в Oracle не определено имя для некоторой ошибки, это еще не означает, что с ней можно работать только по номеру);
- когда нужно присвоить имя специфическому для приложения исключению, инициируемому процедурой
RAISE_APPLICATION_ERROR
(см. далее раздел «Инициирование исключений»). Это позволяет обрабатывать данное исключение по имени, а не по номеру.
В обоих случаях все директивы EXCEPTION_INIT
желательно объединить в пакет, чтобы определения исключений не были разбросаны по всему коду приложения. Допустим, вы интенсивно используете динамический SQL, и при выполнении запросов часто возникает ошибка «invalid column name» (неверное имя столбца). Запоминать код ошибки не хочется, но и определять директивы имя для исключения в 20 разных программах тоже неразумно. Поэтому имеет смысл определить собственные «системные исключения» в отдельном пакете для работы с динамическим SQL:
CREATE OR REPLACE PACKAGE dynsql
IS
invalid_table_name EXCEPTION;
PRAGMA EXCEPTION_INIT (invalid_table_name, -903);
invalid_identifier EXCEPTION;
PRAGMA EXCEPTION_INIT (invalid_identifier, -904);
Теперь перехват этих ошибок в программе может производиться следующим образом:
WHEN dynsql.invalid identifier THEN ...
Аналогичный подход рекомендуется использовать при работе с кодами ошибок –20NNN, передаваемыми процедуре RAISE_APPLICATION_ERROR
(см. далее в этой заметке моего блога). Создайте пакет, в котором этим кодам будут присваиваться имена. Он может выглядеть примерно так:
PACKAGE errnums
IS
en_too_young CONSTANT NUMBER := -20001;
exc_too_young EXCEPTION;
PRAGMA EXCEPTION_INIT (exc_too_young, -20001);
en_sal_too_low CONSTANT NUMBER := -20002;
exc_sal_too_low EXCEPTION;
PRAGMA EXCEPTION_INIT (exc_sal_too_low , -20002);
END errnums;
При наличии такого пакета можно использовать код следующего вида, не указывая номер ошибки в коде:
PROCEDURE validate_emp (birthdate_in IN DATE)
IS
min_years CONSTANT PLS_INTEGER := 18;
BEGIN
IF ADD_MONTHS (SYSDATE, min_years * 12 * -1) < birthdate_in
THEN
RAISE_APPLICATION_ERROR
(errnums.en_too_young,
'Возраст работника должен быть не менее ' || min_years || ' лет.');
END IF;
END;
Именованные системные исключения
В Oracle для относительно небольшого количества исключений определены стандартные имена, задаваемые директивой компилятора EXCEPTION_INIT
во встроенных пакетах. Самые важные и часто применяемые из них определены в пакете STANDARD
. Так как это один из двух используемых по умолчанию пакетов PL/SQL, на определенные в нем исключения можно ссылаться без префикса с именем пакета. Например, если потребуется инициировать в программе исключение NO_DATA_FOUND
, это можно сделать любой из следующих команд:
WHEN NO_DATA_FOUND THEN
WHEN STANDARD.NO_DATA_FOUND THEN
Определения стандартных именованных исключений встречаются и в других встроенных пакетах — например, в пакете DBMS_LOB
, предназначенном для работы с большими объектами. Пример одного такого определения из указанного пакета:
invalid_argval EXCEPTION;
PRAGMA EXCEPTION_INIT(invalid_argval, -21560);
Поскольку пакет DBMS_LOB
не используется по умолчанию, перед ссылкой на это исключение необходимо указать имя пакета:
WHEN DBMS_LOB.invalid_argval THEN...
Многие исключения, определенные в пакете STANDARD
, перечислены в табл. 1. Для каждого из них приводится номер ошибки Oracle, значение, возвращаемое при вызове SQLCODE
(встроенная функция SQLCODE
, которая возвращает текущий код ошибки — см. раздел «Встроенные функции ошибок»), и краткое описание. Значение, возвращаемое SQLCODE
, совпадает с кодом ошибки Oracle, с одним исключением: определяемый стандартом ANSI код ошибки NO_DATA_FOUND
равен 100.
Имя исключения/Ошибка Oracle/SQLCODE | Описание |
CURSOR_ALREADY_OPEN ORA-6511 SQLCODE = –6511 | Попытка открытия курсора, который был открыт ранее. Перед повторным открытием курсор необходимо сначала закрыть |
DUP_VAL_ON_INDEX ORA-00001 SQLCODE = −1 | Команда INSERT или UPDATE пытается сохранить повторяющиеся значения в столбцах, объявленных с ограничением UNIQUE |
INVALID_CURSOR ORA-01001 SQLCODE = −1001 | Ссылка на несуществующий курсор. Обычно ошибка встречается при попытке выборки данных из неоткрытого курсора или закрытия курсора до его открытия |
INVALID_NUMBER ORA-01722 SQLCODE = −1722 | Выполняемая SQL-команда не может преобразовать символьную строку в число. Это исключение отличается от VALUE_ERROR тем, что оно инициируется только из SQL-команд |
LOGIN_DENIED ORA-01017 SQLCODE = −1017 | Попытка программы подключиться к СУБД Oracle с неверным именем пользователя или паролем. Исключение обычно встречается при внедрении кода PL/SQL в язык 3GL |
NO_DATA_FOUND ORA-01403 SQLCODE = +100 | Исключение инициируется в трех случаях: (1) при выполнении инструкции SELECT INTO (неявный курсор), которая не возвращает ни одной записи; (2) при ссылке на неинициализированную запись локальной таблицы PL/SQL; (3) при попытке выполнить операцию чтения после достижения конца файла при использовании пакета UTL_FILE |
NOT_LOGGED ON ORA-01012 SQLCODE = −1012 | Программа пытается обратиться к базе данных (обычно из инструкции DML) до подключения к СУБД Oracle |
PROGRAM_ERROR ORA-06501 SQLCODE = −6501 | Внутренняя программная ошибка PL/SQL. В сообщении об ошибке обычно предлагается обратиться в службу поддержки Oracle |
STORAGE_ERROR ORA-06500 SQLCODE = −6500 | Программе PL/SQL не хватает памяти или память по какой-то причине повреждена |
TIMEOUT_ON_RESOURCE ORA-00051 SQLCODE = −51 | Тайм-аут СУБД при ожидании ресурса |
TOO_MANY_ROWS ORA-01422 SQLCODE = −1422 | Команда SELECT INTO возвращает несколько записей, хотя должна возвращать лишь одну (в таких случаях инструкция SELECT включается в явное определение курсора, а записи выбираются по одной) |
TRANSACTION_BACKED_OUT ORA-00061 SQLCODE = −61 | Удаленная часть транзакции отменена либо при помощи явной инструкции ROLLBACK , либо в результате какого-то другого действия (например, неудачного выполнения команды SQL или DML в удаленной базе данных) |
VALUE_ERROR ORA-06502 SQLCODE = −6502 | Ошибка связана с преобразованием, усечением или проверкой ограничений числовых или символьных данных. Это общее и очень распространенное исключение. Если подобная ошибка содержится в инструкции SQL или DML, то в блоке PL/SQL инициируется исключение INVALID_NUMBER |
ZERO_DIVIDE ORA-01476 SQLCODE = −1476 | Попытка деления на ноль |
Рассмотрим пример использования этой таблицы исключений. Предположим, ваша программа инициирует необрабатываемое исключение для ошибки ORA-6511. Заглянув в таблицу, вы видите, что она связана с исключением CURSOR_ALREADY_OPEN
. Найдите блок PL/SQL, в котором произошла ошибка, и добавьте в него обработчик исключения
CURSOR_ALREADY_OPEN:
EXCEPTION
WHEN CURSOR_ALREADY_OPEN
THEN
CLOSE my_cursor;
END;
Конечно, еще лучше было бы проанализировать весь программный код и заранее определить, какие из стандартных исключений в нем могут инициироваться. В таком случае вы сможете решить, какие исключения следует обрабатывать конкретно, какие следует включить в конструкцию WHEN OTHERS
(см. далее), а какие оставить необработанными.
Область действия исключения
Областью действия исключения называется та часть программного кода, к которой оно относится, то есть блок, где данное исключение может быть инициировано. В следующей таблице указаны области действия исключений четырех разных типов.
Тип исключения | Область действия |
Именованное системное исключение | Исключение является глобальным, то есть не ограничивается каким-то конкретным блоком кода. Системные исключения могут инициироваться и обрабатываться в любом блоке |
Именованное исключение, определяемое программистом | Исключение может инициироваться и обрабатываться только в исполнительном разделе и разделе исключений, входящих в состав блока, где объявлено данное исключение (или в состав любого из вложенных в него блоков). Если исключение определено в спецификации пакета, то его областью действия являются все те программы, владельцы которых обладают для этого пакета привилегией EXECUTE |
Анонимное системное исключение | Исключение может обрабатываться в секции WHEN OTHERS любого раздела исключений PL/SQL. Если присвоить ему имя, то его область действия будет такой же, как у именованного исключения, определяемого программистом |
Анонимное исключение, определяемое программистом | Исключение определяется в вызове процедуры RAISE_APPLICATION_ERROR , а затем передается в вызывающую программу |
Рассмотрим пример исключения overdue_balance
, объявленного в процедуре check_account
(таким образом, область его действия ограничивается указанной процедурой):
PROCEDURE check_account (company_id_in IN NUMBER)
IS
overdue_balance EXCEPTION;
BEGIN
... исполняемые команды ...
LOOP
...
IF ... THEN
RAISE overdue_balance;
END IF;
END LOOP;
EXCEPTION
WHEN overdue_balance THEN ...
END;
С помощью команды RAISE
исключение overdue_balance
можно инициировать в процедуре check_account
, но не в программе, которая ее вызывает. Например, для следующего анонимного блока компилятор выдает ошибку:
DECLARE
company_id NUMBER := 100;
BEGIN
check_account (100);
EXCEPTION
WHEN overdue_balance /* В PL/SQL такая ссылка недопустима. */
THEN ...
END;
PLS-00201: identifier "OVERDUE_BALANCE" must be declared
Для приведенного выше анонимного блока процедура check_account
является «черным ящиком». Все объявленные в ней идентификаторы, в том числе идентификаторы исключения, не видны для внешнего программного кода.
Инициирование исключений
Исключение может быть инициировано приложением в трех случаях:
- Oracle инициирует исключение при обнаружении ошибки;
- приложение инициирует исключение командой
RAISE
; - исключение инициируется встроенной процедурой
RAISE_APPLICATION_ERROR
.
Как Oracle инициирует исключения, вы уже знаете. Теперь давайте посмотрим, как это может сделать программист.
Команда RAISE
Чтобы программист имел возможность самостоятельно инициировать именованные исключения, в Oracle поддерживается команда RAISE
. С ее помощью можно инициировать как собственные, так и системные исключения. Команда имеет три формы:
RAISE имя_исключения;
RAISE имя_пакета.имя_исключения;
RAISE;
Первая форма (без имени пакета) может инициировать исключения, определенные в текущем блоке (или в содержащем его блоке), а также системные исключения, объявленные в пакете STANDARD
. Далее приводятся два примера, в первом из которых инициируется исключение, определенное программистом:
DECLARE
invalid_id EXCEPTION; -- Все идентификаторы должны начинаться с буквы 'X'.
id_value VARCHAR2(30);
BEGIN
id_value := id_for ('SMITH');
IF SUBSTR (id_value, 1, 1) != 'X'
THEN
RAISE invalid_id;
END IF;
...
END;
При необходимости вы всегда можете инициировать системное исключение:
BEGIN
IF total_sales = 0
THEN
RAISE ZERO_DIVIDE; -- Определено в пакете STANDARD
ELSE
RETURN (sales_percentage_calculation (my_sales, total_sales));
END IF;
END;
Если исключение объявлено в пакете (но не в STANDARD
) и инициируется извне, имя исключения необходимо уточнить именем пакета:
IF days_overdue (isbn_in, borrower_in) > 365
THEN
RAISE overdue_pkg.book_is_lost;
END IF;
Третья форма RAISE
не требует указывать имя исключения, но используется только в условии WHEN
раздела исключений. Ее синтаксис предельно прост:
RAISE;
Используйте эту форму для повторного инициирования (передачи) перехваченного исключения:
EXCEPTION
WHEN NO_DATA_FOUND
THEN
-- Используем общий пакет для сохранений всей контекстной
-- информации: код ошибки, имя программы и т. д.
errlog.putline (company_id_in);
-- А теперь исключение NO_DATA_FOUND передается
-- в родительский блок без обработки.
RAISE;
Эта возможность особенно полезна в тех случаях, когда информацию об ошибке нужно записать в журнал, а сам процесс обработки возложить на родительский блок. Таким образом выполнение родительских блоков завершается без потери информации об ошибке.
Процедура RAISE_APPLICATION_ERROR
Для инициирования исключений, специфических для приложения, Oracle предоставляет процедуру RAISE_APPLICATION_ERROR
(определенную в используемом по умолчанию пакете DBMS_STANDARD
). Ее преимущество перед командой RAISE (которая тоже может инициировать специфические для приложения явно объявленные исключения) заключается в том, что она позволяет связать с исключением сообщение об ошибке.
При вызове этой процедуры выполнение текущего блока PL/SQL прекращается, а любые изменения аргументов OUT
и IN OUT
(если таковые имеются) отменяются. Изменения, внесенные в глобальные структуры данных (с помощью команды INSERT, UPDATE, MERGE
или DELETE
), такие как переменные пакетов и объекты баз данных, не отменяются. Для отката DML-команд необходимо явно указать в разделе обработки исключений команду ROLLBACK
.
Заголовок этой процедуры (определяемый в пакете DBMS_STANDARD
) выглядит так:
PROCEDURE RAISE_APPLICATION_ERROR (
num binary_integer,
msg varchar2,
keeperrorstack boolean default FALSE);
Здесь num
— номер ошибки из диапазона от –20 999 до –20 000 (только представьте: все остальные отрицательные числа Oracle резервирует для собственных исключений!); msg
— сообщение об ошибке, длина которого не должна превышать 2048 символов (символы, выходящие за эту границу, игнорируются); аргумент keeperrorstack
указывает, хотите ли вы добавить ошибку к уже имеющимся в стеке (TRUE
), или заменить существующую ошибку (значение по умолчанию — FALSE
).
Oracle выделяет диапазон номеров от –20 999 до –20 000 для пользовательских ошибок, но учтите, что в некоторых встроенных пакетах, в том числе в DBMS_OUTPUT
и DBMS_DESCRIBE
, номера от –20 005 до –20 000 все равно присваиваются системным ошибкам. За дополнительной информацией обращайтесь к документации пакетов.
Рассмотрим пример полезного применения этой встроенной процедуры. Допустим, мы хотим, чтобы сообщения об ошибках выдавались пользователям на разных языках. Создадим для них таблицу error_table
и определим в ней язык каждого сообщения значением столбца string_language
. Затем создается процедура, которая генерирует заданную ошибку, загружая соответствующее сообщение из таблицы с учетом языка текущего сеанса:
PROCEDURE raise_by_language (code_in IN PLS_INTEGER)
IS
l_message error_table.error_string%TYPE;
BEGIN
SELECT error_string
INTO l_message
FROM error_table
WHERE error_number = code_in
AND string_language = USERENV ('LANG');
RAISE_APPLICATION_ERROR (code_in, l_message);
END;
Обработка исключений
Как только в программе возникает исключение, нормальное выполнение блока PL/SQL останавливается, и управление передается в раздел исключений. Затем исключение либо обрабатывается обработчиком исключений в текущем блоке PL/SQL, либо передается в родительский блок.
Чтобы обработать или перехватить исключение, нужно написать для него обработчик. Обработчики исключений располагаются после всех исполняемых команд блока, но перед завершающим ключевым словом END
. Начало раздела исключений отмечает ключевое слово EXCEPTION
:
DECLARE
... объявления ...
BEGIN
... исполняемые команды ...
[ EXCEPTION
... обработчики исключений ... ]
END;
Синтаксис обработчика исключений может быть таким:
WHEN имя_исключения [ OR имя_исключения ... ]
THEN
исполняемые команды
или таким:
WHEN OTHERS
THEN
исполняемые команды
В одном разделе исключений может быть несколько их обработчиков. Структура обработчиков напоминает структуру условной команды CASE
.
Свойство | Описание |
EXCEPTION WHEN NO_DATA_FOUND THEN исполняемые_команды1; | Если инициировано исключение NO_DATA_FOUND , выполнить первый набор команд |
WHEN payment_overdue THEN исполняемые_команды2; | Если просрочена оплата, выполнить второй набор команд |
WHEN OTHERS THEN исполняемые_команды3; END; | Если инициировано иное исключение, выполнить третий набор команд |
Если имя, заданное в условии WHEN
, совпадает с инициированным исключением, то это исключение обрабатывается соответствующим набором команд. Обратите внимание: исключения перехватываются по именам, а не по кодам ошибок. Но если инициированное исключение не имеет имени или его имя не соответствует ни одному из имен, указанных в условиях WHEN
, тогда оно обрабатывается командами, заданными в секции WHEN OTHERS
(если она имеется). Любая ошибка может быть перехвачена только одним обработчиком исключений. После выполнения команд обработчика управление сразу же передается из текущего блока в родительский или вызывающий блок.
Секция WHEN OTHERS
не является обязательной. Когда она отсутствует, все необработанные исключения немедленно передаются в родительский блок, если таковой имеется. Секция WHEN OTHERS
должна быть последним обработчиком исключений в блоке. Если разместить после нее еще одну секцию WHEN
, компилятор выдаст сообщение об ошибке.
Встроенные функции ошибок
Прежде чем переходить к изучению тонкостей обработки ошибок, мы сначала вкратце познакомимся со встроенными функциями Oracle, предназначенными для идентификации, анализа и реагирования на ошибки, возникающие в приложениях PL/SQL.
SQLCODE
Функция SQLCODE
возвращает код ошибки последнего исключения, инициированного в блоке. При отсутствии ошибок SQLCODE
возвращает 0. Кроме того, SQLCODE
возвращает 0 при вызове за пределами обработчика исключений.
База данных Oracle поддерживает стек значений SQLCODE
. Допустим, к примеру, что функция FUNC инициирует исключение VALUE_ERROR
(–6502). В разделе исключений FUNC
вызывается процедура PROC
, которая инициирует исключение DUP_VAL_ON_INDEX
(–1). В разделе исключений PROC
функция SQLCODE
возвращает значение –1. Но когда управление передается в раздел исключений FUNC
, SQLCODE
будет возвращать –6502.
SQLERRM
Функция SQLERRM
возвращает сообщение об ошибке для заданного кода ошибки. Если вызвать SQLERRM
без указания кода ошибки, функция вернет сообщение, связанное со значением, возвращаемым SQLCODE
. Например, если SQLCODE
возвращает 0, функция SQLERRM
вернет следующую строку:
ORA-0000: normal, successful completion
Если же SQLCODE
возвращает 1 (обобщенный код ошибки для исключения, определяемого пользователем), SQLERRM
вернет строку:
User-Defined Exception
Пример вызова SQLERRM
для получения сообщения об ошибке для конкретного кода:
1 BEGIN
2 DBMS_OUTPUT.put_line (SQLERRM (-1403));
3* END;
SQL> /
ORA-01403: no data found
Максимальная длина строки, возвращаемой SQLERRM
, составляет 512 байт (в некоторых ранних версиях Oracle — 255 байт). Из-за этого ограничения Oracle Corporation рекомендует вызывать функцию DBMS_UTILITY
.FORMAT_ERROR_STACK
, чтобы гарантировать вывод полной строки (эта встроенная функция не усекает текст до 2000 байт).
DBMS_UTILITY.FORMAT_ERROR_STACK
Эта встроенная функция, как и SQLERRM
, возвращает сообщение, связанное с текущей ошибкой (то есть значение, возвращаемое SQLCODE
). Ее отличия от SQLERRM
:
- Она возвращает до 1899 символов сообщения, что позволяет избежать проблем с усечением.
- Этой функции не может передаваться код ошибки; соответственно, она не может использоваться для получения сообщения, соответствующего произвольному коду.
Как правило, эта функция вызывается в логике обработчика исключения для получения полного сообщения об ошибке.
Хотя в имя функции входит слово «stack», она не возвращает информацию о стеке ошибок, приведшем к строке, в которой изначально была инициирована ошибка. Эту задачу решает DBMS_UTILITY
.FORMAT_ERROR_BACKTRACE
.
DBMS_UTILITY.FORMAT_ERROR_BACKTRACE
Эта функция, появившаяся в Oracle10g, возвращает отформатированную строку с содержимым стека программ и номеров строк. Ее выходные данные позволяют отследить строку, в которой изначально была инициирована ошибка.
Тем самым заполняется весьма существенный пробел в функциональности PL/SQL. В Oracle9i и предшествующих версиях после обработки исключения в блоке PL/ SQL было невозможно определить строку, в которой произошла ошибка (возможно, самая важная информация для разработчика). Если программист хотел получить эту информацию, он должен был разрешить прохождение необработанного исключения, чтобы полная трассировочная информация ошибки была выведена на экран. Ситуация более подробно описана в следующем разделе.
DBMS_UTILITY.FORMAT_CALL_STACK
Функция возвращает отформатированную строку со стеком вызовов в приложении PL/SQL. Практическая полезность функции не ограничивается обработкой ошибок; она также пригодится для трассировки выполнения вашего кода.
В Oracle Database 12c появился пакет UTL_CALL_STACK
, который также предоставляет доступ к стеку вызовов, стеку ошибок и информации обратной трассировки.
Подробнее о DBMS_UTILITY.FORMAT_ERROR_BACKTRACE
Функцию DBMS_UTILITY
.FORMAT_ERROR_BACKTRACE
следует вызывать в обработчике исключения. Она выводит содержимое стека выполнения в точке инициирования исключения. Таким образом, вызов DBMS_UTILITY
.FORMAT_ERROR_BACKTRACE
в разделе исключений на верхнем уровне стека позволит узнать, где именно в стеке вызовов произошла ошибка. Рассмотрим следующий сценарий: мы определяем процедуру proc3
, которая вызывает процедуру proc2
, а последняя, в свою очередь, вызывает proc1
. Процедура proc1 инициирует исключение:
CREATE OR REPLACE PROCEDURE proc1 IS
BEGIN
DBMS_OUTPUT.put_line ('выполнение proc1');
RAISE NO_DATA_FOUND;
END;
/
CREATE OR REPLACE PROCEDURE proc2 IS
l_str VARCHAR2 (30) := 'вызов proc1';
BEGIN
DBMS_OUTPUT.put_line (l_str);
proc1;
END;
/
CREATE OR REPLACE PROCEDURE proc3 IS
BEGIN
DBMS_OUTPUT.put_line ('вызов proc2');
proc2;
EXCEPTION
WHEN OTHERS
THEN
DBMS_OUTPUT.put_line ('Стек ошибок верхнего уровня:');
DBMS_OUTPUT.put_line (DBMS_UTILITY.format_error_backtrace);
END;
/
Единственной программой с обработчиком ошибок является внешняя процедура proc3
. Вызов функции трассировки включен в обработчик WHEN OTHERS
процедуры proc3
. При выполнении этой процедуры будет получен следующий результат:
SQL> SET SERVEROUTPUT ON
SQL> BEGIN
2 DBMS_OUTPUT.put_line ('Proc3 -> Proc2 -> Proc1 backtrace');
3 proc3;
4 END;
5 /
Proc3 -> Proc2 -> Proc1 backtrace
вызов proc2
вызов proc1
выполнение proc1
Error stack at top level:
ORA-06512: at "SCOTT.PROC1", line 4
ORA-06512: at "SCOTT.PROC2", line 5
ORA-06512: at "SCOTT.PROC3", line 4
Как видите, функция трассировки выводит в начале стека номер строки proc1
, в которой произошла исходная ошибка.
Часто исключение происходит где-то в глубине стека вызовов. Если вы хотите, чтобы оно было передано во внешний блок PL/SQL, вероятно, вам придется заново инициировать его в каждом обработчике стека блоков. Функция DBMS_UTILITY
.FORMAT_ERROR_BACKTRACE
выдает трассировку исполнения вплоть до последней команды RAISE
в сеансе пользователя. Учтите, что вызов RAISE
для конкретного исключения или повторное инициирование текущего исключения приводит к инициализации стека, выдаваемого DBMS_UTILITY
.FORMAT_ERROR_BACKTRACE
. Таким образом, если вы хотите использовать эту функцию, возможны два пути:
- Вызовите функцию в разделе исключений блока, в котором была инициирована ошибка. Это позволит вам получить (и сохранить в журнале) номер ошибки, даже если исключение было заново инициировано в дальнейшей позиции стека.
- Обойдите обработчики исключений в промежуточных программах вашего стека и вызовите функцию в разделе исключений внешней программы в стеке.
Только номер строки, пожалуйста
В реальном приложении трассировка ошибок может быть очень длинной. Как правило, специалиста, занимающегося отладкой или поддержкой, не интересует весь стек — достаточно только последнего элемента. Возможно, разработчику приложения стоит вывести эту важную информацию, чтобы пользователь мог немедленно и точно описать суть проблемы группе поддержки.
В такой ситуации необходимо разобрать строку с данными трассировки и извлечь из нее последний элемент. Я написал для этого специальную программу и оформил ее в пакет BT
. В этом пакете реализован простой, понятный интерфейс:
PACKAGE bt
IS
TYPE error_rt IS RECORD (
program_owner all_objects.owner%TYPE
, program_name all_objects.object_name%TYPE
, line_number PLS_INTEGER
);
FUNCTION info (backtrace_in IN VARCHAR2)
RETURN error_rt;
PROCEDURE show_info (backtrace_in IN VARCHAR2);
END bt;
Тип записи error_rt
содержит отдельное поле для каждого возвращаемого элемента трассировки (владелец программного модуля, имя программного модуля и номер строки в программе). Затем вместо того, чтобы вызывать функцию трассировки в каждом разделе исключения и разбирать ее результаты, я вызываю функцию bt.info
и вывожу конкретную информацию об ошибке.
Полезные применения SQLERRM
Вы можете использовать DBMS_UTILITY
.FORMAT_ERROR_STACK
вместо SQLERRM
, но это не означает, что функция SQLERRM
совершенно неактуальна. В частности, она поможет вам получить ответ на следующие вопросы:
- Является ли заданное число действительным кодом ошибки Oracle?
- Какое сообщение соответствует коду ошибки?
Как упоминалось ранее в нашей статье, функция SQLERRM
возвращает сообщение об ошибке для заданного кода. Но если передать SQLERRM
недействительный код, исключение не инициируется. Вместо этого возвращается строка в одном из двух форматов:
- Если число отрицательно:
ORA-NNNNN: Message NNNNN not found; product=RDBMS; facility=ORA
- Если число положительно или меньше −65535:
-N: non-ORACLE exception
Этим обстоятельством можно воспользоваться для построения функций, возвращающих точную информацию о том коде, с которым вы работаете в настоящее время. Ниже приведена спецификация пакета с этими программами:
PACKAGE oracle_error_info
IS
FUNCTION is_app_error (code_in IN INTEGER)
RETURN BOOLEAN;
FUNCTION is_valid_oracle_error (
code_in IN INTEGER
, app_errors_ok_in IN BOOLEAN DEFAULT TRUE
, user_error_ok_in IN BOOLEAN DEFAULT TRUE
)
RETURN BOOLEAN;
PROCEDURE validate_oracle_error (
code_in IN INTEGER
, message_out OUT VARCHAR2
, is_valid_out OUT BOOLEAN
, app_errors_ok_in IN BOOLEAN DEFAULT TRUE
, user_error_ok_in IN BOOLEAN DEFAULT TRUE
);
END oracle_error_info;
Объединение нескольких исключений в одном обработчике
В одном условии WHEN
можно оператором OR
объединить несколько исключений — подобно тому, как этим оператором объединяются логические выражения:
WHEN invalid_company_id OR negative_balance
THEN
В одном обработчике также можно комбинировать имена пользовательских и системных исключений:
WHEN balance_too_low OR ZERO_DIVIDE OR DBMS_LDAP.INVALID_SESSION
THEN
Впрочем, применять оператор AND
в такой комбинации нельзя, потому что в любой момент времени может быть инициировано только одно исключение.
Необработанные исключения
Исключение, инициированное в программе, но не обработанное в соответствующем разделе текущего или родительского блока PL/SQL, называется необработанным. PL/ SQL возвращает сообщение об ошибке, вызвавшей необработанное исключение, в ту среду, где была запущена данная программа. Эта среда (ею может быть SQL*Plus. Oracle Forms, программа на языке Java и т. д.) действует по ситуации. В частности, SQL*Plus осуществляет откат всех DML-инструкций, выполненных в родительском блоке.
Одним из важнейших моментов, связанных с проектированием архитектуры приложения, является вопрос о том, разрешается ли в нем использовать необработанные исключения. Такие исключения разными средами обрабатываются по-разному, и не всегда это делается корректно. Если ваша программа PL/SQL вызывается не из PL/SQL-среды, в ее «самом внешнем» блоке можно запрограммировать следующие действия:
- перехват всех исключений, которые могли быть переданы до текущей точки;
- запись информации об ошибке в журнал, с тем чтобы впоследствии ее мог проанализировать разработчик;
- возврат кода состояния, описания и другой информации, необходимой управляющей среде для выбора оптимального варианта действий.
Передача необработанного исключения
Блок, в котором может быть инициировано исключение, определяется правилами области действия исключений. В программе инициированное исключение распространяется в соответствии с определенными правилами.
Сначала PL/SQL ищет обработчик исключения в текущем блоке (анонимном блоке, процедуре или функции). Если такового нет, исключение передается в родительский блок. Затем PL/SQL пытается обработать исключение, инициировав его еще раз в родительском блоке. И так происходит в каждом внешнем по отношению к другому блоке до тех пор, пока все они не будут исчерпаны (рис. 2). После этого PL/SQL возвращает необработанное исключение в среду приложения, выполнившего «самый внешний» блок PL/SQL. И только теперь исключение может прервать выполнение основной программы.
Рис. 2. Передача исключений во вложенных блоках PL/SQL
Потеря информации об исключении
Структура процесса обработки локальных, определяемых программистом исключений в PL/SQL такова, что можно легко потерять информацию об исключении (то есть о том, какая именно произошла ошибка). Пример:
BEGIN
<<local_block>>
DECLARE
case_is_not_made EXCEPTION;
BEGIN
...
END local_block;
Допустим, мы забыли включить в этот блок раздел исключений. Область действия исключения case_is_not_made
ограничена блоком local_block
. Если исключение не обрабатывается в данном блоке, оно передается в родительский, где нет никакой информации о нем. Известно только то, что произошла ошибка, а какая именно — неизвестно. Ведь все пользовательские исключения имеют один и тот же номер ошибки 1 и одно и то же сообщение «User Defined Exception» — если только вы не воспользуетесь директивой EXCEPTION_INIT
, чтобы связать с объявленным исключением другой номер, и не присвоите ему другое сообщение об ошибке при вызове RAISE_APPLICATION_ERROR
.
Таким образом, локально объявленные (и инициированные) исключения всегда следует обрабатывать по имени.
Примеры передачи исключения
Рассмотрим несколько примеров передачи исключений через внешние блоки. На рис. 3 показано, как исключение too_many_faults
, инициированное во внутреннем блоке, обрабатывается в следующем — внешнем — блоке. Внутренний блок содержит раздел исключений, так что PL/SQL сначала проверяет, обрабатывается ли в этом разделе инициированное исключение too_many_faults
.
Рис. 3. Передача исключений во вложенных блоках PL/SQL
А поскольку оно не обрабатывается, PL/SQL закрывает этот блок и инициирует исключение too_many_faults
во внешнем блоке, обозначенном на рисунке как вложенный блок 1. (Используемые команды, расположенные после вложенного блока 2, не выполняются.) Затем просматривается раздел исключений этого блока с целью поиска обработчика исключения too_many_faults
, который обрабатывает его и передает управление процедуре list_my_faults
.
Обратите внимание: если исключение NO_DATA_FOUND
будет инициировано в «самом внутреннем» блоке, то оно будет обработано в разделе исключений этого же блока. Затем управление передается во вложенный блок 1 и будут выполнены исполняемые команды, расположенные после вложенного блока 2.
На рис. 4 представлен пример обработки в «самом внешнем» блоке исключения, инициированного во внутреннем блоке. В изображенной ситуации раздел исключений присутствует только во внешнем блоке, поэтому когда во вложенном блоке 2 инициируется исключение too_many_faults
, PL/SQL прекращает выполнение этого блока и инициирует данное исключение в его родительском блоке, то есть вложенном блоке 1. Но поскольку и у него нет раздела исключений, управление передается «самому внешнему» блоку, процедуре list_my_faults
. В этой процедуре имеется раздел исключений, поэтому PL/ SQL проверяет его, находит обработчик исключения too_many_faults
, выполняет имеющийся там код и передает управление программе, вызвавшей процедуру list_my_faults
.
Рис. 4. Исключение, инициированное во вложенном блоке,
обрабатывается в «самом внешнем» блоке
Продолжение выполнения после исключений
Когда в блоке PL/SQL инициируется исключение, нормальная последовательность выполнения программы прерывается, а управление передается в раздел исключений. Вернуться к исполняемому разделу блока после возникновения в нем исключения уже не удастся. Впрочем, в некоторых ситуациях требуется именно это — продолжить выполнение программы после обработки исключения.
Рассмотрим следующий сценарий: требуется написать процедуру, которая применяет серию операций DML к разным таблицам (удаление из одной таблицы, обновление другой, вставка в последнюю таблицу). На первый взгляд код мог бы выглядеть примерно так:
PROCEDURE change_data IS
BEGIN
DELETE FROM employees WHERE ... ;
UPDATE company SET ... ;
INSERT INTO company_history SELECT * FROM company WHERE ... ;
END;
Безусловно, процедура содержит все необходимые команды DML. Однако одно из требований к программе заключается в том, что при последовательном выполнении этих команд они должны быть логически независимы друг от друга. Другими словами, даже если при выполнении DELETE
произойдет сбой, программа должна выполнить UPDATE
и INSERT
.
В текущей версии change_data
ничто не гарантирует, что программа хотя бы попытается выполнить все три операции DML. Если при выполнении DELETE
произойдет исключение, например, то выполнение всей программы прервется, а управление будет передано в раздел исключений (если он имеется). Остальные команды SQL при этом выполняться не будут.
Как обеспечить обработку исключения без прерывания программы? Для этого DELETE
следует поместить в собственный блок PL/SQL. Рассмотрим следующую версию программы change_data
:
PROCEDURE change_data
IS
BEGIN
BEGIN
DELETE FROM employees WHERE ... ;
EXCEPTION
WHEN OTHERS THEN log_error;
END;
BEGIN
UPDATE company SET ... ;
EXCEPTION
WHEN OTHERS THEN log_error;
END;
BEGIN
INSERT INTO company_history SELECT * FROM company WHERE ... ;
EXCEPTION
WHEN OTHERS THEN log_error;
END;
END;
В новом варианте программы, если при выполнении DELETE
произойдет исключение, управление немедленно передается в раздел исключений. Но поскольку команда DELETE
теперь находится в собственном блоке, она может иметь собственный раздел исключений. Условие WHEN OTHERS
этого раздела обрабатывает ошибку без повторного инициирования этой или другой ошибки, после чего управление возвращается за пределы блока DELETE
внешней процедуре change_data
. Так как «активное» исключение отсутствует, выполнение продолжается во внешнем блоке со следующей команды процедуры. Программа входит в новый анонимный блок для команды UPDATE
. Если при выполнении UPDATE
произойдет ошибка, она будет перехвачена условием WHEN OTHERS
раздела исключений UPDATE
. Далее управление будет возвращено процедуре change_data
, которая перейдет к выполнению команды INSERT
(также содержащейся в собственном блоке).
На рис. 5 показано, как выполняется этот процесс для двух последовательно выполняемых команд DELETE
.
Рис. 5. Последовательное выполнение DELETE с разными областями действия
Подведем итог: исключение, инициированное в исполняемом разделе, всегда обрабатывается в текущем блоке (при наличии подходящего обработчика). Любую команду можно заключить в «виртуальный блок», заключив ее между ключевыми словами BEGIN
и END
с определением раздела EXCEPTION
. Это позволяет ограничить область действия сбоев в программе посредством определения «буферных» анонимных блоков.
Эту стратегию можно развить с выделением изолируемого кода в отдельные процедуры и функции. Конечно, именованные блоки PL/SQL тоже могут иметь собственные разделы исключений и предоставлять ту же защиту от общих сбоев. Важнейшее преимущество процедур и функций заключается в том, что они скрывают все команды BEGIN-EXCEPTION-END
от основной программы. Программа лучше читается, код проще сопровождать и повторно использовать в других контекстах.
Существуют и другие способы продолжить выполнение после исключения DML — например, можно использовать конструкцию SAVE EXCEPTIONS
с FORALL
и LOG ERRORS
в сочетании с DBMS_ERRORLOG
.
Написание раздела WHEN OTHERS
Условие WHEN OTHERS
включается в раздел исключений для перехвата всех исключений, не обработанных предшествующими обработчиками. Так как конкретный тип исключения изначально неизвестен, в WHEN OTHERS
очень часто используются встроенные функции для получения информации о возникшей ошибке (такие, как SQLCODE
и DBMS_UTILITY
. FORMAT_ERROR_STACK
).
В сочетании с WHEN OTHERS
функция SQLCODE
представляет средства для обработки разных видов исключений без применения директивы EXCEPTION_INIT
. В следующем примере перехватываются два исключения категории «родитель/потомок», −1 и −2292, и для каждой ситуации выполняется подходящее действие:
PROCEDURE add_company (
id_in IN company.ID%TYPE
, name_in IN company.name%TYPE
, type_id_in IN company.type_id%TYPE
)
IS
BEGIN
INSERT INTO company (ID, name, type_id)
VALUES (id_in, name_in, type_id_in);
EXCEPTION
WHEN OTHERS
THEN
/*
|| Анонимный блок в обработчике исключения позволяет объявить
|| локальные переменные для хранения информации о кодах ошибок.
*/
DECLARE
l_errcode PLS_INTEGER := SQLCODE;
BEGIN
CASE l_errcode
WHEN −1 THEN
-- Дублирующееся значение уникального индекса. Повторяется либо
-- первичный ключ, либо имя. Сообщить о проблеме
-- и инициировать исключение заново.
DBMS_OUTPUT.put_line
( 'идентификатор или имя компании уже используется. ID = '
|| TO_CHAR (id_in)
|| ' name = '
|| name_in
);
RAISE;
WHEN −2291 THEN
-- Родительский ключ не найден. Сообщить о проблеме
-- и инициировать исключение заново.
DBMS_OUTPUT.put_line (
'Недопустимый идентификатор типа компании: ' || TO_CHAR (type_id_in));
RAISE;
ELSE
RAISE;
END CASE;
END; -- Конец анонимного блока.
END add_company;
Будьте осторожны при использовании WHEN OTHERS
— этот раздел способен «поглощать» ошибки, скрывая их от внешних блоков и пользователя. А точнее, обращайте внимание на обработчики WHEN OTHERS
, которые не инициируют текущее исключение заново и не заменяют его другим исключением. Если WHEN OTHERS
не передает исключение наружу, внешние блоки вашей программы не узнают о возникшей ошибке.
В Oracle Database 11g появилось новое предупреждение, которое помогает выявлять программы, игнорирующие ошибки или поглощающие их:
PLW-06009: procedure "string" OTHERS handler does not end in RAISE or RAISE_
APPLICATION_ERROR
Пример использования этого предупреждения:
SQL> ALTER SESSION SET plsql_warnings = 'enable:all'
2 /
SQL> CREATE OR REPLACE PROCEDURE plw6009_demo
2 AS
3 BEGIN
4 DBMS_OUTPUT.put_line ('I am here!');
5 RAISE NO_DATA_FOUND;
6 EXCEPTION
7 WHEN OTHERS
8 THEN
9 NULL;
10 END plw6009_demo;
11 /
SP2-0804: Procedure created with compilation warnings
SQL> SHOW ERRORS
Errors for PROCEDURE PLW6009_DEMO:
LINE/COL ERROR
-------- -----------------------------------------------------------------
7/9 PLW-06009: procedure "PLW6009_DEMO" OTHERS handler does not end
in RAISE or RAISE_APPLICATION_ERROR
Построение эффективной архитектуры управления ошибками
Механизм инициирования и обработки ошибок в PL/SQL отличается мощью и гибкостью, но он не лишен недостатков, которые могут создать проблемы для групп разработки, желающих реализовать надежную, последовательную, содержательную архитектуру управления ошибками. В частности, вы столкнетесь со следующими проблемами:
EXCEPTION
— особая разновидность структуры данных PL/SQL. Переменные, объявленные с типомEXCEPTION
, можно только инициировать и обрабатывать. Исключение нельзя передать в аргументе программы, с ним нельзя связать дополнительные атрибуты.- Повторное использование кода обработки исключений сильно затруднено. Из предыдущего пункта непосредственно следует другой факт: раз исключение нельзя передать в аргументе, разработчику приходится копировать код обработчика — конечно, такой способ написания кода никак не назовешь оптимальным.
- Не существует формализованного способа объявления исключений, которые могут инициироваться программой. Например, в Java эта информация становится частью спецификации программы. Как следствие, разработчику приходится обращаться к коду реализации и искать в нем информацию о потенциальных исключениях — или же надеяться на лучшее.
- Oracle не предоставляет средств организации и классификации исключений, относящихся к конкретному приложению, а просто резервирует (в основном) 1000 кодов в диапазоне от −20 999 до −20 000. Управлять этими значениями должен сам разработчик.
Давайте посмотрим, как преодолеть большинство из перечисленных трудностей.
Определение стратегии управления ошибками
Очень важно, чтобы еще до написания кода была выработана последовательная стратегия и архитектура обработки ошибок в приложении. Вот лишь некоторые вопросы, на которые необходимо ответить для этого:
- Как и когда сохранять информацию об ошибках для последующего просмотра и исправления? Куда выводить информацию — в файл, в таблицу базы данных? выводить на экран?
- Как и где сообщать об ошибках пользователю? Какую информацию должен получать пользователь? Как «перевести» часто невразумительные сообщения об ошибках, выдаваемые базой данных, на язык, понятный пользователям?
С этими общими вопросами тесно связаны более конкретные проблемы:
- Следует ли включать раздел обработки исключений в каждый блок PL/SQL?
- Следует ли включать раздел обработки исключений только в блок верхнего уровня или внешние блоки?
- Как организовать управление транзакциями при возникновении ошибок? Сложность обработки исключений отчасти связана с тем, что на все эти вопросы не существует единственно правильного ответа. Все зависит (по крайней мере частично) от архитектуры приложения и режима его использования (например, пакетное выполнение или транзакции, управляемые пользователем). Но если вы сможете ответить на эти вопросы для своего приложения, я рекомендую «запрограммировать» стратегию и правила обработки ошибок в стандартном пакете (см. далее «Стандартизация обработки ошибок»).
Некоторые общие принципы, которые стоит принять во внимание:
- Когда в коде происходит ошибка, получите как можно больше информации о контексте ее возникновения. Избыток информации — лучше, чем ее нехватка. Далее исключение можно передавать во внешние блоки, собирая дополнительную информацию по мере продвижения.
- Избегайте применения обработчиков вида
WHEN
ошибкаTHEN NULL
; (или еще хуже,WHEN OTHERS THEN NULL;
). Возможно, для написания такого хода у вас имеются веские причины, но вы должны твердо понимать, что это именно то, что вам нужно, и документировать такое использование, чтобы о нем знали другие. - Там, где это возможно, используйте механизмы обработки ошибок PL/SQL по умолчанию. Избегайте написания программ, возвращающих коды состояния управляющей среде или вызывающим блокам. Применять коды состояния следует только в одной ситуации: если управляющая среда не способна корректно обрабатывать ошибки Oracle (в таком случае стоит подумать о смене управляющей среды!).
Стандартизация обработки разных типов исключений
Исключение всегда свидетельствует о критической ситуации? Вовсе нет. Некоторые исключения (например, ORA-00600) сообщают о том, что в базе данных возникли очень серьезные низкоуровневые проблемы. Другие исключения, такие как NO_DATA_FOUND
, встречаются так часто, что мы воспринимаем их не как ошибки, а как условную логическую конструкцию («Если строка не существует, то выполнить следующие действия…»). Нужно ли различать эти категории исключений?
Коллеги-программисты научил меня очень полезной системе классификации исключений.
- Преднамеренные исключения. Архитектура кода сознательно использует особенности работы исключения. Это означает, что разработчик должен предвидеть исключение и запрограммировать его обработку. Пример —
UTL_FILE
.GET_LINE
. - Нежелательные исключения. Происходит ошибка, но ее возможность была предусмотрена заранее. Возможно, исключение даже не свидетельствует о возникновении проблемы. Пример команда
SELECT INTO
, инициирующая исключениеNO_DATA_FOUND
. - Непредвиденные исключения. Серьезные ошибки, указывающие на возникновение проблемы в приложении. Пример — команда
SELECT INTO
, которая должна вернуть строку для заданного первичного ключа, но вместо этого инициирует исключениеTOO_MANY
ROWS
.
Давайте поближе познакомимся с примерами всех категорий, а затем поговорим о том, какую пользу вы можете извлечь из знания этих категорий.
Преднамеренные исключения
Разработчики PL/SQL могут использовать процедуру UTL_FILE
.GET_LINE
для чтения содержимого файла по строкам. Когда GET_LINE
выходит за границу файла, инициируется исключение NO_DATA_FOUND
. Так работает эта процедура. Итак, если я хочу прочитать все содержимое файла и сделать «что-то полезное», программа может выглядеть так:
PROCEDURE read_file_and_do_stuff (
dir_in IN VARCHAR2, file_in IN VARCHAR2
)
IS
l_file UTL_FILE.file_type;
l_line VARCHAR2 (32767);
BEGIN
l_file := UTL_FILE.fopen (dir_in, file_in, 'R', max_linesize => 32767);
LOOP
UTL_FILE.get_line (l_file, l_line);
do_stuff;
END LOOP;
EXCEPTION
WHEN NO_DATA_FOUND
THEN
UTL_FILE.fclose (l_file);
more_stuff_here;
END;
У этого цикла есть одна особенность: он не содержит команды EXIT
. Кроме того, в разделе исключений выполняется дополнительная логика приложения (more_stuff_here
). Цикл можно переписать в следующем виде:
LOOP
BEGIN
UTL_FILE.get_line (l_file, l_line);
do_stuff;
EXCEPTION
WHEN NO_DATA_FOUND
THEN
EXIT;
END;
END LOOP;
UTL_FILE.flcose (l_file);
more_stuff_here;
Теперь цикл содержит команду EXIT
, но код стал более громоздким.
Подобные конструкции приходится использовать при работе с кодом, намеренно инициирующем исключения в своей архитектуре. Дополнительная информация о том, как следует поступать в подобных случаях, приводится в следующих разделах.
Нежелательные и непредвиденные исключения
Я рассматриваю эти две категории вместе, потому что приводимые примеры (NO_DATA_FOUND
и TOO_MANY_ROWS
) тесно связаны между собой. Предположим, я хочу написать функцию, возвращающую полное имя работника (в формате фамилия запятая имя) для заданного значения первичного ключа. Проще всего это сделать так:
FUNCTION fullname (
employee_id_in IN employees.employee_id%TYPE
)
RETURN VARCHAR2
IS
retval VARCHAR2 (32767);
BEGIN
SELECT last_name || ',' || first_name
INTO retval
FROM employees
WHERE employee_id = employee_id_in;
RETURN retval;
END fullname;
Если вызвать эту программу с кодом работника, отсутствующим в таблице, база данных инициирует исключение NO_DATA_FOUND
. Если же вызвать ее с кодом работника, встречающимся в нескольких строках таблицы, будет инициировано исключение TOO_MANY_ROWS
. Один запрос, два разных исключения — нужно ли рассматривать их одинаково? Вероятно, нет. Описывают ли эти два исключения похожие группы проблем? Давайте посмотрим:
NO_DATA_FOUND
— совпадение не найдено. Исключение может указывать на наличие серьезной проблемы, но не обязательно. Возможно, в большинстве обращений к базе данных совпадение не будет обнаруживаться, и я буду вставлять в базу данные нового работника. В общем, исключение нежелательно, но в данном случае оно даже не указывает на возникновение ошибки.TOO_MANY_ROWS
— в базе данных возникла серьезная проблема с ограничением первичного ключа. Трудно представить себе ситуацию, в которой это было бы нормально или просто «нежелательно». Нет, нужно прервать работу программы и привлечь внимание пользователя к совершенно непредвиденной, критической ошибке.
Как извлечь пользу из этой классификации
Надеюсь, вы согласитесь, что такая классификация полезна. Приступая к построению нового приложения, постарайтесь по возможности определиться со стандартным подходом, который будет применяться вами (и всеми остальными участниками группы) для каждого типа исключений. Затем для каждого исключения (которое необходимо обработать или хотя бы учитывать заранее при написании кода) решите, к какой категории относится, и примените уже согласованный подход. Все это поможет сделать ваш код более последовательным, и повысит эффективность вашей работы. Приведу несколько рекомендаций для трех типов исключений.
- Преднамеренные исключения. Пишите код, учитывающий возможность возникновения таких исключений. Прежде всего постарайтесь избежать размещения логики приложения в разделе исключений. Раздел исключений должен содержать только код, относящийся к обработке ошибки: сохранение информации об ошибке в журнале, повторное инициирование исключения и т. д. Программисты не ожидают увидеть логику приложения в разделе исключений, поэтому им будет намного труднее разобраться в таком коде и обеспечить его сопровождение.
- Нежелательные исключения. Если в каких-то обстоятельствах пользователь кода, инициировавшего исключения, не будет интерпретировать ситуацию как ошибку, не передавайте исключения наружу без обработки. Вместо этого верните значение или флаг состояния, показывающий, что исключение было обработано. Далее пользователь программы может сам решить, должна ли программа завершиться с ошибкой. А еще лучше — почему бы не разрешить стороне, вызывающей вашу программу, решить, нужно ли инициировать исключение, и если не нужно — какое значение должно передаваться для обозначения возникшего исключения?
- Непредвиденные исключения. А теперь начинается самое неприятное. Все непредвиденные ошибки должны быть сохранены в журнале с максимумом возможной контекстной информации, которая поможет понять причины возникновения ошибки. Затем программа должна завершиться с необработанным исключением (обычно тем же), инициированным из программы; для этого можно воспользоваться командой
RAISE
. Исключение заставит вызвавшую программу прервать работу и обработать ошибку.
Коды ошибок, связанные с конкретным приложением
Используя команду RAISE_APPLICATION_ERROR
для инициирования ошибок, относящихся к конкретному приложению, вы несете полную ответственность за управление кодами ошибок и сообщениями. Это быстро становится хлопотным и непростым делом («Так, какой бы код мне выбрать? Пожалуй, –20 774 — вроде бы такого еще не было?»).
Чтобы упростить управление кодами ошибок и предоставить последовательный интерфейс, через который разработчики смогут обрабатывать серверные ошибки, постройте таблицу со всеми используемыми кодами ошибок −20 NNN, сопутствующими именами исключений и сообщениями об ошибках.
Разработчик может просмотреть уже определенные ошибки на экране и выбрать ту из них, которая лучше всего подходит для конкретной ситуации.
Также можно попытаться полностью избегать диапазон −20 NNN для ошибок приложений. Почему бы не воспользоваться положительными числами? Из положительного цело-численного поддиапазона Oracle использует только 1 и 100. Теоретически возможно, что когда-нибудь Oracle будет использовать и другие положительные числа, но это весьма маловероятно. В распоряжении разработчиков остается великое множество кодов ошибок.
В частности, я пошел по этому пути при проектировании Quest Error Manager (QEM) — бесплатной программы управления ошибками. В Quest Error Manager вы можете определять свои ошибки в специальной таблице. Ошибка определяется именем и/ или кодом. Коды ошибок могут быть положительными или отрицательными. Если код ошибки положителен, при инициировании исключения QEM использует команду RAISE_APPLICATION_ERROR
для инициирования обобщенного исключения (обычно −20 000). Информация о текущем коде ошибки приложения встраивается в сообщение об ошибке, которое может быть расшифровано программой-получателем.
Упрощенная реализация этого подхода представлена в пакете обработки ошибок errpkg. pkg
, описанном в следующем разделе блога.
Стандартизация обработки ошибок
Обязательным элементом любого профессионально написанного приложения является надежная и согласованная схема обработки ошибок. Согласованность в этом вопросе важна как для пользователя, так и для разработчика. Если при возникновении ошибки пользователю предоставляется понятная, хорошо структурированная информация, он сможет более подробно рассказать об ошибке службе поддержки и будет более уверенно чувствовать себя при работе с приложением. Если приложение всегда обрабатывает и протоколирует ошибки определенным образом, программистам, занимающимся его поддержкой и сопровождением, будет легче их найти и устранить.
Все кажется вполне очевидным, не так ли? К сожалению, на практике (и особенно в больших группах разработчиков) все происходит несколько иначе. Очень часто каждый разработчик идет своим путем, следуя личным принципам и приемам, сохраняя информацию в произвольно выбранном формате и т. д. Одним словом, без стандартизации отладка и сопровождение приложений оборачиваются сущим кошмаром. Рассмотрим типичный пример:
EXCEPTION
WHEN NO_DATA_FOUND
THEN
v_msg := 'Нет компании с идентификатором '||TO_CHAR (v_id);
v_err := SQLCODE;
v_prog := 'fixdebt';
INSERT INTO errlog VALUES
(v_err,v_msg,v_prog,SYSDATE,USER);
WHEN OTHERS
THEN
v_err := SQLCODE;
v_msg := SQLERRM;
v_prog := 'fixdebt';
INSERT INTO errlog VALUES
(v_err,v_msg,v_prog,SYSDATE,USER);
RAISE;
На первый взгляд код выглядит вполне разумно. Если компания с заданным идентификатором не найдена, мы получаем значение SQLCODE
, задаем имя программы и сообщение и записываем строку с информацией об ошибке в таблицу ошибок. Выполнение родительского блока продолжается, поскольку ошибка не критична. Если происходит любая другая ошибка, получаем ее код и соответствующее сообщение, задаем имя программы и записываем строку с информацией об ошибке в таблицу ошибок, а затем передаем исключение в родительский блок, чтобы остановить его выполнение (поскольку неизвестно, насколько критична эта ошибка).
Что же здесь не так? Чтобы подробно объяснить суть проблемы, достаточно взглянуть на код. В нем жестко закодированы все действия по обработке ошибок. В результате (1) код получается слишком объемистым, (2) его придется полностью переписывать при изменении схемы обработки ошибок. Обратите внимание еще и на тот факт, что информация об ошибке записывается в таблицу базы данных. Это означает, что запись в журнале становится частью логической транзакции. И если потребуется выполнить откат транзакции, записи в журнале ошибок будут утеряны.
Существует несколько способов избежать потери информации: можно записывать данные в файл или использовать автономные транзакции для сохранения журнала вне основной транзакции. Но как бы то ни было, код в случае его изменения придется исправлять в сотнях разных мест.
А теперь посмотрите, как этот же раздел исключений оформляется при использовании стандартизированного пакета:
EXCEPTION
WHEN NO_DATA_FOUND
THEN
errpkg.record_and_continue (
SQLCODE, 'Нет компании с идентификатором ' || TO_CHAR (v_id));
WHEN OTHERS
THEN
errpkg.record_and_stop;
END;
Такой пакет обработки ошибок скрывает все подробности реализации; вы просто решаете, какая из процедур-обработчиков должна использоваться в конкретном случае, просматривая спецификацию пакета. Если требуется сохранить информацию об ошибке и продолжить работу, вызывается программа record_and_continue
. Если же нужно сохранить информацию об ошибке и прервать выполнение родительского блока, вызывается программа record_and_stop
. Мы не знаем, как эти программы сохраняют информацию об ошибке, как они останавливают работу родительского блока, то есть передают исключение, но для нас это и не важно. Главное, что все происходит так, как определено стандартами приложения.
Это дает вам возможность уделить больше времени разработке более интересных элементов приложения и не заниматься административной рутиной.
Имеется файл errpkg.pkg
с прототипом стандартизированного пакета обработки ошибок. Правда, прежде чем использовать его в приложениях, вам необходимо будет завершить его реализацию; это поможет составить ясное представление о том, как конструируются подобные утилиты.
Вы также можете воспользоваться намного более мощным (и тоже бесплатным) средством обработки ошибок Quest Error Manager. Важнейшая концепция, заложенная в основу QEM, заключается в возможности перехвата и протоколирования экземпляров ошибок, не только ошибок Oracle. QEM состоит из пакета PL/SQL и четырех таблиц для хранения информации об ошибках, возникающих в приложениях.
Работа с «объектами» исключений
Реализация типа данных EXCEPTION
в Oracle имеет свои ограничения, о которых было рассказано выше. Исключение состоит из идентификатора (имени), с которым связывается числовой код и сообщение. Исключение можно инициировать, его можно обработать… и все. Теперь представьте, как та же ситуация выглядит в Java: все ошибки являются производными от единого класса Exception
. Этот класс можно расширить, дополняя его новыми характеристиками, которые вы хотите отслеживать (стек ошибок, контекстные данные и т. д.). Объект, созданный на основе класса Exception, ничем не отличается от любых других объектов Java. Разумеется, он может передаваться в аргументах методов.
PL/SQL не позволяет делать ничего подобного со своими исключениями. Впрочем, этот факт не мешает вам реализовать свой «объект» исключения. Для этого можно воспользоваться объектными типами Oracle или реляционной таблицей, содержащей информацию об ошибке. Независимо от выбранной реализации очень важно различать определение ошибки (код ошибки –1403, имя «данные не найдены», причина — «неявный курсор не нашел ни одной записи») и ее конкретный экземпляр (я попытался найти компанию с указанным именем, ни одной строки не найдено). Иначе говоря, существует всего одно определение исключения NO_DATA_FOUND
, которое может существовать во множестве экземпляров. Oracle не различает эти два представления ошибки, но для нас это безусловно необходимо.
Пример простой иерархии объектов исключений продемонстрирует этот момент. Начнем с базового объектного типа всех исключений:
CREATE TYPE exception_t AS OBJECT (
name VARCHAR2(100),
code INTEGER,
description VARCHAR2(4000),
help_text VARCHAR2(4000),
recommendation VARCHAR2(4000),
error_stack CLOB,
call_stack CLOB,
created_on DATE,
created_by VARCHAR2(100)
)
NOT FINAL;
/
Затем базовый тип исключения расширяется для ошибок динамического SQL посредством добавления атрибута sql_string. При обработке ошибок динамического SQL очень важно сохранить строку, создавшую проблемы, для анализа в будущем:
CREATE TYPE dynsql_exception_t UNDER exception_t (
sql_string CLOB )
NOT FINAL;
/
А вот другой подтип exception_t
, на этот раз относящийся к конкретной сущности приложения — работнику. Исключение, инициируемое для ошибок, относящихся к работникам, будет включать идентификатор работника и внешний ключ нарушенного правила:
CREATE TYPE employee_exception_t UNDER exception_t (
employee_id INTEGER,
rule_id INTEGER );
/
Полная спецификация иерархии объектов ошибок включает методы супертипа исключения, предназначенные для вывода информации об ошибках или ее записи в репозиторий. Вы можете самостоятельно завершить иерархию, определенную в файле exception.ot
.
Если вы не хотите работать с объектными типами, попробуйте использовать подход, использованный мной в QEM: я определяю таблицу определений ошибок (Q$ERROR
) и другую таблицу экземпляров ошибок (Q$ERROR_INSTANCE
), которая содержит информацию о конкретных экземплярах ошибок. Все контекстные данные экземпляра ошибки сохраняются в таблице Q$ERROR_CONTEXT
.
Пример кода, который мог бы быть написан для QEM API:
WHEN DUP_VAL_ON_INDEX
THEN
q$error_manager.register_error (
error_name_in => 'DUPLICATE-VALUE'
,err_instance_id_out => l_err_instance_id
);
q$error_manager.add_context (
err_instance_id_in => l_err_instance_id
,name_in => 'TABLE_NAME', value_in => 'EMPLOYEES'
);
q$error_manager.add_context (
err_instance_id_in => l_err_instance_id
,name_in => 'KEY_VALUE', value_in => l_employee_id
);
q$error_manager.raise_error_instance (
err_instance_id_in => l_err_instance_id);
END;
Если ошибка повторяющегося значения была вызвана ограничением уникального имени, я получаю идентификатор экземпляра ошибки DUPLICATE-VALUE
. (Да, все верно: я использую имена ошибок, полностью обходя все проблемы, связанные с номерами ошибок.) Затем я добавляю контекстную информацию экземпляра (имя таблицы и значение первичного ключа, вызвавшее проблему). В завершение инициируется экземпляр ошибки, в результате чего исключение передается в следующий наружный блок.
По аналогии с передачей данных из приложения в репозиторий ошибок через API, вы также можете получить информацию об ошибке при помощи процедуры get_error_info
.
Пример:
BEGIN
run_my_application_code;
EXCEPTION
WHEN OTHERS
THEN
DECLARE
l_error q$error_manager.error_info_rt;
BEGIN
q$error_manager.get_error_info (l_error);
DBMS_OUTPUT.put_line ('');
DBMS_OUTPUT.put_line ('Error in DEPT_SAL Procedure:');
DBMS_OUTPUT.put_line ('Code = ' || l_error.code);
DBMS_OUTPUT.put_line ('Name = ' || l_error.NAME);
DBMS_OUTPUT.put_line ('Text = ' || l_error.text);
DBMS_OUTPUT.put_line ('Error Stack = ' || l_error.error_stack);
END;
END;
Это лишь два из многих способов преодоления ограничений типа EXCEPTION
в PL/SQL. Мораль: ничто не заставляет вас мириться с ситуацией по умолчанию, при которой с экземпляром ошибки связывается только код и сообщение.
Создание стандартного шаблона для обобщенной обработки ошибок
Невозможность передачи исключений программе сильно усложняет совместное использование разделов обработки ошибок в разных блоках PL/SQL. Одну и ту же логику обработчика нередко приходится записывать снова и снова, особенно при работе с конкретными функциональными областями — скажем, файловым вводом/ выводом с UTL_FILE
. В таких ситуациях стоит выделить время на создание шаблонов обработчиков.
Давайте поближе познакомимся с UTL_FILE
. До выхода Oracle9i Database Release 2 в спецификации пакета UTL_FILE
определялся набор исключений. Однако компания Oracle не стала предоставлять коды этих исключений через директиву EXCEPTION_INIT
. А без обработки исключений UTL_FILE
по имени SQLCODE
не сможет разобраться, что пошло не так. Вероятно, в такой ситуации для программ UTL_FILE
можно создать шаблон, часть которого выглядит так:
DECLARE
l_file_id UTL_FILE.file_type;
PROCEDURE cleanup (file_in IN OUT UTL_FILE.file_type
,err_in IN VARCHAR2 := NULL)
IS
BEGIN
UTL_FILE.fclose (file_in);
IF err_in IS NOT NULL
THEN
DBMS_OUTPUT.put_line ('Обнаружена ошибка UTL_FILE:');
DBMS_OUTPUT.put_line (err_in);
END IF;
END cleanup;
BEGIN
-- Здесь размещается тело программы.
-- Перед выходом необходимо прибрать за собой ...
cleanup (l_file_id);
EXCEPTION
WHEN UTL_FILE.invalid_path
THEN
cleanup (l_file_id, 'invalid_path');
RAISE;
WHEN UTL_FILE.invalid_mode
THEN
cleanup (l_file_id, 'invalid_mode');
RAISE;
END;
Основные элементы шаблона:
- Программа выполнения завершающих действий, пригодная для повторного использования; гарантирует, что текущий файл будет закрыт до потери дескриптора файла.
- Преобразование именованного исключения в строку, которую можно сохранить в журнале или вывести на экран, чтобы пользователь точно знал, какая ошибка была инициирована.
Рассмотрим еще один пример шаблона, который удобно использовать при работе с UTL_FILE
. В Oracle9i Database Release 2 появилась программа FREMOVE
для удаления файлов. Пакет UTL_FILE
предоставляет исключение DELETE_FAILED
, инициируемое тогда, когда FREMOVE
не удается удалить файл. После тестирования программы я обнаружил, что FREMOVE
может инициировать несколько возможных исключений, в числе которых:
UTL_FILE
.INVALID_OPERATION
— удаляемый файл не существует.UTL_FILE
.DELETE_FAILED
— у вас (или у процесса Oracle) недостаточно привилегий для удаления файла, или попытка завершилась неудачей по другой причине.
Начиная с Oracle9i Database Release 2, UTL_FILE
назначает коды ошибок всем своим исключениям, но вы все равно должны проследить за тем, чтобы при возникновении ошибки файлы были закрыты, и организовать последовательную обработку ошибок.
Итак, при использовании UTL_FILE
.FREMOVE
следует включать раздел обработчика исключения, который различает эти две ошибки:
BEGIN
UTL_FILE.fremove (dir, filename);
EXCEPTION
WHEN UTL_FILE.delete_failed
THEN
DBMS_OUTPUT.put_line (
'Ошибка при попытке удаления: ' || filename || ' в ' || dir);
-- Выполнение соответствующих действий...
WHEN UTL_FILE.invalid_operation
THEN
DBMS_OUTPUT.put_line (
'Не удалось найти и удалить: ' || filename || ' в ' || dir);
-- Выполнение соответствующих действий...
END;
Оптимальная организация обработки ошибок в PL/SQL
Без унифицированной качественной методологии обработки ошибок очень трудно написать приложение, которое было бы удобным в использовании и одновременно простым в отладке.
Архитектура обработки ошибок в Oracle PL/SQL предоставляет очень гибкие средства для определения, инициирования и обработки ошибок. Однако у нее имеются свои ограничения, вследствие чего встроенную функциональность обычно приходится дополнять таблицами и кодами ошибок, специфическими для конкретного приложения.
Для решения проблемы обработки ошибок рекомендуется предпринять следующие действия:
- Тщательно разберитесь в системе инициирования и обработки ошибок в PL/SQL. Далеко не во ее аспекты интуитивно понятны. Простейший пример: исключение, инициированное в секции объявлений, не будет обрабатываться секцией исключений текущего блока.
- Выберите общую схему обработки ошибок в вашем приложении. Где и как будут обрабатываться ошибки? Какая информация об ошибке будет сохраняться и как это будет сделано? Как исключения будут передаваться в управляющую среду? Как будут обрабатываться намеренные и непредвиденные ошибки?
- Постройте стандартную инфраструктуру, которая будет использоваться всеми разработчиками проекта. Инфраструктура должна включать таблицы, пакеты и, возможно, объектные типы, а также четко определенный процесс использования всех перечисленных элементов. Не останавливайтесь на ограничениях PL/ SQL. Найдите обходные пути, расширяя модель обработки ошибок.
- Создайте шаблоны, которые могут использоваться всеми участниками вашей группы. Всегда проще следовать готовому стандарту, чем самостоятельно писать код обработки ошибок.
Жду отклика на статью. Что понравилось? Что нет?
Вас заинтересует / Intresting for you:
Post Views: 463
Whenever you create a program block (no matter it is a trigger, procedure, package, …) you have to face errors, in Oracle PL/SQL they are called “exceptions”. We distinguish two types of exceptions: system (or internal) and user-defined exceptions.
What is an exception
As mentioned above, exceptions are blocks inside PL/SQL codes that are triggered at certain occasions by “exception handlers”. In exception blocks, you can define how that particular “event” will be treated. For instance, you can stop the whole processing, log the error and continue, skip to another part of your code and so on.
How does it work
When your code ends up with an error there are two possible scenarios. You either have an exception handler implemented or you don’t 🙂 If you don’t, the program will stop and you will have no idea what happened – whether it was successful or not. Most internal/system exceptions are logical problems in your process flow (such as dividing by zero, no data found, invalid number, too many rows, …) but you can also implement some business rules as cross-checks in your code logic (such as input parameter checks, no available funds, not authorized, …).
The biggest advantage of using exceptions is the scalability, readability and convenient way of error checking 🙂 Instead of checking every single line in your program for errors (which would be the case without exceptions) you can easily handle them in the exception block (see below).
How to use it
This is the part when I will show you all types of exceptions (internal as well as user-defined) and how you can use them 🙂 Let me start with internal exceptions.
Internal Exceptions
These exceptions are raised when an Oracle rule is violated or any kind of system limit is exceeded. There is a certain list of exceptions with associated error numbers. Even though you know the error number, you have to handle exceptions by their names. See the list of the most common exceptions below (for the full list, please visit Oracle Doc pages).
Exception name | Error Code | Oracle ORA | Description |
---|---|---|---|
CURSOR_ALREADY_OPEN | -6511 | ORA-06511 | You cannot re-open already opened cursor; you have to close it first. Note, that FOR loop automatically opens the given cursor. |
INVALID_CURSOR | -1 | ORA-00001 | You attempted to try to do an illegal operation. The most common action causing this error is closing a curser that was not opened. |
INVALID_NUMBER | -1722 | ORA-01722 | You tried to store a string value as a number that has non-numeric character (i,e, 1×0203023). |
LOGIN_DENIED | -1017 | ORA-01017 | You used an invalid username and/or password in your program. |
NO_DATA_FOUND | -1403 | ORA-01403 | Your operation did not retrieve any data. Common operations for retrieval are SELECT INTO, refer a deleted value in nested tables or un-initialized element in an index-by table. |
NOT_LOGGED_ON | -1012 | ORA-01012 | You were not logged in while trying to execute an operation. |
ROWTYPE_MISMATCH | -6504 | ORA-06504 | You tried to assign a value to an incompatible data type. |
TOO_MANY_ROWS | -1422 | ORA-01422 | You SELECT INTO statement returned more than one row. |
ZERO_DIVIDE | -1476 | ORA-01476 | You cannot divide by zero 🙂 |
For the rest that is not defined by Oracle, you can use either user-defined exceptions (see below) or simple use OTHERS. For the latter choice, there are very handy “variables” you can use SQLERRM and SQLCODE to display details about the error.
Examples:
DECLARE v_dividend NUMBER := 10; v_divisor NUMBER := 0; v_quotient NUMBER; BEGIN v_quotient := v_dividend / v_divisor; dbms_output.put_line(v_dividend||'/'||v_divisor||' = '||v_quotient); EXCEPTION WHEN ZERO_DIVIDE THEN dbms_output.put_line('You cannot divide by zero!'); END;
DECLARE v_dividend NUMBER := 10; v_divisor NUMBER := 0; v_quotient NUMBER; BEGIN v_quotient := v_dividend / v_divisor; dbms_output.put_line(v_dividend||'/'||v_divisor||' = '||v_quotient); EXCEPTION WHEN OTHERS THEN dbms_output.put_line('ErrMsg: '||SQLERRM); dbms_output.put_line('ErrCde: '||SQLCODE); END;
Of course, you can define multiple exceptions handler in the EXCEPTION block (see below).
User-defined Exceptions
As I mentioned above, you can implement your own business logic and rules in error and exception handling to divert the process flow according to your needs. You can either define a general exception name or associated with EXCEPTION_INIT number. Please note, that if you use multiple-level blocks (block inside block) you have to stick to exceptions in each level. Whenever an exception is raised inside the sub-block you have to catch it there because it won’t be triggered in the “outer” block. See the examples below.
General exception
DECLARE v_salary NUMBER := 5000; v_emp_id NUMBER := 1001; e_salary_too_low EXCEPTION; BEGIN IF v_salary < 6000 THEN RAISE e_salary_too_low; ELSE EXECUTE IMMEDIATE 'UPDATE employee SET salary = :1 WHERE id_employee = :2' USING v_salary, v_emp_id; END IF; EXCEPTION WHEN e_salary_too_low THEN dbms_output.put_line('Poor employee, wouldn''t you consider a rise? :('); WHEN OTHERS THEN dbms_output.put_line('ErrMsg: '||SQLERRM); dbms_output.put_line('ErrCde: '||SQLCODE); END;
EXCEPTION_INIT
-- table must exist already (run twice in case you don't have it) DECLARE already_exists EXCEPTION; PRAGMA EXCEPTION_INIT(already_exists, -00955); BEGIN EXECUTE IMMEDIATE 'CREATE TABLE employee (id_emp NUMBER, name VARCHAR2(50))'; EXCEPTION WHEN already_exists THEN dbms_output.put_line('Oops, it is already there.'); WHEN OTHERS THEN dbms_output.put_line('ErrMsg: '||SQLERRM); dbms_output.put_line('ErrCde: '||SQLCODE); END;
Multiblock exceptions
BEGIN ... ---------- sub-block begins DECLARE cust_exception EXCEPTION; BEGIN ... IF ... THEN RAISE cust_exception; END IF; END; ------------- sub-block ends EXCEPTION WHEN OTHERS THEN ROLLBACK; END;
Multiblock exceptions – passing the exception to the outer block
DECLARE my_exception EXCEPTION; BEGIN ... ---------- sub-block begins BEGIN ... IF ... THEN RAISE my_exception; END IF; EXCEPTION WHEN my_exception THEN RAISE; -- pass the current exception into the outer block END; ------------ sub-block ends EXCEPTION WHEN my_exception THEN -- handle the exception here in the outer block ... END;
There are many ways how to use exceptions and you can get really creative with them. For all the details please visit Oracle Docs 🙂
I want to mention one more thing and it is GOTO directive. With this one, you can actually jump between the parts of your process from A to B to D back to C etc based on your exceptions or logic implemented. However, I strongly discourage you from using this. It is not a good programmer habit to use GOTO directives and you can end up in an infinite loop 🙂 Always try to rewrite your code to avoid using GOTO.
Lastly, you can do execute as many commands as you want or implement as robust logic into the EXCEPTION part as possible 🙂 Let me show you the same examples at the end of this article.
BEGIN ... EXCEPTION WHEN custom_no_input_param THEN CONTINUE; --usualy used in an inner block to avoid "escaping" due to an exception ... it will ignore it WHEN ZERO_DIVIDE THEN dbms_output.put_line('Zero division!'); ROLLBACK; WHEN OTHERS THEN ROLLBACK; -- rollback everything done in the block procedure_other_cases(); -- run procedure COMMIT; -- commit changes done in procedure END;
There is nothing more exhilarating than to be shot at without result. —Winston Churchill
Run-time errors arise from design faults, coding mistakes, hardware failures, and many other sources. Although you cannot anticipate all possible errors, you can plan to handle certain kinds of errors meaningful to your PL/SQL program.
With many programming languages, unless you disable error checking, a run-time error such as stack overflow or division by zero stops normal processing and returns control to the operating system. With PL/SQL, a mechanism called exception handling lets you «bulletproof» your program so that it can continue operating in the presence of errors.
This chapter contains these topics:
-
Overview of PL/SQL Runtime Error Handling
-
Advantages of PL/SQL Exceptions
-
Summary of Predefined PL/SQL Exceptions
-
Defining Your Own PL/SQL Exceptions
-
How PL/SQL Exceptions Are Raised
-
How PL/SQL Exceptions Propagate
-
Reraising a PL/SQL Exception
-
Handling Raised PL/SQL Exceptions
-
Tips for Handling PL/SQL Errors
-
Overview of PL/SQL Compile-Time Warnings
Overview of PL/SQL Runtime Error Handling
In PL/SQL, an error condition is called an exception. Exceptions can be internally defined (by the runtime system) or user defined. Examples of internally defined exceptions include division by zero and out of memory. Some common internal exceptions have predefined names, such as ZERO_DIVIDE
and STORAGE_ERROR
. The other internal exceptions can be given names.
You can define exceptions of your own in the declarative part of any PL/SQL block, subprogram, or package. For example, you might define an exception named insufficient_funds
to flag overdrawn bank accounts. Unlike internal exceptions, user-defined exceptions must be given names.
When an error occurs, an exception is raised. That is, normal execution stops and control transfers to the exception-handling part of your PL/SQL block or subprogram. Internal exceptions are raised implicitly (automatically) by the run-time system. User-defined exceptions must be raised explicitly by RAISE
statements, which can also raise predefined exceptions.
To handle raised exceptions, you write separate routines called exception handlers. After an exception handler runs, the current block stops executing and the enclosing block resumes with the next statement. If there is no enclosing block, control returns to the host environment.
The following example calculates a price-to-earnings ratio for a company. If the company has zero earnings, the division operation raises the predefined exception ZERO_DIVIDE
, the execution of the block is interrupted, and control is transferred to the exception handlers. The optional OTHERS
handler catches all exceptions that the block does not name specifically.
SET SERVEROUTPUT ON; DECLARE stock_price NUMBER := 9.73; net_earnings NUMBER := 0; pe_ratio NUMBER; BEGIN -- Calculation might cause division-by-zero error. pe_ratio := stock_price / net_earnings; dbms_output.put_line('Price/earnings ratio = ' || pe_ratio); EXCEPTION -- exception handlers begin -- Only one of the WHEN blocks is executed. WHEN ZERO_DIVIDE THEN -- handles 'division by zero' error dbms_output.put_line('Company must have had zero earnings.'); pe_ratio := null; WHEN OTHERS THEN -- handles all other errors dbms_output.put_line('Some other kind of error occurred.'); pe_ratio := null; END; -- exception handlers and block end here /
The last example illustrates exception handling. With some better error checking, we could have avoided the exception entirely, by substituting a null for the answer if the denominator was zero:
DECLARE stock_price NUMBER := 9.73; net_earnings NUMBER := 0; pe_ratio NUMBER; BEGIN pe_ratio := case net_earnings when 0 then null else stock_price / net_earnings end; END; /
Guidelines for Avoiding and Handling PL/SQL Errors and Exceptions
Because reliability is crucial for database programs, use both error checking and exception handling to ensure your program can handle all possibilities:
-
Add exception handlers whenever there is any possibility of an error occurring. Errors are especially likely during arithmetic calculations, string manipulation, and database operations. Errors could also occur at other times, for example if a hardware failure with disk storage or memory causes a problem that has nothing to do with your code; but your code still needs to take corrective action.
-
Add error-checking code whenever you can predict that an error might occur if your code gets bad input data. Expect that at some time, your code will be passed incorrect or null parameters, that your queries will return no rows or more rows than you expect.
-
Make your programs robust enough to work even if the database is not in the state you expect. For example, perhaps a table you query will have columns added or deleted, or their types changed. You can avoid such problems by declaring individual variables with
%TYPE
qualifiers, and declaring records to hold query results with%ROWTYPE
qualifiers. -
Handle named exceptions whenever possible, instead of using WHEN OTHERS in exception handlers. Learn the names and causes of the predefined exceptions. If your database operations might cause particular ORA- errors, associate names with these errors so you can write handlers for them. (You will learn how to do that later in this chapter.)
-
Test your code with different combinations of bad data to see what potential errors arise.
-
Write out debugging information in your exception handlers. You might store such information in a separate table. If so, do it by making a call to a procedure declared with the
PRAGMA AUTONOMOUS_TRANSACTION
, so that you can commit your debugging information, even if you roll back the work that the main procedure was doing. -
Carefully consider whether each exception handler should commit the transaction, roll it back, or let it continue. Remember, no matter how severe the error is, you want to leave the database in a consistent state and avoid storing any bad data.
Advantages of PL/SQL Exceptions
Using exceptions for error handling has several advantages.
With exceptions, you can reliably handle potential errors from many statements with a single exception handler:
BEGIN SELECT ... SELECT ... procedure_that_performs_select(); ... EXCEPTION WHEN NO_DATA_FOUND THEN -- catches all 'no data found' errors
Instead of checking for an error at every point it might occur, just add an exception handler to your PL/SQL block. If the exception is ever raised in that block (or any sub-block), you can be sure it will be handled.
Sometimes the error is not immediately obvious, and could not be detected until later when you perform calculations using bad data. Again, a single exception handler can trap all division-by-zero errors, bad array subscripts, and so on.
If you need to check for errors at a specific spot, you can enclose a single statement or a group of statements inside its own BEGIN-END block with its own exception handler. You can make the checking as general or as precise as you like.
Isolating error-handling routines makes the rest of the program easier to read and understand.
Summary of Predefined PL/SQL Exceptions
An internal exception is raised automatically if your PL/SQL program violates an Oracle rule or exceeds a system-dependent limit. PL/SQL predefines some common Oracle errors as exceptions. For example, PL/SQL raises the predefined exception NO_DATA_FOUND
if a SELECT
INTO
statement returns no rows.
You can use the pragma EXCEPTION_INIT
to associate exception names with other Oracle error codes that you can anticipate. To handle unexpected Oracle errors, you can use the OTHERS
handler. Within this handler, you can call the functions SQLCODE
and SQLERRM
to return the Oracle error code and message text. Once you know the error code, you can use it with pragma EXCEPTION_INIT
and write a handler specifically for that error.
PL/SQL declares predefined exceptions globally in package STANDARD
. You need not declare them yourself. You can write handlers for predefined exceptions using the names in the following list:
Exception | Oracle Error | SQLCODE Value |
---|---|---|
ACCESS_INTO_NULL |
ORA-06530 |
-6530 |
CASE_NOT_FOUND |
ORA-06592 |
-6592 |
COLLECTION_IS_NULL |
ORA-06531 |
-6531 |
CURSOR_ALREADY_OPEN |
ORA-06511 |
-6511 |
DUP_VAL_ON_INDEX |
ORA-00001 |
-1 |
INVALID_CURSOR |
ORA-01001 |
-1001 |
INVALID_NUMBER |
ORA-01722 |
-1722 |
LOGIN_DENIED |
ORA-01017 |
-1017 |
NO_DATA_FOUND |
ORA-01403 |
+100 |
NOT_LOGGED_ON |
ORA-01012 |
-1012 |
PROGRAM_ERROR |
ORA-06501 |
-6501 |
ROWTYPE_MISMATCH |
ORA-06504 |
-6504 |
SELF_IS_NULL |
ORA-30625 |
-30625 |
STORAGE_ERROR |
ORA-06500 |
-6500 |
SUBSCRIPT_BEYOND_COUNT |
ORA-06533 |
-6533 |
SUBSCRIPT_OUTSIDE_LIMIT |
ORA-06532 |
-6532 |
SYS_INVALID_ROWID |
ORA-01410 |
-1410 |
TIMEOUT_ON_RESOURCE |
ORA-00051 |
-51 |
TOO_MANY_ROWS |
ORA-01422 |
-1422 |
VALUE_ERROR |
ORA-06502 |
-6502 |
ZERO_DIVIDE |
ORA-01476 |
-1476 |
Brief descriptions of the predefined exceptions follow:
Exception | Raised when … |
---|---|
ACCESS_INTO_NULL |
A program attempts to assign values to the attributes of an uninitialized object. |
CASE_NOT_FOUND |
None of the choices in the WHEN clauses of a CASE statement is selected, and there is no ELSE clause. |
COLLECTION_IS_NULL |
A program attempts to apply collection methods other than EXISTS to an uninitialized nested table or varray, or the program attempts to assign values to the elements of an uninitialized nested table or varray. |
CURSOR_ALREADY_OPEN |
A program attempts to open an already open cursor. A cursor must be closed before it can be reopened. A cursor FOR loop automatically opens the cursor to which it refers, so your program cannot open that cursor inside the loop. |
DUP_VAL_ON_INDEX |
A program attempts to store duplicate values in a database column that is constrained by a unique index. |
INVALID_CURSOR |
A program attempts a cursor operation that is not allowed, such as closing an unopened cursor. |
INVALID_NUMBER |
In a SQL statement, the conversion of a character string into a number fails because the string does not represent a valid number. (In procedural statements, VALUE_ERROR is raised.) This exception is also raised when the LIMIT -clause expression in a bulk FETCH statement does not evaluate to a positive number. |
LOGIN_DENIED |
A program attempts to log on to Oracle with an invalid username or password. |
NO_DATA_FOUND |
A SELECT INTO statement returns no rows, or your program references a deleted element in a nested table or an uninitialized element in an index-by table.
Because this exception is used internally by some SQL functions to signal that they are finished, you should not rely on this exception being propagated if you raise it within a function that is called as part of a query. |
NOT_LOGGED_ON |
A program issues a database call without being connected to Oracle. |
PROGRAM_ERROR |
PL/SQL has an internal problem. |
ROWTYPE_MISMATCH |
The host cursor variable and PL/SQL cursor variable involved in an assignment have incompatible return types. For example, when an open host cursor variable is passed to a stored subprogram, the return types of the actual and formal parameters must be compatible. |
SELF_IS_NULL |
A program attempts to call a MEMBER method, but the instance of the object type has not been initialized. The built-in parameter SELF points to the object, and is always the first parameter passed to a MEMBER method. |
STORAGE_ERROR |
PL/SQL runs out of memory or memory has been corrupted. |
SUBSCRIPT_BEYOND_COUNT |
A program references a nested table or varray element using an index number larger than the number of elements in the collection. |
SUBSCRIPT_OUTSIDE_LIMIT |
A program references a nested table or varray element using an index number (-1 for example) that is outside the legal range. |
SYS_INVALID_ROWID |
The conversion of a character string into a universal rowid fails because the character string does not represent a valid rowid. |
TIMEOUT_ON_RESOURCE |
A time-out occurs while Oracle is waiting for a resource. |
TOO_MANY_ROWS |
A SELECT INTO statement returns more than one row. |
VALUE_ERROR |
An arithmetic, conversion, truncation, or size-constraint error occurs. For example, when your program selects a column value into a character variable, if the value is longer than the declared length of the variable, PL/SQL aborts the assignment and raises VALUE_ERROR . In procedural statements, VALUE_ERROR is raised if the conversion of a character string into a number fails. (In SQL statements, INVALID_NUMBER is raised.) |
ZERO_DIVIDE |
A program attempts to divide a number by zero. |
Defining Your Own PL/SQL Exceptions
PL/SQL lets you define exceptions of your own. Unlike predefined exceptions, user-defined exceptions must be declared and must be raised explicitly by RAISE
statements.
Declaring PL/SQL Exceptions
Exceptions can be declared only in the declarative part of a PL/SQL block, subprogram, or package. You declare an exception by introducing its name, followed by the keyword EXCEPTION
. In the following example, you declare an exception named past_due
:
DECLARE past_due EXCEPTION;
Exception and variable declarations are similar. But remember, an exception is an error condition, not a data item. Unlike variables, exceptions cannot appear in assignment statements or SQL statements. However, the same scope rules apply to variables and exceptions.
Scope Rules for PL/SQL Exceptions
You cannot declare an exception twice in the same block. You can, however, declare the same exception in two different blocks.
Exceptions declared in a block are considered local to that block and global to all its sub-blocks. Because a block can reference only local or global exceptions, enclosing blocks cannot reference exceptions declared in a sub-block.
If you redeclare a global exception in a sub-block, the local declaration prevails. The sub-block cannot reference the global exception, unless the exception is declared in a labeled block and you qualify its name with the block label:
block_label.exception_name
The following example illustrates the scope rules:
DECLARE past_due EXCEPTION; acct_num NUMBER; BEGIN DECLARE ---------- sub-block begins past_due EXCEPTION; -- this declaration prevails acct_num NUMBER; due_date DATE := SYSDATE - 1; todays_date DATE := SYSDATE; BEGIN IF due_date < todays_date THEN RAISE past_due; -- this is not handled END IF; END; ------------- sub-block ends EXCEPTION WHEN past_due THEN -- does not handle RAISEd exception dbms_output.put_line('Handling PAST_DUE exception.'); WHEN OTHERS THEN dbms_output.put_line('Could not recognize PAST_DUE_EXCEPTION in this scope.'); END; /
The enclosing block does not handle the raised exception because the declaration of past_due
in the sub-block prevails. Though they share the same name, the two past_due
exceptions are different, just as the two acct_num
variables share the same name but are different variables. Thus, the RAISE
statement and the WHEN
clause refer to different exceptions. To have the enclosing block handle the raised exception, you must remove its declaration from the sub-block or define an OTHERS
handler.
Associating a PL/SQL Exception with a Number: Pragma EXCEPTION_INIT
To handle error conditions (typically ORA-
messages) that have no predefined name, you must use the OTHERS
handler or the pragma EXCEPTION_INIT
. A pragma is a compiler directive that is processed at compile time, not at run time.
In PL/SQL, the pragma EXCEPTION_INIT
tells the compiler to associate an exception name with an Oracle error number. That lets you refer to any internal exception by name and to write a specific handler for it. When you see an error stack, or sequence of error messages, the one on top is the one that you can trap and handle.
You code the pragma EXCEPTION_INIT
in the declarative part of a PL/SQL block, subprogram, or package using the syntax
PRAGMA EXCEPTION_INIT(exception_name, -Oracle_error_number);
where exception_name
is the name of a previously declared exception and the number is a negative value corresponding to an ORA-
error number. The pragma must appear somewhere after the exception declaration in the same declarative section, as shown in the following example:
DECLARE deadlock_detected EXCEPTION; PRAGMA EXCEPTION_INIT(deadlock_detected, -60); BEGIN null; -- Some operation that causes an ORA-00060 error EXCEPTION WHEN deadlock_detected THEN null; -- handle the error END; /
Defining Your Own Error Messages: Procedure RAISE_APPLICATION_ERROR
The procedure RAISE_APPLICATION_ERROR
lets you issue user-defined ORA-
error messages from stored subprograms. That way, you can report errors to your application and avoid returning unhandled exceptions.
To call RAISE_APPLICATION_ERROR
, use the syntax
raise_application_error(error_number, message[, {TRUE | FALSE}]);
where error_number
is a negative integer in the range -20000 .. -20999 and message
is a character string up to 2048 bytes long. If the optional third parameter is TRUE
, the error is placed on the stack of previous errors. If the parameter is FALSE
(the default), the error replaces all previous errors. RAISE_APPLICATION_ERROR
is part of package DBMS_STANDARD
, and as with package STANDARD
, you do not need to qualify references to it.
An application can call raise_application_error
only from an executing stored subprogram (or method). When called, raise_application_error
ends the subprogram and returns a user-defined error number and message to the application. The error number and message can be trapped like any Oracle error.
In the following example, you call raise_application_error
if an error condition of your choosing happens (in this case, if the current schema owns less than 1000 tables):
DECLARE num_tables NUMBER; BEGIN SELECT COUNT(*) INTO num_tables FROM USER_TABLES; IF num_tables < 1000 THEN /* Issue your own error code (ORA-20101) with your own error message. */ raise_application_error(-20101, 'Expecting at least 1000 tables'); ELSE NULL; -- Do the rest of the processing (for the non-error case). END IF; END; /
The calling application gets a PL/SQL exception, which it can process using the error-reporting functions SQLCODE
and SQLERRM
in an OTHERS
handler. Also, it can use the pragma EXCEPTION_INIT
to map specific error numbers returned by raise_application_error
to exceptions of its own, as the following Pro*C example shows:
EXEC SQL EXECUTE /* Execute embedded PL/SQL block using host variables my_emp_id and my_amount, which were assigned values in the host environment. */ DECLARE null_salary EXCEPTION; /* Map error number returned by raise_application_error to user-defined exception. */ PRAGMA EXCEPTION_INIT(null_salary, -20101); BEGIN raise_salary(:my_emp_id, :my_amount); EXCEPTION WHEN null_salary THEN INSERT INTO emp_audit VALUES (:my_emp_id, ...); END; END-EXEC;
This technique allows the calling application to handle error conditions in specific exception handlers.
Redeclaring Predefined Exceptions
Remember, PL/SQL declares predefined exceptions globally in package STANDARD
, so you need not declare them yourself. Redeclaring predefined exceptions is error prone because your local declaration overrides the global declaration. For example, if you declare an exception named invalid_number and then PL/SQL raises the predefined exception INVALID_NUMBER
internally, a handler written for INVALID_NUMBER
will not catch the internal exception. In such cases, you must use dot notation to specify the predefined exception, as follows:
EXCEPTION WHEN invalid_number OR STANDARD.INVALID_NUMBER THEN -- handle the error END;
How PL/SQL Exceptions Are Raised
Internal exceptions are raised implicitly by the run-time system, as are user-defined exceptions that you have associated with an Oracle error number using EXCEPTION_INIT
. However, other user-defined exceptions must be raised explicitly by RAISE
statements.
Raising Exceptions with the RAISE Statement
PL/SQL blocks and subprograms should raise an exception only when an error makes it undesirable or impossible to finish processing. You can place RAISE
statements for a given exception anywhere within the scope of that exception. In the following example, you alert your PL/SQL block to a user-defined exception named out_of_stock
:
DECLARE out_of_stock EXCEPTION; number_on_hand NUMBER := 0; BEGIN IF number_on_hand < 1 THEN RAISE out_of_stock; -- raise an exception that we defined END IF; EXCEPTION WHEN out_of_stock THEN -- handle the error dbms_output.put_line('Encountered out-of-stock error.'); END; /
You can also raise a predefined exception explicitly. That way, an exception handler written for the predefined exception can process other errors, as the following example shows:
DECLARE acct_type INTEGER := 7; BEGIN IF acct_type NOT IN (1, 2, 3) THEN RAISE INVALID_NUMBER; -- raise predefined exception END IF; EXCEPTION WHEN INVALID_NUMBER THEN dbms_output.put_line('Handling invalid input by rolling back.'); ROLLBACK; END; /
How PL/SQL Exceptions Propagate
When an exception is raised, if PL/SQL cannot find a handler for it in the current block or subprogram, the exception propagates. That is, the exception reproduces itself in successive enclosing blocks until a handler is found or there are no more blocks to search. If no handler is found, PL/SQL returns an unhandled exception error to the host environment.
Exceptions cannot propagate across remote procedure calls done through database links. A PL/SQL block cannot catch an exception raised by a remote subprogram. For a workaround, see «Defining Your Own Error Messages: Procedure RAISE_APPLICATION_ERROR».
Figure 10-1, Figure 10-2, and Figure 10-3 illustrate the basic propagation rules.
An exception can propagate beyond its scope, that is, beyond the block in which it was declared. Consider the following example:
BEGIN DECLARE ---------- sub-block begins past_due EXCEPTION; due_date DATE := trunc(SYSDATE) - 1; todays_date DATE := trunc(SYSDATE); BEGIN IF due_date < todays_date THEN RAISE past_due; END IF; END; ------------- sub-block ends EXCEPTION WHEN OTHERS THEN ROLLBACK; END; /
Because the block that declares the exception past_due
has no handler for it, the exception propagates to the enclosing block. But the enclosing block cannot reference the name PAST_DUE
, because the scope where it was declared no longer exists. Once the exception name is lost, only an OTHERS
handler can catch the exception. If there is no handler for a user-defined exception, the calling application gets this error:
ORA-06510: PL/SQL: unhandled user-defined exception
Reraising a PL/SQL Exception
Sometimes, you want to reraise an exception, that is, handle it locally, then pass it to an enclosing block. For example, you might want to roll back a transaction in the current block, then log the error in an enclosing block.
To reraise an exception, use a RAISE
statement without an exception name, which is allowed only in an exception handler:
DECLARE salary_too_high EXCEPTION; current_salary NUMBER := 20000; max_salary NUMBER := 10000; erroneous_salary NUMBER; BEGIN BEGIN ---------- sub-block begins IF current_salary > max_salary THEN RAISE salary_too_high; -- raise the exception END IF; EXCEPTION WHEN salary_too_high THEN -- first step in handling the error dbms_output.put_line('Salary ' || erroneous_salary || ' is out of range.'); dbms_output.put_line('Maximum salary is ' || max_salary || '.'); RAISE; -- reraise the current exception END; ------------ sub-block ends EXCEPTION WHEN salary_too_high THEN -- handle the error more thoroughly erroneous_salary := current_salary; current_salary := max_salary; dbms_output.put_line('Revising salary from ' || erroneous_salary || 'to ' || current_salary || '.'); END; /
Handling Raised PL/SQL Exceptions
When an exception is raised, normal execution of your PL/SQL block or subprogram stops and control transfers to its exception-handling part, which is formatted as follows:
EXCEPTION WHEN exception_name1 THEN -- handler sequence_of_statements1 WHEN exception_name2 THEN -- another handler sequence_of_statements2 ... WHEN OTHERS THEN -- optional handler sequence_of_statements3 END;
To catch raised exceptions, you write exception handlers. Each handler consists of a WHEN
clause, which specifies an exception, followed by a sequence of statements to be executed when that exception is raised. These statements complete execution of the block or subprogram; control does not return to where the exception was raised. In other words, you cannot resume processing where you left off.
The optional OTHERS
exception handler, which is always the last handler in a block or subprogram, acts as the handler for all exceptions not named specifically. Thus, a block or subprogram can have only one OTHERS
handler.
As the following example shows, use of the OTHERS
handler guarantees that no exception will go unhandled:
EXCEPTION WHEN ... THEN -- handle the error WHEN ... THEN -- handle the error WHEN OTHERS THEN -- handle all other errors END;
If you want two or more exceptions to execute the same sequence of statements, list the exception names in the WHEN
clause, separating them by the keyword OR
, as follows:
EXCEPTION WHEN over_limit OR under_limit OR VALUE_ERROR THEN -- handle the error
If any of the exceptions in the list is raised, the associated sequence of statements is executed. The keyword OTHERS
cannot appear in the list of exception names; it must appear by itself. You can have any number of exception handlers, and each handler can associate a list of exceptions with a sequence of statements. However, an exception name can appear only once in the exception-handling part of a PL/SQL block or subprogram.
The usual scoping rules for PL/SQL variables apply, so you can reference local and global variables in an exception handler. However, when an exception is raised inside a cursor FOR
loop, the cursor is closed implicitly before the handler is invoked. Therefore, the values of explicit cursor attributes are not available in the handler.
Handling Exceptions Raised in Declarations
Exceptions can be raised in declarations by faulty initialization expressions. For example, the following declaration raises an exception because the constant credit_limit
cannot store numbers larger than 999:
DECLARE credit_limit CONSTANT NUMBER(3) := 5000; -- raises an exception BEGIN NULL; EXCEPTION WHEN OTHERS THEN -- Cannot catch the exception. This handler is never called. dbms_output.put_line('Can''t handle an exception in a declaration.'); END; /
Handlers in the current block cannot catch the raised exception because an exception raised in a declaration propagates immediately to the enclosing block.
Handling Exceptions Raised in Handlers
When an exception occurs within an exception handler, that same handler cannot catch the exception. An exception raised inside a handler propagates immediately to the enclosing block, which is searched to find a handler for this new exception. From there on, the exception propagates normally. For example:
EXCEPTION WHEN INVALID_NUMBER THEN INSERT INTO ... -- might raise DUP_VAL_ON_INDEX WHEN DUP_VAL_ON_INDEX THEN ... -- cannot catch the exception END;
Branching to or from an Exception Handler
A GOTO
statement can branch from an exception handler into an enclosing block.
A GOTO
statement cannot branch into an exception handler, or from an exception handler into the current block.
Retrieving the Error Code and Error Message: SQLCODE and SQLERRM
In an exception handler, you can use the built-in functions SQLCODE
and SQLERRM
to find out which error occurred and to get the associated error message. For internal exceptions, SQLCODE
returns the number of the Oracle error. The number that SQLCODE
returns is negative unless the Oracle error is no data found, in which case SQLCODE
returns +100. SQLERRM
returns the corresponding error message. The message begins with the Oracle error code.
For user-defined exceptions, SQLCODE
returns +1 and SQLERRM
returns the message: User-Defined Exception
.
unless you used the pragma EXCEPTION_INIT
to associate the exception name with an Oracle error number, in which case SQLCODE
returns that error number and SQLERRM
returns the corresponding error message. The maximum length of an Oracle error message is 512 characters including the error code, nested messages, and message inserts such as table and column names.
If no exception has been raised, SQLCODE
returns zero and SQLERRM
returns the message: ORA-0000: normal, successful completion
.
You can pass an error number to SQLERRM
, in which case SQLERRM
returns the message associated with that error number. Make sure you pass negative error numbers to SQLERRM
.
Passing a positive number to SQLERRM
always returns the message user-defined exception unless you pass +100
, in which case SQLERRM
returns the message no data found. Passing a zero to SQLERRM
always returns the message normal, successful completion.
You cannot use SQLCODE
or SQLERRM
directly in a SQL statement. Instead, you must assign their values to local variables, then use the variables in the SQL statement, as shown in the following example:
DECLARE err_msg VARCHAR2(100); BEGIN /* Get a few Oracle error messages. */ FOR err_num IN 1..3 LOOP err_msg := SUBSTR(SQLERRM(-err_num),1,100); dbms_output.put_line('Error number = ' || err_num); dbms_output.put_line('Error message = ' || err_msg); END LOOP; END; /
The string function SUBSTR
ensures that a VALUE_ERROR
exception (for truncation) is not raised when you assign the value of SQLERRM
to err_msg
. The functions SQLCODE
and SQLERRM
are especially useful in the OTHERS
exception handler because they tell you which internal exception was raised.
Note: When using pragma RESTRICT_REFERENCES
to assert the purity of a stored function, you cannot specify the constraints WNPS
and RNPS
if the function calls SQLCODE
or SQLERRM
.
Catching Unhandled Exceptions
Remember, if it cannot find a handler for a raised exception, PL/SQL returns an unhandled exception error to the host environment, which determines the outcome. For example, in the Oracle Precompilers environment, any database changes made by a failed SQL statement or PL/SQL block are rolled back.
Unhandled exceptions can also affect subprograms. If you exit a subprogram successfully, PL/SQL assigns values to OUT
parameters. However, if you exit with an unhandled exception, PL/SQL does not assign values to OUT
parameters (unless they are NOCOPY
parameters). Also, if a stored subprogram fails with an unhandled exception, PL/SQL does not roll back database work done by the subprogram.
You can avoid unhandled exceptions by coding an OTHERS
handler at the topmost level of every PL/SQL program.
Tips for Handling PL/SQL Errors
In this section, you learn three techniques that increase flexibility.
Continuing after an Exception Is Raised
An exception handler lets you recover from an otherwise fatal error before exiting a block. But when the handler completes, the block is terminated. You cannot return to the current block from an exception handler. In the following example, if the SELECT
INTO
statement raises ZERO_DIVIDE
, you cannot resume with the INSERT
statement:
DECLARE pe_ratio NUMBER(3,1); BEGIN DELETE FROM stats WHERE symbol = 'XYZ'; SELECT price / NVL(earnings, 0) INTO pe_ratio FROM stocks WHERE symbol = 'XYZ'; INSERT INTO stats (symbol, ratio) VALUES ('XYZ', pe_ratio); EXCEPTION WHEN ZERO_DIVIDE THEN NULL; END; /
You can still handle an exception for a statement, then continue with the next statement. Place the statement in its own sub-block with its own exception handlers. If an error occurs in the sub-block, a local handler can catch the exception. When the sub-block ends, the enclosing block continues to execute at the point where the sub-block ends. Consider the following example:
DECLARE pe_ratio NUMBER(3,1); BEGIN DELETE FROM stats WHERE symbol = 'XYZ'; BEGIN ---------- sub-block begins SELECT price / NVL(earnings, 0) INTO pe_ratio FROM stocks WHERE symbol = 'XYZ'; EXCEPTION WHEN ZERO_DIVIDE THEN pe_ratio := 0; END; ---------- sub-block ends INSERT INTO stats (symbol, ratio) VALUES ('XYZ', pe_ratio); EXCEPTION WHEN OTHERS THEN NULL; END; /
In this example, if the SELECT
INTO
statement raises a ZERO_DIVIDE
exception, the local handler catches it and sets pe_ratio
to zero. Execution of the handler is complete, so the sub-block terminates, and execution continues with the INSERT
statement.
You can also perform a sequence of DML operations where some might fail, and process the exceptions only after the entire operation is complete, as described in «Handling FORALL Exceptions with the %BULK_EXCEPTIONS Attribute».
Retrying a Transaction
After an exception is raised, rather than abandon your transaction, you might want to retry it. The technique is:
-
Encase the transaction in a sub-block.
-
Place the sub-block inside a loop that repeats the transaction.
-
Before starting the transaction, mark a savepoint. If the transaction succeeds, commit, then exit from the loop. If the transaction fails, control transfers to the exception handler, where you roll back to the savepoint undoing any changes, then try to fix the problem.
In the following example, the INSERT
statement might raise an exception because of a duplicate value in a unique column. In that case, we change the value that needs to be unique and continue with the next loop iteration. If the INSERT succeeds, we exit from the loop immediately. With this technique, you should use a FOR
or WHILE
loop to limit the number of attempts.
DECLARE name VARCHAR2(20); ans1 VARCHAR2(3); ans2 VARCHAR2(3); ans3 VARCHAR2(3); suffix NUMBER := 1; BEGIN FOR i IN 1..10 LOOP -- try 10 times BEGIN -- sub-block begins SAVEPOINT start_transaction; -- mark a savepoint /* Remove rows from a table of survey results. */ DELETE FROM results WHERE answer1 = 'NO'; /* Add a survey respondent's name and answers. */ INSERT INTO results VALUES (name, ans1, ans2, ans3); -- raises DUP_VAL_ON_INDEX if two respondents have the same name COMMIT; EXIT; EXCEPTION WHEN DUP_VAL_ON_INDEX THEN ROLLBACK TO start_transaction; -- undo changes suffix := suffix + 1; -- try to fix problem name := name || TO_CHAR(suffix); END; -- sub-block ends END LOOP; END; /
Using Locator Variables to Identify Exception Locations
Using one exception handler for a sequence of statements, such as INSERT
, DELETE
, or UPDATE
statements, can mask the statement that caused an error. If you need to know which statement failed, you can use a locator variable:
DECLARE stmt INTEGER; name VARCHAR2(100); BEGIN stmt := 1; -- designates 1st SELECT statement SELECT table_name INTO name FROM user_tables WHERE table_name LIKE 'ABC%'; stmt := 2; -- designates 2nd SELECT statement SELECT table_name INTO name FROM user_tables WHERE table_name LIKE 'XYZ%'; EXCEPTION WHEN NO_DATA_FOUND THEN dbms_output.put_line('Table name not found in query ' || stmt); END; /
Overview of PL/SQL Compile-Time Warnings
To make your programs more robust and avoid problems at run time, you can turn on checking for certain warning conditions. These conditions are not serious enough to produce an error and keep you from compiling a subprogram. They might point out something in the subprogram that produces an undefined result or might create a performance problem.
To work with PL/SQL warning messages, you use the PLSQL_WARNINGS
initialization parameter, the DBMS_WARNING
package, and the USER/DBA/ALL_PLSQL_OBJECT_SETTINGS
views.
PL/SQL Warning Categories
PL/SQL warning messages are divided into categories, so that you can suppress or display groups of similar warnings during compilation. The categories are:
Severe: Messages for conditions that might cause unexpected behavior or wrong results, such as aliasing problems with parameters.
Performance: Messages for conditions that might cause performance problems, such as passing a VARCHAR2
value to a NUMBER
column in an INSERT
statement.
Informational: Messages for conditions that do not have an effect on performance or correctness, but that you might want to change to make the code more maintainable, such as dead code that can never be executed.
The keyword All is a shorthand way to refer to all warning messages.
You can also treat particular messages as errors instead of warnings. For example, if you know that the warning message PLW-05003
represents a serious problem in your code, including 'ERROR:05003'
in the PLSQL_WARNINGS
setting makes that condition trigger an error message (PLS_05003
) instead of a warning message. An error message causes the compilation to fail.
Controlling PL/SQL Warning Messages
To let the database issue warning messages during PL/SQL compilation, you set the initialization parameter PLSQL_WARNINGS
. You can enable and disable entire categories of warnings (ALL
, SEVERE
, INFORMATIONAL
, PERFORMANCE
), enable and disable specific message numbers, and make the database treat certain warnings as compilation errors so that those conditions must be corrected.
This parameter can be set at the system level or the session level. You can also set it for a single compilation by including it as part of the ALTER PROCEDURE
statement. You might turn on all warnings during development, turn off all warnings when deploying for production, or turn on some warnings when working on a particular subprogram where you are concerned with some aspect, such as unnecessary code or performance.
ALTER SYSTEM SET PLSQL_WARNINGS='ENABLE:ALL'; -- For debugging during development. ALTER SESSION SET PLSQL_WARNINGS='ENABLE:PERFORMANCE'; -- To focus on one aspect. ALTER PROCEDURE hello COMPILE PLSQL_WARNINGS='ENABLE:PERFORMANCE'; -- Recompile with extra checking. ALTER SESSION SET PLSQL_WARNINGS='DISABLE:ALL'; -- To turn off all warnings. -- We want to hear about 'severe' warnings, don't want to hear about 'performance' -- warnings, and want PLW-06002 warnings to produce errors that halt compilation. ALTER SESSION SET PLSQL_WARNINGS='ENABLE:SEVERE','DISABLE:PERFORMANCE','ERROR:06002';
Warning messages can be issued during compilation of PL/SQL subprograms; anonymous blocks do not produce any warnings.
The settings for the PLSQL_WARNINGS
parameter are stored along with each compiled subprogram. If you recompile the subprogram with a CREATE OR REPLACE
statement, the current settings for that session are used. If you recompile the subprogram with an ALTER ... COMPILE
statement, the current session setting might be used, or the original setting that was stored with the subprogram, depending on whether you include the REUSE SETTINGS
clause in the statement.
To see any warnings generated during compilation, you use the SQL*Plus SHOW ERRORS
command or query the USER_ERRORS
data dictionary view. PL/SQL warning messages all use the prefix PLW
.
Using the DBMS_WARNING Package
If you are writing a development environment that compiles PL/SQL subprograms, you can control PL/SQL warning messages by calling subprograms in the DBMS_WARNING
package. You might also use this package when compiling a complex application, made up of several nested SQL*Plus scripts, where different warning settings apply to different subprograms. You can save the current state of the PLSQL_WARNINGS
parameter with one call to the package, change the parameter to compile a particular set of subprograms, then restore the original parameter value.
For example, here is a procedure with unnecessary code that could be removed. It could represent a mistake, or it could be intentionally hidden by a debug flag, so you might or might not want a warning message for it.
CREATE OR REPLACE PROCEDURE dead_code AS x number := 10; BEGIN if x = 10 then x := 20; else x := 100; -- dead code (never reached) end if; END dead_code;/ -- By default, the preceding procedure compiles with no errors or warnings. -- Now enable all warning messages, just for this session. CALL DBMS_WARNING.SET_WARNING_SETTING_STRING('ENABLE:ALL' ,'SESSION'); -- Check the current warning setting. select dbms_warning.get_warning_setting_string() from dual; -- When we recompile the procedure, we will see a warning about the dead code. ALTER PROCEDURE dead_code COMPILE;
See Also: ALTER PROCEDURE
, DBMS_WARNING
package in the PL/SQL Packages and Types Reference, PLW- messages in the Oracle Database Error Messages
PL/SQL блок:
DECLARE
… — объявляющая секция
BEGIN
… — выполняющая секция
EXCEPTION
… — секция обработки исключительных ситуаций
END;
/
При установлении исключительной ситуации управление программой сразу же передается
в секцию исключительных ситуаций блока.
Если такой секции в блоке нет, то исключение передается в объемлющий блок.
После передачи управления обработчику, вернуться в выполняющую секцию блока невозможно.
Исключения бывают:
— стандартные
— определенные пользователем
Стандартные исключительные ситуации инициируются автоматически при возникновении
соответствующей ошибки Oracle.
Исключительные ситуации, определяемые пользователем,
устанавливаются явно при помощи оператора RAISE.
Обрабатываются исключения так:
EXCEPTION
WHEN имя_ex1 THEN
…; — обработать
WHEN имя_ex2 THEN
…; — обработать
WHEN OTHERS THEN
…; — обработать
END;
/
Имена исключений не должны повторяться т.е. каждое исключение может
обрабатываться максимум только одним обработчиком в секции EXCEPTION
Один обработчик может обслуживать несколько исключительных ситуаций
и их нужно перечислить в условии WHEN через OR
EXCEPTION
WHEN NO_DATA_FOUND OR TOO_MANY_ROWS THEN
INSERT INTO log_table(info) VALUES (‘A select error occurred.’);
END;
/
Два исключения одновременно один обработчик обработать не может:
WHEN имя_ex1 AND имя_ex2 — > ERR
Пользовательское исключение должно быть определено:
DECLARE
e_my_ex EXCEPTION;
…
BEGIN
IF (…) THEN
RAISE e_my_ex;
END IF;
…
EXCEPTION
WHEN e_my_ex THEN
…
END;
/
После перехвата более специализированных исключений:
WHEN … THEN
…
WHEN … THEN
мы можем перехватить все остальные исключения с помощью:
WHEN OTHERS THEN
…
Обработчик OTHERS рекомендуется помещать на самом высоком уровне программы:
(В самом высшем блоке)
для обеспечения распознавания всех возможных ошибок.
Иначе ошибки будут распространяться в вызывающую среду и возможны
нежелательные последствия, такие как откат на сервере текущей транзакции.
Не используйте в промышленном коде такое:
WHEN OTHERS THEN NULL;
т.к. оно будет молчаливо перехватывать все неожиданные ошибки не сообщая,
что они произошли.
Обработчик OTHERS должен регистрировать ошибку и возможно предоставлять
дополнительную информацию для дальнейшего исследования.
WHEN OTHERS THEN
INSERT INTO log_table(info) VALUES (‘Another error occurred.’);
END;
/
Информацию об ошибках можно получить при помощи двух встроенных функций:
— SQLCODE
— SQLERRM
первая возвращает код текущей ошибки а вторая текст сообщения об ошибке
Для исключений определенных пользователем:
SQLCODE возвращает 1
а
SQLERRM «User-defined Exception»
WHEN OTHERS THEN
v_ErrorCode := SQLCODE;
v_ErrorText := SUBSTR(SQLERRM, 1, 200);
INSERT INTO log_tab(code, message, info) VALUES (v_ErrorCode, v_ErrorText, ‘Oracle error.’);
END;
/
В таблице log_tab поле message ограничено 200 символами
и чтобы не произошло ошибки при вставке, мы урезаем длину
сообщения до 200 символов с помощью SUBSTR
А то максимальная длина сообщения может достигать 512 символов.
Функция SQLERRM может принимать один числовой аргумент.
При этом она возвратит текст сообщения об ошибке, код которой равен заданному числу.
Аргумент должен быть всегда отрицательным числом.
Если аргумент равен 0, то будет возвращено сообщение:
ORA-0000: normal, succesful completion
При положительном аргументе не равном 100 будет возвращено сообщение:
non-ORACLE Exception
А при
SQLERRM(100) — > ORA-1403: no data found
Это исключение ANSI
Остальные коды ошибок Oracle все отрицательные.
Для получения информации об ошибке можно также использовать функцию
FORMAT_ERROR_STACK из пакета DBMS_UTILITY
Её можно непосредственно использовать в операторах SQL:
WHEN OTHERS THEN
INSERT INTO log_tab(code, message, info) VALUES (NULL,
SUBSTR(DBMS_UTILITY.FORMAT_ERROR_STACK, 1, 200),
‘Oracle error occurred.’);
END;
/
Ещё одна функция.
DBMS_UTILITY.FORMAT_ERROR_BACKTRACE
она аналогична FORMAT_ERROR_STACK
но не подвержена ограничению длины сообщения в 2000 байт.
Она возвращает полностью весь стек ошибок на момент инициирования исключительной ситуации.
Любое именованное исключение можно связать с конкретной ошибкой ORACLE.
Например, в ORACLE есть стандартная ошибка ORA-1400, которая возникает при пропуске значения
или вставке значения NULL в столбец с ограничением NOT NULL.
ORA-1400: mandatory NOT NULL column missing or NULL during insert.
Мы хотим создать свое пользовательское именованное исключение и связать его с этой стандартной ошибкой ORA-1400
DECLARE
e_my_ex EXCEPTION;
PRAGMA EXCEPTION_INIT(e_my_ex, -1400);
BEGIN
WHEN e_my_ex THEN
INSERT INTO log_tab(info) VALUES (‘ORA-1400 occurred.’);
END;
/
Теперь мы перехватываем её по имени с помощъю WHEN или THEN
Все стандартные исключительные ситуации также ассоциируются с соответствующими им ошибками Oracle
при помощи прагмы EXCEPTION_INIT в пакете STANDARD
VALUE_ERROR — > ORA-6501
TO_MANY_ROWS — > ORA-1422
ZERO_DIVIDE — > ORA-1476
……….
и т.д.
Так что если вам не хватает некоего имени конкретной ошибки ORA-NNNN,
то придумайте свое имя и свяжите его с ошибкой с помощью прагмы : EXCEPTION_INIT
Для собственных пользовательских исключений можно придумать свои коды ошибок, которые разрешено брать из диапазона:
-20000 до -20999
и придумать свой текст сообщения
RAISE_APPLICATION_ERROR(номер, текст, [флаг]);
TRUE — пополнить список ранее произошедших ошибок
FALSE — новая ошибка заместит текущий список ошибок (по умолчанию)
set serveroutput on
variable a NUMBER;
variable b NUMBER;
exec :a := 0;
exec :b := 10;
DECLARE
l_a NUMBER := :a;
l_b NUMBER := :b;
l_c NUMBER;
BEGIN
IF l_a = 0 THEN
raise_application_error(-20005, ‘Divizor is 0’);
END IF;
l_c := l_b / l_a;
dbms_output.put_line(‘The result: ‘||l_c);
EXCEPTION
WHEN OTHERS THEN
dbms_output.put_line(SQLERRM);
END;
/
Поскольку у исключения нет имени, то его может обработать только обработчик OTHERS
Но такое исключение можно и поименовать
и с помощью прагмы связать с нашим кодом.
DECLARE
my_ex EXCEPTION;
…..
…..
PRAGMA EXCEPTION_INIT(my_ex, -20005);
BEGIN
IF (…) THEN
raise_application_error(-20005, ‘Divizor is 0’);
…..
…..
EXCEPTION
WHEN my_ex THEN
dbms_output.put_line(SQLERRM);
END;
/
Теперь это исключение можно обработать по имени с помощью:
WHEN my_ex THEN
EXCEPTION PROPAGATION
enclosing block — обьемлющий блок
Если в текущем блоке имеется обработчик данной исключительной ситуации,
то он выполняется и блок успешно завершается.
Управление передаётся вышестоящему блоку.
Если обработчик отсутствует, исключительная ситуация передается в обьемлющий блок и инициируется там.
Если обьемлющего блока не существует, то исключение будет передано вызывающей среды (например SQL*Plus).
При вызове процедуры также может создаваться обьемлющий блок:
BEGIN
p(…); — вызов процедуры
EXCEPTION
WHEN OTHERS THEN
— исключение инициированное p()
— будет обработано здесь
END;
/
Исключения инициируемые в секции обьявлений (DECLARE) не обрабатываются секцией EXCEPTION
текущего блока, а передаются в EXCEPTION обьемлющего блока.
Тоже самое, если исключение инициируется в секции EXCEPTION,
то обработка данного исключения передается в обьемлющий блок.
Исключительную ситуацию можно обработать в текущем блоке и сразу снова установить
то же самое исключение, которое будет передано в обьемлющую область:
DECLARE
A EXCEPTION;
BEGIN
RAISE A;
EXCEPTION
WHEN A THEN
INSERT INTO log_tab(info) VALUES (‘Exception A occurred.’);
COMMIT;
RAISE;
END;
/
Тут commit гарантирует, что результаты insert будут зафиксированы
в базе данных в случае отката транзакции.
С помощью пакета UTL_FILE можно избежать необходимости commit
или используйте автономные транзакции.
Область действия исключительной ситуации
BEGIN
DECLARE
e_ex EXCEPTION; — видно по имени только внутри блока
BEGIN
RAISE e_ex;
END;
EXCEPTION
— тут исключение не видно по имени e_ex
— и его можно обработать с помощью обработчика OTHERS
WHEN OTHERS THEN
— инициируем это исключение повторно
RAISE; — Теперь это исключение передается вызывающей среде
END;
/
Если сообщение об ошибке, определяемой пользователем, нужно передать из блока,
рекомендуется описывать исключительную ситуацию и модуле так,
чтобы она была видима вне этого блока.
Или воспользуйтесь функцией : RAISE_APPLICATION_ERROR
Как описать исключение, которое будет видно вне блока?
Нужно создать пакет Globals и описать в нем пользовательское исключение.
Такая исключительная ситуация будет видима и во внешнем блоке.
CREATE OR REPLACE PACKAGE Globals AS
e_ex EXCEPTION;
END Globals;
BEGIN
BEGIN
RAISE Globals.e_ex;
END;
EXCEPTION
WHEN Globals.e_ex THEN
— инициируем повторно
— для передачи в вызывающую среду
RAISE;
END;
/
В пакете Globals можно также объявлять:
— таблицы
— переменные
— типы
Избегайте необработанных исключений
Нельзя допускать завершение программ, пока в них остаются необработанные исключения
Используйте обработчик OTHERS на самом верхнем уровне программы.
И пусть он регистрирует факт и время возникновения ошибки.
И ни одна ошибка не останется без внимания.
DECLARE
v_ErrorNumber NUMBER;
v_ErrorText VARCHAR2(200);
BEGIN
…
…
EXCEPTION
WHEN OTHERS THEN
…
v_ErrorNumber := SQLCODE;
v_ErrorText := SUBSTR(SQLERRM, 1, 200);
INSERT INTO log_tab(code, message, info)
VALUES (v_ErrorNumber, v_ErrorText,
‘Oracle error …at ‘ || to_char(sysdate, ‘DD-MON-YYHH24:MI:SS’));
END;
/
Можно использовать и утилиту DBMS_UTILITY.FORMAT_ERROR_BACKTRACE
она регистрирует первоначальное местовозникновения исключения.
Как определить, где произошла ошибка?
BEGIN
SELECT …
SELECT …
SELECT …
EXCEPTION
WHEN NO_DATA_FOUND THEN
— какой select инициировал ошибку?
END;
/
Можно создать счетчик, указывающий на sql — оператор:
DECLARE
v_sel_count NUMBER := 1;
BEGIN
SELECT …
v_sel_count := 2;
SELECT …
v_sel_count := 3;
SELECT …
EXCEPTION
WHEN NO_DATA_FOUND THEN
INSERT INTO log_tab(info)
VALUES (‘no data found in select ‘||v_sel_count);
END;
/
Можно разместить каждый select в собственном врутреннем блоке
BEGIN
BEGIN
SELECT …
EXCEPTION
WHEN NO_DATA_FOUND THEN
INSERT INTO log_tab(info)
VALUES (‘no data found in select 1’);
END;
BEGIN
SELECT …
EXCEPTION
WHEN NO_DATA_FOUND THEN
INSERT INTO log_tab(info)
VALUES (‘no data found in select 2’);
END;
BEGIN
SELECT …
EXCEPTION
WHEN NO_DATA_FOUND THEN
INSERT INTO log_tab(info)
VALUES (‘no data found in select 3’);
END;
END;
/
Или использовать : DBMS_UTILITY.FORMAT_ERROR_BACKTRACE
и потом анализировать файл трассировки.
Пусть в нашей программе Oracle выдает ошибку ORA-01844: not f valid month
перехватить его можно так:
EXCEPTION
WHEN OTHERS THEN
IF SQLCODE = -1843 THEN
Да, код плохо читаем.
Сделаем его более лучшим:
PROCEDURE my_procedure
IS
invalid_month EXCEPTION;
PRAGMA EXCEPTION_INIT(invalid_month, -1843);
BEGIN
….
EXCEPTION
WHEN invalid_month THEN
так уже более понятней.
An exception occurs when the PL/SQL engine encounters an instruction which it cannot execute due to an error that occurs at run-time. These errors will not be captured at the time of compilation and hence these needed to handle only at the run-time.
For example, if PL/SQL engine receives an instruction to divide any number by ‘0’, then the PL/SQL engine will throw it as an exception. The exception is only raised at the run-time by the PL/SQL engine.
Exceptions will stop the program from executing further, so to avoid such condition, they need to be captured and handled separately. This process is called as Exception-Handling, in which the programmer handles the exception that can occur at the run time.
Exception-Handling Syntax
Exceptions are handled at the block, level, i.e., once if any exception occurs in any block then the control will come out of execution part of that block. The exception will then be handled at the exception handling part of that block. After handling the exception, it is not possible to resend control back to the execution section of that block.
The below syntax explains how to catch and handle the exception.
BEGIN <execution block> . . EXCEPTION WHEN <exceptionl_name> THEN <Exception handling code for the “exception 1 _name’' > WHEN OTHERS THEN <Default exception handling code for all exceptions > END;
Syntax Explanation:
- In the above syntax, the exception-handling block contains series of WHEN condition to handle the exception.
- Each WHEN condition is followed by the exception name which is expected to be raised at the run time.
- When any exception is raised at runtime, then the PL/SQL engine will look in the exception handling part for that particular exception. It will start from the first ‘WHEN’ clause and, sequentially it will search.
- If it found the exception handling for the exception which has been raised, then it will execute that particular handling code part.
- If none of the ‘WHEN’ clause is present for the exception which has been raised, then PL/SQL engine will execute the ‘WHEN OTHERS’ part (if present). This is common for all the exception.
- After executing the exception, part control will go out of the current block.
- Only one exception part can be executed for a block at run-time. After executing it, the controller will skip the remaining exception handling part and will go out of the current block.
Note: WHEN OTHERS should always be at the last position of the sequence. The exception handling part present after WHEN OTHERS will never get executed as the control will exit from the block after executing the WHEN OTHERS.
Types of Exception
There are two types of Exceptions in Pl/SQL.
- Predefined Exceptions
- User-defined Exception
Predefined Exceptions
Oracle has predefined some common exception. These exceptions have a unique exception name and error number. These exceptions are already defined in the ‘STANDARD’ package in Oracle. In code, we can directly use these predefined exception name to handle them.
Below are the few predefined exceptions
Exception | Error Code | Exception Reason |
---|---|---|
ACCESS_INTO_NULL | ORA-06530 | Assign a value to the attributes of uninitialized objects |
CASE_NOT_FOUND | ORA-06592 | None of the ‘WHEN’ clause in CASE statement satisfied and no ‘ELSE’ clause is specified |
COLLECTION_IS_NULL | ORA-06531 | Using collection methods (except EXISTS) or accessing collection attributes on a uninitialized collections |
CURSOR_ALREADY_OPEN | ORA-06511 | Trying to open a cursor which is already opened |
DUP_VAL_ON_INDEX | ORA-00001 | Storing a duplicate value in a database column that is a constrained by unique index |
INVALID_CURSOR | ORA-01001 | Illegal cursor operations like closing an unopened cursor |
INVALID_NUMBER | ORA-01722 | Conversion of character to a number failed due to invalid number character |
NO_DATA_FOUND | ORA-01403 | When ‘SELECT’ statement that contains INTO clause fetches no rows. |
ROW_MISMATCH | ORA-06504 | When cursor variable data type is incompatible with the actual cursor return type |
SUBSCRIPT_BEYOND_COUNT | ORA-06533 | Referring collection by an index number that is larger than the collection size |
SUBSCRIPT_OUTSIDE_LIMIT | ORA-06532 | Referring collection by an index number that is outside the legal range (eg: -1) |
TOO_MANY_ROWS | ORA-01422 | When a ‘SELECT’ statement with INTO clause returns more than one row |
VALUE_ERROR | ORA-06502 | Arithmetic or size constraint error (eg: assigning a value to a variable that is larger than the variable size) |
ZERO_DIVIDE | ORA-01476 | Dividing a number by ‘0’ |
User-defined Exception
In Oracle, other than the above-predefined exceptions, the programmer can create their own exception and handle them. They can be created at a subprogram level in the declaration part. These exceptions are visible only in that subprogram. The exception that is defined in the package specification is public exception, and it is visible wherever the package is accessible.
Syntax: At subprogram level
DECLARE <exception_name> EXCEPTION; BEGIN <Execution block> EXCEPTION WHEN <exception_name> THEN <Handler> END;
- In the above syntax, the variable ‘exception_name’ is defined as ‘EXCEPTION’ type.
- This can be used as in a similar way as a predefined exception.
Syntax:At Package Specification level
CREATE PACKAGE <package_name> IS <exception_name> EXCEPTION; . . END <package_name>;
- In the above syntax, the variable ‘exception_name’ is defined as ‘EXCEPTION’ type in the package specification of <package_name>.
- This can be used in the database wherever package ‘package_name’ can be called.
PL/SQL Raise Exception
All the predefined exceptions are raised implicitly whenever the error occurs. But the user-defined exceptions needs to be raised explicitly. This can be achieved using the keyword ‘RAISE’. This can be used in any of the ways mentioned below.
If ‘RAISE’ is used separately in the program, then it will propagate the already raised exception to the parent block. Only in exception block can be used as shown below.
CREATE [ PROCEDURE | FUNCTION ] AS BEGIN <Execution block> EXCEPTION WHEN <exception_name> THEN <Handler> RAISE; END;
Syntax Explanation:
- In the above syntax, the keyword RAISE is used in the exception handling block.
- Whenever program encounters exception “exception_name”, the exception is handled and will be completed normally
- But the keyword ‘RAISE’ in the exception handling part will propagate this particular exception to the parent program.
Note: While raising the exception to the parent block the exception that is getting raised should also be visible at parent block, else oracle will throw an error.
- We can use keyword ‘RAISE’ followed by the exception name to raise that particular user-defined/predefined exception. This can be used in both execution part and in exception handling part to raise the exception.
CREATE [ PROCEDURE | FUNCTION ] AS BEGIN <Execution block> RAISE <exception_name> EXCEPTION WHEN <exception_name> THEN <Handler> END;
Syntax Explanation:
- In the above syntax, the keyword RAISE is used in the execution part followed by exception “exception_name”.
- This will raise this particular exception at the time of execution, and this needs to be handled or raised further.
Example 1: In this example, we are going to see
- How to declare the exception
- How to raise the declared exception and
- How to propagate it to the main block
DECLARE Sample_exception EXCEPTION; PROCEDURE nested_block IS BEGIN Dbms_output.put_line(‘Inside nested block’); Dbms_output.put_line(‘Raising sample_exception from nested block’); RAISE sample_exception; EXCEPTION WHEN sample_exception THEN Dbms_output.put_line (‘Exception captured in nested block. Raising to main block’); RAISE, END; BEGIN Dbms_output.put_line(‘Inside main block’); Dbms_output.put_line(‘Calling nested block’); Nested_block; EXCEPTION WHEN sample_exception THEN Dbms_output.put_line (‘Exception captured in main block'); END: /
Code Explanation:
- Code line 2: Declaring the variable ‘sample_exception’ as EXCEPTION type.
- Code line 3: Declaring procedure nested_block.
- Code line 6: Printing the statement “Inside nested block”.
- Code line 7: Printing the statement “Raising sample_exception from nested block.”
- Code line 8: Raising the exception using ‘RAISE sample_exception’.
- Code line 10: Exception handler for exception sample_exception in the nested block.
- Code line 11: Printing the statement ‘Exception captured in nested block. Raising to main block’.
- Code line 12: Raising the exception to main block (propagating to the main block).
- Code line 15: Printing the statement “Inside the main block”.
- Code line 16: Printing the statement “Calling nested block”.
- Code line 17: Calling nested_block procedure.
- Code line 18: Exception
- Code line 19: Exception handler for sample_exception in the main block.
- Code line 20: Printing the statement “Exception captured in the main block.”
Important points to note in Exception
- In function, an exception should always either return value or raise the exception further. else Oracle will throw ‘Function returned without a value’ error at run-time.
- Transaction control statements can be given at exception handling block.
- SQLERRM and SQLCODE are the in-built functions that will give the exception message and code.
- If an exception is not handled then by default all the active transaction in that session will be rolled back.
- RAISE_APPLICATION_ERROR (-<error_code>, <error_message>) can be used instead of RAISE to raise the error with user code and message. Error code should be greater than 20000 and prefixed with ‘-‘.
Summary
After this chapter. you should be able to work for the following aspects of Pl SQL exceptions
- Handling the exceptions
- Define an exception
- Raise the exception
- Exception propagation
Summary: in this tutorial, you will learn about PL/SQL exception and how to write exception handler to handle exceptions.
Introduction to PL/SQL Exceptions
PL/SQL treats all errors that occur in an anonymous block, procedure, or function as exceptions. The exceptions can have different causes such as coding mistakes, bugs, even hardware failures.
It is not possible to anticipate all potential exceptions, however, you can write code to handle exceptions to enable the program to continue running as normal.
The code that you write to handle exceptions is called an exception handler.
A PL/SQL block can have an exception-handling section, which can have one or more exception handlers.
Here is the basic syntax of the exception-handling section:
Code language: SQL (Structured Query Language) (sql)
BEGIN -- executable section ... -- exception-handling section EXCEPTION WHEN e1 THEN -- exception_handler1 WHEN e2 THEN -- exception_handler1 WHEN OTHERS THEN -- other_exception_handler END;
In this syntax, e1
, e2
are exceptions.
When an exception occurs in the executable section, the execution of the current block stops and control transfers to the exception-handling section.
If the exception e1
occurred, the exception_handler1
runs. If the exception e2
occurred, the exception_handler2
executes. In case any other exception raises, then the other_exception_handler
runs.
After an exception handler executes, control transfers to the next statement of the enclosing block. If there is no enclosing block, then the control returns to the invoker if the exception handler is in a subprogram or host environment (SQL Developer or SQL*Plus) if the exception handler is in an anonymous block.
If an exception occurs but there is no exception handler, then the exception propagates, which we will discuss in the unhandled exception propagation tutorial.
PL/SQL exception examples
Let’s take some examples of handling exceptions.
PL/SQL NO_DATA_FOUND
exception example
The following block accepts a customer id as an input and returns the customer name :
Code language: SQL (Structured Query Language) (sql)
DECLARE l_name customers.NAME%TYPE; l_customer_id customers.customer_id%TYPE := &customer_id; BEGIN -- get the customer name by id SELECT name INTO l_name FROM customers WHERE customer_id = l_customer_id; -- show the customer name dbms_output.put_line('Customer name is ' || l_name); END; /
If you execute the block and enter the customer id as zero, Oracle will issue the following error:
Code language: SQL (Structured Query Language) (sql)
ORA-01403: no data found
The ORA-01403
is a predefined exception.
Note that the following line does not execute at all because control transferred to the exception handling section.
Code language: SQL (Structured Query Language) (sql)
dbms_output.put_line('Customer name is ' || l_name);
To issue a more meaningful message, you can add an exception-handling section as follows:
Code language: SQL (Structured Query Language) (sql)
DECLARE l_name customers.NAME%TYPE; l_customer_id customers.customer_id%TYPE := &customer_id; BEGIN -- get the customer SELECT NAME INTO l_name FROM customers WHERE customer_id = l_customer_id; -- show the customer name dbms_output.put_line('customer name is ' || l_name); EXCEPTION WHEN NO_DATA_FOUND THEN dbms_output.put_line('Customer ' || l_customer_id || ' does not exist'); END; /
If you execute this code block and enter the customer id 0, you will get the following message:
Code language: SQL (Structured Query Language) (sql)
Customer 0 does not exist
PL/SQL TOO_MANY_ROWS
exception example
First, modify the code block in the above example as follows and execute it:
Code language: SQL (Structured Query Language) (sql)
DECLARE l_name customers.name%TYPE; l_customer_id customers.customer_id%TYPE := &customer_id; BEGIN -- get the customer SELECT name INTO l_name FROM customers WHERE customer_id <= l_customer_id; -- show the customer name dbms_output.put_line('Customer name is ' || l_name); EXCEPTION WHEN NO_DATA_FOUND THEN dbms_output.put_line('Customer ' || l_customer_id || ' does not exist'); END; /
Second, enter the customer id 10 and you’ll get the following error:
Code language: SQL (Structured Query Language) (sql)
ORA-01422: exact fetch returns more than requested number of rows
This is another exception called TOO_MANY_ROWS
which was not handled by the code.
Third, add the exception handler for the TOO_MANY_ROWS
exception:
Code language: SQL (Structured Query Language) (sql)
DECLARE l_name customers.NAME%TYPE; l_customer_id customers.customer_id%TYPE := &customer_id; BEGIN -- get the customer SELECT NAME INTO l_name FROM customers WHERE customer_id > l_customer_id; -- show the customer name dbms_output.put_line('Customer name is ' || l_name); EXCEPTION WHEN NO_DATA_FOUND THEN dbms_output.put_line('Customer ' || l_customer_id || ' does not exist'); WHEN TOO_MANY_ROWS THEN dbms_output.put_line('The database returns more than one customer'); END; /
Finally, if you execute the code, enter 10 as the customer id. You will see that the code will not raise any exception and issue the following message:
Code language: SQL (Structured Query Language) (sql)
The database returns more than one customer
PL/SQL exception categories
PL/SQL has three exception categories:
- Internally defined exceptions are errors which arise from the Oracle Database environment. The runtime system raises the internally defined exceptions automatically. ORA-27102 (out of memory) is one example of Internally defined exceptions. Note that Internally defined exceptions do not have names, but an error code.
- Predefined exceptions are errors which occur during the execution of the program. The predefined exceptions are internally defined exceptions that PL/SQL has given names e.g.,
NO_DATA_FOUND
,TOO_MANY_ROWS
. - User-defined exceptions are custom exception defined by users like you. User-defined exceptions must be raised explicitly.
The following table illustrates the differences between exception categories.
Category | Definer | Has Error Code | Has Name | Raised Implicitly | Raised Explicitly |
---|---|---|---|---|---|
Internally defined | Runtime system | Always | Only if you assign one | Yes | Optionally |
Predefined | Runtime system | Always | Always | Yes | Optionally |
User-defined | User | Only if you assign one | Always | No | Always |
In this tutorial, you have learned about the PL/SQL exceptions and how to write exception handlers to handle the possible exceptions in a block.
October 11, 2020
ORACLE
This article contains information about Oracle PL/SQL Exception and Types such as system defined, user defined.
What is Exception in Oracle PL/SQL?
These are the structures used for the management of errors that occur during the execution of commands.
Oracle PL/SQL Exception Types
- System-defined
- User-defined
The use of the PL / SQL Exception structure is as follows.
DECLARE — definitions BEGIN — commands EXCEPTION WHEN HATA—TURU THEN — commands WHEN OTHERS THEN — commands END; |
Sample Exception Usage is as follows;
BEGIN DBMS_OUTPUT.put_line(3/0); EXCEPTION WHEN ZERO_DIVIDE THEN DBMS_OUTPUT.put_line(‘Divide by zero error.’); WHEN OTHERS THEN DBMS_OUTPUT.put_line(‘unknown error.’); END; |
System Defined Exceptions in Oracle PL/SQL
The Exception type previously created by Oracle PL / SQL is called System defined.
System-defined exception types are listed below.
- ACCESS_INTO_NULL
- ASE_NOT_FOUND
- COLLECTION_IS_NULL
- DUP_VAL_ON_INDEX
- INVALID_CURSOR
- INVALID_NUMBER, LOGIN_DENIED
- NO_DATA_FOUND
- NOT_LOGGED_ON
- PROGRAM_ERROR
- ROWTYPE_MISMATCH
- SELF_IS_NULL
- STORAGE_ERROR
- TOO_MANY_ROWS
- VALUE_ERROR
- ZERO_DIVIDE
User Defined Exceptions in Oracle PL/SQL
Oracle also allows custom exception definition. These Exception types are called user defined exceptions. You can create User Defined Exception as follows.
DECLARE MY_CUSTOM_ERROR EXCEPTION; BEGIN NULL; END; |
We can set a special error code for the exception as follows.
DECLARE CUSTOM_ERROR EXCEPTION; PRAGMA EXCEPTION_INIT (CUSTOM_ERROR, —1453); BEGIN NULL; END; |
The occured error can be triggered by RAISE.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
SET SERVEROUTPUT ON; DECLARE CUSTOM_ERROR EXCEPTION; PRAGMA EXCEPTION_INIT (CUSTOM_ERROR, —1453); v_sayi PLS_INTEGER := ‘0’; BEGIN IF v_sayi = 0 THEN RAISE CUSTOM_ERROR; — RAISE_APPLICATION_ERROR(—1453, ‘Another Error.’); END IF; EXCEPTION WHEN CUSTOM_ERROR THEN DBMS_OUTPUT.put_line(‘Special Error Occured.’); DBMS_OUTPUT.put_line(SQLERRM); WHEN OTHERS THEN DBMS_OUTPUT.put_line(‘Unknown Error Occured.’); END; |
The RAISE_APPLICATION_ERROR function takes the “error code”, “error message”, and “whether the error should be replaced with existing errors” as parameters to create a custom error.
You can find more detailed information about below topics in the below link.
PL/SQL Tutorial
You will find below topics in this article.
- What is PL/SQL
- Oracle PL/SQL Data Types and Variables and Literals
- Oracle PL/SQL Operators
- Oracle PL/SQL Conditional Statements
- Oracle PL/SQL Loops
- Oracle PL/SQL Procedures and Procedure Parameters
- Oracle PL/SQL Functions
- Oracle PL/SQL Cursor
- Oracle PL/SQL Records
- Oracle PL/SQL Exception
- Oracle PL/SQL Trigger
- Oracle PL/SQL Packages
- Oracle PL/SQL Collections
You can find more information about exception at docs.oracle.com
Introduction
Oracle produces a variety of exceptions. You may be surprised how tedious it can be to have your code stop with some unclear message. To improve your PL/SQL code’s ability to get fixed easily it is necessary to handle exceptions at the lowest level. Never hide an exception «under the carpet», unless you’re here to keep your piece of code for you only and for no one else to maintain.
The predefined errors.
Exception handling
-
What is an exception?
Exception in PL/SQL is an error created during a program execution.
We have three types of exceptions:
- Internally defined exceptions
- Predefined exceptions
- User-defined exceptions
-
What is an exception handling?
Exception handling is a possibility to keep our program running even if appear runtime error resulting from for example coding mistakes, hardware failures.We avoid it from exiting abruptly.
Syntax
The general syntax for exception section:
declare
declaration Section
begin
some statements
exception
when exception_one then
do something
when exception_two then
do something
when exception_three then
do something
when others then
do something
end;
An exception section has to be on the end of the PL/SQL block. PL/SQL gives us the opportunity to nest blocks, then each block may have its own exception section for example:
create or replace procedure nested_blocks
is
begin
some statements
begin
some statements
exception
when exception_one then
do something
end;
exception
when exception_two then
do something
end;
If exception will be raised in the nested block it should be handled in the inner exception section, but if inner exception section does not handle this exception then this exception will go to exception section of the external block.
Internally defined exceptions
An internally defined exception doesn’t have a name, but it has its own code.
When to use it?
If you know that your database operation might raise specific exceptions those which don’t have names, then you can give them names so that you can write exception handlers specifically for them. Otherwise, you can use them only with others
exception handlers.
Syntax
declare
my_name_exc exception;
pragma exception_init(my_name_exc,-37);
begin
...
exception
when my_name_exc then
do something
end;
my_name_exc exception;
that is the exception name declaration.
pragma exception_init(my_name_exc,-37);
assign name to the error code of internally defined exception.
Example
We have an emp_id which is a primary key in emp table and a foreign key in dept table.
If we try to remove emp_id when it has child records, it will be thrown an exception with code -2292.
create or replace procedure remove_employee
is
emp_exception exception;
pragma exception_init(emp_exception,-2292);
begin
delete from emp where emp_id = 3;
exception
when emp_exception then
dbms_output.put_line('You can not do that!');
end;
/
Oracle documentation says: «An internally defined exception with a user-declared name is still an internally defined exception, not a user-defined exception.»
Predefined exceptions
Predefined exceptions are internally defined exceptions but they have names. Oracle database raise this type of exceptions automatically.
Example
create or replace procedure insert_emp
is
begin
insert into emp (emp_id, ename) values ('1','Jon');
exception
when dup_val_on_index then
dbms_output.put_line('Duplicate value on index!');
end;
/
Below are examples exceptions name with theirs codes:
Exception Name | Error Code |
---|---|
NO_DATA_FOUND | -1403 |
ACCESS_INTO_NULL | -6530 |
CASE_NOT_FOUND | -6592 |
ROWTYPE_MISMATCH | -6504 |
TOO_MANY_ROWS | -1422 |
ZERO_DIVIDE | -1476 |
Full list of exception names and their codes on Oracle web-site.
User defined exceptions
As the name suggest user defined exceptions are created by users. If you want to create your own exception you have to:
- Declare the exception
- Raise it from your program
- Create suitable exception handler to catch him.
Example
I want to update all salaries of workers. But if there are no workers, raise an exception.
create or replace procedure update_salary
is
no_workers exception;
v_counter number := 0;
begin
select count(*) into v_counter from emp;
if v_counter = 0 then
raise no_workers;
else
update emp set salary = 3000;
end if;
exception
when no_workers then
raise_application_error(-20991,'We don''t have workers!');
end;
/
What does it mean raise
?
Exceptions are raised by database server automatically when there is a need, but if you want, you can raise explicitly any exception using raise
.
Procedure raise_application_error(error_number,error_message);
- error_number must be between -20000 and -20999
- error_message message to display when error occurs.
Define custom exception, raise it and see where it comes from
To illustrate this, here is a function that has 3 different «wrong» behaviors
- the parameter is completely stupid: we use a user-defined expression
- the parameter has a typo: we use Oracle standard
NO_DATA_FOUND
error - another, but not handled case
Feel free to adapt it to your standards:
DECLARE
this_is_not_acceptable EXCEPTION;
PRAGMA EXCEPTION_INIT(this_is_not_acceptable, -20077);
g_err varchar2 (200) := 'to-be-defined';
w_schema all_tables.OWNER%Type;
PROCEDURE get_schema( p_table in Varchar2, p_schema out Varchar2)
Is
w_err varchar2 (200) := 'to-be-defined';
BEGIN
w_err := 'get_schema-step-1:';
If (p_table = 'Delivery-Manager-Is-Silly') Then
raise this_is_not_acceptable;
end if;
w_err := 'get_schema-step-2:';
Select owner Into p_schema
From all_tables
where table_name like(p_table||'%');
EXCEPTION
WHEN NO_DATA_FOUND THEN
-- handle Oracle-defined exception
dbms_output.put_line('[WARN]'||w_err||'This can happen. Check the table name you entered.');
WHEN this_is_not_acceptable THEN
-- handle your custom error
dbms_output.put_line('[WARN]'||w_err||'Please don''t make fun of the delivery manager.');
When others then
dbms_output.put_line('[ERR]'||w_err||'unhandled exception:'||sqlerrm);
raise;
END Get_schema;
BEGIN
g_err := 'Global; first call:';
get_schema('Delivery-Manager-Is-Silly', w_schema);
g_err := 'Global; second call:';
get_schema('AAA', w_schema);
g_err := 'Global; third call:';
get_schema('', w_schema);
g_err := 'Global; 4th call:';
get_schema('Can''t reach this point due to previous error.', w_schema);
EXCEPTION
When others then
dbms_output.put_line('[ERR]'||g_err||'unhandled exception:'||sqlerrm);
-- you may raise this again to the caller if error log isn't enough.
-- raise;
END;
/
Giving on a regular database:
[WARN]get_schema-step-1:Please don't make fun of the delivery manager.
[WARN]get_schema-step-2:This can happen. Check the table name you entered.
[ERR]get_schema-step-2:unhandled exception:ORA-01422: exact fetch returns more than requested number of rows
[ERR]Global; third call:unhandled exception:ORA-01422: exact fetch returns more than requested number of rows
Remember that exception are here to handle rare cases. I saw applications who raised an exception at every access, just to ask for the user password, saying «not connected»… so much computation waste.
Handling connexion error exceptions
Each standard Oracle error is associated with an error number. It’s important to anticipate what could go wrong in your code. Here for a connection to another database, it can be:
-28000
account is locked-28001
password expired-28002
grace period-1017
wrong user / password
Here is a way to test what goes wrong with the user used by the database link:
declare
v_dummy number;
begin
-- testing db link
execute immediate 'select COUNT(1) from [email protected]' into v_dummy ;
-- if we get here, exception wasn't raised: display COUNT's result
dbms_output.put_line(v_dummy||' users on PASS db');
EXCEPTION
-- exception can be referred by their name in the predefined Oracle's list
When LOGIN_DENIED
then
dbms_output.put_line('ORA-1017 / USERNAME OR PASSWORD INVALID, TRY AGAIN');
When Others
then
-- or referred by their number: stored automatically in reserved variable SQLCODE
If SQLCODE = '-2019'
Then
dbms_output.put_line('ORA-2019 / Invalid db_link name');
Elsif SQLCODE = '-1035'
Then
dbms_output.put_line('ORA-1035 / DATABASE IS ON RESTRICTED SESSION, CONTACT YOUR DBA');
Elsif SQLCODE = '-28000'
Then
dbms_output.put_line('ORA-28000 / ACCOUNT IS LOCKED. CONTACT YOUR DBA');
Elsif SQLCODE = '-28001'
Then
dbms_output.put_line('ORA-28001 / PASSWORD EXPIRED. CONTACT YOUR DBA FOR CHANGE');
Elsif SQLCODE = '-28002'
Then
dbms_output.put_line('ORA-28002 / PASSWORD IS EXPIRED, CHANGED IT');
Else
-- and if it's not one of the exception you expected
dbms_output.put_line('Exception not specifically handled');
dbms_output.put_line('Oracle Said'||SQLCODE||':'||SQLERRM);
End if;
END;
/