Invoke-SqlNotebook

Синтаксис

Invoke-SqlNotebook
      [-ServerInstance <Object>]
      [-Database <Object>]
      [-Username <Object>]
      [-Password <Object>]
      [-Credential <PSCredential>]
      [-InputFile <Object>]
      [-InputObject <Object>]
      [-OutputFile <Object>]
      [-AccessToken <PSObject>]
      [-TrustServerCertificate]
      [-Encrypt <String>]
      [-HostNameInCertificate <String>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [<CommonParameters>]

Invoke-SqlNotebook
      [-ConnectionString <Object>]
      [-InputFile <Object>]
      [-InputObject <Object>]
      [-OutputFile <Object>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [<CommonParameters>]

Invoke-SqlNotebook
      -InputFile <Object>
      [-OutputFile <Object>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [<CommonParameters>]

Invoke-SqlNotebook
      -InputObject <Object>
      [-OutputFile <Object>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [<CommonParameters>]

Описание

Командлет Invoke-SqlNotebook выполняет файл записной книжки SQL (IPYNB) и выводит материализованную записную книжку.

Записная книжка будет выполнена на сервере ServerInstance и базе данных.

При запуске командлета результирующий файл записной книжки будет находиться в расположении, где пользователь определяет или в том же каталоге входного файла записной книжки.

Файл командлета может быть опущен: если это так, он будет создан с именем входного файла и _out добавлен к файлу.

Примеры

Пример 1. Выполнение записной книжки на локальном сервере (экземпляр по умолчанию)

PS C:\> Invoke-SqlNotebook -ServerInstance localhost -Database TestNotebook -InputFile C:\notebook.ipynb

   Directory: C:\

Mode           LastWriteTime         Length Name
----           -------------         ------ ----
-a----         8/1/2019  1:00 PM     4656   notebook_out.ipynb

Эта команда запускает записную книжку для экземпляра SQL Server по умолчанию, работающего на компьютере, из которого выполняется командлет. По умолчанию, так как не было передано -OutputFile, материализованная записная книжка сохраняется на диске с тем же именем, что и InputFile с _out в качестве суффикса в имя файла (notebook.ipynb -> notebook_out.ipynb)

Пример 2. Выполнение записной книжки на локальном сервере (экземпляр defaut) и сохранение материализованной записной книжки в указанный файл

PS C:\> Invoke-SqlNotebook -ServerInstance localhost -Database TestNotebook -InputFile C:\notebook.ipynb -OutputFile C:\new_notebook.ipynb

   Directory: C:\

Mode           LastWriteTime         Length Name
----           -------------         ------ ----
-a----         8/1/2019  1:00 PM     44656  new_notebook.ipynb

Эта команда запускает записную книжку для экземпляра SQL Server по умолчанию, работающего на компьютере, из которого выполняется командлет. Затем выполненная записная книжка сохраняется в файл, указанный параметром -OutputFile.

Пример 3. Выполнение записной книжки с помощью параметра -ConnectionString

PS C:\> Invoke-Sqlnotebook -ConnectionString 'Server=Localhost;Database=TestNotebook;Trusted_Connection=True;' -InputFile C:\notebook.ipynb

   Directory: C:\

Mode           LastWriteTime         Length Name
----           -------------         ------ ----
-a----         8/1/2019  1:00 PM     44656  notebook_out.ipynb

Это же, как и в примере 1, только то, что подключение к серверу указывается с помощью параметра -ConnectionString.

Пример 4. Выполнение записной книжки для всех зарегистрированных серверов

dir 'SQLSERVER:\SQLRegistration\Database Engine Server Group' |
WHERE { $_.Mode -ne 'd'} |            
foreach {
    $datetime = Get-Date -Format yyyyMMddhhmm;
    Get-SqlInstance -ServerInstance $_.Name |
    foreach {
            Invoke-SqlNotebook -ServerInstance $_.Name -Database master -InputFile '$home\Documents\SQL Server Management Studio\BPCheck.ipynb' `
            -OutputFile "BPCheck_output_$($_.NetName)_$($datetime).ipynb";
            }
        }

Используйте зарегистрированные серверы или центральный сервер управления для выполнения Invoke-SqlNotebook на нескольких серверах. В этом примере свойство NetName экземпляра SQL Server будет включено в имя выходного файла; материализованная записная книжка будет помечена временем с годом-днем-часом.

Пример 5. Выполнение записной книжки, открытие результатов в Azure Data Studio

Установите расширение PowerShell из Azure Data Studio Marketplace. Используйте интегрированную консоль PowerShell в Azure Data Studio, чтобы запустить Invoke-SqlNotebook и использовать Open-EditorFile, чтобы открыть результаты записной книжки SQL непосредственно в Azure Data Studio.

Invoke-SqlNotebook -ServerInstance ServerA -Database master -InputFile "$home\Documents\SQL Server Management Studio\BPCheck.ipynb" |
Open-EditorFile

Примечание. Команда Open-EditorFile доступна только в интегрированной консоли PowerShell.

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

Import-Module SQLServer
Import-Module Az.Accounts -MinimumVersion 2.2.0

### Obtain the Access Token interactively.
### Note: help for Invoke-Sqlcmd has examples on other ways to acquire the token.
Connect-AzAccount
$access_token = (Get-AzAccessToken -ResourceUrl https://database.windows.net).Token

# Now that we have the token, we use it to connect to the database 'mydb' on server 'myserver'
Invoke-SqlNotebook -ServerInstance myserver.database.windows.net -Database master -AccessToken $access_token`
                   -InputFile MyNotebook.ipynb

Параметры

-AccessToken

-ConnectionString

-Credential

-Database

-Encrypt

-Force

-HostNameInCertificate

-InputFile

-InputObject

-OutputFile

-Password

-ProgressAction

-ServerInstance

-TrustServerCertificate

-Username

Входные данные

System.Object

System.Management.Automation.PSCredential

Выходные данные

System.Object

Примечания

Хорошим способом визуализации материализованной записной книжки является использование Azure Data Studio.

Связанные ссылки

• Записные книжки SQL в Azure Data Studio
• Расширение PowerShell
• SQLServer_Cmdlets
• Субъект-служба
• Управляемое удостоверение