SQL Server PowerShell 帮助

一般信息

有关可通过其了解 Windows PowerShell 的资源的详细信息，请参阅学习 PowerShell。

有关 SQL Server cmdlet 和提供程序的概述，请参阅 SQL Server PowerShell 概述。

使用 Get-Help

使用 Get-Help cmdlet 可在 Windows PowerShell 环境中获得帮助。Get-Help 为 Windows PowerShell 语言以及 Windows PowerShell 中的各种 cmdlet 和提供程序提供基本帮助。

SQL Server cmdlet 支持 Get-Help。Get-Help 返回有关 cmdlet 使用情况的信息，如语法和参数说明。下面的第一个示例返回 Invoke-Sqlcmd 的完整帮助，第二个示例仅返回参数的帮助，第三个示例仅返回所用示例的帮助：

Get-Help Invoke-Sqlcmd -Full
Get-Help Invoke-Sqlcmd -Parameter *
Get-Help Invoke-Sqlcmd -Examples

有关可通过 Get-Help 了解 cmdlet 的方式的详细信息，请参阅 Get-Help: Getting Help（Get-Help：获取帮助）。

SQL Server 提供程序也支持 Get-Help。例如，下面的代码返回有关 SQL Server 提供程序的基本信息：

Get-Help SQLServer

下面的代码返回当前在 Windows PowerShell 会话中启用的提供程序的列表：

Get-Help -Category provider

有关在 Windows PowerShell 中获得提供程序帮助的详细信息，请参阅 Drives and Providers（驱动器和提供程序）。

Invoke-Sqlcmd 帮助

Invoke-Sqlcmd cmdlet 将任何可通过 sqlcmd 实用工具运行的查询或脚本文件作为输入。可以使用 Get-Help 来获得有关 Invoke-Sqlcmd 及其参数的信息，但是对于 sqlcmd 查询，无法使用 Get-Help。

-Query 或 -QueryFromFile 输入可以包含：

• sqlcmd 变量和命令。有关这些变量和命令的信息，请参阅 sqlcmd 实用工具的“备注”部分。

• Transact-SQL 语句。有关 Transact-SQL 语言的详细信息，请参阅 Transact-SQL 参考（数据库引擎）。

• XQuery 语句。有关 SQL Server 支持的 XQuery 语言的详细信息，请参阅 XQuery 语言参考（数据库引擎）。

SQL Server 提供程序帮助

SQL Server 提供程序用类似于文件系统路径的路径公开 SQL Server 对象的层次结构。例如，这是 Purchasing 架构中 Vendor 表的路径，该架构位于默认数据库引擎实例的 AdventureWorks2008R2 数据库中：

SQL:\MyComputer\DEFAULT\Databases\AdventureWorks2008R2\Tables\Purchasing.Vendor

该提供程序针对不同 SQL Server 管理对象模型所包含的对象实现不同的驱动器节点。包含 SQL: 驱动器的路径使用 SQL Server 管理对象 (SMO) 所包含的对象，如表和视图。在导航到路径中的某个节点时，可以使用对象模型中适用于该对象类型的方法和属性。

可以使用 Get-Member cmdlet 来了解可供路径节点使用的方法和属性。例如，可以运行此代码来查看 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。

请参阅

概念