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

Get Help 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

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

Справка Invoke-Sqlcmd

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

Параметр -Query или -QueryFromFile может содержать следующее:

  • Переменные и командыsqlcmd . Сведения об этих переменных и командах см. в разделе "Примечания" статьи Программа sqlcmd.

  • Инструкции Transact-SQL Дополнительные сведения о языке Transact-SQL см. в справочнике по Transact-SQL (ядро СУБД).

  • Инструкции XQuery. Дополнительные сведения о языке XQuery, поддерживаемом SQL Server, см. в справочнике по языку XQuery (SQL Server).

Получение справки по командлету 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, указав имя SQL Server.

Пример: получение справки о поставщике SQL Server

В этом примере возвращаются основные сведения о поставщике SQL Server:

Get-Help SQLServer

Список методов и свойств

Формирование списка методов и свойств узла из пути поставщика SQL Server

  1. Перейдите в узел из пути SQL Server или создайте набор переменных к этому расположению.

  2. Запустите командлет Get-Member с параметром -Type, для параметра задано значение Methods или Properties.

Примеры: список методов и свойств

Этот пример формирует список методов, поддерживаемых для узла Databases.

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
Использование командлетов компонента Database Engine