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

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

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

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

Box への接続を設定

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

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

    Import-Module BoxCmdlets;

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

    $conn = Connect-Box  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Box 接続プロパティの取得・設定方法

Box は、認証にOAuth スタンダードを使用します。Box への認証には、登録アプリのOAuthClientId、OAuthClientSecret、CallbackURL を取得して、接続プロパティに設定してください。詳細はヘルプドキュメントの「はじめに」を参照してください。

なお、Box Driver はBox のファイルの一覧表示やユーザー管理情報の取得用です。Box に保管されているExcel、CSV、JSON などのファイル内のデータを読み込みたい場合には、それぞれExcel Driver、CSV Driver、JSON Driver をご利用ください。

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

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

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

Select-Box -Connection $conn -Table Files | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myFilesData.csv -NoTypeInformation

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

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

データの削除

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

Select-Box -Connection $conn -Table Files -Where "Id = 123" | Remove-Box

データの挿入と更新

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

Import-Csv -Path C:\MyFilesUpdates.csv | %{
  $record = Select-Box -Connection $Box -Table Files -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Box -Connection $box -Table Files -Columns ("Name","Size") -Values ($_.Name, $_.Size) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Box -Connection $box -Table Files -Columns ("Name","Size") -Values ($_.Name, $_.Size)
  }
}

おわりに

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