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

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

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

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

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

Xero のデータの取得

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

    Install-Module XeroCmdlets
  2. Xero への接続:

      $xero = Connect-Xero 
      
  3. 取得ターゲットのリソースの取得:

      $data = Select-Xero -Connection $xero -Table "Items"
      

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

      $data = Invoke-Xero -Connection $xero -Query 'SELECT * FROM Items WHERE Name = @Name' -Params @{'@Name'='Golf balls - white single'}
      
  4. 戻り値からカラム名のリストを保存します。

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

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

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

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

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

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

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

おわりに

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

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

Xero Cmdlets の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Xero Icon Xero Cmdlets お問い合わせ

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