第 2 章 LCConnection クラス
この章では、LCConnection クラスのメソッドおよびプロパティについて説明します。
LCConnection クラスの概要
LCConnection クラスは、個々の Lotus Connector のインスタンスを表します。Connector 経由のデータコネクションごとにコネクションオブジェクトが必要です。これは、別の Connector へのコネクションの場合だけでなく、同じ Lotus Connector へのコネクションでも当てはまります。例えば、DB2® のあるテーブルから Oracle の別のテーブルへデータを転送するとします。この場合、DB2 と Oracle にそれぞれ 1 つずつ、合わせて 2 つの LCConnection オブジェクトを作成し、一方からデータを取り出してもう一方に挿入します。
LEI Scripted アクティビティの構文 - 4
IBM® Lotus Enterprise Integrator® (LEI) Scripted アクティビティ向けの Lotus Connector LotusScript® Extensions (LC LSX) スクリプトを記述するときには、Dim LCSession を名前付きのセッションとして指定する必要があります。これが、デフォルトのログ文書名となります。LCConnection も、既存の名前付き LEI コネクション文書として宣言する必要があります。
LCConnection のプロパティ
すべてのコネクションでは、割り当て可能な値や取得可能な値を、プロパティを使用して設定できます。すべてのプロパティは、整数値 (プロパティトークン) と名前の両方で表されます。プロパティトークンにはすべての Connector に共通なものと、Connector 固有のものがあります。
Connector に共通のプロパティ
以下は、すべての Lotus Connector に共通の定義済みプロパティの一覧です。これらの定義済みプロパティは、LCConnection.GetProperty メソッドと LCConnection.SetProperty メソッドで使用します。各メソッドに関する説明の他に、「LCConnection クラスのメソッドの要約」にある「その他」も参照してください。
LCConnection クラスのメソッドの要約
以下は、LCConnection クラスの各メソッドの要約です。
LCConnection の New メソッド
LCConnection クラスのオブジェクト用のコンストラクタです。
LCConnection の Action メソッド
このメソッドは actionType パラメータに定義されたアクションを実行します。サポートされないアクションもあります。サポートされていないアクション型を使用すると、LCFAIL_UNAVAILABLE エラーが生成されます。
LCConnection の Call メソッド
このメソッドはストアドプロシージャを呼び出して、場合によっては結果セットを作成します。
LCConnection の Catalog メソッド
このメソッドはコネクション経由で使用可能なデータソース、メタデータオブジェクト、ストアドプロシージャ、およびフィールドについての情報を返します。Connector によっては、すべてのオブジェクト型をサポートしないものもあります。
LCConnection の Connect メソッド
このメソッドは Connector へのコネクションを確立します。1 つの Connector に複数のコネクションを別々に確立できます。
LCConnection の Copy メソッド
このメソッドは既存のコネクションのコピーを作成します。コピーにはプロパティ値もすべて含まれます。プロパティはすべてコピーされますが、コネクションの現在の状態および結果セットはコピーされません。
LCConnection の Create メソッド
このメソッドはメタデータオブジェクトを作成します。Connector ごとにサポートされるオブジェクト型が決まっています。Connector でどのオブジェクト型がサポートされるかについては、該当する Connector のドキュメントを参照してください。
LCConnection の Disconnect メソッド
このメソッドはデータソースから切断します。既存の結果セットはすべて消去されます。例えば、Connect メソッドで確立された DB2 へのコネクションがこのメソッドで終了されます。再コネクションの可能性があるため、終了されるのはコネクションと状態のみです。
LCConnection の Drop メソッド
このメソッドは指定されたメタデータオブジェクト (データベース、テーブル、索引またはビュー) を削除します。オブジェクトは単にローカルメモリから削除されるだけでなく、破棄されて復元できなくなります。使用に際しては注意が必要です。
LCConnection の Execute メソッド
このメソッドは Connector 固有の構文を使用したステートメントを実行します。例えばリレーショナルデータベース用 Connector では SQL ステートメントを使用します。このメソッドは、例えば結果セットを作成するために DB2 SQL ステートメントを実行します。
LCConnection の Fetch メソッド
このメソッドは、結果セットから次のレコードのグループを取得します。コネクションにアクティブな結果セットがないと、このメソッドは実行できません。
LCConnection の GetProperty メソッド
このメソッドは、コネクションのプロパティの現在値のコピーを取得します。動的プロパティを使用すると効率が良くなります。例えば、PropertyToken パラメータに指定された Lotus Connector for DB2 プロパティの値を、DestField パラメータに指定されたフィールドに返します。DB2 の場合、Pasword を除くすべてのプロパティがサポートされます。
GetProperty<Type> メソッド
このメソッドは、Connector のプロパティ値を特定のデータ型で返します。サポートされるデータ型は、Boolean、Currency、Datetime、Float、Int、Numeric、および Text です。
LCConnection の Insert メソッド
このメソッドは、コネクションメタデータに指定された数のレコードを挿入します。例えば、DB2 の定義された METADATA オブジェクトに 1 つ以上のレコードを挿入します。
LCConnection の ListProperty メソッド
このメソッドは、Connector でサポートされるプロパティのうち、最初のプロパティまたは次のプロパティの情報を取得します。
LCConnection の LookupProperty メソッド
このメソッドは、Connector が指定されたプロパティをサポートしているかどうかを判断します。
LCConnection の Remove メソッド
このメソッドは、ライトバックの結果セットからの削除または外部システムのレコードに対するキー削除のいずれかを実行します。
LCConnection の Select メソッド
このメソッドは、現在の METADATA プロパティおよびその他のプロパティから結果セットを作成します。
LCConnection の SetProperty メソッド
このメソッドは、コネクションのプロパティに値を割り当てます。
LCConnection の SetProperty<Type> メソッド
このメソッドは、コネクションのプロパティ値を特定のデータ型で割り当てます。サポートされるデータ型は、Boolean、Currency、Datetime、Float、Int、Numeric、および Text です。
LCConnection の Update メソッド
このメソッドは、コネクションメタデータ内の選択されたレコードを更新します。
親トピック:
LSX for Lotus Connectors