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 Notebook ファイル (.ipynb) を実行し、具体化されたノートブックを出力します。

ノートブックは、提供された ServerInstance とデータベースで実行されます。

コマンドレットを実行すると、結果の Notebook ファイルは、ユーザーが定義した場所、または入力ノートブック ファイルの同じディレクトリに配置されます。

コマンドレットの出力ファイルは省略できます。その場合は、入力ファイル名とファイルに追加された _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 が渡されていないため、具体化されたノートブックは、ファイル名のサフィックスとして _out を持つ InputFile と同じ名前のディスクに保存されます (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 を実行します。 この例では、SQL Server インスタンスの NetName プロパティが出力ファイルの名前に含まれます。具体化されたノートブックには、年月の日時分のタイムスタンプが付けられます。

例 5: ノートブックを実行し、Azure Data Studio で結果を開く

Azure Data Studio Marketplace から PowerShell 拡張機能 をインストールします。 Azure Data Studio の PowerShell 統合コンソールを使用して Invoke-SqlNotebook を実行し、Open-EditorFile を使用して SQL Notebook の結果を 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

-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 を使用することです。

関連リンク

• Azure Data Studio の SQL Notebook
• PowerShell 拡張機能
• SQLServer_Cmdlets
• サービス プリンシパル
• マネージド ID