Invoke-SqlNotebook

Sintaxis

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

El cmdlet Invoke-SqlNotebook ejecuta un archivo de SQL Notebook (.ipynb) y genera el cuaderno materializado.

El cuaderno se ejecutará en serverinstance y la base de datos proporcionadas.

Cuando se ejecuta el cmdlet, el archivo notebook resultante estará en la ubicación en la que el usuario define o en el mismo directorio del archivo de cuaderno de entrada.

Se puede omitir el archivo outfile del cmdlet: si es así, se creará con el nombre del archivo de entrada y el _out anexado al archivo.

Ejemplos

Ejemplo 1: Ejecutar un cuaderno en el servidor local (instancia predeterminada)

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

Este comando ejecuta el cuaderno en la instancia predeterminada de SQL Server que se ejecuta en la máquina desde la que se ejecuta el cmdlet. De forma predeterminada, dado que no se pasó ningún -OutputFile, el cuaderno materializado se guarda en el disco con el mismo nombre que el InputFile con un _out como sufijo al nombre de archivo (notebook.ipynb - notebook_out.ipynb)

Ejemplo 2: Ejecutar cuaderno en el servidor local (instancia de defaut) y guardar el cuaderno materializado en un archivo 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

Este comando ejecuta el cuaderno en la instancia predeterminada de SQL Server que se ejecuta en la máquina desde la que se ejecuta el cmdlet. A continuación, el cuaderno ejecutado se guarda en el archivo especificado con el parámetro -OutputFile.

Ejemplo 3: Ejecutar cuaderno mediante -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

Esto es lo mismo que el ejemplo 1, solo que la conexión al servidor se especifica a través del parámetro -ConnectionString.

Ejemplo 4: Ejecutar cuaderno en todos los 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 o servidor de administración central para ejecutar Invoke-SqlNotebook en varios servidores. En este ejemplo, la propiedad NetName de la instancia de SQL Server se incluirá en el nombre del archivo de salida; el cuaderno materializado se marcará con marca de tiempo con un minuto de día de año.

Ejemplo 5: Ejecutar cuaderno, Abrir resultados en Azure Data Studio

Instale la extensión de PowerShell desde Marketplace de Azure Data Studio. Use la consola integrada de PowerShell en Azure Data Studio para ejecutar Invoke-SqlNotebook y usar Open-EditorFile para abrir los resultados de SQL Notebook directamente en Azure Data Studio.

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

Nota: El comando Open-EditorFile solo está disponible en la consola integrada de PowerShell.

Ejemplo 6: Ejecución de cuadernos, Conexión a bases de datos de Azure SQL (o Instancia administrada) mediante una entidad de servicio

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

Salidas

System.Object

Notas

Una buena manera de visualizar un cuaderno materializado es usar Azure Data Studio.

Vínculos relacionados

• Cuadernos de SQL en Azure Data Studio
• Extensión de PowerShell
• SQLServer_Cmdlets
• Entidad de servicio
• Identidad administrada