FireDAC.Comp.Script.TFDScript.SQLScriptFileName

提供:RAD Studio API Documentation

Delphi

property SQLScriptFileName: String read FSQLScriptFileName write FSQLScriptFileName;

C++

__property System::UnicodeString SQLScriptFileName = {read=FSQLScriptFileName, write=FSQLScriptFileName};

プロパティ

種類 可視性 ソース ユニット 親
property published
FireDAC.Comp.Script.pas
FireDAC.Comp.Script.hpp
FireDAC.Comp.Script TFDScript

説明

SQL スクリプト ファイルの名前です。


SQLScriptFileName プロパティを使用して、実行する SQL スクリプト ファイルの名前を設定することができます。

この名前では、Macros コレクションのマクロや Arguments リストの引数を使用することができます。OS ファイル名に拡張子がない場合には、".SQL" が付加されます。パスがない場合には、DefaultScriptPath オプションが使われます。

SQL スクリプトの読み込みメカニズムは、OnGetText イベント ハンドラを使ってオーバーライドすることができます。その 1 つに、SQL スクリプトをファイルから読み込むのではなく EXE リソースから読み込むという方法があります。あるいは、SQLScript コレクションを使ってメモリから SQL スクリプトを送信することもできます。SQLScriptFileName の優先度は、SQLScript コレクションよりも上です。

ExecuteFile メソッドおよび ExecuteScript メソッドによって、既存の SQLScriptFileName の値がクリアされることに注意してください。

パスにはパス変数を含めることができます。

例

 FDScript1.Arguments.Clear;
 FDScript1.Arguments.Add('financial');
 FDScript1.ScriptOptions.DefaultScriptPath := 'c:\temp';
 FDScript1.SQLScriptFileName := 'create_&1_db';
 // a file name will be resolved into c:\temp\create_financial_db.sql
 FDScript1.ExecuteAll;

関連項目