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

古川えりか
古川えりか
コンテンツスペシャリスト
PowerShell のシンプルなスクリプトで、Aha のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。

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

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

まず、Profile 接続プロパティをディスク上のAha! プロファイルの場所に設定します(例:C:\profiles\aha.apip)。次に、ProfileSettings 接続プロパティをAha! の接続文字列に設定します(以下を参照)。

Aha! API プロファイル設定

Aha! API はOAuth ベースの認証を使用します。

まず、Aha! でOAuth アプリを登録する必要があります。これはAha! アカウントの「Settings」>「Personal」>「Developer」>「OAuth Applications」から行えます。また、Aha アカウントのドメイン名にあるDomain を設定します。例えば、Aha アカウントがacmeinc.aha.io の場合、Domain は「acmeinc」となります。

以下の項目を接続文字列に設定すると、接続できるようになります。

  • AuthScheme:OAuth に設定します。
  • InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId:アプリ設定で指定されたclient_id に設定します。
  • OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
  • CallbackURL:アプリ設定で指定したRedirect URI に設定します。
  • Domain:ProfileSettings でAha ドメインに設定します。

Aha のデータの取得

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

    Install-Module APICmdlets
  2. Aha への接続:

      $api = Connect-API  -Profile $Profile -ProfileSettings $ProfileSettings -Authscheme $Authscheme -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackUrl $CallbackUrl
      
  3. 取得ターゲットのリソースの取得:

      $data = Select-API -Connection $api -Table "Ideas"
      

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

      $data = Invoke-API -Connection $api -Query 'SELECT * FROM Ideas WHERE AssignedToUserId = @AssignedToUserId' -Params @{'@AssignedToUserId'='my_user_id'}
      
  4. 戻り値からカラム名のリストを保存します。

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

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

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

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

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

      Select-API -Connection $api -Table "Ideas" | % {
        $row = $_
        $values = @()
        $columns | % {
          $col = $_
          $values += $row.$($col)
        }
        Add-MySQL -Connection $mysql -Table "Ideas" -Columns $columns -Values $values
      }
      
  • 別のPowerShell モジュールで、Aha を別のデータベースに複製する場合、Select-API cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。

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

おわりに

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

はじめる準備はできましたか?

API Driver で Aha のライブデータに接続

Aha に接続 お問い合わせ