Confluence データをPowerShell でMySQL にレプリケーションする方法

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

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

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

API Token を取得する方法

API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

Confluence Cloud Account への接続

Cloud アカウントへの接続には、以下のプロパティを設定します（Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。）:

• User: Confluence サーバーに認証するユーザー名。
• APIToken: 認証するユーザーに紐付けられたAPI Token。
• Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

Confluence Server Instance への接続

Server instance への接続には以下を設定します:

• User: Confluence Instance に接続するユーザー名。
• Password: Confluence Instance に接続するユーザーのパスワード。
• Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

Confluence データの取得

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

   Install-Module ConfluenceCmdlets

2. Confluence への接続:

   $confluence = Connect-Confluence -User $User -APIToken $APIToken -Url $Url -Timezone $Timezone

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

   $data = Select-Confluence -Connection $confluence -Table "Pages"

   Invoke-Confluence cmdlet を使って、SQL-92 クエリを使用することもできます:

   $data = Invoke-Confluence -Connection $confluence -Query 'SELECT * FROM Pages WHERE Id = @Id' -Params @{'@Id'='10000'}

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

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

Confluence データを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. Confluence、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、Confluence のリソース（Pages）と同じテーブル名を持っている必要があります。

   $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Pages" -Columns $columns -Values $values }

次回以降のレプリケーションをシンプルに実現

• 一度PowerShell でConfluence とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:

  Select-Confluence -Connection $confluence -Table "Pages" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Pages" -Columns $columns -Values $values }

• 別のPowerShell モジュールで、Confluence を別のデータベースに複製する場合、Select-Confluence cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。

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

おわりに

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