共用方式為


獲取幫助(SQL Server PowerShell)

有多個資訊來源可供查詢,了解如何使用適用於 Windows PowerShell 的 SQL Server 提供者及其 cmdlet。 這包括 Windows PowerShell 環境中可用的說明。

開始之前

若要瞭解 Windows PowerShell,請參閱 Windows PowerShell 用戶入門指南

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

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 的幫助

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

範例:Cmdlet 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  

取得提供者清單

取得使用中提供者的清單

  1. 執行 Get-Help 指定提供者類別。

如需在 Windows PowerShell 中取得提供者協助的詳細資訊,請參閱 磁碟驅動器和提供者

範例:取得提供者清單

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

Get-Help -Category provider  

取得 SQL Server 提供者的相關說明

若要取得關於服務提供者的協助

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

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

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

Get-Help SQLServer  

列出方法和屬性

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

  1. 切換至 SQL Server 路徑中的某個節點,或者建立一個變數並設定至該位置。

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

範例:列出方法與屬性

此範例會列出 [資料庫] 節點支援的方法:

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 Server PowerShell 提供者
使用資料庫引擎命令列小程式