Caché SQL ゲートウェイの使用法

Caché SQL ゲートウェイのアーキテクチャ

Caché SQL ゲートウェイは、内部的には以下のコンポーネントを使用しています。

• 接続マネージャは、Caché の論理接続定義のリストを管理します。各定義には Caché で使用する論理名、および ODBC または JDBC 準拠の特定の外部データベースに関する接続の詳細が含まれています。Caché SQL ゲートウェイは、接続の確立時にこれらの論理名を使用します ("外部ソースへのゲートウェイ接続の作成" を参照)。

• Caché SQL ゲートウェイ API は、サードパーティの RDBMS と通信するために Caché プログラムで使用される一連の関数です。これらの関数は、ODBC または JDBC 呼び出しを作成する共有ライブラリを使用して実装されます。

• 外部テーブル・クエリ・プロセッサは、外部テーブルを対象とするクエリを処理する Caché SQL クエリ・プロセッサの拡張機能です。

• SQL ディクショナリには、すべての定義済み SQL テーブルのリストが格納されます。任意のテーブルは、そのデータが外部の RDBMS に保存されたときに "外部" のものとしてマークされます。Caché SQL クエリ・プロセッサによって、SQL クエリ内で参照されたテーブルが外部のテーブルであることが検出されると、このプロセッサは、外部テーブル・クエリ・プロセッサを起動します。外部テーブル・クエリ・プロセッサでは、Caché 内に格納されているデータにアクセスする代わりに、Caché SQL ゲートウェイ API を呼び出すことによって、クエリ実行計画が生成されます。

外部ソースへのゲートウェイ接続の作成

Caché では、外部データ・ソースへの接続の論理名である、SQL ゲートウェイ接続定義のリストが管理されます。各接続定義は、論理名 (Caché 内で使用するため)、データ・ソースへの接続情報、および接続を確立するときに使用するユーザ名とパスワードで構成されます。これらの接続は、%Library.sys_SQLConnection テーブルに格納されます。このテーブルのデータをエクスポートして、別の Caché インスタンスにインポートできます。

ゲートウェイ接続の構成要素は、以下のとおりです。

• ゲートウェイ接続の論理名。この名前は、Caché SQL クエリなどで使用されます。

• データベースにアクセスするためのログイン資格情報 (オプション)。

• JDBC または ODBC ドライバを制御するための情報 (オプション)。

• ドライバ固有の接続の詳細 ：

  • JDBC 用 ： JDBC クライアント・ドライバの完全クラス名、ドライバ・クラス・パス (JDBC ドライバの特定時に検索する JAR ファイルのリスト)、および JDBC 接続 URL

  • ODBC 用 ： 通常の方法で定義された DSN (データ・ソース名) ("ODBC での Caché の使用法" の "ODBC データ・ソースとしての Caché の使用法 (Windows)" および "ODBC データ・ソースとしての Caché の使用法 (UNIX)" を参照)

    Note:

    Microsoft SQL Server DNS 構成を使用して、リンク・テーブル・ウィザードで使用される SQL ゲートウェイ接続を作成する場合は、[地域設定を使用] オプションを設定しないでください。このオプションは、データを処理するアプリケーションではなく、データを表示するアプリケーションのみを対象としています。

JDBC および ODBC の論理接続定義の作成の詳細は、以下を参照してください。

• "Caché SQL ゲートウェイの使用法" の "外部ソースへの JDBC SQL ゲートウェイ接続の作成"

• "Caché ODBC の使用法" の "外部ソースへの ODBC SQL ゲートウェイ接続の作成"

リンク・テーブル・ウィザード ： テーブルまたはビューへのリンク

管理ポータルには、ODBC 準拠または JDBC 準拠のデータベースの外部テーブルへのリンクに使用できるウィザードがあります。外部テーブルにリンクすると、以下の操作を実行できます。

