各製品の資料を入手。
詳細はこちら →Backlog のデータをPowerShell でMySQL にレプリケーションする方法
PowerShell のシンプルなスクリプトで、Backlog のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。
最終更新日:2023-09-26
この記事で実現できるBacklog 連携のシナリオ
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
CData Cmdlets for Backlog を使えば、PowerShell からBacklog のデータ データにリアルタイムで連携できます。データ同期などのタスクの連携にぴったりの製品です。 本記事では、PowerShell からCData Cmdlets for Backlog およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。
まずは、PowerShell でBacklog への接続を行います。レプリケーションは4つのステップがあります。
Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。
API キー認証
ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには:
- Backlog の個人設定ページを開きます。
- 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
- ApiKey にAPI キーを指定します。
- URL はBacklog のテナントURL から取得できます。
OAuth 認証
ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。Backlog のデータの取得
-
モジュールのインストール:
Install-Module BacklogCmdlets
-
Backlog への接続:
$backlog = Connect-Backlog -ApiKey $ApiKey -Url $Url
-
取得ターゲットのリソースの取得:
$data = Select-Backlog -Connection $backlog -Table "Issues"
Invoke-Backlog cmdlet を使って、SQL-92 クエリを使用することもできます:
$data = Invoke-Backlog -Connection $backlog -Query 'SELECT * FROM Issues WHERE Id = @Id' -Params @{'@Id'='1'}
-
戻り値からカラム名のリストを保存します。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name
Backlog のデータをMySQL データベースにレプリケーション
カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。
-
モジュールのインストール:
Install-Module MySQLCmdlets
-
MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:
$mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
-
Backlog、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、Backlog のリソース(Issues)と同じテーブル名を持っている必要があります。
$data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Issues" -Columns $columns -Values $values }
次回以降のレプリケーションをシンプルに実現
-
一度PowerShell でBacklog とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:
Select-Backlog -Connection $backlog -Table "Issues" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Issues" -Columns $columns -Values $values }
-
別のPowerShell モジュールで、Backlog を別のデータベースに複製する場合、Select-Backlog cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。
$columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}
おわりに
これで、Backlog のデータをMySQL に複製できました。分析、BI などでBacklog のデータをMySQL から使うことができるようになります。