dtexec ユーティリティ

  • [アーティクル]

適用対象: SQL Server Azure Data Factory の SSIS 統合ランタイム

dtexec コマンド プロンプト ユーティリティは、SQL Server Integration Services パッケージの構成と実行に使用します。 dtexec ユーティリティを使用すると、パラメーター、接続、プロパティ、変数、ログ記録、進行状況インジケーターなど、パッケージの構成と実行に関するすべての機能にアクセスできます。 また dtexec ユーティリティでは、さまざまな変換元 (Integration Services サーバー、.ispac プロジェクト ファイル、Microsoft SQL Server データベース、SSIS パッケージ ストア、およびファイル システム) からパッケージを読み込むことができます。

注意

最新バージョンの dtexec ユーティリティを使用して旧バージョンの Integration Services で作成したパッケージを実行すると、パッケージは一時的に最新のパッケージ形式にアップグレードされます。 ただし、アップグレードされたパッケージを dtexec ユーティリティで保存することはできません。 パッケージを最新バージョンに永続的にアップグレードする方法については、「 Upgrade Integration Services Packages」を参照してください。

このトピックのセクションは次のとおりです。

Integration Services サーバーとプロジェクト ファイル

dtexec を使用して Integration Services サーバーでパッケージを実行すると、dtexec は catalog.create_execution (SSISDB データベース)、catalog.set_execution_parameter_value (SSISDB データベース)、catalog.start_execution (SSISDB データベース) の各ストアド プロシジャを呼び出すことにより、実行を作成し、パラメーター値を設定して、実行を開始します。 すべての実行ログは、関連するビューでサーバーから確認できます。また、 SQL Server Management Studioで利用可能な標準レポートを使用して確認することもできます。 レポートの詳細については、「 Integration Services サーバーのレポート」を参照してください。

Integration Services サーバーでのパッケージの実行例を次に示します。

DTExec /ISSERVER "\SSISDB\folderB\Integration Services Project17\Package.dtsx" /SERVER "." /Envreference 2 /Par "$Project::ProjectParameter(Int32)";1 /Par "Parameter(Int32)";21 /Par "CM.sqlcldb2.SSIS_repro.InitialCatalog";ssisdb /Par "$ServerOption::SYNCHRONIZED(Boolean)";True

dtexec を使用して .ispac プロジェクト ファイルからパッケージを実行する場合の関連オプションは、/Proj[ect] と /Pack[age] です。これらは、プロジェクトのパスとパッケージのストリーム名を指定するために使用されます。 から Integration Services プロジェクト変換ウィザード SQL Server Management Studioを実行してプロジェクトをプロジェクト配置モデルに変換する場合、ウィザードは .ispac プロジェクト ファイルを生成します。 詳細については、「Integration Services (SSIS) プロジェクトとパッケージの配置」を参照してください。

dtexec とサードパーティのスケジューリング ツールを使用して、 Integration Services サーバーに配置されているパッケージのスケジュールを設定できます。

64 ビット コンピューターでのインストールに関する注意点

64 ビット コンピューターには、 Integration Services によって 64 ビット版の dtexec ユーティリティ (dtexec.exe) がインストールされます。 特定のパッケージを 32 ビット モードで実行する必要がある場合は、32 ビット版の dtexec ユーティリティをインストールする必要があります。 32 ビット版の dtexec ユーティリティをインストールするには、セットアップ中に [クライアント ツール] または [ SQL Server Data Tools (SSDT) ] を選択する必要があります。

既定では、64 ビットと 32 ビットの両方のバージョンの Integration Services コマンド プロンプト ユーティリティがインストールされている 64 ビット コンピューターでは、コマンド プロンプトで 32 ビット バージョンが実行されます。 これは、PATH 環境変数で、32 ビット バージョンのディレクトリ パスが 64 ビット バージョンのディレクトリ パスより前に配置されているためです (通常、32 ビットのディレクトリ パスは <ドライブ>:\Program Files(x86)\Microsoft SQL Server\110\DTS\Binn で、64 ビットのディレクトリ パスは <ドライブ>:\Program Files\Microsoft SQL Server\110\DTS\Binn です)。

注意

SQL Server エージェントを使用してユーティリティを実行する場合は、SQL Server エージェントによって 64 ビット バージョンのユーティリティが自動的に使用されます。 SQL Server エージェントでは、PATH 環境変数ではなくレジストリを使用してユーティリティの適切な実行可能ファイルが特定されます。

コマンド プロンプトで 64 ビット バージョンのユーティリティが実行されるようにするには、次のいずれかの操作を実行します。

  • コマンド プロンプト ウィンドウを開いて、64 ビット バージョンのユーティリティが格納されたディレクトリ (<ドライブ>:\Program Files\Microsoft SQL Server\110\DTS\Binn) に移動し、その場所からユーティリティを実行します。

  • コマンド プロンプトで、64 ビット バージョンのユーティリティの完全なパス (<ドライブ>:\Program Files\Microsoft SQL Server\110\DTS\Binn) を入力してユーティリティを実行します。

  • PATH 環境変数で、64 ビットのパス (<ドライブ>:\Program Files\Microsoft SQL Server\110\DTS\Binn) を 32 ビットのパス (<ドライブ>:\ Program Files(x86)\Microsoft SQL Server\110\DTS\Binn) より前に配置してパスの順序を永続的に変更します。

サイド バイ サイド インストールを使用しているコンピューターに関する注意点