• 外部のリレーショナル・データベースに保存されたデータへ、Caché アプリケーション内でオブジェクトや SQL クエリを使用してアクセスします。

• Caché の永続オブジェクトを外部リレーショナル・データベースに格納します。

例えば、Employee テーブルが、外部リレーショナル・データベースに保存されているとします。JDBC または ODBC 経由で SQL クエリを実行することによって外部データベースと通信する Employee クラスを作成することによって、このテーブルをオブジェクトとして Caché 内で使用できます。

Caché アプリケーションから見ると、Employee クラスは他の永続クラスと同じように動作します。インスタンスを開き、変更して、それを保存できます。SQL クエリを Employee クラスに対して発行する場合、このクラスは自動的に外部データベースに送信されます。

Caché SQL ゲートウェイの使用は、アプリケーション論理とは独立した関係です。最小限の処理でアプリケーション論理が変更されることなく外部データベースと組み込みの Caché データベースの間で切り替わるようにアプリケーションを変更することができます。

Caché SQL ゲートウェイを使用して、オブジェクトに永続性を提供するクラスは、使用性においては、ネイティブの永続性を使用して、Java、ActiveX、SQL、Web アクセスなどの Caché のすべての機能を使用できるクラスと同等です。

プロシージャへのリンク作成ウィザード ： ストアド・プロシージャへのリンク

管理ポータルには、ODBC 準拠または JDBC 準拠のデータベースで定義されたストアド・プロシージャへのリンクに使用できるウィザードがあります。プロシージャにリンクすると、メソッドおよびそのメソッドを含むクラスが生成されます。ストアド・プロシージャにリンクする場合、そのストアド・プロシージャが実行するものと同じ操作を実行するクラス・メソッドを作成します。このメソッドは、SqlProc キーワードでマークします。このクラス・メソッドは、新しいクラス内に生成されます。クラス名やパッケージ名などの情報を指定できます。このメソッドは、可変個数の引数を受け取ることはできません。既定のパラメータは許可されますが、ストアド・プロシージャのシグニチャは固定されています。

• 外部データベースへのゲートウェイ接続をまだ作成していない場合は、開始する前に作成してください ("外部ソースへのゲートウェイ接続の作成" を参照)。

• 管理ポータルで [システム・エクスプローラ] を選択し、[SQL] (システム, SQL) を選択します。ページ上部の [切り替え] オプションを使ってネームスペースを選択します。利用可能なネームスペースのリストが表示されます。

  ページ上部の [ウィザード] ドロップダウン・リストをクリックし、[プロシージャのリンク] を選択します。

• ウィザードの最初のページで、以下のように 1 つまたは複数のプロシージャを選択します。

  • [宛先のネームスペースを選択してください] — データのコピー先の Caché ネームスペースを選択します。

  • [スキーマ・フィルタ] — プロシージャを含むスキーマ (クラス・パッケージ) 名を指定します。ワイルドカードを使用して名前を指定し、複数のスキーマを返すことや、% を使用してすべてのスキーマを返すことができます。例えば、C% は、先頭文字が C であるネームスペース内のすべてのスキーマを返します。選択元となるスキーマの返されるリストが短くなることでロード速度が向上するため、このフィルタを使用することをお勧めします。

  • [プロシージャ・フィルタ] — リンク先となるプロシージャを指定します。ワイルドカードを使用して名前を指定し、複数のプロシージャを返すことや、% を使用してすべてのプロシージャを返すことができます。複数のプロシージャを選択できます。複数の項目を選択する場合、[次へ] をクリックすると、次の画面にパッケージ名の入力を求めるプロンプトが表示されます。クラスを格納するパッケージの名前を指定して、[完了] をクリックします。

  • [SQL ゲートウェイ接続を選択してください] — 使用する SQL ゲートウェイ接続を選択します。

• [次へ] をクリックします。

