Invoke-SqlNotebook

Sintaxe

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

Description

O cmdlet Invoke-SqlNotebook executa um arquivo sql notebook (.ipynb) e gera o notebook materializado.

O Notebook será executado no ServerInstance e no Banco de Dados fornecidos.

Quando o cmdlet for executado, o arquivo do Notebook resultante estará no local definido pelo usuário ou no mesmo diretório do arquivo de notebook de entrada.

O arquivo de saída do cmdlet pode ser omitido: se esse for o caso, ele será criado com o nome do arquivo de entrada e o _out acrescentado ao arquivo.

Exemplos

Exemplo 1: Executar um Notebook no servidor local (instância padrão)

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

Esse comando executa o notebook na instância padrão do SQL Server em execução no computador do qual o cmdlet é executado. Por padrão, como nenhum -OutputFile foi passado, o notebook materializado é salvo em disco com o mesmo nome que o InputFile com um _out como um sufixo para o nome do arquivo (notebook.ipynb -> notebook_out.ipynb)

Exemplo 2: Executar Notebook no servidor local (instância desfator) e salva o Notebook materializado em um arquivo especificado

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

Esse comando executa o notebook na instância padrão do SQL Server em execução no computador do qual o cmdlet é executado. O notebook executado é salvo no arquivo especificado com o parâmetro -OutputFile.

Exemplo 3: Executar Notebook usando -ConnectionString parâmetro

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

Isso é o mesmo que o Exemplo 1, apenas que a conexão com o servidor é especificada por meio do parâmetro -ConnectionString.

Exemplo 4: Executar notebook em todos os servidores registrados

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";
            }
        }

Use servidores registrados ou servidor de gerenciamento central para executar Invoke-SqlNotebook em vários servidores. Neste exemplo, a propriedade NetName da instância do SQL Server será incluída no nome do arquivo de saída; o bloco de anotações materializado será carimbado com o ano-mês-dia-hora-minuto.

Exemplo 5: Executar Notebook, Abrir Resultados no Azure Data Studio

Instale o de extensão do PowerShell do marketplace do Azure Data Studio. Use o Console Integrado do PowerShell no Azure Data Studio para executar Invoke-SqlNotebook e usar Open-EditorFile para abrir os resultados do SQL Notebook diretamente no Azure Data Studio.

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

Observação: o comando Open-EditorFile só está disponível no Console Integrado do PowerShell.

Exemplo 6: Executar Notebook, Conectar-se aos Bancos de Dados SQL do Azure (ou Instância Gerenciada) usando uma Entidade de Serviço

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

Parâmetros

-AccessToken

-ConnectionString

-Credential

-Database

-Encrypt

-Force

-HostNameInCertificate

-InputFile

-InputObject

-OutputFile

-Password

-ProgressAction

-ServerInstance

-TrustServerCertificate

-Username

Entradas

System.Object

System.Management.Automation.PSCredential

Saídas

System.Object

Observações

Uma boa maneira de visualizar um Notebook materializado é usar o Azure Data Studio.

Links Relacionados

• Blocos de anotações SQL no Azure Data Studio
• Extensão do PowerShell
• SQLServer_Cmdlets
• Entidade de Serviço
• Identidade Gerenciada