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

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

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

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

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

Harvest API プロファイル設定

Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

トークン認証の使用

トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

OAuth 認証の使用

まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

以下の接続プロパティを設定すると、接続できるようになります。

  • ProfileSettings:ProfileSettings でAccountId を設定します。
  • AuthScheme:OAuth に設定します。
  • OAuthClientId:アプリ設定で指定したclient ID に設定します。
  • OAuthClientSecret:アプリ設定で指定したclient secret に設定します。
  • CallbackURL:アプリ設定で指定したRedirect URI に設定します。
  • InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

Harvest のデータの取得

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

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

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

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

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

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

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

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

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

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

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

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

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

おわりに

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

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

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

Harvest に接続 お問い合わせ