• 2 ページ目では、Caché で生成されたクラスに関する情報を指定します。

  • [新規パッケージ名] — クラスを含めるパッケージの名前を指定します。

  • [新規クラス名] — 生成するクラスの名前を指定します。

  • [新規プロシージャ名] — プロシージャの名前、具体的には、メソッドの SqlName キーワードを制御するプロシージャの名前を指定します。

  • [新規メソッド名] — 生成するメソッドの名前を指定します。

  • [メソッド名の説明] — オプションで、メソッドの説明を入力します。これは、クラス定義のコメントとして使用され、クラス・リファレンスに表示されます。

• [完了] ボタンをクリックします。[バックグラウンド・ジョブ] ページに、バックグラウンド・タスクのページへのリンクが表示されます。

• [閉じる] をクリックします。または、バックグラウンド・タスクのページを表示する特定のリンクをクリックします。いずれの場合も、ウィザードによって、処理を実行するバックグラウンド・タスクが開始されます。

ウィザードにより、Caché データベース内に新しいクラス定義が保存され、そのクラス定義がコンパイルされます。

ゲートウェイ接続の制御

場合によっては、外部テーブルまたはストアド・プロシージャをリンクするコードによって作成された接続の管理が必要になります (“リンク・テーブル・ウィザード” および “リンク・プロシージャ・ウィザード” を参照)。SQL ゲートウェイ接続は、%SYSTEM.SQLGatewayOpens in a new tab クラスによって管理できます。このクラスには、以下のようなメソッドがあります。

• DropAll()Opens in a new tab — 開いているすべての接続を中断し、SQL ゲートウェイ・ライブラリをアンロードします。

• DropConnection()Opens in a new tab — 指定された JDBC または ODBC 接続を切断します。

• TestConnection()Opens in a new tab — 前に定義した SQL ゲートウェイ接続をテストし (“外部ソースへのゲートウェイ接続の作成” を参照)、診断の出力を現在のデバイスに書き込みます。

• 接続の確立およびトランザクションの制御のためのさまざまなメソッド。全詳細は、%SYSTEM.SQLGatewayOpens in a new tab クラス・ドキュメントを参照してください。

これらのメソッドは、特別な $SYSTEM オブジェクトを使用して呼び出すことができます。例えば、以下のコマンドは、前に定義した "MyConnectionName" という名前の SQL ゲートウェイ接続を切断します。

   do $system.SQLGateway.DropConnection("MyConnectionName")

SQL ゲートウェイ接続名の大文字と小文字は区別されます。

データ移行ウィザード ： ODBC ソースからのデータの移行

管理ポータルには、外部テーブルまたは外部ビューからのデータの移行に使用できるウィザードがあります。

外部ソースのテーブルまたはビューからデータを移行する場合、そのテーブルまたはビューのデータを格納する永続クラスが生成され、データがコピーされます。このウィザードには、クラスの名前が移行元のテーブルまたはビューの名前と同じであり、同様にプロパティ名もテーブルやビューのものと同じであるという前提があります。クラスが生成されると、そのクラスには、外部データ・ソースとの接続はありません。

• 外部データベースへの SQL ゲートウェイ接続をまだ作成していない場合は、開始する前に作成してください ("外部ソースへのゲートウェイ接続の作成" を参照)。

• 管理ポータルで [システム・エクスプローラ] を選択し、[SQL] (システム, SQL) を選択します。ページ上部の [切り替え] オプションを使ってネームスペースを選択します。利用可能なネームスペースのリストが表示されます。

  ページ上部の [ウィザード] ドロップダウン・リストをクリックし、[データ移行] を選択します。

