FireDAC.Comp.Client.TFDCustomConnection.GetTableNames

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

procedure GetTableNames(const ACatalogName, ASchemaName, APattern: string;  AList: TStrings; AScopes: TFDPhysObjectScopes = [osMy]; AKinds: TFDPhysTableKinds = [tkSynonym, tkTable, tkView]; AFullName: Boolean = True);

C++

void __fastcall GetTableNames(const System::UnicodeString ACatalogName, const System::UnicodeString ASchemaName, const System::UnicodeString APattern, System::Classes::TStrings* AList, Firedac::Phys::Intf::TFDPhysObjectScopes AScopes = (Firedac::Phys::Intf::TFDPhysObjectScopes() << Firedac::Phys::Intf::TFDPhysObjectScope::osMy ), Firedac::Phys::Intf::TFDPhysTableKinds AKinds = (Firedac::Phys::Intf::TFDPhysTableKinds() << Firedac::Phys::Intf::TFDPhysTableKind::tkSynonym << Firedac::Phys::Intf::TFDPhysTableKind::tkTable << Firedac::Phys::Intf::TFDPhysTableKind::tkView ), bool AFullName = true);

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomConnection

説明

DB 内のテーブルの名前を文字列リストに追加します。


GetTableNames を呼び出すと、DB 内のテーブルのリストを取得することができます。

ACatalogName、ASchemaName で、テーブル名を取得するカタログとスキーマを制限します。

APattern は、テーブル名をフィルタリングするための LIKE パターンです。

AList は、テーブル名を受け取る TStrings の下位オブジェクトです。GetTableNames では、リストに文字列が既に含まれている場合にはそれを削除してから、DB 内のすべてのテーブルの名前を追加します。

AScopes では、テーブル名を取得する範囲を指定のスコープに制限します。

AKinds では、取得するテーブル名を指定のオブジェクトの種類のテーブルに制限します。

テーブル名は、必要であれば正規化されます(引用符で囲まれます)。そうでなければ、ディクショナリのデフォルトの大文字/小文字設定に合わせて変換されます。接続定義で MetaDefSchema/MetaDefCatalog パラメータを指定すると、そのスキーマ名やカタログ名がテーブル名に含まれなくなります。

 FDConnection1.GetTableNames('NORTHWIND', 'DBO', 'ADQA%', '', ListBox1.Items,
   [osMy, osSystem, osOther], [tkTable, tkView]);

関連項目