• [アーティクル]

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 の入力には以下が含まれます。

SQL Server プロバイダーのヘルプ

SQL Server プロバイダーは、ファイル システム パスと同様のパスで SQL Server オブジェクトの階層を公開します。たとえば、データベース エンジンの既定のインスタンスにある AdventureWorks2008R2 データベースの Purchasing スキーマ内の Vendor テーブルへのパスは次のようになります。

SQL:\MyComputer\DEFAULT\Databases\AdventureWorks2008R2\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

異なるドライブのオブジェクト モデルのドキュメントを次に示します。