SQL スクリプト制御コマンド（FireDAC）
目次
説明
| コマンド | 説明 |
|---|---|
| (@ | @@ | START | INput) <スクリプト> [<引数>] | 指定されたスクリプトの実行を開始します。'@@' の場合は、親スクリプト パスからの相対的なファイル名を持つスクリプトが実行されます。<引数> は値をコンマで区切ったリストです。これが指定されない場合は、親の引数が継承されます。 |
| ACCept <変数> (NUMber|CHAR|DATE) [FORmat <形式>] [DEFault <デフォルト値>] [PROmpt '<プロンプト>' | NOPRompt] [HIDE] | パラメータ値を入力するようにユーザーに求めます。NUMber|CHAR|DATE -- 値の型（省略可能）。FORmat <形式> -- DATE 値の解析に使用される Delphi 形式の文字列。DEFault <デフォルト値> -- デフォルト値（ユーザーの入力が空文字列の場合）。PROmpt '<プロンプト>' | NOPRompt -- コンソールに出力するプロンプト。 |
| CONnect <FireDAC 接続文字列> | 指定された DBMS に接続します（OpenConnection）。 |
| COPY FROM (FILE '<ファイル>' | SQL '<SQL>' [CONnect '<接続>']) TO (FILE '<ファイル>' | TABle '<テーブル名>' [CONnect '<接続>']) [TRUNCate | CLEar | ALWAYSinsert | APPend | UPDate | APPENDUPDate | DELete] [LOG (OFF | (SPOol|OUTput) | ([APPend] <ログ ファイル名>)] [USING (FILE '<構成ファイル>' | PARAMS '<定義>')] | データベース間またはテキスト ファイル間でデータを移動します。詳細は以下のとおりです。
|
| DEFine [<名前> | <名前>=<値>] | DEFINE のみ（名前がない） -- すべてのマクロを出力します。DEFINE <名前> -- 指定されたマクロを出力します。DEFINE <名前>=<値> -- 指定されたマクロ値を設定します。 |
| DELIMiter <テキスト> | スクリプトのコマンド区切り記号 ScriptOptions.CommandSeparator を設定します。 |
| DISconnect | CloseConnection を使って DBMS との接続を解除します。 |
| (EXECute | CALL) <手続き> | 指定されたストアド プロシージャを実行します。 |
| EXIT | スクリプトの実行を停止し、変更内容をコミットします。 |
| QUIT | スクリプトの実行を停止し、変更内容をロールバックします。 |
| STOP | スクリプトの実行を停止します。 |
| HELP | 登録されているすべてのコマンドのヘルプを表示します。 |
| (HOst | !! | SHELL) <コマンド> | ホストのシェル コマンドを実行します。Windows の場合は、ShellExecute('open', ACommand) 呼び出しが使用されます。 |
| PAUse <プロンプト> | 指定されたプロンプトを出力し、スクリプトの実行を一時停止します。 |
| PROmpt <プロンプト> | 指定されたテキストを出力します。 |
| PRInt <変数 1> [..., <変数 N>] | 指定されたパラメータの値を出力します。 |
| REMark <テキスト> | スクリプトにコメントを追加します。 |
| SET ARRAY <値> | 行セット サイズ FetchOptions.RowsetSize を指定します。 |
| SET AUTOcommit OFF|ON|<値> | 自動コミット モードをオフまたはオンに設定します。あるいは、N 個の各コマンドをコミットするように設定します（ScriptOptions.CommitEachNCommands）。 |
| SET AUTOPrint OFF|ON | コマンドの実行後にパラメータ値を表示します（ScriptOptions.AutoPrintParams）。 |
| SET BREAK OFF|ON | エラーの発生時にスクリプトの実行を停止します（ScriptOptions.BreakOnError）。 |
| SET (CMDSeparator | TERMinator) <値> | コマンド区切り記号を指定します（ScriptOptions.CommandSeparator）。TERM は IB/FB 専用です。 |
| SET (DEFine | SCAN) OFF|ON | マクロ展開を制御します（ScriptOptions.MacroExpand）。 |
| SET DROPnonexistent ON|OFF | 存在しないオブジェクトを削除できるようにします（ScriptOptions.DropNonexistObj）。 |
| SET ECHO OFF|(ON [SQL|ALL] [TRIM 50|<値>]) | コマンドの実行前にコマンド テキストを出力します（ScriptOptions.EchoCommands）。その際に、オプションでテキストがトリミングされます（EchoCommandTrim）。 |
| SET ENCoding ANSI | UTF8 | UTF16 | SQL スクリプト ファイルおよびログ ファイルのエンコーディングを設定します（ScriptOptions.FileEncoding）。 |
| SET (FEEDback|COUNT) 6|<値>|OFF|ON | コマンドの実行後にフィードバックを出力します（ScriptOptions.FeedbackCommands）。 |
| SET HEAding OFF|ON | 結果セットの列名を出力します（ScriptOptions.ColumnHeadings）。 |
| SET LINESize 0|<値> | 行の幅を設定します（ScriptOptions.LineSize）。 |
| SET LONG 80|<値> | 文字列値または BLOB 値を最大で指定文字数分まで出力します（ScriptOptions.MaxStringWidth）。 |
| SET PAGESize 24|<値> | 結果セットを出力する際のページ長を設定します（ScriptOptions.PageSize）。 |
| SET PARAMARRAY 1|<値> | パラメータ配列のサイズを指定します（ScriptOptions.ParamArraySize、Params.ArraySize）。 |
| SET SERVEROUTPUT OFF|(ON [SIZE <値>]) | コマンドの実行後にサーバー出力を表示します（ResourceOptions.ServerOutput、ServerOutputSize）。 |
| SET (TERMout|CONsole) OFF|ON | コマンドの結果セット、パラメータ値、状態、エラーなどをコンソールに出力できるようにします（ScriptOptions.ConsoleOutput）。 |
| SET TIMing OFF|ON | コマンドの実行時間を出力します（ScriptOptions.Timing）。 |
| SET TRIMout OFF|ON | コンソール出力時に文字列からスペースをトリミングします（ScriptOptions.TrimConsole）。 |
| SET TRIMSpool ON|OFF | スプール出力時に文字列からスペースをトリミングします（ScriptOptions.TrimSpool）。 |
| SET VERify OFF|ON | SQL コマンドの実行前に、マクロ置換後のコマンドを出力します（ScriptOptions.Verify）。 |
| (SPOol | OUTput) [OFF|[APPend] <スプール名>] | 引数がない場合 -- スプール処理の状態を出力します。OFF が指定された場合 -- スプール処理を無効にします。<スプール名> が指定された場合 -- スプール処理を有効にし、SQLScripts コレクション内の指定された項目名、またはファイル名にリダイレクトします。 |
| UNDEFine <変数 1> [..., <変数 N>] | 指定されたマクロの定義を解除します。 |
| VARiable [<名前> (NUMber|CHAR|NCHAR [(<サイズ>)]] [TABle <サイズ>] [IN|OUT|INOUT] [=<値>] | 引数がない場合 -- パラメータ値をすべて出力します。<名前> が指定された場合 -- 指定されたデータ型、サイズ、方向を持つパラメータを定義します。
= <値> が指定された場合 -- パラメータに値を割り当てます。 |
| CREATE DATABASE <データベース ファイル名> [PAGE_SIZE <n>] [DEFAULT CHARACTER SET '<文字セット>'] [USER '<ユーザー>'] [PASSWORD '<パスワード>'] | Firebird 接続および InterBase 接続に使用して、データベースを作成します。 |
| DROP DATABASE | Firebird 接続および InterBase 接続に使用して、データベースを削除します。 |