SQL Server 2019 Integration Services (SSIS) を、 SQL Server 2005 Integration Services (SSIS) または SQL Server 2008 Integration Services (SSIS) がインストールされているコンピューターにインストールすると、複数のバージョンの dtexec ユーティリティがインストールされます。

正しいバージョンのユーティリティを実行していることを確認するには、コマンド プロンプトで完全なパス (<ドライブ>:\Program Files\Microsoft SQL Server<バージョン>\DTS\Binn) を入力してユーティリティを実行します。

実行のフェーズ

このユーティリティの実行には、4 つのフェーズがあります。 それらのフェーズを次に示します。

  1. コマンド初期フェーズ:コマンド プロンプトによって、指定されたオプションおよび引数のリストが読み取られます。 /? オプションまたは /HELP オプションが指定されている場合、後続のフェーズはすべてスキップされます。

  2. パッケージ読み込みフェーズ: /SQL、 /FILE、または /DTS オプションによって指定されたパッケージが読み込まれます。

  3. 構成フェーズ:オプションは次の順序で処理されます。

    • パッケージのフラグ、変数、およびプロパティを設定するオプション

    • パッケージのバージョン番号およびビルドを確認するオプション

    • レポートなど、ユーティリティの実行時の動作を構成するオプション

  4. 検証および実行フェーズ:パッケージを実行します。 /VALIDATE オプションが指定された場合は、実行せずに検証を実行します。

返される終了コード

dtexec ユーティリティから返される終了コード

パッケージの実行時、 dtexec は終了コードを返すことができます。 終了コードは、ERRORLEVEL 変数の値を設定する場合に使用されます。この変数の値は、バッチ ファイル内の条件ステートメントや分岐ロジックでテストできます。 次の表は、終了時に dtexec ユーティリティが設定できる値を示しています。

値 説明
0 パッケージが正常に実行されました。
1 パッケージが失敗しました。
3 パッケージはユーザーによって取り消されました。
4 ユーティリティは要求されたパッケージを見つけられません。 パッケージが見つかりませんでした。
5 ユーティリティは要求されたパッケージを読み込めません。 パッケージを読み込めませんでした。
6 ユーティリティは、コマンド ラインに構文の内部エラーまたはセマンティック エラーを検出しました。

構文規則

ユーティリティの構文規則

すべてのオプションは、スラッシュ (/) またはマイナス記号 (-) で始まる必要があります。 ここに示すオプションはスラッシュ (/) で始まりますが、マイナス記号 (-) を代わりに使用することもできます。

引数に空白文字を含めるには、引用符で囲む必要があります。 引数を引用符で囲まないと、空白文字を引数に含めることはできません。

引用符で囲まれた文字列内に二重引用符がある場合は、単一引用符がエスケープされていることを表します。

パスワードを除いて、オプションおよび引数では大文字と小文字が区別されません。

xp_cmdshell での dtexec の使用

xp_cmdshell での dtexec の使用

xp_cmdshell プロンプトから dtexec を実行できます。 次の例では、UpsertData.dtsx というパッケージを実行し、リターン コードを無視します。

EXEC xp_cmdshell 'dtexec /f "C:\UpsertData.dtsx"'

次の例では、同じパッケージを実行し、リターン コードを取得します。

DECLARE @returncode int  
EXEC @returncode = xp_cmdshell 'dtexec /f "C:\UpsertData.dtsx"'

重要

Microsoft SQL Server の新しいインストールでは、xp_cmdshell オプションは既定で無効になります。 オプションを有効にするには、 sp_configure システム ストアド プロシージャを実行します。 詳細については、「 xp_cmdshell サーバー構成オプション」を参照してください。

Bash からの dtexec の使用

Bash シェルは、Linux では一般的なシェルです。 Windows でも使用できます。 Bash プロンプトから dtexec を実行できます。 Bash ではセミコロン (;) がコマンド区切り演算子となることに注意してください。 これは特に、/Conn[ection]、/Par[arameter] または '/Set オプションを使用してパッケージに値を渡すときに重要です。セミコロンを使用して、名前と、指定された項目の値を区切るためです。 次の例では、Bash を使って値をパッケージに渡すときに、セミコロンとその他の項目を正しくエスケープする方法を示します。

dtexec /F MyPackage.dtsx /CONN "MyConnection"\;"\"MyConnectionString\""

構文

dtexec /option [value] [/option [value]]...

