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

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

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

それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

アクセストークンによる接続

アクセストークン経由の接続には、以下の2つのステップが必要です。

1. Shopify の管理画面でアクセストークンを作成
2. アクセストークンを使用して認証

アクセストークンの作成

まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

1. 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
2. Develop apps をクリックしてCreate an app を選択します
3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
4. Save をクリックします
5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
   • unauthenticated_read_content
6. Save をクリックします
7. API Credentials を選択します
8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
9. Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

アクセストークンによる認証

続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

• AuthScheme：AccessToken に設定
• AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

Shopify のデータの取得

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

   Install-Module ShopifyCmdlets

2. Shopify への接続:

     $shopify = Connect-Shopify  -AppId $AppId -Password $Password -ShopUrl $ShopUrl
     

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

     $data = Select-Shopify -Connection $shopify -Table "Customers"
     

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

     $data = Invoke-Shopify -Connection $shopify -Query 'SELECT * FROM Customers WHERE FirstName = @FirstName' -Params @{'@FirstName'='jdoe1234'}
     

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

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

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

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

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

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

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

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

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

おわりに

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