共用方式為


Get Help SQL Server PowerShell

針對 Windows PowerShell 和 Cmdlet 使用SQL Server提供者有數個資訊來源。 其中包括 Windows PowerShell 環境中可用的說明。

開始之前

若要了解 Windows PowerShell,請參閱 Windows PowerShell 開始使用手冊

如需SQL Server Cmdlet 和提供者的概觀,請參閱powerShell SQL Server

Windows PowerShell 環境中的説明

您可以使用 Get-Help Cmdlet,在 Windows PowerShell 環境中取得說明。 Get-Help 提供 Windows PowerShell 語言的基本說明,以及 Windows PowerShell 中可用的各種 Cmdlet 和提供者。

如需使用 Get-Help之方式的詳細資訊,請參閱 Get-Help:取得說明

SQL Server PowerShell 提供者說明

SQL Server PowerShell 提供者會在 SQLSERVER 虛擬磁片磁碟機上實作數個資料夾,例如 SQLSERVER:\SQL 和 SQLSERVER:\DAC 資料夾。 每一個資料夾都會與一個 SQL Server 管理能力物件模型有關聯。 雖然您可以列出與 SQL Server 路徑中每個節點相關聯的方法和屬性,但是無法在 PowerShell 環境中取得它們的說明。 如需含有相關聯程式設計參考連結之資料夾的表格,請參閱 SQL Server PowerShell 提供者

Invoke-Sqlcmd 說明

Invoke-Sqlcmd Cmdlet 會採用 sqlcmd 公用程式可執行的任何查詢或指令碼檔案作為輸入。 您可以使用 Get-Help 取得有關 Invoke-Sqlcmd 和其參數的資訊,但是不包含 sqlcmd 查詢的 Get-Help

-Query-QueryFromFile 輸入可包含:

取得 SQL Server Cmdlet 的説明

取得 Cmdlet 的說明

  • 指定 Cmdlet 的名稱以及要傳回的說明層級,以執行 Get-Help。

範例:Get-Help Cmdlet

下列範例傳回 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  

取得提供者清單

取得作用中的提供者清單

  1. 指定提供者類別目錄,以執行 Get-Help。

如需在 Windows PowerShell 中取得提供者說明的詳細資訊,請參閱 磁碟機和提供者

範例:取得提供者清單

此程式碼會傳回目前在 Windows PowerShell 工作階段中啟用的提供者清單:

Get-Help -Category provider  

取得 SQL Server 提供者的說明

取得提供者的相關說明

  1. 指定名稱 SQLServer,以執行 Get-Help

範例:取得 SQL Server 提供者說明

此範例會傳回SQL Server提供者的基本資訊:

Get-Help SQLServer  

列出方法和屬性

列出 SQL Server 提供者路徑中節點的方法和屬性

  1. CD (切換) 至 SQL Server 路徑中的節點,或建立該位置的變數集。

  2. 執行 Get-Member Cmdlet,並將 -Type 參數設定為 [方法] 或 [屬性]

範例:列出方法與屬性

此範例列出 Databases 節點所支援的方法:

Set-Location SQL:\MyComputer\DEFAULT\Databases  
Get-Item . | Get-Member -Type Methods  

此範例列出已設為 SMO 資料表物件之變數的屬性:

$MyVar = New-Object Microsoft.SqlServer.Management.SMO.Table  
$MyVar | Get-Member -Type Properties  

另請參閱

SQL Server PowerShell 提供者
使用 Database Engine Cmdlet