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

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

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

FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。

• Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
• APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。

Freshdesk のデータの取得

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

   Install-Module FreshDeskCmdlets

2. Freshdesk への接続:

     $freshdesk = Connect-FreshDesk  -Domain $Domain -APIKey $APIKey
     

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

     $data = Select-FreshDesk -Connection $freshdesk -Table "Tickets"
     

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

     $data = Invoke-FreshDesk -Connection $freshdesk -Query 'SELECT * FROM Tickets WHERE Status = @Status' -Params @{'@Status'='2'}
     

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

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

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

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

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

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

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

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

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

おわりに

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