• ウィザードの最初のページで、以下のようにテーブルまたはビューを選択します。

  • [宛先のネームスペースを選択してください] — データのコピー先の Caché ネームスペースを選択します。

  • [スキーマ・フィルタ] — テーブルまたはビューを含むスキーマ (クラス・パッケージ) 名を指定します。ワイルドカードを使用して名前を指定し、複数のスキーマを返すことや、% を使用してすべてのスキーマを返すことができます。例えば、C% は、先頭文字が C であるネームスペース内のすべてのスキーマを返します。選択元となるスキーマの返されるリストが短くなることでロード速度が向上するため、このフィルタを使用することをお勧めします。

  • [テーブル・フィルタ] — テーブルまたはビューの名前を指定します。ワイルドカードを使用して名前を指定し、複数のテーブルまたはビューを返すことや、% を使用してすべてのテーブル/ビューを返すことができます。

  • [テーブルタイプ] — [テーブル]、[ビュー]、[システムテーブル]、または [すべて] を選択します。既定は [テーブル] です。

  • [SQL ゲートウェイ接続を選択してください] — 使用する SQL ゲートウェイ接続を選択します。

• [次へ] をクリックします。

• 次のページでは、必要に応じて、クラスごとに以下の情報を指定することができます。

  • [新規スキーマ] — クラスを含むパッケージを指定します。長さ制限も含め、ObjectScript 識別子のルールに従う必要があります ("Caché オブジェクトの使用法" の "名前付け規約" のセクションを参照)。

    Tip:

    すべてのクラスのパッケージ名を変更するには、この列の一番上に値を入力し、[すべて変更] をクリックします。

  • [定義をコピーする] — 外部ソースのテーブル定義に基づいてこのクラスを生成する場合は、このチェック・ボックスにチェックを付けます。クラスが既に生成されている場合は、このチェック・ボックスのチェックを外すことができます。

  • [データをコピーする] — 外部ソースからこのクラスのデータをコピーする場合は、このチェック・ボックスにチェックを付けます。データをコピーするときに、ウィザードによって、Caché クラスの既存データが上書きされます。

• [次へ] をクリックします。ウィザードに以下のオプション設定が表示されます。

  • [妥当性検証無効] — チェックを付けると、INSERT コマンドの restriction パラメータで %NOCHECK が指定されて、データがインポートされます。

  • [インポート・プロセスのジャーナリングを無効化] — チェックを付けると、データ移行 (システム規模ではない移行) の実行プロセスについてジャーナリングが無効化されます。これにより、移行を高速化できますが、システム障害で移行が中断された場合、移行されたデータが不確定の状態で残される可能性があります。ジャーナリングは、実行が成功したかどうかにかかわらず、実行終了時に再有効化されます。

  • [インデックスを延期] — チェックを付けると、データの挿入後にインデックスが構築されます。ウィザードはクラスの %SortBegin() メソッドをテーブルへのデータ挿入の前に呼び出します。これにより、インデックス・エントリが並べ替えのための一時的な場所に書き込まれます。すべての行が挿入された後でウィザードが %SortEnd() を呼び出すと、インデックス・エントリは実際のインデックス位置に書き込まれます。テーブルにユニーク・インデックスが定義されており、一意の制約に対する違反を移行時にすべて検出したい場合は、[インデックスを延期] を使用しないでください。[インデックスを延期] を使用すると、一意の制約に対する違反は検出されません。

  • [トリガ無効] — チェックを付けると、INSERT コマンドの restriction パラメータで %NOTRIGGER が指定されて、データがインポートされます。

  • [インポート前にテーブルの既存データを削除する] — チェックを付けると、既存のデータは新しいデータにマージされずに削除されます。

• [完了] ボタンをクリックします。新しいウィンドウが開き、[バックグラウンドジョブ] ページに、バックグラウンド・タスクのページへのリンクが表示されます。直ちにインポートを開始する場合は [閉じる] をクリックし、バックグラウンド・タスクのページを表示する場合は特定のリンクをクリックします。いずれの場合も、ウィザードによって、インポートはバックグラウンド・タスクとして開始されます。

• [データ移行ウィザード] ウィンドウで [完了] をクリックして、管理ポータルのホーム・ページに戻ります。