PowerShell Scripting to Replicate X-Cart Data to MySQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart Data Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to X-Cart. 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 X-Cart data to a MySQL database.

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

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

An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

  • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
  • Search for REST API Module. Install the Module.
  • After the module has been installed, you need to set it up.
    • Go to the Settings section for the REST API Module.
    • On the settings page specify the API Key (only read)
  • Set the ApiKey and Url to the connection property to connect to data.

Collecting X-Cart Data

  1. Install the module:

    Install-Module XCartCmdlets
  2. Connect to X-Cart:

    $xcart = Connect-XCart -Url $Url -ApiKey $ApiKey
  3. Retrieve the data from a specific resource:

    $data = Select-XCart -Connection $xcart -Table "PROFILES"

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

    $data = Invoke-XCart -Connection $xcart -Query 'SELECT * FROM PROFILES WHERE Language = @Language' -Params @{'@Language'='en'}
  4. Save a list of the column names from the returned data.

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

Inserting X-Cart 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 X-Cart 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 X-Cart resource (PROFILES) and to exist in the database.

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

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

Notes

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

    Select-XCart -Connection $xcart -Table "PROFILES" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "PROFILES" -Columns $columns -Values $values }
  • If you wish to replicate the X-Cart 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-XCart 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')}