PowerShell Scripting to Replicate Adobe Commerce Data to MySQL

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

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

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

• Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

• Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

  If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

Collecting Adobe Commerce Data

1. Install the module:

   Install-Module Adobe CommerceCmdlets

2. Connect to Adobe Commerce:

   $adobe commerce = Connect-Adobe Commerce -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL -Url $Url

3. Retrieve the data from a specific resource:

   $data = Select-Adobe Commerce -Connection $adobe commerce -Table "Products"

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

   $data = Invoke-Adobe Commerce -Connection $adobe commerce -Query 'SELECT * FROM Products WHERE Style = @Style' -Params @{'@Style'='High Tech'}

4. Save a list of the column names from the returned data.

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

Inserting Adobe Commerce 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 Adobe Commerce 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 Adobe Commerce resource (Products) and to exist in the database.

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

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

  Select-Adobe Commerce -Connection $adobe commerce -Table "Products" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Products" -Columns $columns -Values $values }

• If you wish to replicate the Adobe Commerce 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-Adobe Commerce 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')}