パラメーター

  • /? [option_name]:(省略可能)。 コマンド プロンプトのオプション、または指定された option_name のヘルプを表示して、ユーティリティを終了します。

    option_name 引数を指定すると、dtexec によって SQL Server オンライン ブックが起動され、「dtexec ユーティリティ」トピックが表示されます。

  • /Ca[llerInfo] :(省略可能)。 パッケージ実行の追加情報を指定します。 SQL Server エージェントを使用してパッケージを実行する場合、エージェントはこの引数を設定して、パッケージ実行が SQL Server エージェントによって呼び出されることを示します。 dtexec ユーティリティがコマンド ラインから実行される場合、このパラメーターは無視されます。

  • /CheckF[ile]filespec: (省略可能)。 パッケージの CheckpointFileName プロパティが、 filespecで指定されたパスおよびファイルに設定されます。 このファイルは、パッケージが再起動されたときに使用されます。 このオプションが指定されていて、ファイル名の値が指定されていない場合、パッケージの CheckpointFileName には空の文字列が設定されます。 このオプションが指定されない場合、パッケージの値は保持されます。

  • /CheckP[ointing] {on\off} : (省略可能)。 パッケージの実行時にパッケージがチェックポイントを使用するかどうかを決定する値を設定します。 値 on を指定すると、失敗したパッケージが再実行されます。 失敗したパッケージが再実行される場合、ランタイム エンジンは、障害点からパッケージを再起動するためにチェックポイント ファイルを使用します。

    オプションが値なしで宣言されている場合、既定値は on です。 値が on に設定されていて、チェックポイント ファイルが見つからない場合、パッケージの実行は失敗します。 このオプションが指定されない場合、パッケージの値セットは保持されます。 詳細については、「 Restart Packages by Using Checkpoints」を参照してください。

    dtexec の /CheckPointing on オプションを使用すると、パッケージの SaveCheckpoints プロパティを True に設定した場合、および CheckpointUsage プロパティを Always に設定した場合と同等の効果が得られます。

  • /Com[mandFile] filespec: (省略可能)。 dtexecで実行するコマンド オプションを指定します。 filespec で指定されたファイルが開き、ファイルに EOF が見つかるまでそのファイルからオプションを読み取ります。 filespec は、テキスト ファイルです。 filespec 引数には、パッケージの実行に関連付けるコマンド ファイルのファイル名とパスを指定します。

  • /Conf[igFile] filespec: (省略可能)。 値を抽出する構成ファイルを指定します。 このオプションを使用すると、パッケージのデザイン時に指定された構成と異なる実行時構成を設定できます。 パッケージを実行するには、XML 構成ファイルに異なる構成設定を格納してから、 /ConfigFile オプションを使用して設定を読み込む必要があります。

    /ConfigFile オプションを使用すると、デザイン時に指定しなかった追加の構成を実行時に読み込むことができますが、 /ConfigFile オプションを使用しても、デザイン時に指定した構成値を置き換えることはできません。 パッケージ構成が適用されるしくみについては、「 Package Configurations」を参照してください。

  • /Conn[ection] id_or_name;connection_string [[;id_or_name;connection_string]...]: (省略可能)。 指定した名前または GUID の接続マネージャーがパッケージ内にあり、接続文字列が指定されていることを示します。

    このオプションでは、接続マネージャーの名前または GUID を指定する id_or_name 引数と、有効な接続文字列を指定する connection_string 引数の両方のパラメーターが必須です。 詳細については、「Integration Services (SSIS) の接続」を参照してください。

    実行時に /Connection オプションを使用すると、デザイン時に指定した場所とは別の場所からパッケージ構成を読み込むことができます。 デザイン時に指定した値は、それらの構成の値で置き換えられます。 ただし、 /Connection オプションを使用できるのは、接続マネージャーを使用する構成 ( SQL Server 構成など) だけです。 パッケージ構成が適用されるしくみについては、「 Package Configurations 」 (パッケージ構成) および「 SQL Server 2016 における Integration Services 機能の動作の変更」を参照してください。

  • /Cons[oleLog] [[displayoptions];[list_options;src_name_or_guid]...]:(省略可能)。 パッケージの実行中に、指定されたログ エントリをコンソールに表示します。 このオプションを省略した場合、ログ エントリはコンソールに表示されません。 表示を制限するパラメーターなしでオプションが指定された場合、すべてのログ エントリが表示されます。 コンソールに表示されるエントリを制限するには、 displayoptions パラメーターを使用して表示する列を指定し、 list_options パラメーターを使用してログ エントリの種類を制限します。

    注意

    Integration Services サーバーで /ISSERVER パラメーターを使用してパッケージを実行すると、コンソールの出力が制限され、/Cons[oleLog] オプションのほとんどが適用されなくなります。 すべての実行ログは、関連するビューでサーバーから確認できます。また、 SQL Server Management Studioで利用可能な標準レポートを使用して確認することもできます。 レポートの詳細については、「 Integration Services サーバーのレポート」を参照してください。

    displayoptions の値は次のとおりです。

    • N (名前)

    • C (コンピューター)

    • O (オペレーター)

    • S (変換元の名前)

    • G (変換元の GUID)

    • X (実行 GUID)

    • M (メッセージ)

    • T (開始時刻および終了時刻)

    list_options の値は次のとおりです。

    • I - 包含一覧を指定します。 指定された変換元の名または変換元の GUID のみがログに記録されます。

    • E - 除外一覧を指定します。 指定された変換元の名前または変換元の GUID はログに記録されません。

    • src_name_or_guid パラメーターには、含めるまたは除外するイベント名、変換元の名前、変換元の GUID を指定します。

    同じコマンド プロンプトで複数の /ConsoleLog オプションを使用する場合、次のような相互作用があります。

    • 表示の順序には影響しません。

    • 包含一覧がコマンド ラインに指定されていない場合、すべての種類のログ エントリに対して除外一覧が適用されます。

    • 包含一覧がコマンド ラインに指定されている場合、すべての包含一覧の集合に対して除外一覧が適用されます。

    /ConsoleLog オプションの例については、「 解説 」を参照してください。

  • /D[ts] package_path: (省略可能)。 SSIS パッケージ ストアからパッケージを読み込みます。 SSIS パッケージ ストアに格納されているパッケージは、従来のパッケージ配置モデルを使用して配置されます。 プロジェクト配置モデルを使用して、Integration Services サーバーに配置されているパッケージを実行するには、 /ISServer オプションを使用します。 パッケージとプロジェクトの配置モデルの詳細については、「 Deployment of Projects and Packages」を参照してください。

    package_path 引数には、 SSIS パッケージの相対パスを指定します。このパスは SSIS パッケージ ストアのルートから始まり、 SSIS パッケージの名前を含むパスです。 package_path 引数に指定するパスまたはファイル名に空白文字を含める場合は、 package_path 引数を引用符で囲む必要があります。

    /DTS オプションは、 /File オプションまたは /SQL オプションと同時に使用できません。 複数のオプションが指定された場合、 dtexec は失敗します。

  • /De[crypt] password: (省略可能)。 パスワードが暗号化されているパッケージを読み込むときに使用する暗号化解除用パスワードを設定します。

  • (省略可)。パッケージの実行中に指定のイベントが 1 つ以上発生した場合に、デバッグ ダンプ ファイル (.mdmp および .tmp) を作成します。 error code 引数では、システムによるデバッグ ダンプ ファイル作成のトリガーとなるイベント コードの種類 (エラー、警告、または情報) が指定されます。 イベント コードを複数指定するには、各 error code 引数をセミコロン (;) で区切ります。 error code 引数に引用符を含めないでください。

    次の例では、DTS_E_CANNOTACQUIRECONNECTIONFROMCONNECTIONMANAGER のエラーが発生したときにデバッグ ダンプ ファイルが生成されます。

    /Dump 0xC020801C

    /Dump error code: Integration Services の既定では、デバッグ ダンプ ファイルは <<ドライブ>>:\Program Files\Microsoft SQL Server\110\Shared\ErrorDumps フォルダーに格納されます。

    Note

    デバッグ ダンプ ファイルには機密情報が含まれている場合があります。 アクセス制御リスト (ACL) を使用してファイルへのアクセスを制限するか、アクセスが制限されたフォルダーにファイルをコピーしてください。 たとえば、デバッグ ファイルを Microsoft サポート サービスに送信する前には、機密性の高い情報をすべて削除することをお勧めします。

    dtexec ユーティリティで実行するすべてのパッケージにこのオプションを適用するには、 DumpOnCodes REG_SZ 値をレジストリ キー HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\110\SSIS\Setup\DtsPath に追加します。 DumpOnCodes のデータ値では、システムによるデバッグ ダンプ ファイル作成のトリガーとなるエラー コードを指定します。 複数のエラー コードは、セミコロン (;) で区切る必要があります。

    DumpOnCodes 値をレジストリ キーに追加し、 /Dump オプションも使用した場合、両方の設定に基づくデバッグ ダンプ ファイルが作成されます。

    デバッグ ダンプ ファイルの詳細については、「 Generating Dump Files for Package Execution」を参照してください。

  • /DumpOnError:(省略可) パッケージの実行中にエラーが発生した場合に、デバッグ ダンプ ファイル (.mdmp および .tmp) を作成します。

    Integration Services の既定では、デバッグ ダンプ ファイルは <ドライブ>:\Program Files\Microsoft SQL Server\110\Shared\ErrorDumps フォルダーに格納されます。

    注意

    デバッグ ダンプ ファイルには機密情報が含まれている場合があります。 アクセス制御リスト (ACL) を使用してファイルへのアクセスを制限するか、アクセスが制限されたフォルダーにファイルをコピーしてください。 たとえば、デバッグ ファイルを Microsoft サポート サービスに送信する前には、機密性の高い情報をすべて削除することをお勧めします。

    dtexec ユーティリティで実行するすべてのパッケージにこのオプションを適用するには、 DumpOnError REG_DWORD 値をレジストリ キー HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\110\SSIS\Setup\DtsPath に追加します。 DumpOnError REG_DWORD の値によって、 dtexec ユーティリティで /DumpOnError オプションを使用する必要があるかどうかが決まります。

    • ゼロ以外のデータ値を指定すると、 dtexec ユーティリティで /DumpOnError オプションを使用するかどうかにかかわらず、エラーの発生時にデバッグ ダンプ ファイルが作成されます。

    • ゼロのデータ値を指定すると、 DumpOnError ユーティリティで dtexec ユーティリティをインストールする必要があります。

    デバッグ ダンプ ファイルの詳細については、「 Generating Dump Files for Package Execution」を参照してください。

  • /Env[Reference] environment reference ID: (省略可能)。 Integration Services サーバーに配置するパッケージ用に、パッケージ実行で使用される環境参照 (ID) を指定します。 このパラメーターを変数にバインドするように構成すると、環境に含まれる変数の値が使用されます。

    /Env[Reference] オプションは、 /ISServer オプションおよび /Server オプションと共に使用します。

    このパラメーターは SQL Server エージェントによって使用されます。
    -- /F[ile] filespec: (省略可能)。 ファイル システムに保存されているパッケージを読み込みます。 ファイル システムに保存されているパッケージは、従来のパッケージ配置モデルを使用して配置されます。 プロジェクト配置モデルを使用して、Integration Services サーバーに配置されているパッケージを実行するには、 /ISServer オプションを使用します。 パッケージとプロジェクトの配置モデルの詳細については、「 Deployment of Projects and Packages」を参照してください。

