ESQL エディター

ESQL エディターは、ESQL (.esql) ファイルの編集用に、 「ブローカー・アプリケーション開発 (Broker Application Development)」パースペクティブ によって提供されているデフォルトのエディターです。

Compute、Database、または Filter ノード上で、 メニュー項目の「ESQL のオープン (Open ESQL)」を選択すると、 エディター領域にエディターが起動します。 または、ナビゲーター・ビューの ESQL ファイルをダブルクリックすることによってもエディターを起動できます。

ESQL エディターのビュー

ESQL エディターには、以下のビューがあります。

「リソース・ナビゲーター (Resource Navigator)」ビュー
「リソース・ナビゲーター (Resource Navigator)」ビューには、ワークスペース内のすべてのリソース、 つまり、ESQL ファイルを含むすべてのメッセージ・セット・リソースとすべてのメッセージ・フロー・リソースが表示されます。
「エディター (Editor)」ビュー
「エディター (Editor)」ビューには、現在開かれているリソースの内容が表示されます。 さらにこのビューでは、開いている各リソースがタブとして表示されるため、 リソースを瞬時に切り替えることができます。
「アウトライン (Outline)」ビュー
「アウトライン (Outline)」ビューには、この ESQL ファイルから参照されるすべてのスキーマ、 定義済み定数、モジュール、およびルーチンが表示されます。
「タスク (Tasks)」ビュー
「タスク (Tasks)」ビューには、ESQL ファイルの保管時にエディターの妥当性検査によって生成される、 警告およびエラー・メッセージが表示されます。 エラーをダブルクリックすると、該当する ESQL コードが強調表示されることによって、 エラーの発生箇所がエディター上に示されます。

ESQL エディター関数

ESQL エディターには、次のような関数があります。

  • コンテキスト依存の内容支援 (Content Assist) 内容支援は編集メニューまたは、いくつかのシステム上で、他の関数を割り当てていない場合にはCtrl (キー) + スペース・キーを押すと起動できます。

    この内容支援は、Properties フォルダーの内容に対する参照の構成を支援します。 また、事前定義メッセージに対して ESQL エディターを使用する際には、フィールド参照の構成も支援します。

    データベース・スキーマ定義に対して ESQL エディターを使用する場合、 内容支援は、スキーマ、テーブル、および列参照の構成を支援します。 ESQL エディターを使用して、ユーザー定義マップを呼び出すこともできます。

    ESQL ファイル内に関数およびプロシージャーを作成する場合、 定義する名前の先頭は IBM_ (IBM の後に下線) という文字であってはなりません。

  • 自動コード・フォーマット設定

次のような付加的な関数にアクセスするには、 エディター・ビューで右マウス・ボタンをクリックしてください。:

  • 「元に戻す (Undo)」および「復帰する (Revert)」。 ESQL ファイルに加えた変更を元に戻すには、 「元に戻す (Undo)」をクリックします。変更を元に戻した場合は、「復帰する (Revert)」をクリックして復元することができます。
  • 「切り取り (Cut)」「コピー (Copy)」、および 「貼り付け (Paste)」。 これらは標準エディター機能です。
  • 「シフト右方 (Shift Right)」および「シフト左方 (Shift Left)」。 これらは標準エディター機能です。
  • 「保管する (Save)」。 変更を保管するにはこれをクリックします。
  • 「コメント (Comment)」および「アンコメント (Uncomment)」。ESQL コードの行をコメントに変更するには「コメント (Comment)」をクリックします。コメントを ESQL コードの行に変更するには「アンコメント (Uncomment)」をクリックします。
  • 「フォーマット (Format)」。 この関数では、選択されたコードの行すべてが (ただ部分的に選択されている行は無視されます。 そうでない場合) フォーマット設定されるか、または選択された行がない場合には、 ファイル全体が (位置合わせとインデントを正して) フォーマット設定されます。
  • 「スキーマ・パスを編成する (Organize Schema Paths)」 および 「スキーマ・パスを追加する (Add Schema Path)」。これらの関数はブローカー・スキーマ管理を使ってユーザーを支援します。

    「スキーマ・パスを編成する (Organize Schema Paths)」をクリックすると、ESQL ファイルによって呼び出されたプロシージャーまたは関数を収容する任意のブローカー・スキーマが自動的に PATH ステートメントに追加されます (まだ追加されていなかった場合)。この関数は、ESQL ファイルをスキャンして、このファイル内でまだ完全に修飾されていないスキーマにあるプロシージャーまたは関数のインスタンスを調べます。

    PATH ステートメントに組み込まれている任意のものに対して、 異なるブローカー・スキーマにあるプロシージャーまたは関数の呼び出しをコーディングする場合、 「スキーマ・パスを追加する (Add Schema Path)」をクリックすると、 このスキーマは PATH ステートメントに追加されます。カーソルが呼び出しているプロシージャーの名前の上にあることを確認してください。

ESQL エディター設定

