日日是Oracle APEX: 制約の違反に対応したエラー・メッセージを定義する

オランダ在住のRoel Hartmanさん(ODTUGのボード・メンバーです)が彼のブログに以下の記事を書いていました。

Stop using validations for checking constraints!

記事の内容は、データベースの表に設定している制約に違反したときに発生するエラー・メッセージを画面に表示する際には、Oracle APEXが提供している(アプリケーション定義に含まれる)エラー処理ファンクションを活用しましょう、というものです。関連するドキュメントの記載としては、パッケージAPEX_ERRORの説明になります。

彼の記事の中で面白いなと思ったのは、出力するメッセージの取得にAPEX_LANG.MESSAGEを使用しているところです。このファンクションは元々はアプリケーションの翻訳に使用するものです。翻訳で使用する方法については、以前にこのような記事を書きました。もちろん、アプリケーションの翻訳をしなくても、キーとなる値を指定して、メッセージとする文字列を取得することができます。

実際に実装して効果を確認してみましょう。

確認用アプリケーションの作成

Oracle APEXのワークスペースにサインインし、SQLワークショップからユーティリティのクイックSQLを開きます。

以下のクイックSQLのモデルを使って、表AET_EMPとAET_EMP_ATTRIBUTESを作成します。表AET_EMP_ATTRIBUTESには、各種の制約を付加しておきます。これらの制約に違反したときに表示されるエラー・メッセージを、Oracle Databaseが返すメッセージから、利用者向けに分かりやすいメッセージに変更することが本記事のゴールです。

# prefix: aet
# prefixPKwithTname: true
# semantics: default
# language: ja
emp /insert 5
  emp_id /pk /values 1,2,3,4,5
  emp_name

emp_attributes
  emp_attr_id /pk 
  emp_id /fk emp
  national_id num /unique
  attribute_name vc20 /nn
  attribute_value vc80
  gender vc1 /check M,F 
  age num /between 0 and 120

制約としては、主キー、外部キー、一意、NULL不可、チェック、範囲指定を設定しています。必要なディレクティブはモデルに含んでいるので、クイックSQLでSQLの生成、SQLスクリプトの保存、レビューおよび実行、即時実行とボタンをクリックしていけば、今回使用する表が作成されます。

続いてアプリケーション・ビルダーより、空のアプリケーションを作成します。アプリケーションの作成より新規アプリケーションを選び、アプリケーションの名前だけを指定して、アプリケーションの作成を実行します。ここではアプリケーションの名前を、エラー処理の確認としています。

空のアプリケーションが作成されたら、確認に使用するフォームと対話グリッドのページを作成します。最初にフォームのページを作成します。アプリケーション・ビルダーの画面より、ページの作成を開始します。

コンポーネントのフォームを選択します。

フォーム付きレポートを選択します。

レポート・タイプを対話モード・レポート、フォーム・ページ・モードをモーダル・ダイアログとします。それ以外は任意の値を設定できます。次に進みます。

ナビゲーションのプリファレンスとして新規ナビゲーション・メニュー・エントリの作成を選択します。次に進みます。

データ・ソースはローカル・データベース、ソース・タイプを表とし、表/ビューの名前としてAET_EMP_ATTRIBUTES(表)を選択します。次に進みます。

主キー制約でのエラーも発生させるため、主キー型としてデータベースで管理(ROWID)を選択します。作成を実行します。

以上でレポートとフォームの２つのページが作成されます。続いて、対話グリッドのページを作成します。フォームの作成と同様に、ページの作成を開始し、フォームの選択に続いて対話グリッドを選びます。

ページ名は任意ですが、ここではグリッド編集とします。次に進みます。

ナビゲーションのプリファレンスとして新規ナビゲーション・メニュー・エントリの作成を選択します。次に進みます。

データ・ソースとしてローカル・データベース、編集が有効をON、ソース・タイプを表とし、表/ビューの名前としてAET_EMP_ATTRIBUTES(表)を選択します。こちらも主キー制約のエラーを発生させるため、あえて主キー列にROWIDを選択します。作成を実行します。

対話グリッドが作成されます。作成されたアプリケーションを実行し、表の制約に違反したデータを投入し、エラーの表示を確認してみましょう。

すでに作成済みの行を重複させて保存を実行すると、ORA-00001: 一意制約(DBCLOUD_TEST.AET_EMP_ATTRIBU_EMP_ATTR_ID_PK)に反しています、が発生しました。

Ageに400を指定して作成を実行すると、ORA-02290: チェック制約(DBCLOUD_TEST.AET_EMP_ATTRIBUTES_AGE_BET)に違反しました、が発生しました。

以上で確認用アプリケーションは完成です。

エラー処理ファンクションの設定

マニュアルに記載されている例を元に、エラー処理ファンクションを定義します。コードに含まれているコメントが日本語マニュアルでも翻訳されていないので、処理内容がわかるように日本語に翻訳しました。

元の記事ではapex_lang.create_messageの引数であるp_languageにapex_util.get_preference('FSP_LANGUAGE_PREFERENCE')を与えていますが、これはアプリケーション言語の導出元がアプリケーション・プリファレンス(FSP_LANGUAGE_PREFERENCEを使用)になっていて初めて有効なので、アプリケーションのプライマリ言語になっているときはNULLを返します。日本では大抵、プライマリ言語として日本語(ja)を設定しているため、単にjaを指定する様に変更しました。