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


Справка по SQL Server PowerShell

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

Общие сведения

Ресурсы для изучения Windows PowerShell см. в разделе Изучение PowerShell.

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

Использование командлета Get-Help

Командлет Get-Help служит для получения справки в среде Windows PowerShell. Командлет Get-Help предоставляет основную справку по языку Windows PowerShell и различным командлетам и поставщикам, доступным в среде Windows PowerShell.

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

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

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

Поставщик SQL Server также поддерживает командлет Get-Help. Например, этот код возвращает основные сведения о поставщике SQL Server:

Get-Help SQLServer

Следующий код возвращает список поставщиков, которые включены в текущем сеансе Windows PowerShell:

Get-Help -Category provider

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

Справка Invoke-Sqlcmd

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

Параметры -Query и -QueryFromFile могут содержать следующие объекты.

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

Поставщик SQL Server отображает иерархию объектов SQL Server в виде путей, похожих на пути файловой системы. Например, далее показан путь к таблице Vendor в схеме Purchasing базы данных AdventureWorks в экземпляре компонента Database Engine по умолчанию:

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

В поставщике реализованы различные узлы дисков для объектов, поддерживаемых различными моделями управляющих объектов SQL Server. Пути с диском SQL используют объекты SMO, такие как таблицы и представления. Во время перемещения к узлу в пути можно использовать методы и свойства модели объектов, которая применима к этому типу объекта.

Можно использовать командлет Get-Member, чтобы узнать, какие методы и свойства доступны для узла пути. Например, чтобы узнать, какие методы поддерживаются узлом 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

Далее представлены ссылки на документацию по моделям объектов для различных дисков.