Get Help SQL Server PowerShell
Windows PowerShellとコマンドレットにSQL Server プロバイダーを使用する方法については、いくつかの情報ソースがあります。 これには、Windows PowerShell 環境で参照できるヘルプが含まれます。
はじめに
Windows PowerShell について学習するには、「 Windows PowerShell ファースト ステップ ガイド」をご覧ください。
SQL Server コマンドレットとプロバイダーの概要については、「powerShell のSQL Server」を参照してください。
Windows PowerShell 環境でのヘルプ
Windows PowerShell 環境でヘルプを参照するには、 Get-Help コマンドレットを使用します。 Get-Help では、Windows PowerShell 言語および Windows PowerShell で使用できるさまざまなコマンドレットやプロバイダーの基本的なヘルプが提供されます。
Get-Helpの使用方法の詳細については、「 ヘルプの表示: Get-Help」を参照してください。
SQL Server PowerShell プロバイダーのヘルプ
SQL Server PowerShell プロバイダーは、SQLSERVER:\SQL フォルダーや SQLSERVER:\DAC フォルダーなど、複数のフォルダーを SQLSERVER 仮想ドライブに実装します。 各フォルダーは、SQL Server 管理オブジェクト モデルの 1 つに関連付けられています。 SQL Server パスの各ノードに関連付けられているメソッドとプロパティを一覧表示することはできますが、PowerShell 環境でそれらのヘルプを参照することはできません。 フォルダーと、関連するプログラミング リファレンスへのリンクの表については、「 SQL Server PowerShell Provider」をご覧ください。
Invoke-Sqlcmd のヘルプ
Invoke-Sqlcmd コマンドレットは、 sqlcmd ユーティリティで実行できる任意のクエリまたはスクリプト ファイルを入力として受け取ります。 Get-Help を使用すると Invoke-Sqlcmd とそのパラメーターに関する情報を取得できますが、 sqlcmd クエリは Get-Help に対応していません。
-Query または -QueryFromFile の入力には以下が含まれます。
sqlcmd の変数とコマンド。 これらの変数とコマンドについては、「 sqlcmd Utility」の「解説」をご覧ください。
Transact-SQL ステートメント。 Transact-SQL 言語の詳細については、「 Transact-SQL リファレンス (データベース エンジン)」を参照してください。
XQuery ステートメント。 SQL Serverでサポートされている XQuery 言語の詳細については、「XQuery 言語リファレンス (SQL Server)」を参照してください。
SQL Server コマンドレットのヘルプの参照
コマンドレットのヘルプを取得するには
- コマンドレットの名前と返されるヘルプのレベルを指定して、Get-Help を実行します。
例: コマンドレット Get-Help
次の例は、 Invoke-Sqlcmdのさまざまなレベルのヘルプを返します:
## Get the basic help.
Get-Help Invoke-Sqlcmd
## Get the full help.
Get-Help Invoke-Sqlcmd -Full
## Get the parameter descriptions.
Get-Help Invoke-Sqlcmd -Parameter *
## Get the code examples.
Get-Help Invoke-Sqlcmd -Examples
## Get the syntax diagram.
Get-Help Invoke-Sqlcmd -Syntax
プロバイダーの一覧の取得
アクティブ プロバイダーの一覧を取得するには
- プロバイダーのカテゴリを指定して、Get-Help を実行します。
Windows PowerShell でプロバイダーのヘルプを参照する方法の詳細については、「 ドライブとプロバイダー」をご覧ください。
例: プロバイダーの一覧の取得
次のコードは、Windows PowerShell セッションで現在有効になっているプロバイダーの一覧を返します。
Get-Help -Category provider
SQL Server プロバイダーのヘルプの参照
プロバイダーのヘルプを参照するには
- 名前を SQLServer と指定して、Get-Help を実行します。
例: SQL Server プロバイダーのヘルプの参照
この例では、SQL Server プロバイダーに関する基本情報を返します。
Get-Help SQLServer
メソッドとプロパティの一覧表示
SQL Server プロバイダーのパス内のノードのメソッドとプロパティを一覧表示するには
SQL Server パスのノードに CD するか、その場所を設定された変数を作成します。
-Type パラメーターを Methods または Properties に設定して 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