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

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

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

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

Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。

Tenant プロパティの設定

プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。

• USProduction：リクエストはhttps://rest.zuora.com に送信されます。
• USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
• USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
• EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
• EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。

デフォルトではUSProduction テナントを使用します。

Zuora サービスの選択

データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。

DataQuery

データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。

制限

• フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
• 出力レコードの最大数： 100,000
• テナントごとの、実行用に送信される同時クエリの最大数： 5
• テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
• 1時間単位での、各クエリの最大処理時間： 1
• GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
• Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

AQuADataExport

AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。

制限

• AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
• 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。

Zuora データの取得

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

   Install-Module ZuoraCmdlets

2. Zuora への接続:

   $zuora = Connect-Zuora -OAuthClientID $OAuthClientID -OAuthClientSecret $OAuthClientSecret -Tenant $Tenant -ZuoraService $ZuoraService

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

   $data = Select-Zuora -Connection $zuora -Table "Invoices"

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

   $data = Invoke-Zuora -Connection $zuora -Query 'SELECT * FROM Invoices WHERE BillingState = @BillingState' -Params @{'@BillingState'='CA'}

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

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

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

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

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

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

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

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

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

おわりに

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