Ready to get started?

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

 Download Now

Learn more:

WooCommerce Icon WooCommerce Cmdlets

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

PowerShell Scripting to Replicate WooCommerce Data to MySQL



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

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

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

WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

Connecting using one-legged OAuth 1.0 Authentication

Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

  • ConsumerKey
  • ConsumerSecret

Connecting using WordPress OAuth 2.0 Authentication

After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL
  • InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

In either case, you will need to set the Url property to the URL of the WooCommerce instance.

Collecting WooCommerce Data

  1. Install the module:

    Install-Module WooCommerceCmdlets
  2. Connect to WooCommerce:

    $woocommerce = Connect-WooCommerce -Url $Url -ConsumerKey $ConsumerKey -ConsumerSecret $ConsumerSecret
  3. Retrieve the data from a specific resource:

    $data = Select-WooCommerce -Connection $woocommerce -Table "Orders"

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

    $data = Invoke-WooCommerce -Connection $woocommerce -Query 'SELECT * FROM Orders WHERE ParentId = @ParentId' -Params @{'@ParentId'='3'}
  4. Save a list of the column names from the returned data.

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

Inserting WooCommerce 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 WooCommerce 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 WooCommerce resource (Orders) and to exist in the database.

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

You have now replicated your WooCommerce data to a MySQL database. This gives you freedom to work with WooCommerce 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 WooCommerce and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

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