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

PowerShell のシンプルなスクリプトで、SuiteCRM のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。

古川えりか
コンテンツスペシャリスト

最終更新日:2023-09-26

この記事で実現できるSuiteCRM 連携のシナリオ

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

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

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

次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。

  • Schema:suitecrmv4 に設定。
  • Url:SuiteCRM アプリケーションに紐づいているURL(例:http://suite.crm.com)に設定。
  • User:SuiteCRM に紐づいているユーザーに設定。
  • Password:SuiteCRM に紐づいているパスワードに設定。

SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。

SuiteCRM のデータの取得

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

    Install-Module SuiteCRMCmdlets
  2. SuiteCRM への接続:

    $suitecrm = Connect-SuiteCRM -URL $URL -User $User -Password $Password
  3. 取得ターゲットのリソースの取得:

    $data = Select-SuiteCRM -Connection $suitecrm -Table "Accounts"

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

    $data = Invoke-SuiteCRM -Connection $suitecrm -Query 'SELECT * FROM Accounts WHERE Industry = @Industry' -Params @{'@Industry'='Manufacturing'}
  4. 戻り値からカラム名のリストを保存します。

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

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

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

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

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

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

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

おわりに

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。