製品をチェック

無償トライアル:

無償トライアルへ

製品の情報と無償トライアルへ:

Backlog Data Cmdlets

PowerShell Cmdlets は、Backlog へのリアルタイム連携機能を提供します。Cmdlets を使って、データに直接連携し、読み書き更新をDB と同感覚で行うことができます。

データ連携でお困りですか？

お問い合わせ

記事の内容

関連記事

Backlog データをMySQL にレプリケーションするPowerShell スクリプト


PowerShell でシンプルなスクリプトを記述し、Backlog data をMySQL データベースにレプリケーション（複製）。

古川えりか
コンテンツスペシャリスト

backlog ロゴ画像

Cmdlets

powershell ロゴ画像
MySQL ロゴ画像

CData Cmdlets for Backlog をつかって、PowerShell からリアルタイムBacklog data に連携できます。データ同期などのタスクの連携にぴったりの製品です。 本記事では、PowerShell からCData Cmdlets for Backlog およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。

まずは、PowerShell でBacklog への接続を行います。レプリケーションは4つのステップがあります。

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

API キー認証

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

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

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。

Backlog データの取得

  1. モジュールのインストール:

    Install-Module BacklogCmdlets

  2. Backlog への接続:

    $backlog = Connect-Backlog -ApiKey $ApiKey -Url $Url

  3. 取得ターゲットのリソースの取得:

    $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'}

  4. 戻り値からカラム名のリストを保存します。

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Backlog データをMySQL データベースに入れます

カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。

  1. モジュールのインストール:

    Install-Module MySQLCmdlets

  2. MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port

  3. 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 }

これで、Backlog データをMySQL に複製できました。これで、分析、BI などでBacklog データをMySQL から使うことができるようになります。

Notes

  • 一度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 のデータから、カラム、接続およびテーブルを除外する方がいいでしょう。これらのデータは、CData cmdlet からデータを移動する際にのみ必要なものだからです。:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}