Получение справок по 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, поставщик.
Справка Invoke-Sqlcmd
Командлет Invoke-Sqlcmd принимает в качестве входных данных любой файл запроса или скрипта, который можно запустить с помощью программы sqlcmd. Получить сведения о командлете Invoke-Sqlcmd и его параметрах можно с помощью командлета Get-Help, однако он не содержит сведений о запросах sqlcmd.
Параметры -Query и -QueryFromFile могут содержать следующие объекты.
Переменные и команды sqlcmd. Сведения об этих переменных и командах см. в подразделе «Примечания» раздела Программа sqlcmd.
Инструкции Transact-SQL. Дополнительные сведения о языке Transact-SQL см. в разделе Справочник по Transact-SQL (компонент Database Engine).
Инструкции XQuery. Сведения о языке XQuery, поддерживаемом SQL Server, см. в разделе Справочник по языку XQuery (SQL Server).
Получение справки по командлету SQL Server
Получение справки по командлету
- Запустите командлет Get-Help, указав имя командлета и уровень справочных данных, которые должны быть возвращены.
Пример: 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
Получение списка поставщиков
Получение списка активных поставщиков
- Запустите командлет Get-Help, указав категорию поставщиков.
Дополнительные сведения о получении справки поставщика в среде Windows PowerShell см. в разделе Диски и поставщики.
Пример. Получение списка поставщиков
Следующий код возвращает список поставщиков, которые включены в текущем сеансе Windows PowerShell:
Get-Help -Category provider
Получение справки о поставщике SQL Server
Получение справки о поставщике
- Запустите командлет Get-Help, указав имя SQL Server.
Пример. Получение справки о поставщике SQL Server
Код, приведенные в этом примере, возвращает основные сведения о поставщике SQL Server:
Get-Help SQLServer
Список методов и свойств
Формирование списка методов и свойств узла из пути поставщика SQL Server
Перейдите в узел из пути SQL Server или создайте набор переменных к этому расположению.
Запустите командлет 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