sqlps ユーティリティ
このユーティリティはsqlps
、SQL Server PowerShell プロバイダーとコマンドレットを読み込んで登録して、Windows PowerShell 2.0 セッションを開始します。 SQL Server PowerShell コンポーネントを使用する PowerShell コマンドやスクリプトを入力して、SQL Server インスタンスとそのオブジェクトを操作できます。
重要
この機能は、Microsoft SQL Server の将来のバージョンで削除されます。 新規の開発作業ではこの機能を使用しないようにし、現在この機能を使用しているアプリケーションは修正することを検討してください。 代わりに sqlps
PowerShell モジュールを使用してください。 モジュールの sqlps
詳細については、「 SQLPS モジュールのインポート」を参照してください。
構文
sqlps
[ [ [ -NoLogo ][ -NoExit ][ -NoProfile ]
[ -OutPutFormat { Text | XML } ] [ -InPutFormat { Text | XML } ]
]
[ -Command { -
| script_block [ -argsargument_array ]
| string [ command_parameters ]
}
]
]
[ -? | -Help ]
引数
-NoLogo
sqlps
ユーティリティの起動時に著作権画面を表示しないように指定します。
-NoExit
スタートアップ コマンドの完了後に sqlps
ユーティリティの実行を継続するように指定します。
-NoProfile
sqlps
ユーティリティがユーザー プロファイルを読み込まないように指定します。 ユーザー プロファイルには、複数の PowerShell セッションで共通して使用する別名、関数、および変数が記録されます。
-OutPutFormat { Text | XML }
ユーティリティ出力を sqlps
テキスト文字列 (Text) またはシリアル化された CLIXML 形式 (XML) として書式設定することを指定します。
-InPutFormat { Text | XML }
ユーティリティへの sqlps
入力がテキスト文字列 (Text) またはシリアル化された CLIXML 形式 (XML) として書式設定されるように指定します。
-Command
sqlps
ユーティリティで実行するコマンドを指定します。 sqlps
-NoExit も指定されていない限り、ユーティリティは コマンドを実行して終了します。 -Commandの後にはその他のスイッチを指定しないでください。指定すると、コマンド パラメーターとして読み取られます。
-
-Command- ユーティリティが sqlps
標準入力から入力を読み取っていることを指定します。
script_block [ -argsargument_array ]
実行する PowerShell コマンドのブロックを指定します。ブロックは中かっこ {} で囲む必要があります。 Script_blockは、PowerShell または別sqlps
のsqlps
ユーティリティ セッションからユーティリティが呼び出された場合にのみ指定できます。 argument_array は、 script_block内の PowerShell コマンドの引数を含む PowerShell 変数の配列です。
string [ command_parameters ]
実行する PowerShell コマンドを含む文字列を指定します。 "&{command
}" という形式を使用します。 引用符は文字列を示し、呼び出し演算子 (&) によってユーティリティが sqlps
コマンドを実行します。
[ -? | -Help ]
sqlps
ユーティリティ オプションの構文の概要を表示します。
注釈
ユーティリティは sqlps
PowerShell 環境 (PowerShell.exe) を起動し、SQL Server PowerShell モジュールを読み込みます。 という名前sqlps
のモジュールは、PowerShell スナップインSQL Server読み込んで登録します。
Microsoft.SqlServer.Management.PSProvider.dll
SQL Server PowerShell プロバイダーおよび関連するコマンドレット (Encode-SqlName や Decode-SqlName など) を実装します。
Microsoft.SqlServer.Management.PSSnapin.dll
Invoke-Sqlcmd および Invoke-PolicyEvaluation コマンドレットを実装します。
sqlps
ユーティリティを使用して、次の操作を行うことができます。
PowerShell コマンドを対話的に実行する。
PowerShell スクリプト ファイルを実行する。
SQL Server コマンドレットを実行します。
SQL Server プロバイダー パスを使用して、SQL Server オブジェクトの階層間を移動します。
既定では、ユーティリティは sqlps
スクリプト実行ポリシーを Restricted に設定して実行されます。 これにより、PowerShell スクリプトの実行が防止されます。 Set-ExecutionPolicy コマンドレットを使用すると、署名されたスクリプトまたは任意のスクリプトの実行を有効にすることができます。 信頼できるソースからのスクリプト以外は実行しないでください。また、適切な NTFS 権限を使用して、すべての入力ファイルと出力ファイルのセキュリティを保護してください。 PowerShell スクリプトの有効化の詳細については、「 Windows PowerShell スクリプトの実行」を参照してください。
SQL Server 2008 および SQL Server 2008 R2 のユーティリティのバージョンsqlps
は、Windows PowerShell 1.0 ミニシェルとして実装されました。 ミニシェルには特定の制限があります。たとえば、ミニシェルによって読み込まれているスナップイン以外、ユーザーは読み込むことができません。 これらの制限は、モジュールを使用sqlps
するように変更された SQL Server 2012 以降のバージョンのユーティリティには適用されません。
例
A. 既定の対話モードで著作権画面を表示せずに sqlps ユーティリティを実行する
sqlps -NoLogo
B. コマンド プロンプトから SQL Server PowerShell スクリプトを実行する
sqlps -Command "&{.\MyFolder.MyScript.ps1}"
C. コマンド プロンプトから SQL Server PowerShell スクリプトを実行し、スクリプト完了後も実行を続ける
sqlps -NoExit -Command "&{.\MyFolder.MyScript.ps1}"