获取帮助 SQL Server PowerShell

有多个有关使用适用于 Windows PowerShell 和 cmdlet 的 SQL Server 提供程序的信息来源。 这包括 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 的帮助

  • 运行 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 提供程序
使用数据库引擎命令集