PowerShell からAzure Synapse データに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Cmdlets for AzureSynapse を使えば、PowerShell からAzure Synapse に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、Azure Synapse への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

Azure Synapse への接続を設定

それでは、まずはAzure Synapse への接続設定からはじめていきましょう。接続設定にはCData Azure Synapse Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module AzureSynapseCmdlets;

Connect-AzureSynapse コマンドを使ってAzure Synapse との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-AzureSynapse  -User "$User" -Password "$Password" -Server "$Server" -Database "$Database"

Azure Synapse への接続

Azure Synapse データベースに接続するには、認証に加えて（下記参照）、次のプロパティを設定します。

• Server：Azure を実行しているサーバー。Azure ポータルにログインして、［Azure Synapse Analytics］->［Select your database］->［Overview］->［Server name］に進むと確認できます。
• Database：［Azure Synapse Analytics］ページのAzure ポータルに表示されるデータベース名。

Azure Synapse への認証

次のプロパティを使用してAzure Synapse に接続します。

• User：Azure との認証のためのユーザー名。
• Password：認証ユーザーに関連付けられたパスワード。

これで接続設定は完了です。

Azure Synapse データを取得してCSV にパイプライン

接続が完了したので、Products テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-AzureSynapse -Connection $conn -Table Products | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myProductsData.csv -NoTypeInformation

このコードでは、Select-AzureSynapse から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-AzureSynapse -Connection $conn -Table Products -Where "ProductName = Konbu" | Remove-AzureSynapse

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyProductsUpdates.csv | %{
  $record = Select-AzureSynapse -Connection $AzureSynapse -Table Products -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-AzureSynapse -Connection $azuresynapse -Table Products -Columns ("Id","ProductName") -Values ($_.Id, $_.ProductName) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-AzureSynapse -Connection $azuresynapse -Table Products -Columns ("Id","ProductName") -Values ($_.Id, $_.ProductName)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのAzure Synapse データへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。