Invoke-SqlNotebook

Referencia

Módulo:: SQLServer

Ejecuta un archivo de SQL Notebook (.ipynb) y genera el cuaderno materializado.

Syntax

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

Description

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

El cuaderno se ejecutará en la base de datos y ServerInstance 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 ese es el caso, se creará con el nombre de 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 con la instancia predeterminada de SQL Server que se ejecuta en el equipo desde el que se ejecuta el cmdlet. De forma predeterminada, dado que no se pasó -OutputFile , el cuaderno materializado se guarda en el disco con el mismo nombre que 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 con la instancia predeterminada de SQL Server que se ejecuta en el equipo desde el 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 el parámetro -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

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 NetName propiedad de la instancia de SQL Server se incluirá en el nombre del archivo de salida; el cuaderno materializado se marcará con un minuto de año-mes-día-hora.

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 Open-EditorFile comando solo está disponible en la consola integrada de PowerShell.

Ejemplo 6: Ejecutar cuaderno, Conectarse 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

Token de acceso que se usa para autenticarse en SQL Server, como alternativa a la autenticación de usuario o contraseña de Windows.

Esto se puede usar, por ejemplo, para conectarse a SQL Azure DB y SQL Azure Managed Instance usar o Service Principal ( Managed Identity vea referencias en la parte inferior de esta página).

En escenarios comunes, este parámetro se obtiene con algo parecido (Get-AzAccessToken -ResourceUrl https://database.windows.net).Token (requiere el módulo Az.Account).

No especifique UserName, Password o Credential al usar este parámetro.

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

-ConnectionString

Especifica un cadena de conexión para conectarse al servidor.

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

-Credential

Objeto PSCredential cuyos campos Nombre de usuario y Contraseña se usarán para conectarse a la instancia de SQL.

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

-Database

Este cmdlet se conecta a esta base de datos en la instancia especificada en el parámetro ServerInstance.

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

-Encrypt

Tipo de cifrado que se va a usar al conectarse a SQL Server.

Este valor se asigna a la Encrypt propiedad SqlConnectionEncryptOption del objeto SqlConnection del controlador Microsoft.Data.SqlClient.

En la versión 22 del módulo, el valor predeterminado es Optional (por compatibilidad con v21). En la versión 23+ del módulo, el valor predeterminado será "Obligatorio", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del módulo.

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

-Force

De forma predeterminada, cuando el cmdlet escribe el cuaderno materializado en un archivo, se realiza una comprobación para evitar que el usuario sobrescriba accidentalmente un archivo existente. Use -Force para omitir esta comprobación y permitir que el cmdlet sobrescriba el archivo existente.

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

-HostNameInCertificate

Nombre de host que se va a usar al validar el certificado TLS/SSL de SQL Server.

Este parámetro es nuevo en la versión 22 del módulo.

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

-InputFile

Especifica un archivo de cuaderno (.ipynb) que se ejecutará a través del cmdlet .

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

-InputObject

Especifica el cuaderno como una cadena Json que se usará como cuaderno de entrada.

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

-OutputFile

Especifica el archivo notebook de salida deseado para el que se guardará el cuaderno ejecutado.

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

-Password

Especifica la contraseña del identificador de inicio de sesión de autenticación de SQL Server que se especificó en el parámetro Username.

En las contraseñas se distingue entre mayúsculas y minúsculas. Cuando sea posible, use la autenticación de Windows o considere la posibilidad de usar el parámetro -Credential en su lugar.

Si especifica el parámetro Password seguido de la contraseña, la contraseña es visible para cualquier persona que pueda ver el monitor.

Si codifica la contraseña seguida de la contraseña en un script de .ps1, cualquier persona que lea el archivo de script verá la contraseña.

Asigne los permisos NTFS apropiados al archivo para impedir que otros usuarios puedan leer el archivo.

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

-ServerInstance

Especifica una cadena de caracteres o un objeto SQL Server Objetos de administración (SMO) que especifica el nombre de una instancia del motor de base de datos.

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

-TrustServerCertificate

Indica si el canal se cifrará al pasar la cadena de certificados para validar la confianza.

En la versión 22 del módulo, el valor predeterminado es $true (por compatibilidad con v21). En la versión 23 y posteriores del módulo, el valor predeterminado será "$false", lo que puede crear un cambio importante para los scripts existentes.

Este parámetro es nuevo en la versión 22 del módulo.

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

-Username

Especifica el identificador de inicio de sesión para establecer una conexión de la autenticación de SQL Server con una instancia del Motor de base de datos.

La contraseña debe especificarse a través del parámetro Password.

Si no se especifica el nombre de usuario y la contraseña, este cmdlet intenta una conexión de autenticación de Windows mediante la cuenta de Windows que ejecuta la sesión de Windows PowerShell. Siempre que sea posible, utilice la autenticación de Windows.

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

Entradas

System.Object

System.Management.Automation.PSCredential

Salidas

System.Object

Notas

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

Invoke-SqlNotebook

Syntax

Description

Ejemplos

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

Ejemplo 2: Ejecutar cuaderno en el servidor local (instancia de defaut) y guardar el cuaderno materializado en un archivo especificado

Ejemplo 3: Ejecutar cuaderno mediante el parámetro -ConnectionString

Ejemplo 4: Ejecutar cuaderno en todos los servidores registrados

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

Ejemplo 6: Ejecutar cuaderno, Conectarse a bases de datos de Azure SQL (o Instancia administrada) mediante una entidad de servicio

Parámetros

-AccessToken

-ConnectionString

-Credential

-Database

-Encrypt

-Force

-HostNameInCertificate

-InputFile

-InputObject

-OutputFile

-Password

-ServerInstance

-TrustServerCertificate

-Username

Entradas

Salidas

Notas

Vínculos relacionados

Recursos adicionales