IBX.IBExtract.TIBExtract.ExtractObject
Delphi
procedure ExtractObject(ObjectType : TExtractObjectType; ObjectName : String = ''; {do not localize}
ExtractTypes : TExtractTypes = []);
C++
void __fastcall ExtractObject(TExtractObjectType ObjectType, System::UnicodeString ObjectName = System::UnicodeString(), TExtractTypes ExtractTypes = TExtractTypes() );
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
public | IBX.IBExtract.pas IBX.IBExtract.hpp |
IBX.IBExtract | TIBExtract |
説明
InterBase サーバーから指定されたメタデータを取り出して，Items プロパティに書き込みます。
ExtractObject メソッドを呼び出すと，Database プロパティによって指定されたデータベースからメタデータを取り出して，Items プロパティに書き込むことができます。
ObjectType は，目的のメタデータの種類を示します。その意味は，ObjectName および ExtractTypes パラメータにより，次の表のように変更されます。
| 値 | 意味 |
|---|---|
|
eoDatabase |
データベース上で定義されるオブジェクトをすべてリストします。これは，ObjectName および ExtractTypes パラメータによって指定される制限なしに，ほかの各オブジェクトタイプに対して順に ExtractObject メソッド（および，サポートされる create database コマンド）を呼び出したときに取り出されるリストです。 |
|
eoDomain |
すべてのドメインをリストします。ExtractTypes パラメータが etTable を含んでいる場合，このリストには ObjectName パラメータによって指定されるテーブルのドメインだけが含まれます。 |
|
eoTable |
ObjectName パラメータが空の文字列である場合，サーバー上に定義されたテーブルをすべてリストします。ObjectName パラメータが空でない場合は，ObjectName パラメータで指定されたテーブルのすべての列と型，および ExtractTypes パラメータによって指定されたそのテーブル関連の情報をリストします。その情報には，ドメイン（etDomain），インデックス（etIndex），外部キー制約（etForeign），チェック制約（etCheck），トリガ（Trigger），ユーザー権限（etGrant），およびデータ（etData）などが含まれます。 |
|
eoView |
ObjectName パラメータが空の文字列である場合，すべてのビューのテキストをリストします。そうでない場合は，ObjectName パラメータで指定されたビューのテキストをリストします。 |
|
eoProcedure |
ObjectName パラメータが空の文字列である場合，すべてのストアドプロシージャをリストします。そうでない場合は，ObjectName パラメータによって指定されたストアドプロシージャのテキストをリストします。プロシージャ間で相互参照が行われる場面に対処するために，ExtractObject メソッドは正しい名前のダミーのプロシージャを作成し，それぞれを正しい形式に変更します。ExtractTypes パラメータに etAlterProc が含まれている場合，正しく変更された形式だけが取り出されます。 |
|
eoFunction |
すべての外部関数をリストします。ObjectName パラメータが空でない場合，リストには指定された名前と一致する関数だけが含まれるようにフィルタリングされます。 |
|
eoGenerator |
すべての非システムジェネレータをリストします。ObjectName パラメータが空でない場合，リストには指定された名前と一致するジェネレータだけが含まれるようにフィルタリングされます。 |
|
eoException |
データベースが定義する例外をすべてリストします。ObjectName パラメータが空でない場合，リストには指定された名前と一致する例外だけが含まれるようにフィルタリングされます。 |
|
eoBLOBFilter |
すべての BLOB フィルタをリストします。ObjectName パラメータが空でない場合，リストには関数名が指定された名前と一致するフィルタだけが含まれるようにフィルタリングされます。 |
|
eoRole |
すべてのロールをリストします。ObjectName パラメータが空でない場合，リストには指定された文字列と一致する名前のロールだけが含まれるようにフィルタリングされます。 |
|
eoTrigger |
ExtractTypes パラメータが etTable を含んでいる場合，ObjectName パラメータによって指定されたテーブルの定義済みトリガをすべてリストします。そうでない場合は，すべてのトリガをリストするか，または ObjectName パラメータが空でなければ，ObjectName パラメータによって指定された文字列と一致するトリガをすべてリストします。 |
|
eoForeign |
ExtractTypes パラメータが etTable を含んでいる場合，ObjectName パラメータによって指定されたテーブルに関連する外部キー制約をすべてリストします。そうでない場合は，すべての外部キー制約をリストするか，または，ObjectName パラメータが空でなければ，ObjectName パラメータと一致する名前を持つ外部キー制約をすべてリストします。 |
|
eoIndexes |
ExtractTypes パラメータが etTable を含んでいる場合，ObjectName パラメータによって指定されたテーブルの定義済みインデックスをすべてリストします。そうでない場合は，ObjectName パラメータが空でなければ，ObjectName パラメータと一致する名前を持つインデックスをすべてリストします。 |
|
eoChecks |
ExtractTypes パラメータが etTable を含んでいる場合，ObjectName パラメータによって指定されたテーブル上の非外部チェック制約をすべてリストします。そうでない場合は，ObjectName パラメータが空でなければ，ObjectName パラメータと一致する名前を持つチェック制約をすべてリストします。 |
|
eoData |
ObjectName パラメータによって指定されたオブジェクトのデータをすべてリストします。 |
ObjectName パラメータは，情報を取得するオブジェクト（テーブルやストアドプロシージャなど）の名前を指定します。このオブジェクトのタイプと，取り出された情報を制限する方法は，ObjectType および ExtractTypes によって異なります。
ExtractTypes パラメータは ObjectType の解釈を変更し，取り出された情報の種類をフィルタリングします。