Ready to get started?

Download a free trial of the IBM Cloud Data Engine Cmdlets to get started:

 Download Now

Learn more:

IBM Cloud Data Engine Icon IBM Cloud Data Engine Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to IBM Cloud Data Engine. The Cmdlets allow users to easily query live data - just like working with SQL server.

PowerShell Scripting to Replicate IBM Cloud Data Engine Data to MySQL



Write a simple PowerShell script to replicate IBM Cloud Data Engine data to a MySQL database.

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

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

IBM Cloud Data Engine uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Collecting IBM Cloud Data Engine Data

  1. Install the module:

    Install-Module IBMCloudDataEngineCmdlets
  2. Connect to IBM Cloud Data Engine:

    $ibmclouddataengine = Connect-IBMCloudDataEngine -Api Key $Api Key -Instance CRN $Instance CRN -Region $Region -Schema $Schema -OAuth Client Id $OAuth Client Id -OAuth Client Secret $OAuth Client Secret
  3. Retrieve the data from a specific resource:

    $data = Select-IBMCloudDataEngine -Connection $ibmclouddataengine -Table "Jobs"

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

    $data = Invoke-IBMCloudDataEngine -Connection $ibmclouddataengine -Query 'SELECT * FROM Jobs WHERE UserId = @UserId' -Params @{'@UserId'='user@domain.com'}
  4. Save a list of the column names from the returned data.

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

Inserting IBM Cloud Data Engine 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 IBM Cloud Data Engine 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 IBM Cloud Data Engine resource (Jobs) and to exist in the database.

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

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

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