Invoke-Sqlcmd コマンドレット
Invoke-Sqlcmd は、言語 (Transact-SQL と XQuery) のステートメントと sqlcmd ユーティリティでサポートされているコマンドを含むスクリプトを実行するSQL Serverコマンドレットです。
Invoke-Sqlcmd の使用
Invoke-Sqlcmd コマンドレットを使用すると、Windows PowerShell 環境で sqlcmd スクリプト ファイルを実行できます。 sqlcmd で実行できる処理の多くは、 Invoke-Sqlcmdを使用しても実行できます。
次の例では、Invoke-Sqlcmd を呼び出して単純なクエリを実行しています。これは、 sqlcmd で -Q および -S オプションを指定する場合と同様です。
Invoke-Sqlcmd -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance"
次の例では、 Invoke-Sqlcmdを呼び出し、入力ファイルを指定して、出力をファイルにパイプしています。これは、 sqlcmd に -i および -o オプションを指定する場合と同様です。
Invoke-Sqlcmd -InputFile "C:\MyFolder\TestSQLCmd.sql" | Out-File -FilePath "C:\MyFolder\TestSQLCmd.rpt"
次の例では、Windows PowerShell 配列を使用して複数の sqlcmd スクリプト変数を Invoke-Sqlcmdに渡しています。 SELECT ステートメントで sqlcmd スクリプト変数を識別する "$" 文字をエスケープするために、PowerShell のバック ティック "`" エスケープ文字が使用されています。
$MyArray = "MyVar1 = 'String1'", "MyVar2 = 'String2'"
Invoke-Sqlcmd -Query "SELECT `$(MyVar1) AS Var1, `$(MyVar2) AS Var2;" -Variable $MyArray
SQL Server プロバイダーを使用して Windows PowerShellデータベース エンジンのインスタンスに移動し、Windows PowerShell Get-Item コマンドレットを使用してインスタンスの SMO Server オブジェクトを取得し、Invoke-Sqlcmd に渡す例を示します。
Set-Location SQLSERVER:\SQL\MyComputer\MyInstance
Invoke-Sqlcmd -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance (Get-Item .)
-Query パラメーターは位置で指定するパラメーターであり、名前を指定する必要はありません。 Invoke-Sqlcmdに渡された最初の文字列に名前が付いていない場合、その文字列は -Query パラメーターとして扱われます。
Invoke-Sqlcmd "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance"
Invoke-Sqlcmd のパス コンテキスト
-Database パラメーターを使用しない場合、Invoke-Sqlcmd のデータベース コンテキストは、コマンドレットが呼び出されたときにアクティブなパスによって設定されます。
| パス | データベース コンテキスト |
|---|---|
| SQLSERVER: 以外のドライブで始まります。 | ローカル コンピューター上の既定のインスタンスのログイン ID の既定のデータベースです。 |
| SQLSERVER:\SQL | ローカル コンピューター上の既定のインスタンスのログイン ID の既定のデータベースです。 |
| SQLSERVER:\SQL\ComputerName | 指定したコンピューター上の既定のインスタンスのログイン ID の既定のデータベースです。 |
| SQLSERVER:\SQL\ComputerName\InstanceName | 指定したコンピューター上の指定したインスタンスのログイン ID の既定のデータベースです。 |
| SQLSERVER:\SQL\ComputerName\InstanceName\Databases | 指定したコンピューター上の指定したインスタンスのログイン ID の既定のデータベースです。 |
| SQLSERVER:\SQL\ComputerName\InstanceName\Databases\DatabaseName | 指定したコンピューター上の指定したインスタンスの指定したデータベースです。 これは、より長いパス (たとえばデータベース内の Tables ノードや Columns ノードを指定するパス) にも適用されます。 |
たとえば、ローカル コンピューターの既定のインスタンスの Windows アカウントの既定のデータベースが master であるとします。 次のコマンドを実行すると、master が返されます。
Set-Location SQLSERVER:\SQL
Invoke-Sqlcmd "SELECT DB_NAME() AS DatabaseName;"
次のコマンドは AdventureWorks2012 を返します。
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks2012\Tables\Person.Person
Invoke-Sqlcmd "SELECT DB_NAME() AS DatabaseName;"
Invoke-Sqlcmd は、パス データベース コンテキストを使用するときに警告を表示します。 -SuppressProviderContextWarning パラメーターを使用すると、警告メッセージが出力されないようにすることができます。 -IgnoreProviderContext パラメーターを使用すると、Invoke-Sqlcmd を実行するときに常にログインの既定のデータベースが使用されます。
Invoke-Sqlcmd と sqlcmd ユーティリティの比較
Invoke-Sqlcmd では、 sqlcmd ユーティリティを使用して実行できるスクリプトの多くを実行できます。 ただし、 Invoke-Sqlcmd が実行される Windows PowerShell 環境は、 sqlcmd が実行されるコマンド プロンプト環境とは異なります。 Invoke-Sqlcmd の動作は、Windows PowerShell 環境で機能するように変更されています。
すべての sqlcmd コマンドが Invoke-Sqlcmdで実装されるわけではありません。 実装されないコマンドには、 :!!、 :connect、 :error、 :out、 :ed、 :list、 :listvar、 :reset、 :perftrace、 :serverlistがあります。
Invoke-Sqlcmd では sqlcmd 環境または SQLCMDDBNAME や SQLCMDWORKSTATION などのスクリプト変数が初期化されません。
Invoke-Sqlcmd では、Windows PowerShell の -Verbose 共通パラメーターを指定しない限り、PRINT ステートメントの出力などのメッセージが表示されません。 次に例を示します。
Invoke-Sqlcmd -Query "PRINT N'abc';" -Verbose
sqlcmd のすべてのパラメーターが PowerShell 環境で必要となるわけではありません。 たとえば、Windows PowerShell ではコマンドレットからのすべての出力の書式が自動的に設定されるため、書式設定オプションを指定する sqlcmd のパラメーターは Invoke-Sqlcmdには実装されていません。 次の表は、 Invoke-Sqlcmd パラメーターと sqlcmd オプションの関係を示しています。
| 説明 | sqlcmd オプション | Invoke-Sqlcmd パラメーター |
|---|---|---|
| サーバーとインスタンスの名前 | -S | -ServerInstance |
| 使用する初期データベース | -d | -Database |
| 指定したクエリの実行と終了 | -Q | -Query |
| [認証ログイン ID] をSQL Serverします。 | -U | -Username |
| SQL Server認証パスワード。 | -P | -Password |
| 変数の定義 | -v | -Variable |
| クエリのタイムアウト間隔 | -t | -QueryTimeout |
| エラー発生時の実行停止 | -b | -AbortOnError |
| 専用管理者接続 | 。 | -DedicatedAdministratorConnection |
| 対話型コマンド、スタートアップ スクリプト、および環境変数の無効化 | -X | -DisableCommands |
| 変数の代入の無効化 | -X | -DisableVariables |
| レポートする最小重大度レベル | -v | -SeverityLevel |
| レポートする最小エラー レベル | -M | -ErrorLevel |
| ログインのタイムアウト間隔 | -l | -ConnectionTimeout |
| ホスト名 | -H | -HostName |
| パスワードの変更と終了 | -Z | -NewPassword |
| クエリが含まれている入力ファイル | -i | -InputFile |
| 文字出力の最大長 | -w | -MaxCharLength |
| バイナリ出力の最大長 | -w | -MaxBinaryLength |
| SSL 暗号化を使用した接続 | パラメーターなし | -EncryptConnection |
| エラーの表示 | パラメーターなし | -OutputSqlErrors |
| stderr へのメッセージの出力 | -r | パラメーターなし |
| クライアントの地域別設定の使用 | -R | パラメーターなし |
| 指定したクエリの実行と実行の継続 | -Q | パラメーターなし |
| 出力データに使用するコード ページ | -f | パラメーターなし |
| パスワードの変更と実行の継続 | -Z | パラメーターなし |
| パケット サイズ | -a | パラメーターなし |
| 列の区切り | -S | パラメーターなし |
| 出力ヘッダーの制御 | -H | パラメーターなし |
| 制御文字の指定 | -k | パラメーターなし |
| 固定長表示幅 | -y | パラメーターなし |
| 可変長表示幅 | -y | パラメーターなし |
| 入力のエコー | -E | パラメーターなし |
| 引用符で囲まれた識別子の有効化 | -I | パラメーターなし |
| 末尾のスペースの削除 | -w | パラメーターなし |
| インスタンスの一覧表示 | -l | パラメーターなし |
| 出力の形式を Unicode に設定 | -U | パラメーターなし |
| 統計情報の印刷 | -p | パラメーターなし |
| コマンドの終了 | -c | パラメーターなし |
| Windows 認証を使用した接続 | -E | パラメーターなし |