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

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

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

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

Backlog への接続を設定

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

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

    Import-Module BacklogCmdlets;

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

    $conn = Connect-Backlog  -ApiKey "$ApiKey" -Url "$Url"

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

1. Backlog の個人設定ページを開きます。
2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
3. ApiKey にAPI キーを指定します。
4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

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

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

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

Select-Backlog -Connection $conn -Table Issues | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myIssuesData.csv -NoTypeInformation

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

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

データの削除

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

Select-Backlog -Connection $conn -Table Issues -Where "Id = 1" | Remove-Backlog

データの挿入と更新

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

Import-Csv -Path C:\MyIssuesUpdates.csv | %{
  $record = Select-Backlog -Connection $Backlog -Table Issues -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Backlog -Connection $backlog -Table Issues -Columns ("Id","ProjectID") -Values ($_.Id, $_.ProjectID) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Backlog -Connection $backlog -Table Issues -Columns ("Id","ProjectID") -Values ($_.Id, $_.ProjectID)
  }
}

おわりに

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