SQL Server PowerShell のヘルプ
Windows PowerShell 用 SQL Server プロバイダおよびコマンドレットの使用方法に関しては、いくつかの情報源が用意されています。これには、Windows PowerShell 環境で参照できるヘルプが含まれます。
一般情報
Windows PowerShell の学習に使用できるリソースについては、「PowerShell の学習」を参照してください。
SQL Server コマンドレットおよびプロバイダの概要については、「SQL Server PowerShell の概要」を参照してください。
Get-Help の使用
Windows PowerShell 環境でヘルプを参照するには、Get-Help コマンドレットを使用します。Get-Help では、Windows PowerShell 言語および Windows PowerShell で使用できるさまざまなコマンドレットやプロバイダの基本的なヘルプが提供されます。
SQL Server コマンドレットでは、Get-Help がサポートされます。Get-Help では、構文やパラメータ定義など、コマンドレットの使用方法に関する情報が返されます。以下の例では、Invoke-Sqlcmd の完全なヘルプ、パラメータのみのヘルプ、および例のみのヘルプが返されます。
Get-Help Invoke-Sqlcmd -Full
Get-Help Invoke-Sqlcmd -Parameter *
Get-Help Invoke-Sqlcmd -Examples
Get-Help を使用してコマンドレットのヘルプを参照する方法の詳細については、「Get-Help: ヘルプの表示」を参照してください。
SQL Server プロバイダでも、Get-Help がサポートされます。たとえば、次のコードは、SQL Server プロバイダに関する基本的な情報を返します。
Get-Help SQLServer
次のコードは、Windows PowerShell セッションで現在有効になっているプロバイダの一覧を返します。
Get-Help -Category provider
Windows PowerShell でプロバイダのヘルプを参照する方法の詳細については、「ドライブとプロバイダ」を参照してください。
Invoke-Sqlcmd のヘルプ
Invoke-Sqlcmd コマンドレットは、sqlcmd ユーティリティで実行できる任意のクエリまたはスクリプト ファイルを入力として受け取ります。Invoke-Sqlcmd とそのパラメータに関する情報は Get-Help を使用して取得できますが、Get-Help は sqlcmd クエリには対応していません。
-Query または -QueryFromFile の入力には以下が含まれます。
sqlcmd の変数とコマンド。これらの変数とコマンドについては、「sqlcmd ユーティリティ」の「解説」を参照してください。
Transact-SQL ステートメント。Transact-SQL 言語については、「Transact-SQL リファレンス (データベース エンジン)」を参照してください。
XQuery ステートメント。SQL Server でサポートされる XQuery 言語の詳細については、「XQuery 言語リファレンス (データベース エンジン)」を参照してください。
SQL Server プロバイダのヘルプ
SQL Server プロバイダは、ファイル システム パスと同様のパスで SQL Server オブジェクトの階層を公開します。たとえば、次のコードは、データベース エンジンの既定のインスタンスにある AdventureWorks データベースの Purchasing スキーマ内の Vendor テーブルへのパスです。
SQL:\MyComputer\DEFAULT\Databases\AdventureWorks\Tables\Purchasing.Vendor
プロバイダは、異なる SQL Server 管理オブジェクト モデルが対応するオブジェクトに対して別のドライブ ノードを実装します。SQL: ドライブが指定されたパスでは、テーブルやビューなど、SQL Server 管理オブジェクト (SMO) が対応するオブジェクトを使用します。パスでノードに移動すると、そのオブジェクトの種類に適用されるオブジェクト モデルのメソッドとプロパティを使用できます。
Get-Member コマンドレットを使用して、パス ノードで使用できるメソッドとプロパティを確認できます。たとえば、次のコードを実行すると、Databases ノードでサポートされるメソッドを参照できます。
Set-Location SQL:\MyComputer\DEFAULT\Databases
Get-Item . | Get-Member -Type Methods
次のコードは、SMO Table オブジェクトに設定されている変数のプロパティを一覧表示します。
$MyVar = New-Object Microsoft.SqlServer.Management.SMO.Table
$MyVar | Get-Member -Type Properties
異なるドライブのオブジェクト モデルのドキュメントを次に示します。
SQL: ドライブ
SMO の概念の詳細については、「SQL Server 管理オブジェクト (SMO)」を参照してください。
SMO のリファレンス情報については、「Microsoft.SqlServer.Management.Smo」を参照してください。