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

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

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

Excel Online への接続を設定

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

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

    Import-Module ExcelOnlineCmdlets;

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

    $conn = Connect-ExcelOnline 

ワークブックに接続するには、Excel Online への認証を提供し、 次のプロパティを設定します。

• Workbook: ワークブックの名前かId に設定。利用可能なワークブックに関する情報のリストを表示する場合は、認証後にWorkbooks ビューに対してクエリを実行します。

• UseSandbox: Sandbox アカウントのワークブックに接続している場合はtrue に設定。それ以外の場合は、これを空のままにしてプロダクションアカウントに接続します。

OAuth 認証を使うこともできます。ユーザー資格情報の接続プロパティを設定せずに接続できます。接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。 他のOAuth 認証フローについては、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

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

Excel Online のデータを取得してCSV にパイプライン

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

Select-ExcelOnline -Connection $conn -Table Test_xlsx_Sheet1 | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTest_xlsx_Sheet1Data.csv -NoTypeInformation

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

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

データの削除

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

Select-ExcelOnline -Connection $conn -Table Test_xlsx_Sheet1 -Where "Column2 = Bob" | Remove-ExcelOnline

データの挿入と更新

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

Import-Csv -Path C:\MyTest_xlsx_Sheet1Updates.csv | %{
  $record = Select-ExcelOnline -Connection $ExcelOnline -Table Test_xlsx_Sheet1 -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ExcelOnline -Connection $excelonline -Table Test_xlsx_Sheet1 -Columns ("Id","Column1") -Values ($_.Id, $_.Column1) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ExcelOnline -Connection $excelonline -Table Test_xlsx_Sheet1 -Columns ("Id","Column1") -Values ($_.Id, $_.Column1)
  }
}

おわりに

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