ESQL コードの処理方法に影響を与える以下の設定を変更できます。

  • コード生成の設定 (ランタイム・コード生成時):
    RDB テーブルへのアクセスに使用するスキーマ名
    以下のいずれかのラジオ・ボタンを選択して、 ESQL にデータベース・テーブルへの参照を組み込む際に使用するスキーマを指定してください。
    データ・ソースのデフォルト・ランタイム・スキーマを使用 (Use default runtime schema for this data source)
    これを選択した場合は、データ・ソースのデフォルト・スキーマが使用されます。
    テーブル定義のスキーマ名を使用
    これを選択した場合は、テーブル定義の作成時に指定されたスキーマが使用されます。
    指定する名前を使用
    これを選択した場合は、関連するテキスト入力フィールドに入力したスキーマ名を使用します。
    デフォルト互換性レベル
    ドロップダウン・リストから 5.0 または 2.1 を選択します。
    5.0
    この値を選択した場合、生成されるランタイム ESQL コードには以前のバージョンとの互換性がないため、 コンパイルされたメッセージ・フローはバージョン 5.0 のブローカーにのみ展開できます。 メッセージ・フロー内で ESQL コードをデバッグする場合には、この設定が必要です。 また、マッピング・ファイル (.mfmap ファイル) のあるノードがメッセージ・フローに含まれている場合も、この設定が必要です。 この値を設定している状態で、 バージョン 5.0 のランタイム ESQL コードが含まれているメッセージ・フローの bar ファイルをバージョン 2.1 のブローカーに展開すると、メッセージ・フローを開始する時にエラーになります。

    これはデフォルト設定です。

    2.1
    メッセージ・フローをバージョン 2.1 のブローカーに展開する場合は、この値を選択する必要があります。 これらのメッセージ・フローはバージョン 5.0 のブローカーに展開することもできますが、 その場合は、バージョン 5.0 に固有のコンテンツ (たとえば、 マッピング・ファイルや BROKER SCHEMA ステートメントなど) を組み込まないようにする必要があります。 この値を設定している状態で、 バージョン 5.0 のランタイム ESQL コードが含まれているメッセージ・フローの bar ファイルを展開すると、 展開は失敗します。

    この設定を 5.0 から 2.1 へ、あるいは 2.1 から 5.0 へ変更する場合は、 ワークスペース内のすべてのメッセージ・フロー・プロジェクトの再構築が必要になります。 この再構築を行ないませんと、 これらのメッセージ・フローを 1 つ以上含む bar ファイルの展開時にエラーが発生することがあります。

  • エディターの設定 (エディター・ビューにおけるコード表示の様式):
    • テキスト・フォント
    • 表示されるタブの幅 (デフォルト 4)
    • 背景色および前景色 (コメント、ステートメントなど)
  • 妥当性検査の設定 (ファイル保管時に実行する妥当性検査のレベル):

    妥当性検査では、4 つの潜在的な問題を検出することができます。

    未解決の ID
    バリデーターは、参照した任意の ID の解決を試行します (例: メッセージ・フィールド)。
    メッセージ参照とメッセージ定義の不一致
    メッセージ定義が存在する場合 (MRM ドメイン内のメッセージのみ)、バリデーターは、参照の使用がその定義と整合しているかどうか (たとえば、数値フィールドに対するアクションは有効な数値アクション) をチェックします。
    データベース参照とデータベース・スキーマの不一致
    バリデーターは、参照の使用がデータベース・スキーマと整合しているかどうか (たとえば、数値フィールドに対するアクションは有効な数値アクション) をチェックします。
    推奨されないキーワードの使用
    バリデーターは、このリリースで推奨されないキーワードを使用していないかチェックします。

    上にあげたそれぞれの状態について、 以下のいずれかの妥当性検査の設定を適用してください。

    Ignore
    妥当性検査は実行されません。
    Warning
    バリデーターは、検出したそれぞれの潜在的な問題について、 「タスク (Tasks)」ビューに警告メッセージを書き込みます。 これはデフォルト設定です。
    Error
    バリデーターは、検出したそれぞれの潜在的な問題について、 「タスク (Tasks)」ビューにエラー・メッセージを書き込みます。

    妥当性検査では、指定した名前の大文字小文字が、宣言の入力どおりかどうかのチェックは行われません。 モジュール、関数、およびプロシージャーの名前には大文字小文字の区別はありませんが、それ以外の名前 (スキーマ、定数、変数、ラベル) には大文字小文字の区別があります。 使用している名前の大文字小文字が宣言どおりになっているかどうかをチェックしてください。 これはブローカーがこれらの名前に関して大文字と小文字を区別して扱うため、使用されている名前と宣言されている名前との間に大文字小文字の違いがあると、ランタイム・エラーが発生するからです。

これらの設定を変更する方法については、 ESQL 設定の変更 を参照してください。

ESQL エディター・ツールバー

ESQL エディターのツールバーには、 追加のアイコンおよびアクションは存在しません。

関連タスク
ESQL の開発
ESQL 設定の変更

関連資料
ESQL のステートメント
ESQL の関数
「ブローカー・アプリケーション開発 (Broker Application Development)」パースペクティブ
エディターのプリファレンスおよびローカライズ設定