filespec 引数には、パッケージのパスとファイル名を指定します。 汎用名前付け規則 (UNC) 形式のパス、またはローカル パスのどちらかでパスを指定できます。 filespec 引数に指定するパスまたはファイル名に空白文字を含める場合は、 filespec 引数を引用符で囲む必要があります。

  • /File オプションは、 /DTS オプションまたは /SQL オプションと同時に使用できません。 複数のオプションが指定された場合、 dtexec は失敗します。

  • /H[elp] [option_name]:(省略可能)。 オプションのヘルプ、または指定された option_name のヘルプを表示して、ユーティリティを終了します。

    option_name 引数を指定すると、dtexec によって SQL Server オンライン ブックが起動され、「dtexec ユーティリティ」トピックが表示されます。

  • /ISServer packagepath: (省略可能)。 Integration Services サーバーに配置するパッケージを実行します。 PackagePath 引数には、 Integration Services サーバーに配置するパッケージの完全なパスとファイル名を指定します。 PackagePath 引数に指定するパスまたはファイル名に空白文字を含める場合は、 PackagePath 引数を引用符で囲む必要があります。

    パッケージ形式は次のとおりです。

    \<catalog name>\<folder name>\<project name>\package file name

    /Server オプションは、 /ISSERVER オプションと共に使用します。 SSIS サーバーでパッケージを実行できるのは Windows 認証のみです。 現在の Windows ユーザーはパッケージへのアクセスに使用されます。 /Server オプションを省略した場合、 SQL Server の既定のローカル インスタンスが使用されます。

    /ISSERVER オプションは、 /DTS、 /SQL 、または /File オプションと同時には使用できません。 複数のオプションが指定された場合、dtexec は失敗します。

    このパラメーターは SQL Server エージェントによって使用されます。

  • /L[ogger] classid_orprogid;configstring: (省略可能)。 1 つまたは複数のログ プロバイダーを SSIS パッケージの実行と関連付けます。 classid_orprogid パラメーターには、ログ プロバイダーを指定します。指定できるのはクラス GUID です。 configstring は、ログ プロバイダーを構成するために使用する文字列です。

    使用できるログ プロバイダーは次のとおりです。

    • テキスト ファイル:

      • ProgID:DTS.LogProviderTextFile.1

      • ClassID: {59B2C6A5-663F-4C20-8863-C83F9B72E2EB}

    • SQL Server プロファイラー:

      • ProgID:DTS.LogProviderSQLProfiler.1

      • ClassID: {5C0B8D21-E9AA-462E-BA34-30FF5F7A42A1}

    • SQL Server:

      • ProgID:DTS.LogProviderSQLServer.1

      • ClassID: {6AA833A1-E4B2-4431-831B-DE695049DC61}

    • Windows イベント ログ:

      • ProgID:DTS.LogProviderEventLog.1

      • ClassID: {97634F75-1DC7-4F1F-8A4C-DAF0E13AAA22}

    • XML ファイル:

      • ProgID:DTS.LogProviderXMLFile.1

      • ClassID: {AFED6884-619C-484F-9A09-F42D56E1A7EA}

  • /M[axConcurrent] concurrent_executables: (省略可能)。 パッケージが同時に実行できる実行可能ファイルの数を指定します。 負以外の整数または -1 を指定する必要があります。 値 -1 は、 SSIS が同時に実行できる実行可能ファイルの最大数が、パッケージを実行するコンピューターのプロセッサの合計数に 2 を加えたものと等しいことを意味します。

  • /Pack[age] PackageName: (省略可能)。 実行されるパッケージを指定します。 このパラメーターは、 Visual Studioからパッケージを実行する場合に主に使用されます。

  • /P[assword] password: (省略可能)。 SQL Server 認証によって保護されているパッケージの取得を可能にします。 このオプションは、 /User オプションと共に使用します。 /Password オプションを省略して /User オプションを使用する場合、空白のパスワードが使用されます。 password 値は引用符で囲むことができます。

    重要

    可能な場合は、Windows 認証を使用します。

  • /Par[ameter] [$Package:: | $Project:: | $ServerOption::] parameter_name [(data_type)]; literal_value:(省略可能)。 パラメーター値を指定します。 複数の /Parameter オプションを指定できます。 データ型は、文字列としての CLR TypeCodes です。 文字列型でないパラメーターの場合、データ型をかっこで囲んで指定してから、続けてパラメーター名を指定します。

    /Parameter オプションは、 /ISServer オプションと共に使用する必要があります。

    パッケージ パラメーター、プロジェクト パラメーター、およびサーバー オプション パラメーターを示すには、$Package、$Project、$ServerOption の各プレフィックスをそれぞれ使用します。 既定のパラメーターの型はパッケージです。

    パッケージを実行して、プロジェクト パラメーター (myparam) に myvalue を指定し、パッケージ パラメーター (anotherparam) に整数値 12 を指定する例を次に示します。

    Dtexec /isserver "SSISDB\MyFolder\MyProject\MyPackage.dtsx" /server "." /parameter $Project::myparam;myvalue /parameter anotherparam(int32);12

    パラメーターを使用して、接続マネージャーのプロパティを設定することもできます。 接続マネージャーのパラメーターであることを示すには、CM プレフィックスを使用します。

    次の例では、SourceServer 接続マネージャーの InitialCatalog プロパティが ssisdbに設定されています。

    /parameter CM.SourceServer.InitialCatalog;ssisdb

    次の例では、SourceServer 接続マネージャーの ServerName プロパティが、ローカル サーバーを示すためにピリオド (.) に設定されています。

    /parameter CM.SourceServer.ServerName;.

  • /Proj[ect] ProjectFile: (省略可能)。 実行されるパッケージの取得元となるプロジェクトを指定します。 ProjectFile 引数には、.ispac ファイル名を指定します。 このパラメーターは、 Visual Studioからパッケージを実行する場合に主に使用されます。

  • /Rem comment: (省略可能)。 コマンド プロンプトまたはコマンド ファイルにコメントを含めます。 引数は省略可能です。 comment の値は、引用符で囲むか、空白を含まない文字列を指定する必要があります。 引数を指定しない場合、空白行が挿入されます。 comment の値はコマンド初期フェーズで破棄されます。

  • /Rep[orting]level [;event_guid_or_name[;event_guid_or_name[...]]: (省略可能)。 レポートするメッセージの種類を指定します。 level に使用できるレポート オプションは次のとおりです。

    N レポートしません。

    E エラーがレポートされます。

    W 警告がレポートされます。

    I 情報メッセージがレポートされます。

    C カスタム イベントがレポートされます。

    D データ フロー タスク イベントがレポートされます。

    P 進行状況がレポートされます。

    V 詳細がレポートされます。

    V および N の引数は、他のすべての引数と同時には使用できないため、単独で指定する必要があります。 /Reporting オプションが指定されない場合、既定のレベルは E (エラー)、 W (警告)、および P (進行状況) になります。

    すべてのイベントの先頭には、"YY/MM/DD HH:MM:SS" の形式のタイムスタンプが付きます。また使用可能な場合は、GUID または表示名も付加されます。

    省略可能なパラメーターの event_guid_or_name には、ログ プロバイダーに関する例外のリストを指定します。 この例外で指定されるイベントは、ログに記録されません。指定されないイベントがログに記録されます。

    既定でログに記録されないイベントは、除外する必要はありません。

  • /Res[tart] {deny | force | ifPossible}:(省略可能)。 パッケージの CheckpointUsage プロパティの新しい値を指定します。 パラメーターの意味は次のとおりです。

    deny ： CheckpointUsage プロパティを DTSCU_NEVER」を参照してください。

    force ： CheckpointUsage プロパティを DTSCU_ALWAYS」を参照してください。

    ifPossible ： CheckpointUsage プロパティを DTSCU_IFEXISTS」を参照してください。

    値が指定されない場合は、既定値の force が使用されます。

  • /Set [$Sensitive::]propertyPath;value:(省略可能)。 パッケージ内のパラメーター、変数、プロパティ、コンテナー、ログ プロバイダー、Foreach 列挙子、または接続の構成をオーバーライドします。 このオプションを指定すると、 /Set は propertyPath 引数を、指定された値に変更します。 複数の /Set オプションを指定できます。

    /Set オプションは /F[ile] オプションと共に使用できます。また。 /Set オプションは /ISServer オプションまたは /Project オプションと共に使用することもできます。 /Set を /Projectと共に使用すると、 /Set によってパラメーター値が設定されます。 /Set を /ISServerと共に使用すると、 /Set によってプロパティのオーバーライドが設定されます。 また、 /Set を /ISServerと共に使用すると、オプションの $Sensitive プレフィックスを使用して、 Integration Services サーバーでプロパティが機密として扱われるよう指定できます。

    パッケージ構成ウィザードを実行して、 propertyPath の値を確認できます。 最後の [ウィザードの完了] ページに選択したアイテムのパスが表示されるので、これをコピーして貼り付けることができます。 この操作のみが目的でウィザードを使用した場合は、パスをコピーした後、ウィザードを取り消してください。

    ファイル システムに保存されているパッケージを実行して、変数に新しい値を指定する例を次に示します。

    dtexec /f mypackage.dtsx /set \package.variables[myvariable].Value;myvalue

    .ispac プロジェクト ファイルからパッケージを実行して、パッケージとプロジェクトのパラメーターを指定する例を次に示します。

    /Project c:\project.ispac /Package Package1.dtsx /SET \Package.Variables[$Package::Parameter];1 /SET \Package.Variables[$Project::Parameter];1

    /Set オプションを使用すると、パッケージ構成を読み込む場所を変更することができます。 ただし、 /Set オプションを使用しても、デザイン時の構成で指定した値をオーバーライドすることはできません。 パッケージ構成が適用されるしくみについては、「 Package Configurations 」 (パッケージ構成) および「 SQL Server 2016 における Integration Services 機能の動作の変更」を参照してください。

  • /Ser[ver] server: (省略可能)。 /SQL または /DTS オプションが指定されている場合、このオプションにはパッケージを取得するサーバーの名前を指定します。 /Server オプションを省略して /SQL オプションまたは /DTS オプションを指定した場合、ローカル サーバーに対してパッケージの実行が試行されます。 server_instance 値は引用符で囲むことができます。

    /Ser[ver] オプションが指定されている場合、 /ISServer オプションは必須です。

  • /SQ[L] package_path: SQL Server の msdb データベースに格納されているパッケージを読み込みます。 msdb データベースに格納されているパッケージは、パッケージ配置モデルを使用して配置されます。 プロジェクト配置モデルを使用して、Integration Services サーバーに配置されているパッケージを実行するには、 /ISServer オプションを使用します。 パッケージとプロジェクトの配置モデルの詳細については、「 Deployment of Projects and Packages」を参照してください。

  • package_path 引数には、取得するパッケージの名前を指定します。 パス名を指定する場合、パス内のフォルダーの最後には円記号 ("\") を指定します。 Package_path 値は引用符で囲むことができます。 package_path 引数に指定するパスまたはファイル名に空白文字を含める場合は、 package_path 引数を引用符で囲む必要があります。

    /User、 /Password、 /Server の各オプションは、 /SQL オプションと共に使用できます。

    /User オプションを省略した場合、パッケージへのアクセスに Windows 認証が使用されます。 /User オプションを使用する場合、指定する /User ログイン名は SQL Server 認証に関連付けられます。

    /Password オプションは、 /User オプションと共に使用する必要があります。 /Password オプションを使用する場合、パッケージは指定されたユーザー名とパスワード情報を使用してアクセスされます。 /Password オプションを省略した場合、空白のパスワードが使用されます。

    重要

    可能な場合は、Windows 認証を使用します。

  • /Server オプションを省略した場合、 SQL Server の既定のローカル インスタンスが使用されます。

    /SQL オプションは、 /DTS オプションまたは /File オプションと同時に使用できません。 複数のオプションが指定された場合、 dtexec は失敗します。

  • /Su[m] :(省略可能)。 後続のコンポーネントが受け取る行数を示す増分カウンターを表示します。

  • /U[ser] user_name: (省略可能)。 SQL Server 認証によって保護されているパッケージの取得を可能にします。 このオプションは、 /SQL オプションが指定されている場合にのみ使用されます。 User_name 値は引用符で囲むことができます。

    重要

    可能な場合は、Windows 認証を使用します。

  • /Va[lidate] :(省略可能)。 検証フェーズ後、パッケージの実行を停止します。パッケージは実際には実行されません。 検証を行う場合、 /WarnAsError オプションを指定すると、 dtexec は警告をエラーとして処理するので、検証中に警告が発生した場合にパッケージが失敗します。

  • /VerifyB[uild] major[;minor[;build]]: (省略可能)。 検証フェーズ中に、パッケージのビルド番号を、 major、 minor、および build 引数に指定されたビルド番号に対して検証します。 不一致が発生した場合、パッケージは実行されません。

    値は長整数型です。 引数は次の 3 つの形式のいずれかになります。 major の値は必須です。

    • major

    • major;minor

    • major; minor; build

  • /VerifyP[ackageID] packageID: (省略可能)。 実行するパッケージの GUID を、 package_id 引数に指定された値と比較して検証します。

  • /VerifyS[igned] :(省略可能)。 Integration Services でパッケージのデジタル署名を確認します。 パッケージが署名されていないか、署名が有効でない場合、パッケージは失敗します。 詳細については、「 デジタル署名を使用してパッケージのソースを特定する」を参照してください。

    重要

    パッケージの署名を確認するように構成した場合、 Integration Services によって確認されるのは、デジタル署名が存在するかどうか、有効かどうか、および信頼関係のある発行元の署名であるかどうかのみです。 Integration Services では、パッケージが変更されたかどうかは確認されません。

    Note

    オプションの BlockedSignatureStates レジストリ値では、 SQL Server Data Tools (SSDT) または dtexec コマンド ラインで設定されたデジタル署名オプションよりも制限が厳しい設定を指定できます。 この場合、制限が厳しい方のレジストリ設定が他の設定をオーバーライドします。

  • /VerifyV[ersionID] versionID: (省略可能)。 パッケージの検証フェーズ中に、実行されるパッケージのバージョン GUID を version_id 引数に指定された値と比較して検証します。

  • /VLog [Filespec]: (省略可能)。 すべての Integration Services パッケージ イベントを、パッケージの設計時に有効にしたログ プロバイダーに書き込みます。 Integration Services でテキスト ファイルのログ プロバイダーを有効にし、指定したテキスト ファイルにログ イベントを書き込むには、パスとファイル名を Filespec パラメーターとして含めます。

    Filespec パラメーターを含めない場合、Integration Services でテキスト ファイルのログ プロバイダーが有効になりません。 Integration Services では、パッケージの設計時に有効にしたログ プロバイダーに対してのみ、ログ イベントが書き込まれます。

  • /W[arnAsError] :(省略可能)。 パッケージは警告をエラーと判断するので、検証中に警告が発生した場合にはパッケージが失敗します。 検証中に警告が発生せず、 /Validate オプションが指定されていない場合、パッケージは実行されます。

  • /X86:(省略可能)。 SQL Server エージェントは 64 ビット コンピューター上で 32 ビット モードでパッケージを実行します。 このオプションは、次に示す条件が満たされた場合に SQL Server エージェントによって設定されます。

    • ジョブ ステップの種類が [SQL Server Integration Services パッケージ] であること。

    • [新しいジョブ ステップ] ダイアログ ボックスの [実行オプション] タブで [32 ビット ランタイムを使用] オプションが選択されていること。

    このオプションは、ストアド プロシージャまたは SQL Server 管理オブジェクト (SMO) を使用してジョブをプログラムにより作成することで、 SQL Server エージェント ジョブ ステップに設定することもできます。

    このオプションは、 SQL Server エージェントのみに使用されます。 コマンド プロンプトで dtexec ユーティリティを実行している場合、このオプションは無視されます。

解説

コマンド オプションの指定順序は、パッケージの実行方法に影響します。

  • オプションは、コマンド ライン上で指定されている順に処理されます。 コマンド ファイルは、コマンド ラインで指定されているとおりに読み取られます。 コマンド ファイル内のコマンドも指定されている順に処理されます。

  • 同じオプション、パラメーター、または変数が、同じコマンド ライン ステートメントに複数指定されている場合は、最後に指定されているものが優先されます。

  • /Set オプションと /ConfigFile オプションは、指定されている順に処理されます。

例

次の例では、dtexec コマンド プロンプト ユーティリティを使用して SQL Server Integration Services パッケージを構成および実行する方法について説明します。

パッケージの実行

Windows 認証を使用する SSIS に保存されている SQL Server パッケージを実行するには、次のコードを使用します。

dtexec /sq pkgOne /ser productionServer

SSIS パッケージ ストアの [ファイル システム] フォルダーに保存されている SSIS パッケージを実行するには、次のコードを使用します。

dtexec /dts "\File System\MyPackage"

Windows 認証が使用されていて、 SQL Server に保存されているパッケージを実行せずに検証するには、次のコードを使用します。

dtexec /sq pkgOne /ser productionServer /va

ファイル システムに保存されている SSIS パッケージを実行するには、次のコードを使用します。

dtexec /f "c:\pkgOne.dtsx"

ファイル システムに保存されている SSIS パッケージの実行、およびログ オプションの指定を行うには、次のコードを使用します。

dtexec /f "c:\pkgOne.dtsx" /l "DTS.LogProviderTextFile;c:\log.txt"

Windows 認証が使用され、 SQL Serverの既定のローカル インスタンスに保存されているパッケージの実行、および実行前にバージョンの確認を行うには、次のコードを使用します。

dtexec /sq pkgOne /verifyv {c200e360-38c5-11c5-11ce-ae62-08002b2b79ef}

ファイル システムに保存されているが、外部で構成されている SSIS パッケージを実行するには、次のコードを使用します。

dtexec /f "c:\pkgOne.dtsx" /conf "c:\pkgOneConfig.cfg"

注意

/SQL、/DTS、または /FILE オプションの package_path または filespec 引数は、パスまたはファイル名に空白文字が含まれる場合、引用符で囲む必要があります。 引数を引用符で囲まないと、空白文字を引数に含めることはできません。

ログ オプション

ログ エントリの種類が A、B、C の 3 つある場合、次のように、パラメーターを指定せずに ConsoleLog オプションを使用すると、3 つすべてのログの種類がすべてのフィールドと共に表示されます。

/CONSOLELOG

次のオプションを指定すると、すべてのログの種類が、Name 列および Message 列のみと共に表示されます。

/CONSOLELOG NM

次のオプションを指定すると、A の種類のログ エントリのみが、すべての列と共に表示されます。

/CONSOLELOG I;LogEntryTypeA

次のオプションを指定すると、A の種類のログ エントリのみが Name 列および Message 列と共に表示されます。

/CONSOLELOG NM;I;LogEntryTypeA

次のオプションを指定すると、A および B の種類のログ エントリが表示されます。

/CONSOLELOG I;LogEntryTypeA;LogEntryTypeB

複数の ConsoleLog オプションを指定すると、同じ結果を得ることができます。

/CONSOLELOG I;LogEntryTypeA /CONSOLELOG I;LogEntryTypeB

パラメーターなしで ConsoleLog オプションを指定すると、すべてのフィールドが表示されます。 次の指定に list_options パラメーターを含めると、A の種類のログ エントリのみがすべてのフィールドと共に表示されます。

/CONSOLELOG NM;I;LogEntryTypeA /CONSOLELOG

次の例では、種類 A のログ エントリを除くすべてのログ エントリ (種類 B と C) が表示されます。

/CONSOLELOG E;LogEntryTypeA

次のように複数の ConsoleLog オプションを使用し、単一のログ エントリを除外することで、前の例と同じ結果が得られます。

/CONSOLELOG E;LogEntryTypeA /CONSOLELOG  
/CONSOLELOG E;LogEntryTypeA /CONSOLELOG E;LogEntryTypeA  
/CONSOLELOG E;LogEntryTypeA;LogEntryTypeA

ログ ファイルの種類が包含一覧と除外一覧の両方に指定されている場合、そのログ ファイルは除外されるため、次の例ではログ メッセージは表示されません。

/CONSOLELOG E;LogEntryTypeA /CONSOLELOG I;LogEntryTypeA

SET オプション

/SET オプションの使用方法の例を次に示します。これは、パッケージのプロパティ値または変数値をコマンド ラインからパッケージを起動するときに変更します。

/SET \package\DataFlowTask.Variables[User::MyVariable].Value;newValue

プロジェクトのオプション

/Project オプションと /Package オプションの使用例を次に示します。

/Project c:\project.ispac /Package Package1.dtsx

次の例は、 /Project オプションと /Package オプションを使用してパッケージとプロジェクトのパラメーターを設定する方法を示しています。

/Project c:\project.ispac /Package Package1.dtsx /SET \Package.Variables[$Package::Parameter];1 /SET \Package.Variables[$Project::Parameter];1

ISServer のオプション

/ISServer オプションの使用例を次に示します。

dtexec /isserver "\SSISDB\MyFolder\MyProject\MyPackage.dtsx" /server "."

次の例は、 /ISServer オプションを使用してプロジェクトと接続マネージャーのパラメーターを設定する方法を示しています。

/Server localhost /ISServer "\SSISDB\MyFolder\Integration Services Project1\Package.dtsx" /Par "$Project::ProjectParameter(Int32)";1 /Par "CM.SourceServer.InitialCatalog";SourceDB