FireDAC.Comp.Client.TFDCommand.CommandText
Delphi
property CommandText;
C++
__property CommandText;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
property | published | FireDAC.Comp.Client.pas FireDAC.Comp.Client.hpp |
FireDAC.Comp.Client | TFDCommand |
説明
実行する SQL コマンドのテキストです。
FireDAC.Comp.Client.TFDCommand.CommandText は FireDAC.Comp.Client.TFDCustomCommand.CommandText を継承しています。以下の内容はすべて FireDAC.Comp.Client.TFDCustomCommand.CommandText を参照しています。
実行する SQL コマンドのテキストです。
CommandText で以下を設定/取得することができます。
- 実行する SQL コマンドのテキスト。
- CommandKind が
[skStoredProc, skStoredProcWithCrs, skStoredProcNoCrs]
のいずれかの場合には、実行するストアド プロシージャの名前。
CommandText を設定した後、ストアド プロシージャ以外の場合には FireDAC は以下のアクションを実行します。
- ResourceOptions.ParamCreate が True であれば、パラメータの名前を取り出して Params コレクションに追加します。
- ResourceOptions.MacroCreate が True であれば、マクロ名を取り出して Macros コレクションに追加します。
- ResourceOptions.PreprocessCmdText が True であれば、
SELECT
コマンドのFROM
テーブルの名前を取り出して CommandIntf.SourceObjectName に代入します。 - 明示的に設定されていなければ、CommandKind プロパティの値を設定します。
CommandText.Add メソッドを使って長いコマンドを追加する場合には、コマンドを変更する前に CommandText.BeginUpdate を、コマンドの変更が終了した後に CommandText.EndUpdate を呼び出すことをお勧めします。
その後 Prepare が呼び出されると、コマンド テキストはプリプロセスされ、対象の DBMS のコマンドに変換されます。FireDAC マクロおよびエスケープ シーケンスとプリプロセッサ命令についての詳細は、「コマンド テキストのプリプロセス」を参照してください。
関連項目
- コマンド テキストのプリプロセス
- コマンドの実行
- FireDAC.Stan.Option.TFDResourceOptions.ParamCreate
- FireDAC.Stan.Option.TFDResourceOptions.MacroCreate
- FireDAC.Stan.Option.TFDResourceOptions.PreprocessCmdText
- FireDAC.Comp.Client.TFDCustomCommand.CommandKind
- FireDAC.Comp.Client.TFDCustomCommand.Params
- FireDAC.Comp.Client.TFDCustomCommand.Macros
- FireDAC.Comp.Client.TFDCustomCommand.ResourceOptions