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

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

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

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

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

Shippo API プロファイル設定

Shippo に認証するには、API Key が必要です。このAPI Key は「Settings」>「API」>「Generate Token」で確認できます。キーを生成した後、ProfileSettings 接続プロパティのAPIKey に設定します。

Shippo のデータの取得

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

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

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

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

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

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

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

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

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

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

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

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

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

おわりに

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

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

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

Shippo に接続 お問い合わせ