Invoke-SqlNotebook

Ссылка

Модуль:: SQLServer

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

Синтаксис

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]
      [<CommonParameters>]

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

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

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

Описание

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

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

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

Файл outfile командлета может быть опущен: в этом случае он будет создан с именем входного файла и _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. Выполнение записной книжки, подключение к базам данных Azure SQL (или Управляемый экземпляр) с помощью субъекта-службы

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

Маркер доступа, используемый для проверки подлинности для SQL Server в качестве альтернативы проверке подлинности пользователя или пароля или проверки подлинности Windows.

Это можно использовать, например, для подключения к SQL Azure DB и SQL Azure Managed Instance с помощью Service Principal или Managed Identity (см. ссылки в нижней части этой страницы).

В распространенных сценариях этот параметр получается с помощью чего-то вроде (Get-AzAccessToken -ResourceUrl https://database.windows.net).Token (требуется модуль Az.Account).

Не указывайте UserName, Password или Credential при использовании этого параметра.

Type:	PSObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionString

Указывает строка подключения для подключения к серверу.

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Объект PSCredential, поля имя пользователя и пароль которого будут использоваться для подключения к экземпляру SQL.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Database

Этот командлет подключается к этой базе данных в экземпляре, указанном в параметре ServerInstance.

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encrypt

Тип шифрования, используемый при подключении к SQL Server.

Это значение сопоставляется со свойством EncryptSqlConnectionEncryptOption объекта SqlConnection драйвера Microsoft.Data.SqlClient.

В версии 22 модуля по умолчанию используется Optional значение (для совместимости с версией 21). В версии 23+ модуля значением по умолчанию будет "Обязательно", что может привести к критическому изменению для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

Type:	String
Accepted values:	Mandatory, Optional, Strict
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HostNameInCertificate

Имя узла используется для проверки TLS/SSL-сертификата SQL Server.

Этот параметр является новым в версии 22 модуля.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputFile

Указывает файл записной книжки (IPYNB), который будет выполняться с помощью командлета .

Type:	Object
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Указывает записную книжку в виде строки JSON, которая будет использоваться в качестве входной записной книжки.

Type:	Object
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputFile

Указывает нужный выходной файл записной книжки, для которого будет сохранена выполненная записная книжка.

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Password

Указывает пароль для SQL Server идентификатор входа для проверки подлинности, указанный в параметре Username.

В паролях учитывается регистр символов. По возможности используйте проверку подлинности Windows или используйте параметр -Credential .

Если указать параметр Пароль, за которым следует пароль, пароль будет виден всем, кто может видеть ваш монитор.

Если в скрипте .ps1 закодирован пароль, за которым следует пароль, любой пользователь, читающий файл скрипта, увидит ваш пароль.

Для предотвращения несанкционированного чтения файла задайте для файла соответствующие разрешения NTFS.

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServerInstance

Задает символьную строку или объект SQL Server management objects (SMO), указывающий имя экземпляра ядра СУБД.

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TrustServerCertificate

Указывает, будет ли канал зашифрован при обходе цепочки сертификатов для проверки доверия.

В версии 22 модуля по умолчанию используется $true значение (для совместимости с версией 21). В версии 23+ модуля значение по умолчанию будет "$false", что может привести к критическому изменению для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Username

Указывает идентификатор входа для создания соединения, использующего проверку подлинности SQL Server, с экземпляром компонента Database Engine.

Пароль необходимо указать с помощью параметра Password.

Если имя пользователя и пароль не указаны, этот командлет пытается установить подключение проверки подлинности Windows с помощью учетной записи Windows, на которой выполняется сеанс Windows PowerShell. По возможности используйте аутентификацию Windows.

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

System.Object

System.Management.Automation.PSCredential

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

System.Object

Примечания

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

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

Invoke-SqlNotebook

Синтаксис

Описание

Примеры

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

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

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

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

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

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

Параметры

-AccessToken

-ConnectionString

-Credential

-Database

-Encrypt

-Force

-HostNameInCertificate

-InputFile

-InputObject

-OutputFile

-Password

-ServerInstance

-TrustServerCertificate

-Username

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

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

Примечания

Дополнительные ресурсы

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

Invoke-SqlNotebook

Синтаксис

Описание

Примеры

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

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

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

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

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

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

Параметры

-AccessToken

-ConnectionString

-Credential

-Database

-Encrypt

-Force

-HostNameInCertificate

-InputFile

-InputObject

-OutputFile

-Password

-ServerInstance

-TrustServerCertificate

-Username

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

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

Примечания

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

Дополнительные ресурсы