Ready to get started?

Download a free trial of the SuiteCRM Cmdlets to get started:

 Download Now

Learn more:

SuiteCRM Icon SuiteCRM Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to SuiteCRM data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

PowerShell Scripting to Replicate SuiteCRM Data to MySQL

Write a simple PowerShell script to replicate SuiteCRM data to a MySQL database.

The CData Cmdlets for SuiteCRM offer live access to SuiteCRM data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for SuiteCRM and the CData Cmdlets for MySQL in PowerShell to replicate SuiteCRM data to a MySQL database.

After obtaining the needed connection properties, accessing SuiteCRM data in PowerShell and preparing for replication consists of four basic steps.

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

Collecting SuiteCRM Data

  1. Install the module:

    Install-Module SuiteCRMCmdlets
  2. Connect to SuiteCRM:

    $suitecrm = Connect-SuiteCRM -URL $URL -User $User -Password $Password
  3. Retrieve the data from a specific resource:

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

    You can also use the Invoke-SuiteCRM cmdlet to execute pure SQL-92 statements:

    $data = Invoke-SuiteCRM -Connection $suitecrm -Query 'SELECT * FROM Accounts WHERE Industry = @Industry' -Params @{'@Industry'='Manufacturing'}
  4. Save a list of the column names from the returned data.

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

Inserting SuiteCRM Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the SuiteCRM data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the SuiteCRM resource (Accounts) and to exist in the database.

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

You have now replicated your SuiteCRM data to a MySQL database. This gives you freedom to work with SuiteCRM data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.


  • Once you have connected to SuiteCRM and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-SuiteCRM -Connection $suitecrm -Table "Accounts" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Accounts" -Columns $columns -Values $values }
  • If you wish to replicate the SuiteCRM data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-SuiteCRM cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

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