Data.SqlExpr.TCustomSQLDataSet.CommandText
Delphi
property CommandText: string read FCommandText write SetCommandText;
C++
__property System::UnicodeString CommandText = {read=FCommandText, write=SetCommandText};
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| property | public | Data.SqlExpr.pas Data.SqlExpr.hpp |
Data.SqlExpr | TCustomSQLDataSet |
説明
データセットにより実行されるコマンドを指定します。
CommandText の値は、以下のように、CommandType プロパティによって異なります。
- CommandType が ctQuery の場合、CommandText は、データセットにより実行される SQL 文です。
- この SQL 文が SELECT 文の場合は、SQL データセットが開かれたとき、この SQL 文が実行されます。
- この SQL 文が結果セットを返さない場合は、ExecSQL メソッドが呼び出されたときに、この SQL 文が SQL データセットにより実行されます。
- CommandType が ctStoredProc の場合、CommandText はストアド プロシージャの名前です。
- このストアド プロシージャがレコード セットを返すかどうかに応じて、SQL データセットが開かれたときか ExecSQL メソッドが呼び出されたときに、このストアド プロシージャが SQL データセットにより実行されます。
- CommandType が ctTable の場合、CommandText はデータベース サーバー上のテーブルの名前です。
- SQL データセットでは、このテーブル内のすべてのフィールドに関してすべてのレコードを取得し、SortFieldNames プロパティに列挙されているフィールドで並べ替える SELECT 文を自動的に生成します。
- 生成された SQL 文は、データセットが開かれたときに実行されます。
CommandText が、パラメータを含んだ SQL 文か、パラメータを持つストアド プロシージャの名前のどちらかである場合は、Params プロパティを使用すると、パラメータ値を指定できます。
CommandText プロパティの使用例については、「モバイル チュートリアル：dbExpress で InterBase ToGo を使用する（iOS および Android）」を参照してください。このチュートリアルでは、コマンド テキスト エディタを使用するのではなく文字列（クエリ）を入力することで CommandText プロパティに必要な情報を設定する例について説明しています。コマンド テキスト エディタは、［オブジェクト インスペクタ］で CommandText プロパティの値フィールドの参照（［...］）ボタンをダブルクリックして開くことができます。