获取 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. 使用 CD 命令转到 SQL Server 路径中的节点,或创建一个指向该位置的变量集。

  2. 运行 –Type 参数设置为 Methods 或 Properties 的 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 Server PowerShell 提供程序

使用数据库引擎 cmdlet