Поделиться через

Получить справку SQL Server PowerShell

Существует несколько источников информации об использовании поставщика SQL Server для Windows PowerShell и командлетов. Это включает в себя справку, доступную в среде Windows PowerShell.

Перед началом работы

Дополнительные сведения о Windows PowerShell см. в руководстве по началу работы с Windows PowerShell.

Общие сведения о командлетах и поставщиках SQL Server см. в статье SQL Server PowerShell.

Справка в среде Windows PowerShell

Используйте командлет Get-Help , чтобы получить справку в среде Windows PowerShell. Get-Help предоставляет справочную информацию по языку Windows PowerShell и различным командлетам и поставщикам, которые доступны в Windows PowerShell.

Для получения дополнительной информации о способах использования Get-Help см. статью Get-Help: Получение справки.

Справка поставщика SQL Server PowerShell

Поставщик SQL Server PowerShell реализует несколько папок на виртуальном диске SQLSERVER, таких как ПАПКИ SQLSERVER:\SQL и SQLSERVER:\DAC. Каждая папка связана с одной из объектных моделей управляемости SQL Server. Хотя вы можете перечислить методы и свойства, связанные с каждым узлом в пути SQL Server, вы не можете получить справку по ним в среде PowerShell. Для таблицы папок со ссылками на связанную справочную информацию о программировании см. раздел SQL Server PowerShell Provider.

Справка Invoke-Sqlcmd

Командлет Invoke-Sqlcmd принимает в качестве входных данных любой запрос или файл скрипта, который может выполняться программой sqlcmd . Вы можете использовать get-Help для получения сведений о Invoke-Sqlcmd и его параметрах, но для запросов sqlcmd нет покрытия get-Help.

Входные данные -Query или -QueryFromFile могут содержать:

Получить справку для командлета SQL Server

Получение справки по командлету

  • Запустите Get-Help, укажите имя командлета и уровень справки, который требуется вернуть.

Пример: командлет 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. Запустите командлет Get-Member с параметром -Type, заданным для методов или свойств.

Примеры: перечисление методов и свойств

В этом примере перечислены методы, поддерживаемые для узла Баз данных:

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
Используйте командлеты движка базы данных