PowerShell Scripting to Replicate Sugar CRM Data to MySQL

Ready to get started?

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

 Download Now

Learn more:

Sugar Icon SugarCRM Cmdlets

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

Write a simple PowerShell script to replicate Sugar CRM data to a MySQL database.

The CData Cmdlets for Sugar CRM offer live access to Sugar CRM 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 Sugar CRM and the CData Cmdlets for MySQL in PowerShell to replicate Sugar CRM data to a MySQL database.

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

The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

Collecting Sugar CRM Data

  1. Install the module:

    Install-Module SugarCRMCmdlets
  2. Connect to Sugar CRM:

    $sugarcrm = Connect-SugarCRM -User $User -Password $Password -URL $URL -CacheMetadata $CacheMetadata
  3. Retrieve the data from a specific resource:

    $data = Select-SugarCRM -Connection $sugarcrm -Table "Accounts"

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

    $data = Invoke-SugarCRM -Connection $sugarcrm -Query 'SELECT * FROM Accounts WHERE Name = @Name' -Params @{'@Name'='Bob'}
  4. Save a list of the column names from the returned data.

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

Inserting Sugar CRM 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 Sugar CRM 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 Sugar CRM 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 Sugar CRM data to a MySQL database. This gives you freedom to work with Sugar CRM 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 Sugar CRM and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-SugarCRM -Connection $sugarcrm -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 Sugar CRM 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-SugarCRM 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')}