Ready to get started?

Learn more about the IBM Cloudant PowerShell Cmdlets or download a free trial:

Download Now

PowerShell Scripting to Replicate Cloudant Data to MySQL

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

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

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

Set the following connection properties to connect to Cloudant:

  • User: Set this to your username.
  • Password: Set this to your password.

Collecting Cloudant Data

  1. Install the module:

    Install-Module CloudantCmdlets
  2. Connect to Cloudant:

    $cloudant = Connect-Cloudant -User $User -Password $Password
  3. Retrieve the data from a specific resource:

    $data = Select-Cloudant -Connection $cloudant -Table "Movies"

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

    $data = Invoke-Cloudant -Connection $cloudant -Query 'SELECT * FROM Movies WHERE MovieRating = @MovieRating' -Params @{'@MovieRating'='R'}
  4. Save a list of the column names from the returned data.

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

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

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

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

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